Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooStats::UpperLimitMCSModule Class Reference

This class allow to compute in the ToyMcStudy framework the ProfileLikelihood upper limit for each toy-MC sample generated.

Definition at line 27 of file UpperLimitMCSModule.h.

Public Member Functions

 UpperLimitMCSModule (const RooArgSet *poi, double CL=0.95)
 
 UpperLimitMCSModule (const UpperLimitMCSModule &other)
 Copy constructor.
 
 ~UpperLimitMCSModule () override
 Destructor.
 
RooDataSetfinalizeRun () override
 Return auxiliary dataset with results of delta(-log(L)) calculations of this module so that it is merged with RooMCStudy::fitParDataSet() by RooMCStudy.
 
bool initializeInstance () override
 Initialize module after attachment to RooMCStudy object.
 
bool initializeRun (Int_t) override
 Initialize module at beginning of RooCMStudy run.
 
TClassIsA () const override
 
bool processBetweenGenAndFit (Int_t) override
 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 RooAbsMCStudyModule
 RooAbsMCStudyModule (const char *name, const char *title)
 Constructor.
 
 RooAbsMCStudyModule (const RooAbsMCStudyModule &other)
 Copy constructor.
 
 ~RooAbsMCStudyModule () override
 
bool doInitializeInstance (RooMCStudy &)
 Initializer method called upon attachement to given RooMCStudy object.
 
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)
 
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 ("").
 
TObjectClone (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.
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (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 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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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)
 
TObjectoperator= (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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from RooAbsMCStudyModule
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.
 
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 Attributes

double _cl
 
RooDataSet_data
 Summary dataset to store results.
 
RooAbsPdf_model
 
std::string _parName
 Name of Nsignal parameter.
 
RooStats::ProfileLikelihoodCalculator_plc
 
const RooArgSet_poi
 parameters of interest
 
RooRealVar_ul
 

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 RooAbsMCStudyModule
RooArgSetallDependents ()
 Return all observables.
 
bool binGenData ()
 If true binning of data between generating and fitting is requested.
 
RooArgSetdependents ()
 Return fit model observables.
 
bool extendedGen ()
 If true extended mode generation is requested.
 
RooArgSetfitInitParams ()
 Return initial value of parameters of fit model.
 
RooAbsPdffitModel ()
 Return fit model.
 
RooLinkedListfitOptList ()
 Return list of fit options provided by user.
 
RooArgSetfitParams ()
 Return current value of parameters of fit model.
 
RooAbsGenContextgenContext ()
 
RooArgSetgenInitParams ()
 Return initial value of generator model parameters.
 
RooAbsPdfgenModel ()
 Return generator pdf.
 
RooArgSetgenParams ()
 Return current value of generator model parameters.
 
const RooDataSetgenProtoData ()
 Return generator prototype data provided by user.
 
RooAbsDatagenSample ()
 Return generate sample.
 
RooRealVarnllVar ()
 Return pointer to RooRealVar holding minimized -log(L) value.
 
double numExpGen ()
 Return expected number of events from generator model.
 
RooArgSetprojDeps ()
 Return projected observables.
 
bool randProto ()
 If true randomization of prototype data order is requested.
 
RooFit::OwningPtr< RooFitResultrefit (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 ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <RooStats/UpperLimitMCSModule.h>

Inheritance diagram for RooStats::UpperLimitMCSModule:
[legend]

Constructor & Destructor Documentation

◆ UpperLimitMCSModule() [1/2]

UpperLimitMCSModule::UpperLimitMCSModule ( const RooArgSet poi,
double  CL = 0.95 
)

Definition at line 44 of file UpperLimitMCSModule.cxx.

◆ UpperLimitMCSModule() [2/2]

UpperLimitMCSModule::UpperLimitMCSModule ( const UpperLimitMCSModule other)

Copy constructor.

Definition at line 60 of file UpperLimitMCSModule.cxx.

◆ ~UpperLimitMCSModule()

UpperLimitMCSModule::~UpperLimitMCSModule ( )
override

Destructor.

Definition at line 70 of file UpperLimitMCSModule.cxx.

Member Function Documentation

◆ Class()

static TClass * RooStats::UpperLimitMCSModule::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooStats::UpperLimitMCSModule::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t RooStats::UpperLimitMCSModule::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 54 of file UpperLimitMCSModule.h.

◆ DeclFileName()

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

Definition at line 54 of file UpperLimitMCSModule.h.

◆ finalizeRun()

RooDataSet * UpperLimitMCSModule::finalizeRun ( )
overridevirtual

Return auxiliary dataset with results of delta(-log(L)) calculations of this module so that it is merged with RooMCStudy::fitParDataSet() by RooMCStudy.

Reimplemented from RooAbsMCStudyModule.

Definition at line 134 of file UpperLimitMCSModule.cxx.

◆ initializeInstance()

bool UpperLimitMCSModule::initializeInstance ( )
overridevirtual

Initialize module after attachment to RooMCStudy object.

Reimplemented from RooAbsMCStudyModule.

Definition at line 93 of file UpperLimitMCSModule.cxx.

◆ initializeRun()

bool UpperLimitMCSModule::initializeRun ( Int_t  )
overridevirtual

Initialize module at beginning of RooCMStudy run.

Reimplemented from RooAbsMCStudyModule.

Definition at line 123 of file UpperLimitMCSModule.cxx.

◆ IsA()

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

Reimplemented from RooAbsMCStudyModule.

Definition at line 54 of file UpperLimitMCSModule.h.

◆ processBetweenGenAndFit()

bool UpperLimitMCSModule::processBetweenGenAndFit ( Int_t  )
overridevirtual

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

Definition at line 170 of file UpperLimitMCSModule.cxx.

◆ Streamer()

void RooStats::UpperLimitMCSModule::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from RooAbsMCStudyModule.

◆ StreamerNVirtual()

void RooStats::UpperLimitMCSModule::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 54 of file UpperLimitMCSModule.h.

Member Data Documentation

◆ _cl

double RooStats::UpperLimitMCSModule::_cl
private

Definition at line 51 of file UpperLimitMCSModule.h.

◆ _data

RooDataSet* RooStats::UpperLimitMCSModule::_data
private

Summary dataset to store results.

Definition at line 50 of file UpperLimitMCSModule.h.

◆ _model

RooAbsPdf* RooStats::UpperLimitMCSModule::_model
private

Definition at line 52 of file UpperLimitMCSModule.h.

◆ _parName

std::string RooStats::UpperLimitMCSModule::_parName
private

Name of Nsignal parameter.

Definition at line 45 of file UpperLimitMCSModule.h.

◆ _plc

RooStats::ProfileLikelihoodCalculator* RooStats::UpperLimitMCSModule::_plc
private

Definition at line 46 of file UpperLimitMCSModule.h.

◆ _poi

const RooArgSet* RooStats::UpperLimitMCSModule::_poi
private

parameters of interest

Definition at line 49 of file UpperLimitMCSModule.h.

◆ _ul

RooRealVar* RooStats::UpperLimitMCSModule::_ul
private

Definition at line 47 of file UpperLimitMCSModule.h.

Libraries for RooStats::UpperLimitMCSModule:

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