Logo ROOT  
Reference Guide
RooAbsMCStudyModule Class Reference

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 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. More...
 
 RooAbsMCStudyModule (const RooAbsMCStudyModule &other)
 Copy constructor. More...
 
 ~RooAbsMCStudyModule () override
 
bool doInitializeInstance (RooMCStudy &)
 Initializer method called upon attachement to given RooMCStudy object. More...
 
virtual RooDataSetfinalizeRun ()
 Method called at the end of each RooMCStudy run. More...
 
virtual bool initializeInstance ()
 Initializer called immediately after attachment to RooMCStudy object and initialization of module base class. More...
 
virtual bool initializeRun (Int_t)
 Method called at the beginning of each RooMCStudy run. More...
 
TClassIsA () const override
 
virtual bool processAfterFit (Int_t)
 Method called after fit has been performed. More...
 
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) More...
 
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. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
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. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
void Clear (Option_t *option="") override
 Set name and title to empty strings (""). More...
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility. More...
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects. More...
 
void Copy (TObject &named) const override
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
const char * GetName () const override
 Returns name of object. More...
 
const char * GetTitle () const override
 Returns title of object. More...
 
ULong_t Hash () const override
 Return hash value for this object. More...
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
void Print (Option_t *option="") const override
 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...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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 Clear (Option_t *="")
 
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 abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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=nullptr)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object. More...
 
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 ULong_t Hash () const
 Return hash value for this object. 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 TClassIsA () const
 
Bool_t IsDestructed () const
 IsDestructed. More...
 
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
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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)
 
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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
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 Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_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

RooArgSetallDependents ()
 Return all observables. More...
 
bool binGenData ()
 If true binning of data between generating and fitting is requested. More...
 
RooArgSetdependents ()
 Return fit model observables. More...
 
bool extendedGen ()
 If true extended mode generation is requested. More...
 
RooArgSetfitInitParams ()
 Return initial value of parameters of fit model. More...
 
RooAbsPdffitModel ()
 Return fit model. More...
 
RooLinkedListfitOptList ()
 Return list of fit options provided by user. More...
 
RooArgSetfitParams ()
 Return current value of parameters of fit model. More...
 
RooAbsGenContextgenContext ()
 
RooArgSetgenInitParams ()
 Return initial value of generator model parameters. More...
 
RooAbsPdfgenModel ()
 Return generator pdf. More...
 
RooArgSetgenParams ()
 Return current value of generator model parameters. More...
 
const RooDataSetgenProtoData ()
 Return generator prototype data provided by user. More...
 
RooAbsDatagenSample ()
 Return generate sample. More...
 
RooRealVarnllVar ()
 Return pointer to RooRealVar holding minimized -log(L) value. More...
 
double numExpGen ()
 Return expected number of events from generator model. More...
 
RooArgSetprojDeps ()
 Return projected observables. More...
 
bool randProto ()
 If true randomization of prototype data order is requested. More...
 
RooFitResultrefit (RooAbsData *inGenSample=nullptr)
 Refit model using original or specified data sample. More...
 
bool verboseGen ()
 If true verbose message in the generation step is requested. 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 ()
 

Private Attributes

RooMCStudy_mcs
 Pointer to RooMCStudy object module is attached to. More...
 

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 45 of file RooAbsMCStudyModule.cxx.

◆ RooAbsMCStudyModule() [2/2]

RooAbsMCStudyModule::RooAbsMCStudyModule ( const RooAbsMCStudyModule other)

Copy constructor.

Definition at line 53 of file RooAbsMCStudyModule.cxx.

◆ ~RooAbsMCStudyModule()

RooAbsMCStudyModule::~RooAbsMCStudyModule ( )
inlineoverride

Definition at line 35 of file RooAbsMCStudyModule.h.

Member Function Documentation

◆ allDependents()

RooArgSet * RooAbsMCStudyModule::allDependents ( )
inlineprotected

Return all observables.

Definition at line 127 of file RooAbsMCStudyModule.h.

◆ binGenData()

bool RooAbsMCStudyModule::binGenData ( )
inlineprotected

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

Definition at line 164 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 187 of file RooAbsMCStudyModule.h.

◆ DeclFileName()

static const char * RooAbsMCStudyModule::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 187 of file RooAbsMCStudyModule.h.

◆ dependents()

RooArgSet * RooAbsMCStudyModule::dependents ( )
inlineprotected

Return fit model observables.

Definition at line 122 of file RooAbsMCStudyModule.h.

