Logo ROOT   6.19/01
Reference Guide
RooStats::HLFactory Class Reference

HLFactory is an High Level model Factory allows you to describe your models in a configuration file (datacards) acting as an interface with the RooFactoryWSTool.

Moreover it provides tools for the combination of models and datasets.

Definition at line 31 of file HLFactory.h.

Public Member Functions

 HLFactory (const char *name, const char *fileName=0, bool isVerbose=false)
 Constructor. More...
 
 HLFactory (const char *name, RooWorkspace *externalWs, bool isVerbose=false)
 Constructor with external RooWorkspace. More...
 
 HLFactory ()
 Default Constructor. More...
 
 ~HLFactory ()
 Default Destructor. More...
 
int AddChannel (const char *label, const char *SigBkgPdfName, const char *BkgPdfName=0, const char *datasetName=0)
 Add channel for the combination. More...
 
void DumpCfg (const char *)
 Dump the Workspace content as configuration file. More...
 
RooAbsPdfGetTotBkgPdf ()
 Get the combined background pdf. More...
 
RooCategoryGetTotCategory ()
 Get the combined dataset. More...
 
RooDataSetGetTotDataSet ()
 Get the combined dataset. More...
 
RooAbsPdfGetTotSigBkgPdf ()
 Get the combined signal plus background pdf. More...
 
RooWorkspaceGetWs ()
 Get the RooWorkspace containing the models and variables. More...
 
int ProcessCard (const char *filename)
 Process a configuration file. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Private Member Functions

void fCreateCategory ()
 Create the category for the combinations. More...
 
bool fNamesListsConsistent ()
 Check the length of the lists. More...
 
int fParseLine (TString &line)
 Parse a single line an puts the content in the RooWorkSpace. More...
 
int fReadFile (const char *fileName, bool is_included=false)
 Read the actual cfg file. More...
 

Private Attributes

TList fBkgPdfNames
 List of channels names to combine for the background pdfs. More...
 
bool fCombinationDone
 Flag to keep trace of the status of the combination. More...
 
RooAbsPdffComboBkgPdf
 The background model combination. More...
 
RooCategoryfComboCat
 The category of the combination. More...
 
RooDataSetfComboDataset
 The datasets combination. More...
 
RooAbsPdffComboSigBkgPdf
 The signal plus background model combination. More...
 
TList fDatasetsNames
 List of channels names to combine for the datasets. More...
 
int fInclusionLevel
 Keep trace of the inclusion deepness. More...
 
TList fLabelsNames
 List of channels names to combine for the datasets. More...
 
bool fOwnWs
 Owns workspace. More...
 
TList fSigBkgPdfNames
 List of channels names to combine for the signal plus background pdfs. More...
 
bool fVerbose
 The verbosity flag. More...
 
RooWorkspacefWs
 The RooWorkspace containing the models and variables. More...
 

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)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <RooStats/HLFactory.h>

Inheritance diagram for RooStats::HLFactory:
[legend]

Constructor & Destructor Documentation

◆ HLFactory() [1/3]

HLFactory::HLFactory ( const char *  name,
const char *  fileName = 0,
bool  isVerbose = false 
)

Constructor.

Constructor with the name of the config file to interpret and the verbosity flag.

The extension for the config files is assumed to be ".rs".

Definition at line 50 of file HLFactory.cxx.

◆ HLFactory() [2/3]

HLFactory::HLFactory ( const char *  name,
RooWorkspace externalWs,
bool  isVerbose = false 
)

Constructor with external RooWorkspace.

Constructor without a card but with an external workspace.

Definition at line 77 of file HLFactory.cxx.

◆ HLFactory() [3/3]

HLFactory::HLFactory ( )

Default Constructor.

Definition at line 98 of file HLFactory.cxx.

◆ ~HLFactory()

HLFactory::~HLFactory ( )

Default Destructor.

destructor

Definition at line 119 of file HLFactory.cxx.

Member Function Documentation

◆ AddChannel()

int HLFactory::AddChannel ( const char *  label,
const char *  SigBkgPdfName,
const char *  BkgPdfName = 0,
const char *  DatasetName = 0 
)

Add channel for the combination.

Add a channel to the combination.

The channel can be specified as:

  • A signal plus background pdf
  • A background only pdf
  • A dataset Once the combination of the pdfs is done, no more channels should be added.

Definition at line 141 of file HLFactory.cxx.

◆ DumpCfg()

void RooStats::HLFactory::DumpCfg ( const char *  )
inline

Dump the Workspace content as configuration file.

Definition at line 59 of file HLFactory.h.

◆ fCreateCategory()

void HLFactory::fCreateCategory ( )
private

Create the category for the combinations.

Builds the category necessary for the mutidimensional models.

Its name will be <HLFactory name>_category and the types are specified by the model labels.

Definition at line 534 of file HLFactory.cxx.

◆ fNamesListsConsistent()

bool HLFactory::fNamesListsConsistent ( )
private

Check the length of the lists.

Check the number of entries in each list.

If not the same and the list is not empty prompt an error.

Definition at line 559 of file HLFactory.cxx.

