RooAbsMCStudyModule is a 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 RooDLLSignificanceMCStudyModule for an example of an implementation

Definition at line 31 of file RooAbsMCStudyModule.h.

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

	RooAbsMCStudyModule (const RooAbsMCStudyModule &other)
	Copy constructor. More...

virtual	~RooAbsMCStudyModule ()

Bool_t	doInitializeInstance (RooMCStudy &)
	Store reference to RooMCStudy object that this module relates to and call internal module initialization function. More...

virtual RooDataSet *	finalizeRun ()

virtual Bool_t	initializeInstance ()

virtual Bool_t	initializeRun (Int_t)

virtual Bool_t	processAfterFit (Int_t)

virtual Bool_t	processBeforeGen (Int_t)

virtual Bool_t	processBetweenGenAndFit (Int_t)

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

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

virtual TObject *	Clone (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...

TNamed &	operator= (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...

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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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...

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

Bool_t	IsOnHeap () const

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

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

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

Protected Member Functions
RooArgSet *	allDependents ()

Bool_t	binGenData ()

RooArgSet *	dependents ()

Bool_t	extendedGen ()

RooArgSet *	fitInitParams ()

RooAbsPdf *	fitModel ()

const char *	fitOptions ()

RooLinkedList *	fitOptList ()

RooArgSet *	fitParams ()

RooAbsGenContext *	genContext ()

RooArgSet *	genInitParams ()

RooAbsPdf *	genModel ()

RooArgSet *	genParams ()

const RooDataSet *	genProtoData ()

RooAbsData *	genSample ()

RooRealVar *	nllVar ()

Double_t	numExpGen ()

RooArgSet *	projDeps ()

Bool_t	randProto ()

RooFitResult *	refit (RooAbsData *inGenSample=0)

Bool_t	verboseGen ()

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

Private Attributes
RooMCStudy *	_mcs

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

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

enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = 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 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 46 of file RooAbsMCStudyModule.cxx.

◆ RooAbsMCStudyModule() [2/2]

RooAbsMCStudyModule::RooAbsMCStudyModule ( const RooAbsMCStudyModule & other )

Copy constructor.

Definition at line 54 of file RooAbsMCStudyModule.cxx.

◆ ~RooAbsMCStudyModule()

virtual RooAbsMCStudyModule::~RooAbsMCStudyModule ( )

inlinevirtual

Definition at line 36 of file RooAbsMCStudyModule.h.

Member Function Documentation

◆ allDependents()

RooArgSet* RooAbsMCStudyModule::allDependents ( )

inlineprotected

Definition at line 122 of file RooAbsMCStudyModule.h.

◆ binGenData()

Bool_t RooAbsMCStudyModule::binGenData ( )

inlineprotected

Definition at line 156 of file RooAbsMCStudyModule.h.

◆ dependents()

RooArgSet* RooAbsMCStudyModule::dependents ( )

inlineprotected

Definition at line 118 of file RooAbsMCStudyModule.h.

◆ doInitializeInstance()

Bool_t RooAbsMCStudyModule::doInitializeInstance ( RooMCStudy & study )

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

Definition at line 63 of file RooAbsMCStudyModule.cxx.

◆ extendedGen()

Bool_t RooAbsMCStudyModule::extendedGen ( )

inlineprotected

Definition at line 152 of file RooAbsMCStudyModule.h.

◆ finalizeRun()

virtual RooDataSet* RooAbsMCStudyModule::finalizeRun ( )

inlinevirtual

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

Definition at line 51 of file RooAbsMCStudyModule.h.

◆ fitInitParams()

RooArgSet* RooAbsMCStudyModule::fitInitParams ( )

inlineprotected

Definition at line 130 of file RooAbsMCStudyModule.h.

◆ fitModel()

RooAbsPdf* RooAbsMCStudyModule::fitModel ( )

inlineprotected

Definition at line 126 of file RooAbsMCStudyModule.h.

◆ fitOptions()

const char* RooAbsMCStudyModule::fitOptions ( )

inlineprotected

Definition at line 144 of file RooAbsMCStudyModule.h.

◆ fitOptList()

RooLinkedList* RooAbsMCStudyModule::fitOptList ( )

inlineprotected

Definition at line 148 of file RooAbsMCStudyModule.h.

◆ fitParams()

RooArgSet* RooAbsMCStudyModule::fitParams ( )

inlineprotected

Definition at line 134 of file RooAbsMCStudyModule.h.

◆ genContext()

RooAbsGenContext* RooAbsMCStudyModule::genContext ( )

inlineprotected

Definition at line 96 of file RooAbsMCStudyModule.h.

◆ genInitParams()

RooArgSet* RooAbsMCStudyModule::genInitParams ( )

inlineprotected

Definition at line 100 of file RooAbsMCStudyModule.h.

◆ genModel()

RooAbsPdf* RooAbsMCStudyModule::genModel ( )

inlineprotected

Definition at line 90 of file RooAbsMCStudyModule.h.

◆ genParams()

RooArgSet* RooAbsMCStudyModule::genParams ( )

inlineprotected

Definition at line 104 of file RooAbsMCStudyModule.h.

◆ genProtoData()

const RooDataSet* RooAbsMCStudyModule::genProtoData ( )

inlineprotected

Definition at line 108 of file RooAbsMCStudyModule.h.

◆ genSample()

RooAbsData* RooAbsMCStudyModule::genSample ( )

inlineprotected

Definition at line 86 of file RooAbsMCStudyModule.h.

◆ initializeInstance()

virtual Bool_t RooAbsMCStudyModule::initializeInstance ( )

inlinevirtual

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

Definition at line 41 of file RooAbsMCStudyModule.h.

◆ initializeRun()

virtual Bool_t RooAbsMCStudyModule::initializeRun ( Int_t )

inlinevirtual

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

Definition at line 46 of file RooAbsMCStudyModule.h.

◆ nllVar()

RooRealVar* RooAbsMCStudyModule::nllVar ( )

inlineprotected

Definition at line 138 of file RooAbsMCStudyModule.h.

◆ numExpGen()

Double_t RooAbsMCStudyModule::numExpGen ( )

inlineprotected

Definition at line 160 of file RooAbsMCStudyModule.h.

◆ processAfterFit()

virtual Bool_t RooAbsMCStudyModule::processAfterFit ( Int_t )

inlinevirtual

Reimplemented in RooDLLSignificanceMCSModule, and RooChi2MCSModule.

Definition at line 71 of file RooAbsMCStudyModule.h.

◆ processBeforeGen()

virtual Bool_t RooAbsMCStudyModule::processBeforeGen ( Int_t )

inlinevirtual

Reimplemented in RooRandomizeParamMCSModule.

Definition at line 57 of file RooAbsMCStudyModule.h.

◆ processBetweenGenAndFit()

virtual Bool_t RooAbsMCStudyModule::processBetweenGenAndFit ( Int_t )

inlinevirtual

Reimplemented in RooStats::UpperLimitMCSModule.

Definition at line 64 of file RooAbsMCStudyModule.h.

◆ projDeps()

RooArgSet* RooAbsMCStudyModule::projDeps ( )

inlineprotected

Definition at line 112 of file RooAbsMCStudyModule.h.

◆ randProto()

Bool_t RooAbsMCStudyModule::randProto ( )

inlineprotected

Definition at line 164 of file RooAbsMCStudyModule.h.

◆ refit()

RooFitResult* RooAbsMCStudyModule::refit ( RooAbsData * inGenSample = 0 )

inlineprotected

Definition at line 81 of file RooAbsMCStudyModule.h.

◆ verboseGen()

Bool_t RooAbsMCStudyModule::verboseGen ( )

inlineprotected

Definition at line 168 of file RooAbsMCStudyModule.h.

Member Data Documentation

◆ _mcs

RooMCStudy* RooAbsMCStudyModule::_mcs

private

Definition at line 175 of file RooAbsMCStudyModule.h.

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RooAbsMCStudyModule() [1/2]

◆ RooAbsMCStudyModule() [2/2]

◆ ~RooAbsMCStudyModule()

Member Function Documentation

◆ allDependents()

◆ binGenData()

◆ dependents()

◆ doInitializeInstance()

◆ extendedGen()

◆ finalizeRun()

◆ fitInitParams()

◆ fitModel()

◆ fitOptions()

◆ fitOptList()

◆ fitParams()

◆ genContext()

◆ genInitParams()

◆ genModel()

◆ genParams()

◆ genProtoData()

◆ genSample()

◆ initializeInstance()

◆ initializeRun()

◆ nllVar()

◆ numExpGen()

◆ processAfterFit()

◆ processBeforeGen()

◆ processBetweenGenAndFit()

◆ projDeps()

◆ randProto()

◆ refit()

◆ verboseGen()

Member Data Documentation

◆ _mcs