◆ doInitializeInstance()

bool RooAbsMCStudyModule::doInitializeInstance ( RooMCStudy study)

Initializer method called upon attachement to given RooMCStudy object.

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

Definition at line 62 of file RooAbsMCStudyModule.cxx.

◆ extendedGen()

bool RooAbsMCStudyModule::extendedGen ( )
inlineprotected

If true extended mode generation is requested.

Definition at line 159 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 52 of file RooAbsMCStudyModule.h.

◆ fitInitParams()

RooArgSet * RooAbsMCStudyModule::fitInitParams ( )
inlineprotected

Return initial value of parameters of fit model.

Definition at line 137 of file RooAbsMCStudyModule.h.

◆ fitModel()

RooAbsPdf * RooAbsMCStudyModule::fitModel ( )
inlineprotected

Return fit model.

Definition at line 132 of file RooAbsMCStudyModule.h.

◆ fitOptList()

RooLinkedList * RooAbsMCStudyModule::fitOptList ( )
inlineprotected

Return list of fit options provided by user.

Definition at line 154 of file RooAbsMCStudyModule.h.

◆ fitParams()

RooArgSet * RooAbsMCStudyModule::fitParams ( )
inlineprotected

Return current value of parameters of fit model.

Definition at line 142 of file RooAbsMCStudyModule.h.

◆ genContext()

RooAbsGenContext * RooAbsMCStudyModule::genContext ( )
inlineprotected

Definition at line 95 of file RooAbsMCStudyModule.h.

◆ genInitParams()

RooArgSet * RooAbsMCStudyModule::genInitParams ( )
inlineprotected

Return initial value of generator model parameters.

Definition at line 100 of file RooAbsMCStudyModule.h.

◆ genModel()

RooAbsPdf * RooAbsMCStudyModule::genModel ( )
inlineprotected

Return generator pdf.

Definition at line 90 of file RooAbsMCStudyModule.h.

◆ genParams()

RooArgSet * RooAbsMCStudyModule::genParams ( )
inlineprotected

Return current value of generator model parameters.

Definition at line 105 of file RooAbsMCStudyModule.h.

◆ genProtoData()

const RooDataSet * RooAbsMCStudyModule::genProtoData ( )
inlineprotected

Return generator prototype data provided by user.

Definition at line 110 of file RooAbsMCStudyModule.h.

◆ genSample()

RooAbsData * RooAbsMCStudyModule::genSample ( )
inlineprotected

Return generate sample.

Definition at line 85 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 41 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 46 of file RooAbsMCStudyModule.h.

◆ IsA()

TClass * RooAbsMCStudyModule::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TNamed.

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

Definition at line 187 of file RooAbsMCStudyModule.h.

◆ nllVar()

RooRealVar * RooAbsMCStudyModule::nllVar ( )
inlineprotected

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

Definition at line 147 of file RooAbsMCStudyModule.h.

◆ numExpGen()

double RooAbsMCStudyModule::numExpGen ( )
inlineprotected

Return expected number of events from generator model.

Definition at line 169 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 70 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 58 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 65 of file RooAbsMCStudyModule.h.

◆ projDeps()

RooArgSet * RooAbsMCStudyModule::projDeps ( )
inlineprotected

Return projected observables.

Definition at line 115 of file RooAbsMCStudyModule.h.

◆ randProto()

bool RooAbsMCStudyModule::randProto ( )
inlineprotected

If true randomization of prototype data order is requested.

Definition at line 174 of file RooAbsMCStudyModule.h.

◆ refit()

RooFitResult * RooAbsMCStudyModule::refit ( RooAbsData inGenSample = nullptr)
inlineprotected

Refit model using original or specified data sample.

Definition at line 80 of file RooAbsMCStudyModule.h.

◆ Streamer()

void RooAbsMCStudyModule::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TNamed.

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

◆ StreamerNVirtual()

void RooAbsMCStudyModule::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 187 of file RooAbsMCStudyModule.h.

◆ verboseGen()

bool RooAbsMCStudyModule::verboseGen ( )
inlineprotected

If true verbose message in the generation step is requested.

Definition at line 179 of file RooAbsMCStudyModule.h.

Member Data Documentation

◆ _mcs

RooMCStudy* RooAbsMCStudyModule::_mcs
private

Pointer to RooMCStudy object module is attached to.

Definition at line 185 of file RooAbsMCStudyModule.h.

Libraries for RooAbsMCStudyModule:
[legend]

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