◆ fParseLine()

int HLFactory::fParseLine ( TString line)
private

Parse a single line an puts the content in the RooWorkSpace.

Parse a single line and puts the content in the RooWorkSpace.

Definition at line 574 of file HLFactory.cxx.

◆ fReadFile()

int HLFactory::fReadFile ( const char *  fileName,
bool  is_included = false 
)
private

Read the actual cfg file.

Parses the configuration file.

The objects can be specified following the rules of the RooFactoryWSTool, plus some more flexibility.

The official format for the datacards is ".rs".

All the instructions end with a ";" (like in C++).

Carriage returns and white lines are irrelevant but advised since they improve readability (like in C++).

The (Roo)ClassName::objname(description) can be replaced with the more "pythonic" objname = (Roo)ClassName(description).

The comments can be specified with a "//" if on a single line or with "multiple lines" in C/C++ like comments.

The "#include path/to/file.rs" statement triggers the inclusion of a configuration fragment.

The "import myobject:myworkspace:myrootfile" will add to the Workspace the object myobject located in myworkspace recorded in myrootfile. Alternatively, one could choose the "import myobject:myrootfile" in case no Workspace is present.

The "echo" statement prompts a message on screen.

Definition at line 391 of file HLFactory.cxx.

◆ GetTotBkgPdf()

RooAbsPdf * HLFactory::GetTotBkgPdf ( )

Get the combined background pdf.

Return the combination of the background only channels.

If no background channel is specified a NULL pointer is returned. The factory owns the object.

Definition at line 241 of file HLFactory.cxx.

◆ GetTotCategory()

RooCategory * HLFactory::GetTotCategory ( )

Get the combined dataset.

Return the category.

The factory owns the object.

Definition at line 343 of file HLFactory.cxx.

◆ GetTotDataSet()

RooDataSet * HLFactory::GetTotDataSet ( )

Get the combined dataset.

Return the combination of the datasets.

If no dataset is specified a NULL pointer is returned. The factory owns the object.

Definition at line 290 of file HLFactory.cxx.

◆ GetTotSigBkgPdf()

RooAbsPdf * HLFactory::GetTotSigBkgPdf ( )

Get the combined signal plus background pdf.

Return the combination of the signal plus background channels.

The factory owns the object.

Definition at line 190 of file HLFactory.cxx.

◆ GetWs()

RooWorkspace* RooStats::HLFactory::GetWs ( )
inline

Get the RooWorkspace containing the models and variables.

Definition at line 74 of file HLFactory.h.

◆ ProcessCard()

int HLFactory::ProcessCard ( const char *  filename)

Process a configuration file.

Process an additional configuration file.

Definition at line 360 of file HLFactory.cxx.

Member Data Documentation

◆ fBkgPdfNames

TList RooStats::HLFactory::fBkgPdfNames
private

List of channels names to combine for the background pdfs.

Definition at line 106 of file HLFactory.h.

◆ fCombinationDone

bool RooStats::HLFactory::fCombinationDone
private

Flag to keep trace of the status of the combination.

Definition at line 94 of file HLFactory.h.

◆ fComboBkgPdf

RooAbsPdf* RooStats::HLFactory::fComboBkgPdf
private

The background model combination.

Definition at line 85 of file HLFactory.h.

◆ fComboCat

RooCategory* RooStats::HLFactory::fComboCat
private

The category of the combination.

Definition at line 82 of file HLFactory.h.

◆ fComboDataset

RooDataSet* RooStats::HLFactory::fComboDataset
private

The datasets combination.

Definition at line 91 of file HLFactory.h.

◆ fComboSigBkgPdf

RooAbsPdf* RooStats::HLFactory::fComboSigBkgPdf
private

The signal plus background model combination.

Definition at line 88 of file HLFactory.h.

◆ fDatasetsNames

TList RooStats::HLFactory::fDatasetsNames
private

List of channels names to combine for the datasets.

Definition at line 109 of file HLFactory.h.

◆ fInclusionLevel

int RooStats::HLFactory::fInclusionLevel
private

Keep trace of the inclusion deepness.

Definition at line 118 of file HLFactory.h.

◆ fLabelsNames

TList RooStats::HLFactory::fLabelsNames
private

List of channels names to combine for the datasets.

Definition at line 112 of file HLFactory.h.

◆ fOwnWs

bool RooStats::HLFactory::fOwnWs
private

Owns workspace.

Definition at line 124 of file HLFactory.h.

◆ fSigBkgPdfNames

TList RooStats::HLFactory::fSigBkgPdfNames
private

List of channels names to combine for the signal plus background pdfs.

Definition at line 103 of file HLFactory.h.

◆ fVerbose

bool RooStats::HLFactory::fVerbose
private

The verbosity flag.

Definition at line 115 of file HLFactory.h.

◆ fWs

RooWorkspace* RooStats::HLFactory::fWs
private

The RooWorkspace containing the models and variables.

Definition at line 121 of file HLFactory.h.

Libraries for RooStats::HLFactory:
[legend]

The documentation for this class was generated from the following files: