RooSimWSTool Class Reference

The RooSimWSTool is a tool operating on RooWorkspace objects that can clone PDFs into a series of variations that are joined together into a RooSimultanous PDF.

Splitting a single PDF

The simplest use case is to take a workspace PDF as prototype and "split" a parameter of that PDF into two specialized parameters depending on a category in the dataset.

For example, given a Gaussian PDF \( G(x \,|\, m,s) \) we want to construct a \( G_a(x \,|\, m_a,s) \) and a \( G_b(x \,|\, m_b,s) \) with different mean parameters to be fit to a dataset with observables \( (x,c) \) where \( c \) is a category with states 'a' and 'b'.

Using RooSimWSTool, one can create a simultaneous PDF from \( G_a \) and \( G_b \) from \( G \) with the following commands:

RooSimWSTool wst(wspace);
wst.build("G_sim", "G", SplitParam("m","c"));

Splitting using a product category

From this simple example one can go to builds of arbitrary complexity by specifying multiple SplitParam arguments on multiple parameters involving multiple splitting categories. Splits can also be performed in the product of multiple categories, i.e.,

wst.build("G_sim", "G", SplitParam("m","c,d"));

splits the parameter \( m \) in the product of the states of \( c \) and \( d \).

Constrained split

Another possibility is the "constrained" split, which clones the parameter for all but one state and inserts a formula specialization in a chosen state that evaluates to \( 1 - \sum_i(a_i) \) where \( a_i \) are all other specializations. For example, given a category \( c \) with the states "A","B","C","D", the specification

SplitParamConstrained("m","c","D")

will create the parameters \( m_A,m_B,m_C \) and a formula expression \( m_D \) that evaluates to \( (1-(m_A+m_B+m_C)) \). Constrained splits can also be specified in the product of categories. In that case, the name of the remainder state follows the syntax "{State1;State2}", where State1 and State2 are the state names of the two spitting categories.

Splitting multiple PDFs

The examples so far deal with a single prototype PDF. It is also possible to build with multiple prototype PDFs by specifying a mapping between the prototype to use and the names of states of a "master" splitting category. To specify these configurations, an intermediate MultiBuildConfig must be composed with all the necessary specifications. This, for example,

RooSimWSTool::MultiBuildConfig mbc("mc");
mbc.addPdf("I","G",SplitParam("m,s","c"));
mbc.addPdf("II,III","F",SplitParam("a","c,d"));

configures a build with two prototype PDFs \( G \) and \( F \). Prototype \( G \) is used for state "I" of the master split category mc and prototype \( F \) is used for states "II" and "III" of the master split category mc. Furthermore, the parameters \( m,s \) of prototype \( G \) are split in category \( c \) while the parameter \( a \) of prototype \( F \) is split in the product of the categories \( c \) and \( d \). The actual build is then performed by passing the build configuration to RooSimWSTool, e.g.,

wst.build("MASTER", mbc);

By default, a specialisation is built for each permutation of states of the splitting categories that are used. It is possible to restrict the building of specialised PDFs to a subset of states by adding a restriction on the number of states to build as follows:

mbc.restrictBuild("c","A,B");

The restrictBuild method can be called multiple times, but at most once for each splitting category in use. For simple builds with a single prototype, restriction can be specified with a Restrict() argument on the build command line.

PyROOT

Some member functions of RooSimWSTool that take a RooCmdArg as argument also support keyword arguments. So far, this applies to RooSimWSTool::build. For example, the following code is equivalent in PyROOT:

# Directly passing a RooCmdArg:
sct.build("model_sim2", "model", ROOT.RooFit.SplitParam("p0", "c,d"))
 
# With keyword arguments:
sct.build("model_sim2", "model", SplitParam=("p0", "c,d"))

Definition at line 37 of file RooSimWSTool.h.

Classes
class	BuildConfig
class	MultiBuildConfig
class	ObjBuildConfig
class	ObjSplitRule
class	SimWSIFace
class	SplitRule

Public Member Functions
	RooSimWSTool (RooWorkspace &ws)
	Constructor of SimWSTool on given workspace.
