XML interfate to binning schemes, for use with the unfolding algorithm TUnfoldDensity.
Binning schemes are used to map analysis bins on a single histogram axis and back. The analysis bins may include unconnected bins (e.g nuisances for background normalisation) or various multidimensional histograms (signal bins, differential background normalisation bins, etc).
If you use this software, please consider the following citation
S.Schmitt, JINST 7 (2012) T10003 [arXiv:1205.6201]
Detailed documentation and updates are available on http://www.desy.de/~sschmitt
Please consult the documentation of the class TUnfoldBinning about how to use binning schemes. This class provides methods to read and write binning schemes in the XML language. There is also a method which writes out a dtd file for validation.
Example XML code
The example below encodes two binning schemes, detector and generator. The detecor scheme consists of a single, three-dimensional distribution (pt,eta,discriminator). The generator scheme consists of two two-dimensional distributions, signal and background.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE TUnfoldBinning SYSTEM "tunfoldbinning.dtd">
<TUnfoldBinning>
<BinningNode name="detector" firstbin="1" factor="1">
<BinningNode name="detectordistribution" firstbin="1" factor="1">
<Bin repeat="3" width="0.5" >
<Bin repeat="3" width="1" >
<Bin width="2" >
<Bin width="3" >
<Bin location="overflow">
<Bin repeat="2" width="0.5" >
<Bin width="1" >
<Bin repeat="4" width="0.5" >
<Bin width="1" >
<Bin repeat="2" width="0.5" >
<Bin width="0.15" >
<Bin repeat="2" width="0.35" >
<Bin width="0.15" >
</Axis>
</Axis>
</Axis>
</BinningNode>
</BinningNode>
<BinningNode name="generator" firstbin="1" factor="1">
<BinningNode name="signal" firstbin="1" factor="1">
<Bin location="underflow" >
<Bin width="1" >
<Bin width="2" >
<Bin width="3" >
<Bin location="overflow" >
<Bin location="underflow" >
<Bin width="1.5" >
<Bin width="1" >
<Bin width="1.5" >
<Bin location="overflow" >
</Axis>
</Axis>
</BinningNode>
<BinningNode name="background" firstbin="26" factor="1">
<Bin repeat="3" width="0.5" >
<Bin repeat="3" width="1" >
<Bin width="2" >
<Bin width="3" >
<Bin location="overflow" >
<Bin repeat="2" width="0.5" >
<Bin width="1" >
<Bin repeat="4" width="0.5" >
<Bin width="1" >
<Bin repeat="2" width="0.5" >
</Axis>
</Axis>
</BinningNode>
</BinningNode>
</TUnfoldBinning>
Definition at line 59 of file TUnfoldBinningXML.h.
|
| | TUnfoldBinningXML (const char *name=nullptr, Int_t nBins=0, const char *binNames=nullptr) |
| | construct a new binning scheme, for use with the root streamer
|
| |
| Int_t | ExportXML (const char *fileName) const |
| | export this binning scheme to a file
|
| |
| TClass * | IsA () const override |
| |
| void | Streamer (TBuffer &) override |
| | Stream an object of class TObject.
|
| |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| |
| | TUnfoldBinning (const char *name=nullptr, Int_t nBins=0, const char *binNames=nullptr) |
| | create a new node without axis
|
| |
| | TUnfoldBinning (const TAxis &axis, Int_t includeUnderflow, Int_t includeOverflow) |
| | create a new node containing a distribution with one axis
|
| |
| | ~TUnfoldBinning (void) override |
| |
| Bool_t | AddAxis (const char *name, Int_t nBins, const Double_t *binBorders, Bool_t hasUnderflow, Bool_t hasOverflow) |
| | add an axis with the specified bin borders
|
| |
| Bool_t | AddAxis (const char *name, Int_t nBins, Double_t xMin, Double_t xMax, Bool_t hasUnderflow, Bool_t hasOverflow) |
| | add an axis with equidistant bins
|
| |
| Bool_t | AddAxis (const TAxis &axis, Bool_t includeUnderflow, Bool_t includeOverflow) |
| | add an axis to the distribution, using the TAxis as blueprint
|
| |
| TUnfoldBinning * | AddBinning (const char *name, Int_t nBins=0, const char *binNames=nullptr) |
| | add a new binning node as last last child of this node
|
| |
| TUnfoldBinning * | AddBinning (TUnfoldBinning *binning) |
| | add a TUnfoldBinning as the last child of this node
|
| |
| Int_t * | CreateEmptyBinMap (void) const |
| | create an empty bin map, useful together with the getter methods of class TUnfold and TUnfoldSys
|
| |
| TH2D * | CreateErrorMatrixHistogram (const char *histogramName, Bool_t originalAxisBinning, Int_t **binMap=nullptr, const char *histogramTitle=nullptr, const char *axisSteering=nullptr) const |
| | create a TH2D histogram capable to hold a covariance matrix
|
| |
| TH1 * | CreateHistogram (const char *histogramName, Bool_t originalAxisBinning=kFALSE, Int_t **binMap=nullptr, const char *histogramTitle=nullptr, const char *axisSteering=nullptr) const |
| | create a THxx histogram capable to hold the bins of this binning node and its children
|
| |
| void | DecodeAxisSteering (const char *axisSteering, const char *options, Int_t *isOptionGiven) const |
| | decode axis steering
|
| |
| TH1 * | ExtractHistogram (const char *histogramName, const TH1 *globalBins, const TH2 *globalBinsEmatrix=nullptr, Bool_t originalAxisBinning=kTRUE, const char *axisSteering=nullptr) const |
| |
| Int_t | FillBinMap1D (Int_t *binMap, const char *axisSteering, Int_t firstBinX) const |
| | map all global bins referenced by this node to the one-dimensional histogram destHist, starting with bin firstBinX
|
| |
| TUnfoldBinning const * | FindNode (char const *name) const |
| | traverse the tree and return the first node which matches the given name
|
| |
| virtual Double_t | GetBinFactor (Int_t iBin) const |
| | return scaling factor for the given global bin number
|
| |
| TString | GetBinName (Int_t iBin) const |
| | get the name of a bin
|
| |
| Int_t | GetBinNeighbours (Int_t globalBin, Int_t axis, Int_t *prev, Double_t *distPrev, Int_t *next, Double_t *distNext, Bool_t isPeriodic=kFALSE) const |
| | get neighbour bins along the specified axis
|
| |
| Double_t | GetBinSize (Int_t iBin) const |
| | get N-dimensional bin size
|
| |
| void | GetBinUnderflowOverflowStatus (Int_t iBin, Int_t *uStatus, Int_t *oStatus) const |
| | return bit maps indicating underflow and overflow status
|
| |
| TUnfoldBinning * | GetChildNode (void) |
| |
| TUnfoldBinning const * | GetChildNode (void) const |
| | first daughter node
|
| |
| virtual Double_t | GetDistributionAverageBinSize (Int_t axis, Bool_t includeUnderflow, Bool_t includeOverflow) const |
| | get average bin size on the specified axis
|
| |
| TString | GetDistributionAxisLabel (Int_t axis) const |
| | get name of an axis
|
| |
| virtual Double_t | GetDistributionBinCenter (Int_t axis, Int_t bin) const |
| | return bin center for a given axis and bin number
|
| |
| TVectorD const * | GetDistributionBinning (Int_t axis) const |
| | get vector of bin borders for one axis
|
| |
| Int_t | GetDistributionDimension (void) const |
| | query dimension of this node's distribution
|
| |
| Int_t | GetDistributionNumberOfBins (void) const |
| | number of bins in the distribution possibly including under/overflow
|
| |
| virtual Double_t | GetDistributionOverflowBinWidth (Int_t axis) const |
| | return bin width assigned to the overflow bin
|
| |
| virtual Double_t | GetDistributionUnderflowBinWidth (Int_t axis) const |
| | return bin width assigned to the underflow bin
|
| |
| Int_t | GetEndBin (void) const |
| | last+1 bin of this node (includes children)
|
| |
| Int_t | GetGlobalBinNumber (const Double_t *x, Int_t *isBelow=nullptr, Int_t *isAbove=nullptr) const |
| | locate a bin in an N-dimensional distribution
|
| |
| Int_t | GetGlobalBinNumber (Double_t x) const |
| | locate a bin in a one-dimensional distribution
|
| |
| Int_t | GetGlobalBinNumber (Double_t x, Double_t y) const |
| | locate a bin in a two-dimensional distribution
|
| |
| Int_t | GetGlobalBinNumber (Double_t x, Double_t y, Double_t z) const |
| | locate a bin in a three-dimensional distribution
|
| |
| Int_t | GetGlobalBinNumber (Double_t x0, Double_t x1, Double_t x2, Double_t x3) const |
| | locate a bin in a four-dimensional distribution
|
| |
| Int_t | GetGlobalBinNumber (Double_t x0, Double_t x1, Double_t x2, Double_t x3, Double_t x4) const |
| | locate a bin in a five-dimensional distribution
|
| |
| Int_t | GetGlobalBinNumber (Double_t x0, Double_t x1, Double_t x2, Double_t x3, Double_t x4, Double_t x5) const |
| | locate a bin in a six-dimensional distribution
|
| |
| Double_t | GetGlobalFactor (void) const |
| | return global scaling factor for this node
|
| |
| TUnfoldBinning * | GetNextNode (void) |
| |
| TUnfoldBinning const * | GetNextNode (void) const |
| | next sister node
|
| |
| TUnfoldBinning * | GetParentNode (void) |
| |
| TUnfoldBinning const * | GetParentNode (void) const |
| | mother node
|
| |
| TUnfoldBinning const * | GetPrevNode (void) const |
| | previous sister node
|
| |
| TUnfoldBinning const * | GetRootNode (void) const |
| | return root node of the binnig scheme
|
| |
| Int_t | GetStartBin (void) const |
| | first bin of this node
|
| |
| Int_t | GetTH1xNumberOfBins (Bool_t originalAxisBinning=kTRUE, const char *axisSteering=nullptr) const |
| | return the number of histogram bins required when storing this binning in a one-dimensional histogram
|
| |
| const TObjString * | GetUnconnectedBinName (Int_t bin) const |
| | return the bin names of unconnected bins
|
| |
| Bool_t | HasOverflow (int axis) const |
| | check whether the axis has an overflow bin
|
| |
| Bool_t | HasUnconnectedBins (void) const |
| | check whether there are bins but no axis
|
| |
| Bool_t | HasUnderflow (int axis) const |
| | check whether an axis has an underflow bin
|
| |
| virtual Bool_t | IsBinFactorGlobal (void) const |
| | check whether there is only a global scaling factor for this node
|
| |
| void | PrintStream (std::ostream &out, Int_t indent=0, int debug=0) const |
| | print some information about this binning tree
|
| |
| void | SetBinFactorFunction (Double_t normalisation, TF1 *userFunc=nullptr) |
| | set normalisation factor and function which are used in calls to GetBinFactor()
|
| |
| void | SetBinMapEntry (Int_t *binMap, Int_t globalBin, Int_t destBin) const |
| | set one entry in a bin map
|
| |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| |
| | TNamed () |
| |
| | TNamed (const char *name, const char *title) |
| |
| | TNamed (const TNamed &named) |
| | TNamed copy ctor.
|
| |
| | TNamed (const TString &name, const TString &title) |
| |
| virtual | ~TNamed () |
| | TNamed destructor.
|
| |
| void | Clear (Option_t *option="") override |
| | Set name and title to empty strings ("").
|
| |
| TObject * | Clone (const char *newname="") const override |
| | Make a clone of an object using the Streamer facility.
|
| |
| Int_t | Compare (const TObject *obj) const override |
| | Compare two TNamed objects.
|
| |
| void | Copy (TObject &named) const override |
| | Copy this to obj.
|
| |
| virtual void | FillBuffer (char *&buffer) |
| | Encode TNamed into output buffer.
|
| |
| const char * | GetName () const override |
| | Returns name of object.
|
| |
| const char * | GetTitle () const override |
| | Returns title of object.
|
| |
| ULong_t | Hash () const override |
| | Return hash value for this object.
|
| |
| Bool_t | IsSortable () const override |
| |
| void | ls (Option_t *option="") const override |
| | List TNamed name and title.
|
| |
| TNamed & | operator= (const TNamed &rhs) |
| | TNamed assignment operator.
|
| |
| void | Print (Option_t *option="") const override |
| | Print TNamed name and title.
|
| |
| virtual void | SetName (const char *name) |
| | Set the name of the TNamed.
|
| |
| virtual void | SetNameTitle (const char *name, const char *title) |
| | Set all the TNamed parameters (name and title).
|
| |
| virtual void | SetTitle (const char *title="") |
| | Set the title of the TNamed.
|
| |
| virtual Int_t | Sizeof () const |
| | Return size of the TNamed part of the TObject.
|
| |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| |
| | TObject () |
| | TObject constructor.
|
| |
| | TObject (const TObject &object) |
| | TObject copy ctor.
|
| |
| virtual | ~TObject () |
| | TObject destructor.
|
| |
| void | AbstractMethod (const char *method) const |
| | Use this method to implement an "abstract" method that you don't want to leave purely abstract.
|
| |
| virtual void | AppendPad (Option_t *option="") |
| | Append graphics object to current pad.
|
| |
| virtual void | Browse (TBrowser *b) |
| | Browse object. May be overridden for another default action.
|
| |
| ULong_t | CheckedHash () |
| | Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
|
| |
| virtual const char * | ClassName () const |
| | Returns name of class to which the object belongs.
|
| |
| virtual void | Delete (Option_t *option="") |
| | Delete this object.
|
| |
| virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
| | Computes distance from point (px,py) to the object.
|
| |
| virtual void | Draw (Option_t *option="") |
| | Default Draw method for all objects.
|
| |
| virtual void | DrawClass () const |
| | Draw class inheritance tree of the class to which this object belongs.
|
| |
| virtual TObject * | DrawClone (Option_t *option="") const |
| | Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
|
| |
| virtual void | Dump () const |
| | Dump contents of object on stdout.
|
| |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| | Issue error message.
|
| |
| virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
| | Execute method on this object with the given parameter string, e.g.
|
| |
| virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
| | Execute method on this object with parameters stored in the TObjArray.
|
| |
| virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
| | Execute action corresponding to an event at (px,py).
|
| |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| | Issue fatal error message.
|
| |
| virtual TObject * | FindObject (const char *name) const |
| | Must be redefined in derived classes.
|
| |
| virtual TObject * | FindObject (const TObject *obj) const |
| | Must be redefined in derived classes.
|
| |
| virtual Option_t * | GetDrawOption () const |
| | Get option used by the graphics system to draw this object.
|
| |
| virtual const char * | GetIconName () const |
| | Returns mime type name of object.
|
| |
| virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| | Returns string containing info about the object at position (px,py).
|
| |
| virtual Option_t * | GetOption () const |
| |
| virtual UInt_t | GetUniqueID () const |
| | Return the unique object id.
|
| |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| | Execute action in response of a timer timing out.
|
| |
| Bool_t | HasInconsistentHash () const |
| | Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
|
| |
| virtual void | Info (const char *method, const char *msgfmt,...) const |
| | Issue info message.
|
| |
| virtual Bool_t | InheritsFrom (const char *classname) const |
| | Returns kTRUE if object inherits from class "classname".
|
| |
| virtual Bool_t | InheritsFrom (const TClass *cl) const |
| | Returns kTRUE if object inherits from TClass cl.
|
| |
| virtual void | Inspect () const |
| | Dump contents of this object in a graphics canvas.
|
| |
| void | InvertBit (UInt_t f) |
| |
| Bool_t | IsDestructed () const |
| | IsDestructed.
|
| |
| virtual Bool_t | IsEqual (const TObject *obj) const |
| | Default equal comparison (objects are equal if they have the same address in memory).
|
| |
| virtual Bool_t | IsFolder () const |
| | Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
|
| |
| R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
| |
| R__ALWAYS_INLINE Bool_t | IsZombie () const |
| |
| void | MayNotUse (const char *method) const |
| | Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
|
| |
| virtual Bool_t | Notify () |
| | This method must be overridden to handle object notification (the base implementation is no-op).
|
| |
| void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| | Use this method to declare a method obsolete.
|
| |
| void | operator delete (void *ptr) |
| | Operator delete.
|
| |
| void | operator delete (void *ptr, void *vp) |
| | Only called by placement new when throwing an exception.
|
| |
| void | operator delete[] (void *ptr) |
| | Operator delete [].
|
| |
| void | operator delete[] (void *ptr, void *vp) |
| | Only called by placement new[] when throwing an exception.
|
| |
| void * | operator new (size_t sz) |
| |
| void * | operator new (size_t sz, void *vp) |
| |
| void * | operator new[] (size_t sz) |
| |
| void * | operator new[] (size_t sz, void *vp) |
| |
| TObject & | operator= (const TObject &rhs) |
| | TObject assignment operator.
|
| |
| virtual void | Paint (Option_t *option="") |
| | This method must be overridden if a class wants to paint itself.
|
| |
| virtual void | Pop () |
| | Pop on object drawn in a pad to the top of the display list.
|
| |
| virtual Int_t | Read (const char *name) |
| | Read contents of object with specified name from the current directory.
|
| |
| virtual void | RecursiveRemove (TObject *obj) |
| | Recursively remove this object from a list.
|
| |
| void | ResetBit (UInt_t f) |
| |
| virtual void | SaveAs (const char *filename="", Option_t *option="") const |
| | Save this object in the file specified by filename.
|
| |
| virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
| | Save a primitive as a C++ statement(s) on output stream "out".
|
| |
| void | SetBit (UInt_t f) |
| |
| void | SetBit (UInt_t f, Bool_t set) |
| | Set or unset the user status bits as specified in f.
|
| |
| virtual void | SetDrawOption (Option_t *option="") |
| | Set drawing option for object.
|
| |
| virtual void | SetUniqueID (UInt_t uid) |
| | Set the unique object id.
|
| |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| | Issue system error message.
|
| |
| R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
| |
| Int_t | TestBits (UInt_t f) const |
| |
| virtual void | UseCurrentStyle () |
| | Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
|
| |
| virtual void | Warning (const char *method, const char *msgfmt,...) const |
| | Issue warning message.
|
| |
| virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
| | Write this object to the current directory.
|
| |
| virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
| | Write this object to the current directory.
|
| |
Public Member Functions inherited from TUnfoldBinning