Logo ROOT  
Reference Guide
RooDLLSignificanceMCSModule Class Reference

RooDLLSignificanceMCSModule is an add-on modules to RooMCStudy that calculates the significance of a signal by comparing the likelihood of a fit fit with a given parameter floating with a fit with that given parameter fixed to a nominal value (usually zero).

The difference in the -log(L) of those two fits can be interpreted as the probability that a statistical background fluctation may result in a signal as large or larger than the signal observed. This interpretation is contingent on underlying normal sampling distributions and a MC study is a good way to test that assumption.

Definition at line 23 of file RooDLLSignificanceMCSModule.h.

Public Member Functions

 RooDLLSignificanceMCSModule (const char *parName, double nullHypoValue=0)
 Constructor of module with parameter name to be interpreted as nSignal and the value of the null hypothesis for nSignal (usually zero) More...
 
 RooDLLSignificanceMCSModule (const RooDLLSignificanceMCSModule &other)
 Copy constructor. More...
 
 RooDLLSignificanceMCSModule (const RooRealVar &param, double nullHypoValue=0)
 Constructor of module with parameter to be interpreted as nSignal and the value of the null hypothesis for nSignal (usually zero) More...
 
 ~RooDLLSignificanceMCSModule () override
 Destructor. More...
 
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. More...
 
bool initializeInstance () override
 Initialize module after attachment to RooMCStudy object. More...
 
bool initializeRun (Int_t) override
 Initialize module at beginning of RooCMStudy run. More...
 
TClassIsA () const override
 
bool processAfterFit (Int_t) override
 Save likelihood from nominal fit, fix chosen parameter to its null hypothesis value and rerun fit Save difference in likelihood and associated Gaussian significance in auxilary dataset. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from RooAbsMCStudyModule
 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=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 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
 
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=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...
 

Static Public Member Functions

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

Private Attributes

RooDataSet_data
 Summary dataset to store results. More...
 
RooRealVar_dll0h
 Container variable for delta NLL. More...
 
RooRealVar_nll0h
 Container variable for NLL result on null hypothesis. More...
 
double _nullValue
 Numeric value of Nsignal parameter representing the null hypothesis. More...
 
std::string _parName
 Name of Nsignal parameter. More...
 
RooRealVar_sig0h
 Container variable for NLL result with signal. 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 Member Functions inherited from RooAbsMCStudyModule
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=0)
 Refit model using orignal 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 ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <RooDLLSignificanceMCSModule.h>

Inheritance diagram for RooDLLSignificanceMCSModule:
[legend]

Constructor & Destructor Documentation

◆ RooDLLSignificanceMCSModule() [1/3]

RooDLLSignificanceMCSModule::RooDLLSignificanceMCSModule ( const RooRealVar param,
double  nullHypoValue = 0 
)

Constructor of module with parameter to be interpreted as nSignal and the value of the null hypothesis for nSignal (usually zero)

Definition at line 55 of file RooDLLSignificanceMCSModule.cxx.

◆ RooDLLSignificanceMCSModule() [2/3]

RooDLLSignificanceMCSModule::RooDLLSignificanceMCSModule ( const char *  parName,
double  nullHypoValue = 0 
)

Constructor of module with parameter name to be interpreted as nSignal and the value of the null hypothesis for nSignal (usually zero)

Definition at line 68 of file RooDLLSignificanceMCSModule.cxx.

◆ RooDLLSignificanceMCSModule() [3/3]

RooDLLSignificanceMCSModule::RooDLLSignificanceMCSModule ( const RooDLLSignificanceMCSModule other)

Copy constructor.

Definition at line 80 of file RooDLLSignificanceMCSModule.cxx.

◆ ~RooDLLSignificanceMCSModule()

RooDLLSignificanceMCSModule::~RooDLLSignificanceMCSModule ( )
override

Destructor.

Definition at line 92 of file RooDLLSignificanceMCSModule.cxx.

Member Function Documentation

◆ Class()

static TClass * RooDLLSignificanceMCSModule::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

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

◆ Class_Version()

static Version_t RooDLLSignificanceMCSModule::Class_Version ( )
inlinestatic
Returns
Version of this class

Definition at line 47 of file RooDLLSignificanceMCSModule.h.

◆ DeclFileName()

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

Definition at line 47 of file RooDLLSignificanceMCSModule.h.

◆ finalizeRun()

RooDataSet * RooDLLSignificanceMCSModule::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 160 of file RooDLLSignificanceMCSModule.cxx.

◆ initializeInstance()

bool RooDLLSignificanceMCSModule::initializeInstance ( )
overridevirtual

Initialize module after attachment to RooMCStudy object.

Reimplemented from RooAbsMCStudyModule.

Definition at line 113 of file RooDLLSignificanceMCSModule.cxx.

◆ initializeRun()

bool RooDLLSignificanceMCSModule::initializeRun ( Int_t  )
overridevirtual

Initialize module at beginning of RooCMStudy run.

Reimplemented from RooAbsMCStudyModule.

Definition at line 147 of file RooDLLSignificanceMCSModule.cxx.

◆ IsA()

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

Reimplemented from RooAbsMCStudyModule.

Definition at line 47 of file RooDLLSignificanceMCSModule.h.

◆ processAfterFit()

bool RooDLLSignificanceMCSModule::processAfterFit ( Int_t  )
overridevirtual

Save likelihood from nominal fit, fix chosen parameter to its null hypothesis value and rerun fit Save difference in likelihood and associated Gaussian significance in auxilary dataset.

Reimplemented from RooAbsMCStudyModule.

Definition at line 172 of file RooDLLSignificanceMCSModule.cxx.

◆ Streamer()

void RooDLLSignificanceMCSModule::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from RooAbsMCStudyModule.

◆ StreamerNVirtual()

void RooDLLSignificanceMCSModule::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 47 of file RooDLLSignificanceMCSModule.h.

Member Data Documentation

◆ _data

RooDataSet* RooDLLSignificanceMCSModule::_data
private

Summary dataset to store results.

Definition at line 41 of file RooDLLSignificanceMCSModule.h.

◆ _dll0h

RooRealVar* RooDLLSignificanceMCSModule::_dll0h
private

Container variable for delta NLL.

Definition at line 43 of file RooDLLSignificanceMCSModule.h.

◆ _nll0h

RooRealVar* RooDLLSignificanceMCSModule::_nll0h
private

Container variable for NLL result on null hypothesis.

Definition at line 42 of file RooDLLSignificanceMCSModule.h.

◆ _nullValue

double RooDLLSignificanceMCSModule::_nullValue
private

Numeric value of Nsignal parameter representing the null hypothesis.

Definition at line 45 of file RooDLLSignificanceMCSModule.h.

◆ _parName

std::string RooDLLSignificanceMCSModule::_parName
private

Name of Nsignal parameter.

Definition at line 40 of file RooDLLSignificanceMCSModule.h.

◆ _sig0h

RooRealVar* RooDLLSignificanceMCSModule::_sig0h
private

Container variable for NLL result with signal.

Definition at line 44 of file RooDLLSignificanceMCSModule.h.

Libraries for RooDLLSignificanceMCSModule:
[legend]

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