Base class for add-on modules to RooMCStudy that can perform additional calculations on each generate+fit cycle managed by RooMCStudy.

This class can insert code to be executed before each generation step, between the generation and fitting step and after the fitting step. Any summary output variables declared in the RooDataSet exported through summaryData() is merged with the 'master' summary dataset in RooMCStudy.

Look at RooDLLSignificanceMCSModule for an example of an implementation.

Definition at line 30 of file RooAbsMCStudyModule.h.

Public Member Functions
	RooAbsMCStudyModule (const char name, const char title)
	Constructor.

	RooAbsMCStudyModule (const RooAbsMCStudyModule &other)
	Copy constructor.

bool	doInitializeInstance (RooMCStudy &)
	Initializer method called upon attachment to given RooMCStudy object.

virtual RooDataSet *	finalizeRun ()
	Method called at the end of each RooMCStudy run.

virtual bool	initializeInstance ()
	Initializer called immediately after attachment to RooMCStudy object and initialization of module base class.

virtual bool	initializeRun (Int_t)
	Method called at the beginning of each RooMCStudy run.

TClass *	IsA () const override

virtual bool	processAfterFit (Int_t)
	Method called after fit has been performed.

virtual bool	processBeforeGen (Int_t)
	Method called after resetting of generator parameters to initial values and before call to generator context Any modifications to generator parameters will affect next generation operation (only)

virtual bool	processBetweenGenAndFit (Int_t)
	Method called after generation of toy data sample and resetting of fit parameters to initial values and before actual fit is performed.

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.

Protected Member Functions
RooArgSet *	allDependents ()
	Return all observables.

bool	binGenData ()
	If true binning of data between generating and fitting is requested.

RooArgSet *	dependents ()
	Return fit model observables.

bool	extendedGen ()
	If true extended mode generation is requested.

RooArgSet *	fitInitParams ()
	Return initial value of parameters of fit model.

RooAbsPdf *	fitModel ()
	Return fit model.

RooLinkedList *	fitOptList ()
	Return list of fit options provided by user.

RooArgSet *	fitParams ()
	Return current value of parameters of fit model.

RooAbsGenContext *	genContext ()

RooArgSet *	genInitParams ()
	Return initial value of generator model parameters.

RooAbsPdf *	genModel ()
	Return generator pdf.

RooArgSet *	genParams ()
	Return current value of generator model parameters.

const RooDataSet *	genProtoData ()
	Return generator prototype data provided by user.

RooAbsData *	genSample ()
	Return generate sample.

RooRealVar *	nllVar ()
	Return pointer to RooRealVar holding minimized -log(L) value.

double	numExpGen ()
	Return expected number of events from generator model.

RooArgSet *	projDeps ()
	Return projected observables.

bool	randProto ()
	If true randomization of prototype data order is requested.

RooFit::OwningPtr< RooFitResult >	refit (RooAbsData *inGenSample=nullptr)
	Refit model using original or specified data sample.

bool	verboseGen ()
	If true verbose message in the generation step is requested.

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 ()

Private Attributes
RooMCStudy *	_mcs
	Pointer to RooMCStudy object module is attached to.

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 Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <RooAbsMCStudyModule.h>

Inheritance diagram for RooAbsMCStudyModule:

[legend]

Constructor & Destructor Documentation

◆ RooAbsMCStudyModule() [1/2]

RooAbsMCStudyModule::RooAbsMCStudyModule	(	const char *	name,
		const char *	title
	)

Constructor.

Definition at line 44 of file RooAbsMCStudyModule.cxx.

◆ RooAbsMCStudyModule() [2/2]

RooAbsMCStudyModule::RooAbsMCStudyModule ( const RooAbsMCStudyModule & other )

Copy constructor.

Definition at line 52 of file RooAbsMCStudyModule.cxx.

Member Function Documentation

◆ allDependents()

RooArgSet * RooAbsMCStudyModule::allDependents ( )

inlineprotected

Return all observables.

Definition at line 124 of file RooAbsMCStudyModule.h.

◆ binGenData()

bool RooAbsMCStudyModule::binGenData ( )

inlineprotected

If true binning of data between generating and fitting is requested.

Definition at line 161 of file RooAbsMCStudyModule.h.

◆ Class()

static TClass * RooAbsMCStudyModule::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooAbsMCStudyModule::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooAbsMCStudyModule::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 184 of file RooAbsMCStudyModule.h.

