RooCustomizer is a factory class to produce clones of a prototype composite PDF object with the same structure but different leaf servers (parameters or dependents).
RooCustomizer supports two kinds of modifications:
Splitting is particularly useful when building simultaneous fits to subsets of the data sample with different background properties. In such a case, the user builds a single prototype PDF representing the structure of the signal and background and splits the dataset into categories with different background properties. Using RooCustomizer a PDF for each subfit can be constructed from the prototype that has same structure and signal parameters, but different instances of the background parameters: e.g.
If the master category state is a super category, leafs may be split by any subset of that master category. E.g. if the master category is 'A x B', leafs may be split by A, B or AxB.
In addition to replacing leaf nodes, RooCustomizer clones all branch nodes that depend directly or indirectly on modified leaf nodes, so that the input pdf is untouched by each build operation.
The customizer owns all the branch nodes including the returned top level node, so the customizer should live as longs as the cloned composites are needed.
Any leaf nodes that are created by the customizer will be put into the leaf list that is passed into the customizers constructor (splitLeafs in the above example. The list owner is responsible for deleting these leaf nodes after the customizer is deleted.
By default, the customizer clones the prototype leaf node when splitting a leaf, but the user can feed pre-defined split leafs in leaf list. These leafs must have the name <split_leaf>_<splitcat_label> to be picked up. The list of pre-supplied leafs may be partial, any missing split leafs will be auto generated.
Another common construction is to have two prototype PDFs, each to be customized by a separate customizer instance, that share parameters. To ensure that the customized clones also share their respective split leafs, i.e.
feed the same split leaf list into both customizers. In that case, the second customizer will pick up the split leafs instantiated by the first customizer and the link between the two PDFs is retained.
If leaf nodes are provided in the sets, the customiser will use them. This is a complete example that customises the yield
parameter, and splits (automatically clones) the mean of the Gaussian. This is a short version of the tutorial rf514_RooCustomizer.C.
Definition at line 35 of file RooCustomizer.h.
Classes | |
class | CustIFace |
Public Member Functions | |
RooCustomizer (const RooAbsArg &pdf, const char *name) | |
Sterile Constructor. | |
RooCustomizer (const RooAbsArg &pdf, const RooAbsCategoryLValue &masterCat, RooArgSet &splitLeafListOwned, RooArgSet *splitLeafListAll=0) | |
Constructor with a prototype and masterCat index category. | |
virtual | ~RooCustomizer () |
Destructor. | |
RooAbsArg * | build (Bool_t verbose=kFALSE) |
Build a clone of the prototype executing all registered 'replace' rules. | |
RooAbsArg * | build (const char *masterCatState, Bool_t verbose=kFALSE) |
Build a clone of the prototype executing all registered 'replace' rules and 'split' rules for the masterCat state named 'masterCatState'. | |
const RooArgSet & | cloneBranchList () const |
const RooArgSet & | cloneLeafList () const |
virtual void | Print (Option_t *options=0) const |
Print TNamed name and title. | |
virtual void | printArgs (std::ostream &os) const |
Print arguments of customizer, i.e. input p.d.f and input master category (if any) | |
virtual void | printClassName (std::ostream &os) const |
Print class name of customizer. | |
virtual void | printMultiline (std::ostream &os, Int_t content, Bool_t verbose=kFALSE, TString indent="") const |
Print customizer configuration details. | |
virtual void | printName (std::ostream &os) const |
Print name of customizer. | |
virtual void | printTitle (std::ostream &os) const |
Print title of customizer. | |
void | replaceArg (const RooAbsArg &orig, const RooAbsArg &subst) |
Replace any occurence of arg 'orig' with arg 'subst'. | |
void | setCloneBranchSet (RooArgSet &cloneBranchSet) |
Install the input RooArgSet as container in which all cloned branches will be stored. | |
void | setOwning (Bool_t flag) |
void | splitArg (const RooAbsArg &arg, const RooAbsCategory &splitCat) |
Split all argument 'arg' into individualized clones for each defined state of 'splitCat'. | |
void | splitArgs (const RooArgSet &argSet, const RooAbsCategory &splitCat) |
Split all arguments in 'set' into individualized clones for each defined state of 'splitCat'. | |
Public Member Functions inherited from TNamed | |
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. | |
virtual void | Clear (Option_t *option="") |
Set name and title to empty strings (""). | |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare two TNamed objects. | |
virtual void | Copy (TObject &named) const |
Copy this to obj. | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. | |
virtual const char * | GetName () const |
Returns name of object. | |
virtual const char * | GetTitle () const |
Returns title of object. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
virtual Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List TNamed name and title. | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
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. | |
Public Member Functions inherited from TObject | |
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 for instance with: gROOT->SetSelectedPad(gPad) . | |
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=0) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
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. | |
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) |
Operator delete []. | |
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. | |
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=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Public Member Functions inherited from RooPrintable | |
RooPrintable () | |
virtual | ~RooPrintable () |
virtual Int_t | defaultPrintContents (Option_t *opt) const |
Default choice of contents to be printed (name and value) | |
virtual StyleOption | defaultPrintStyle (Option_t *opt) const |
virtual void | printAddress (std::ostream &os) const |
Print class name of object. | |
virtual void | printExtras (std::ostream &os) const |
Interface to print extras of object. | |
virtual void | printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const |
Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'. | |
virtual void | printTree (std::ostream &os, TString indent="") const |
Interface for tree structure printing of object. | |
virtual void | printValue (std::ostream &os) const |
Interface to print value of object. | |
Protected Member Functions | |
RooCustomizer (const RooCustomizer &) | |
RooAbsArg * | doBuild (const char *masterCatState, Bool_t verbose) |
Back-end implementation of the p.d.f building functionality. | |
void | initialize () |
Initialize the customizer. | |
Protected Member Functions inherited from TObject | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
Protected Attributes | |
RooArgSet * | _cloneBranchList |
RooArgSet * | _cloneNodeListAll |
RooArgSet * | _cloneNodeListOwned |
RooArgSet | _internalCloneBranchList |
RooArgSet | _masterBranchList |
RooAbsCategoryLValue * | _masterCat |
RooArgSet | _masterLeafList |
RooAbsArg * | _masterPdf |
TString | _name |
Bool_t | _owning |
TList | _replaceArgList |
TList | _replaceSubList |
TList | _splitArgList |
TList | _splitCatList |
Bool_t | _sterile |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) } |
enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
enum | EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) } |
Public Types inherited from RooPrintable | |
enum | ContentsOption { kName =1 , kClassName =2 , kValue =4 , kArgs =8 , kExtras =16 , kAddress =32 , kTitle =64 , kCollectionHeader =128 } |
enum | StyleOption { kInline =1 , kSingleLine =2 , kStandard =3 , kVerbose =4 , kTreeStructure =5 } |
Static Public Member Functions inherited from TObject | |
static Longptr_t | GetDtorOnly () |
Return destructor only flag. | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. | |
Static Public Member Functions inherited from RooPrintable | |
static std::ostream & | defaultPrintStream (std::ostream *os=0) |
Return a reference to the current default stream to use in Print(). | |
static void | nameFieldLength (Int_t newLen) |
Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. | |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = BIT(3) } |
Static Protected Attributes inherited from RooPrintable | |
static Int_t | _nameLength |
#include <RooCustomizer.h>
RooCustomizer::RooCustomizer | ( | const RooAbsArg & | pdf, |
const RooAbsCategoryLValue & | masterCat, | ||
RooArgSet & | splitLeafs, | ||
RooArgSet * | splitLeafsAll = 0 |
||
) |
Constructor with a prototype and masterCat index category.
Customizers created by this constructor offer both the replaceArg() and splitArg() functionality.
[in] | Proto PDF to be customised. | |
[in] | masterCat | Category to be used for splitting. |
[in,out] | splitLeafs | All nodes created in the customisation process are added to this set. The user can provide nodes that are taken from the set if they have a name that matches <parameterNameToBeReplaced>_<category> . |
[in,out] | splitLeafsAll | All leafs that are used when customising are collected here. If this set already contains leaves, they will be used for customising if the names match as above. |
Definition at line 219 of file RooCustomizer.cxx.
RooCustomizer::RooCustomizer | ( | const RooAbsArg & | pdf, |
const char * | name | ||
) |
Sterile Constructor.
Customizers created by this constructor offer only the replace() method. The supplied 'name' is used as suffix for any cloned branch nodes
Definition at line 244 of file RooCustomizer.cxx.
|
virtual |
Destructor.
Definition at line 279 of file RooCustomizer.cxx.
|
protected |
Build a clone of the prototype executing all registered 'replace' rules.
If verbose is set, a message is printed for each leaf or branch node modification. The returned head node owns all cloned branch nodes that were created in the cloning process.
Definition at line 361 of file RooCustomizer.cxx.
Build a clone of the prototype executing all registered 'replace' rules and 'split' rules for the masterCat state named 'masterCatState'.
If verbose is set a message is printed for each leaf or branch node modification. The returned composite arg is owned by the customizer. This function cannot be called on customizer build with the sterile constructor.
Definition at line 397 of file RooCustomizer.cxx.
|
inline |
Definition at line 55 of file RooCustomizer.h.
|
inline |
Definition at line 59 of file RooCustomizer.h.
Back-end implementation of the p.d.f building functionality.
Definition at line 420 of file RooCustomizer.cxx.
|
protected |
Initialize the customizer.
Definition at line 268 of file RooCustomizer.cxx.
Print TNamed name and title.
Reimplemented from TNamed.
Definition at line 71 of file RooCustomizer.h.
|
virtual |
Print arguments of customizer, i.e. input p.d.f and input master category (if any)
Reimplemented from RooPrintable.
Definition at line 637 of file RooCustomizer.cxx.
|
virtual |
Print class name of customizer.
Reimplemented from RooPrintable.
Definition at line 628 of file RooCustomizer.cxx.
|
virtual |
Print customizer configuration details.
Reimplemented from RooPrintable.
Definition at line 651 of file RooCustomizer.cxx.
|
virtual |
Print name of customizer.
Reimplemented from RooPrintable.
Definition at line 610 of file RooCustomizer.cxx.
|
virtual |
Print title of customizer.
Reimplemented from RooPrintable.
Definition at line 619 of file RooCustomizer.cxx.
Replace any occurence of arg 'orig' with arg 'subst'.
Definition at line 341 of file RooCustomizer.cxx.
Install the input RooArgSet as container in which all cloned branches will be stored.
Definition at line 680 of file RooCustomizer.cxx.
Definition at line 44 of file RooCustomizer.h.
void RooCustomizer::splitArg | ( | const RooAbsArg & | arg, |
const RooAbsCategory & | splitCat | ||
) |
Split all argument 'arg' into individualized clones for each defined state of 'splitCat'.
The 'splitCats' category must be subset of or equal to the master category supplied in the customizer constructor.
Splitting is only available on customizers created with a master index category
Definition at line 318 of file RooCustomizer.cxx.
void RooCustomizer::splitArgs | ( | const RooArgSet & | set, |
const RooAbsCategory & | splitCat | ||
) |
Split all arguments in 'set' into individualized clones for each defined state of 'splitCat'.
The 'splitCats' category must be subset of or equal to the master category supplied in the customizer constructor.
Splitting is only available on customizers created with a master index category
Definition at line 295 of file RooCustomizer.cxx.
|
protected |
Definition at line 111 of file RooCustomizer.h.
|
protected |
Definition at line 114 of file RooCustomizer.h.
|
protected |
Definition at line 115 of file RooCustomizer.h.
|
protected |
Definition at line 110 of file RooCustomizer.h.
|
protected |
Definition at line 107 of file RooCustomizer.h.
|
protected |
Definition at line 105 of file RooCustomizer.h.
|
protected |
Definition at line 108 of file RooCustomizer.h.
|
protected |
Definition at line 104 of file RooCustomizer.h.
|
protected |
Definition at line 95 of file RooCustomizer.h.
|
protected |
Definition at line 94 of file RooCustomizer.h.
|
protected |
Definition at line 100 of file RooCustomizer.h.
|
protected |
Definition at line 101 of file RooCustomizer.h.
|
protected |
Definition at line 97 of file RooCustomizer.h.
|
protected |
Definition at line 98 of file RooCustomizer.h.
|
protected |
Definition at line 93 of file RooCustomizer.h.