virtual	~RooSimWSTool ()
	Destructor.
RooSimultaneous *	build (const char *simPdfName, BuildConfig &bc, Bool_t verbose=kTRUE)
	Build a RooSimultaneous PDF with name simPdfName from cloning specializations of protytpe PDF protoPdfName.
RooSimultaneous *	build (const char *simPdfName, const char *protoPdfName, const RooCmdArg &arg1=RooCmdArg::none(), const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none(), const RooCmdArg &arg6=RooCmdArg::none())
	Build a RooSimultaneous PDF with name simPdfName from cloning specializations of protytpe PDF protoPdfName.
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	Print (Option_t *option="") const
	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.
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	printArgs (std::ostream &os) const
	Interface for printing of object arguments.
virtual void	printClassName (std::ostream &os) const
	Print class name of object.
virtual void	printExtras (std::ostream &os) const
	Interface to print extras of object.
virtual void	printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
	Interface for detailed printing of object.
virtual void	printName (std::ostream &os) const
	Print name 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	printTitle (std::ostream &os) const
	Print title of object.
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
	RooSimWSTool (const RooSimWSTool &)
RooSimultaneous *	executeBuild (const char *simPdfName, ObjBuildConfig &obc, Bool_t verbose=kTRUE)
	Internal build driver from validation ObjBuildConfig.
std::string	makeSplitName (const RooArgSet &splitCatSet)
	Construct name of composite split.
ObjBuildConfig *	validateConfig (BuildConfig &bc)
	Validate build configuration.
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
RooWorkspace *	_ws
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 <RooSimWSTool.h>

Inheritance diagram for RooSimWSTool:

Constructor & Destructor Documentation

RooSimWSTool() [1/2]

RooSimWSTool::RooSimWSTool

(

RooWorkspace &

ws

)

Constructor of SimWSTool on given workspace.

All input is taken from the workspace All output is stored in the workspace

Definition at line 150 of file RooSimWSTool.cxx.

~RooSimWSTool()

RooSimWSTool::~RooSimWSTool ( )

virtual

Destructor.

Definition at line 159 of file RooSimWSTool.cxx.

RooSimWSTool() [2/2]

RooSimWSTool::RooSimWSTool ( const RooSimWSTool &  )

protected

Member Function Documentation

build() [1/2]

RooSimultaneous * RooSimWSTool::build	(	const char *	simPdfName,
		BuildConfig &	bc,
		Bool_t	verbose = kTRUE
	)

Build a RooSimultaneous PDF with name simPdfName from cloning specializations of protytpe PDF protoPdfName.

Use the provided BuildConfig or MultiBuildConfig object to configure the build

Definition at line 190 of file RooSimWSTool.cxx.

build() [2/2]

RooSimWSTool::build	(	const char *	simPdfName,
		const char *	protoPdfName,
		const RooCmdArg &	arg1 = RooCmdArg::none(),
		const RooCmdArg &	arg2 = RooCmdArg::none(),
		const RooCmdArg &	arg3 = RooCmdArg::none(),
		const RooCmdArg &	arg4 = RooCmdArg::none(),
		const RooCmdArg &	arg5 = RooCmdArg::none(),
		const RooCmdArg &	arg6 = RooCmdArg::none()
	)

Build a RooSimultaneous PDF with name simPdfName from cloning specializations of protytpe PDF protoPdfName.

Optional Arguments	Effect
SplitParam(varname, catname)	Split parameter(s) with given name(s) in category(s) with given names
SplitParam(var, cat)	Split given parameter(s) in givem category(s)
SplitParamConstrained(vname, cname, remainder)	Make constrained split in parameter(s) with given name(s) in category(s) with given names putting remainder fraction formula in state with name "remainder"
SplitParamConstrained(var,cat,remainder)	Make constrained split in parameter(s) with given name(s) in category(s) with given names putting remainder fraction formula in state with name "remainder"
Restrict(catName,stateNameList)	Restrict build by only considered listed state names of category with given name

PyROOT

The RooSimWSTool::build() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Definition at line 177 of file RooSimWSTool.cxx.