◆ DeclFileName()

static const char * RooAbsMCStudyModule::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 184 of file RooAbsMCStudyModule.h.

◆ dependents()

RooArgSet * RooAbsMCStudyModule::dependents ( )

inlineprotected

Return fit model observables.

Definition at line 119 of file RooAbsMCStudyModule.h.

◆ doInitializeInstance()

bool RooAbsMCStudyModule::doInitializeInstance ( RooMCStudy & study )

Initializer method called upon attachment to given RooMCStudy object.

Store reference to RooMCStudy object that this module relates to and call internal module initialization function.

Definition at line 61 of file RooAbsMCStudyModule.cxx.

◆ extendedGen()

bool RooAbsMCStudyModule::extendedGen ( )

inlineprotected

If true extended mode generation is requested.

Definition at line 156 of file RooAbsMCStudyModule.h.

◆ finalizeRun()

virtual RooDataSet * RooAbsMCStudyModule::finalizeRun ( )

inlinevirtual

Method called at the end of each RooMCStudy run.

If a RooDataSet is returned, it must have a length equal to the number of toy experiments performed and will merged with the fitpar dataset of RooMCStudy.

Reimplemented in RooChi2MCSModule, RooDLLSignificanceMCSModule, RooRandomizeParamMCSModule, and RooStats::UpperLimitMCSModule.

Definition at line 51 of file RooAbsMCStudyModule.h.

◆ fitInitParams()

RooArgSet * RooAbsMCStudyModule::fitInitParams ( )

inlineprotected

Return initial value of parameters of fit model.

Definition at line 134 of file RooAbsMCStudyModule.h.

◆ fitModel()

RooAbsPdf * RooAbsMCStudyModule::fitModel ( )

inlineprotected

Return fit model.

Definition at line 129 of file RooAbsMCStudyModule.h.

◆ fitOptList()

RooLinkedList * RooAbsMCStudyModule::fitOptList ( )

inlineprotected

Return list of fit options provided by user.

Definition at line 151 of file RooAbsMCStudyModule.h.

◆ fitParams()

RooArgSet * RooAbsMCStudyModule::fitParams ( )

inlineprotected

Return current value of parameters of fit model.

Definition at line 139 of file RooAbsMCStudyModule.h.

◆ genContext()

RooAbsGenContext * RooAbsMCStudyModule::genContext ( )

inlineprotected

Definition at line 92 of file RooAbsMCStudyModule.h.

◆ genInitParams()

RooArgSet * RooAbsMCStudyModule::genInitParams ( )

inlineprotected

Return initial value of generator model parameters.

Definition at line 97 of file RooAbsMCStudyModule.h.

◆ genModel()

RooAbsPdf * RooAbsMCStudyModule::genModel ( )

inlineprotected

Return generator pdf.

Definition at line 87 of file RooAbsMCStudyModule.h.

◆ genParams()

RooArgSet * RooAbsMCStudyModule::genParams ( )

inlineprotected

Return current value of generator model parameters.

Definition at line 102 of file RooAbsMCStudyModule.h.

◆ genProtoData()

const RooDataSet * RooAbsMCStudyModule::genProtoData ( )

inlineprotected

Return generator prototype data provided by user.

Definition at line 107 of file RooAbsMCStudyModule.h.

◆ genSample()

RooAbsData * RooAbsMCStudyModule::genSample ( )

inlineprotected

Return generate sample.

Definition at line 82 of file RooAbsMCStudyModule.h.

◆ initializeInstance()

virtual bool RooAbsMCStudyModule::initializeInstance ( )

inlinevirtual

Initializer called immediately after attachment to RooMCStudy object and initialization of module base class.

Reimplemented in RooChi2MCSModule, RooDLLSignificanceMCSModule, RooRandomizeParamMCSModule, and RooStats::UpperLimitMCSModule.

Definition at line 40 of file RooAbsMCStudyModule.h.

◆ initializeRun()

virtual bool RooAbsMCStudyModule::initializeRun ( Int_t )

inlinevirtual

Method called at the beginning of each RooMCStudy run.

Reimplemented in RooChi2MCSModule, RooDLLSignificanceMCSModule, RooRandomizeParamMCSModule, and RooStats::UpperLimitMCSModule.

Definition at line 45 of file RooAbsMCStudyModule.h.

◆ IsA()

