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 29 of file HLFactory.h.

Public Member Functions
	HLFactory ()
	Default Constructor.

	HLFactory (const char name, const char fileName=nullptr, bool isVerbose=false)
	Constructor.

	HLFactory (const char name, RooWorkspace externalWs, bool isVerbose=false)
	Constructor with external RooWorkspace.

	~HLFactory () override
	Default Destructor.

int	AddChannel (const char label, const char SigBkgPdfName, const char BkgPdfName=nullptr, const char datasetName=nullptr)
	Add channel for the combination.

void	DumpCfg (const char *)
	Dump the Workspace content as configuration file.

RooAbsPdf *	GetTotBkgPdf ()
	Get the combined background pdf.

RooCategory *	GetTotCategory ()
	Get the combined dataset.

RooDataSet *	GetTotDataSet ()
	Get the combined dataset.

RooAbsPdf *	GetTotSigBkgPdf ()
	Get the combined signal plus background pdf.

RooWorkspace *	GetWs ()
	Get the RooWorkspace containing the models and variables.

TClass *	IsA () const override

int	ProcessCard (const char *filename)
	Process a configuration file.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

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.

TClass *	IsA () const override

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	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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 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.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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.

Private Member Functions
void	fCreateCategory ()
	Create the category for the combinations.

bool	fNamesListsConsistent ()
	Check the length of the lists.

int	fParseLine (TString &line)
	Parse a single line an puts the content in the RooWorkSpace.

int	fReadFile (const char *fileName, bool is_included=false)
	Read the actual cfg file.

Private Attributes
TList	fBkgPdfNames
	List of channels names to combine for the background pdfs.

bool	fCombinationDone = false
	Flag to keep trace of the status of the combination.

RooAbsPdf *	fComboBkgPdf = nullptr
	The background model combination.

RooCategory *	fComboCat = nullptr
	The category of the combination.

RooDataSet *	fComboDataset = nullptr
	The datasets combination.

RooAbsPdf *	fComboSigBkgPdf = nullptr
	The signal plus background model combination.

TList	fDatasetsNames
	List of channels names to combine for the datasets.

int	fInclusionLevel = 0
	Keep trace of the inclusion deepness.

TList	fLabelsNames
	List of channels names to combine for the datasets.

bool	fOwnWs = false
	Owns workspace.

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

bool	fVerbose = false
	The verbosity flag.

RooWorkspace *	fWs = nullptr
	The RooWorkspace containing the models and variables.

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

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 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 = `nullptr`,
		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 48 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 66 of file HLFactory.cxx.

◆ HLFactory() [3/3]

HLFactory::HLFactory ( )

Default Constructor.

Definition at line 76 of file HLFactory.cxx.

◆ ~HLFactory()

HLFactory::~HLFactory ( )

override

Default Destructor.

destructor

Definition at line 86 of file HLFactory.cxx.

Member Function Documentation

◆ AddChannel()

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

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 108 of file HLFactory.cxx.

◆ Class()

static TClass * RooStats::HLFactory::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooStats::HLFactory::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooStats::HLFactory::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 105 of file HLFactory.h.

◆ DeclFileName()

static const char * RooStats::HLFactory::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 105 of file HLFactory.h.

◆ DumpCfg()

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

inline

Dump the Workspace content as configuration file.

Definition at line 57 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 483 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 504 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 519 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 347 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 nullptr pointer is returned. The factory owns the object.

Definition at line 202 of file HLFactory.cxx.

◆ GetTotCategory()

RooCategory * HLFactory::GetTotCategory ( )

Get the combined dataset.

Return the category.

The factory owns the object.

Definition at line 299 of file HLFactory.cxx.

◆ GetTotDataSet()

RooDataSet * HLFactory::GetTotDataSet ( )

Get the combined dataset.

Return the combination of the datasets.

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

Definition at line 247 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 157 of file HLFactory.cxx.

◆ GetWs()

RooWorkspace * RooStats::HLFactory::GetWs ( )

inline

Get the RooWorkspace containing the models and variables.

Definition at line 72 of file HLFactory.h.

◆ IsA()

TClass * RooStats::HLFactory::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 105 of file HLFactory.h.

◆ ProcessCard()

int HLFactory::ProcessCard ( const char * filename )

Process a configuration file.

Process an additional configuration file.

Definition at line 316 of file HLFactory.cxx.

◆ Streamer()

void RooStats::HLFactory::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void RooStats::HLFactory::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 105 of file HLFactory.h.

Member Data Documentation

◆ fBkgPdfNames

TList RooStats::HLFactory::fBkgPdfNames

private

List of channels names to combine for the background pdfs.

Definition at line 97 of file HLFactory.h.

◆ fCombinationDone

bool RooStats::HLFactory::fCombinationDone = false

private

Flag to keep trace of the status of the combination.

Definition at line 95 of file HLFactory.h.

◆ fComboBkgPdf

RooAbsPdf* RooStats::HLFactory::fComboBkgPdf = nullptr

private

The background model combination.

Definition at line 92 of file HLFactory.h.

◆ fComboCat

RooCategory* RooStats::HLFactory::fComboCat = nullptr

private

The category of the combination.

Definition at line 91 of file HLFactory.h.

◆ fComboDataset

RooDataSet* RooStats::HLFactory::fComboDataset = nullptr

private

The datasets combination.

Definition at line 94 of file HLFactory.h.

◆ fComboSigBkgPdf

RooAbsPdf* RooStats::HLFactory::fComboSigBkgPdf = nullptr

private

The signal plus background model combination.

Definition at line 93 of file HLFactory.h.

◆ fDatasetsNames

TList RooStats::HLFactory::fDatasetsNames

private

List of channels names to combine for the datasets.

Definition at line 98 of file HLFactory.h.

◆ fInclusionLevel

int RooStats::HLFactory::fInclusionLevel = 0

private

Keep trace of the inclusion deepness.

Definition at line 101 of file HLFactory.h.

◆ fLabelsNames

TList RooStats::HLFactory::fLabelsNames

private

List of channels names to combine for the datasets.

Definition at line 99 of file HLFactory.h.

◆ fOwnWs

bool RooStats::HLFactory::fOwnWs = false

private

Owns workspace.

Definition at line 103 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 96 of file HLFactory.h.

◆ fVerbose

bool RooStats::HLFactory::fVerbose = false

private

The verbosity flag.

Definition at line 100 of file HLFactory.h.

◆ fWs

RooWorkspace* RooStats::HLFactory::fWs = nullptr

private

The RooWorkspace containing the models and variables.

Definition at line 102 of file HLFactory.h.

Libraries for RooStats::HLFactory:

[legend]

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

roofit/roostats/inc/RooStats/HLFactory.h
roofit/roostats/src/HLFactory.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ HLFactory() [1/3]

◆ HLFactory() [2/3]

◆ HLFactory() [3/3]

◆ ~HLFactory()

Member Function Documentation

◆ AddChannel()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ DumpCfg()

◆ fCreateCategory()

◆ fNamesListsConsistent()

◆ fParseLine()

◆ fReadFile()

◆ GetTotBkgPdf()

◆ GetTotCategory()

◆ GetTotDataSet()

◆ GetTotSigBkgPdf()

◆ GetWs()

◆ IsA()

◆ ProcessCard()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fBkgPdfNames

◆ fCombinationDone

◆ fComboBkgPdf

◆ fComboCat

◆ fComboDataset

◆ fComboSigBkgPdf

◆ fDatasetsNames

◆ fInclusionLevel

◆ fLabelsNames

◆ fOwnWs

◆ fSigBkgPdfNames

◆ fVerbose

◆ fWs