TClass * RooAbsMCStudyModule::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in RooChi2MCSModule, RooDLLSignificanceMCSModule, RooRandomizeParamMCSModule, and RooStats::UpperLimitMCSModule.

Definition at line 184 of file RooAbsMCStudyModule.h.

◆ nllVar()

RooRealVar * RooAbsMCStudyModule::nllVar ( )

inlineprotected

Return pointer to RooRealVar holding minimized -log(L) value.

Definition at line 144 of file RooAbsMCStudyModule.h.

◆ numExpGen()

double RooAbsMCStudyModule::numExpGen ( )

inlineprotected

Return expected number of events from generator model.

Definition at line 166 of file RooAbsMCStudyModule.h.

◆ processAfterFit()

virtual bool RooAbsMCStudyModule::processAfterFit ( Int_t )

inlinevirtual

Method called after fit has been performed.

Reimplemented in RooChi2MCSModule, and RooDLLSignificanceMCSModule.

Definition at line 69 of file RooAbsMCStudyModule.h.

◆ processBeforeGen()

virtual bool RooAbsMCStudyModule::processBeforeGen ( Int_t )

inlinevirtual

Method called after resetting of generator parameters to initial values and before call to generator context Any modifications to generator parameters will affect next generation operation (only)

Reimplemented in RooRandomizeParamMCSModule.

Definition at line 57 of file RooAbsMCStudyModule.h.

◆ processBetweenGenAndFit()

virtual bool RooAbsMCStudyModule::processBetweenGenAndFit ( Int_t )

inlinevirtual

Method called after generation of toy data sample and resetting of fit parameters to initial values and before actual fit is performed.

Any modifications to fit parameters will apply to next fit operation. Note that setConstant flag of fit parameters are not explicitly reset by RooMCStudy, so any changes made to these flags here will persist

Reimplemented in RooStats::UpperLimitMCSModule.

Definition at line 64 of file RooAbsMCStudyModule.h.

◆ projDeps()

RooArgSet * RooAbsMCStudyModule::projDeps ( )

inlineprotected

Return projected observables.

Definition at line 112 of file RooAbsMCStudyModule.h.

◆ randProto()

bool RooAbsMCStudyModule::randProto ( )

inlineprotected

If true randomization of prototype data order is requested.

Definition at line 171 of file RooAbsMCStudyModule.h.

◆ refit()

RooFit::OwningPtr< RooFitResult > RooAbsMCStudyModule::refit ( RooAbsData * inGenSample = nullptr )

protected

Refit model using original or specified data sample.

Definition at line 67 of file RooAbsMCStudyModule.cxx.

◆ Streamer()

void RooAbsMCStudyModule::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in RooChi2MCSModule, RooDLLSignificanceMCSModule, RooRandomizeParamMCSModule, and RooStats::UpperLimitMCSModule.

◆ StreamerNVirtual()

void RooAbsMCStudyModule::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 184 of file RooAbsMCStudyModule.h.

◆ verboseGen()

bool RooAbsMCStudyModule::verboseGen ( )

inlineprotected

If true verbose message in the generation step is requested.

Definition at line 176 of file RooAbsMCStudyModule.h.

Member Data Documentation

◆ _mcs

RooMCStudy* RooAbsMCStudyModule::_mcs

private

Pointer to RooMCStudy object module is attached to.

Definition at line 182 of file RooAbsMCStudyModule.h.

Libraries for RooAbsMCStudyModule:

[legend]

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

roofit/roofitcore/inc/RooAbsMCStudyModule.h
roofit/roofitcore/src/RooAbsMCStudyModule.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RooAbsMCStudyModule() [1/2]

◆ RooAbsMCStudyModule() [2/2]

Member Function Documentation

◆ allDependents()

◆ binGenData()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ dependents()

◆ doInitializeInstance()

◆ extendedGen()

◆ finalizeRun()

◆ fitInitParams()

◆ fitModel()

◆ fitOptList()

◆ fitParams()

◆ genContext()

◆ genInitParams()

◆ genModel()

◆ genParams()

◆ genProtoData()

◆ genSample()

◆ initializeInstance()

◆ initializeRun()

◆ IsA()

◆ nllVar()

◆ numExpGen()

◆ processAfterFit()

◆ processBeforeGen()

◆ processBetweenGenAndFit()

◆ projDeps()

◆ randProto()

◆ refit()

◆ Streamer()

◆ StreamerNVirtual()

◆ verboseGen()

Member Data Documentation

◆ _mcs