Logo ROOT   6.21/01
Reference Guide
RooStats::HybridResult Class Reference

Class encapsulating the result of the HybridCalculatorOriginal.

This class is a fresh rewrite in RooStats of RooStatsCms/LimitResults developed by D. Piparo and G. Schott New contributions to this class have been written by Matthias Wolf (error estimation)

The objects of this class store and access with lightweight methods the information calculated by LimitResults through a Lent calculation using MC toy experiments. In some ways can be considered an extended and extensible implementation of the TConfidenceLevel class (http://root.cern.ch/root/html/TConfidenceLevel.html).

Definition at line 25 of file HybridResult.h.

Public Member Functions

 HybridResult (const char *name=0)
 Default constructor. More...
 
 HybridResult (const char *name, const std::vector< double > &testStat_sb_vals, const std::vector< double > &testStat_b_vals, bool sumLargerValues=true)
 Constructor for HybridResult. More...
 
virtual ~HybridResult ()
 Destructor of HybridResult. More...
 
void Add (HybridResult *other)
 add additional toy-MC experiments to the current results use the data test statistics of the added object if none is already present (otherwise, ignore the new one) More...
 
Double_t AlternatePValue () const
 Returns \(CL_{s+b}\) : the S+B p-value. More...
 
Double_t CLbError () const
 The error on the "confidence level" of the null hypothesis. More...
 
Double_t CLsError () const
 The error on the ratio \(CL_{s+b}/CL_{b}\). More...
 
Double_t CLsplusbError () const
 The error on the "confidence level" of the alternative hypothesis. More...
 
HybridPlotGetPlot (const char *name, const char *title, int n_bins)
 prepare a plot showing a result and return a pointer to a HybridPlot object the needed arguments are: an object name, a title and the number of bins in the plot More...
 
std::vector< double > GetTestStat_b ()
 Get test statistics values for the b model. More...
 
double GetTestStat_data ()
 Get test statistics value for data. More...
 
std::vector< double > GetTestStat_sb ()
 Get test statistics values for the sb model. More...
 
Double_t NullPValue () const
 Returns \(1 - CL_{b}\) : the B p-value. More...
 
void PrintMore (const char *options)
 Print out some information about the results. More...
 
void SetDataTestStatistics (double testStat_data_val)
 set the value of the test statistics on data More...
 
- Public Member Functions inherited from RooStats::HypoTestResult
 HypoTestResult (const char *name=0)
 default constructor More...
 
 HypoTestResult (const HypoTestResult &other)
 copy constructor More...
 
 HypoTestResult (const char *name, Double_t nullp, Double_t altp)
 constructor from name, null and alternate p values More...
 
virtual ~HypoTestResult ()
 destructor More...
 
virtual void Append (const HypoTestResult *other)
 add values from another HypoTestResult More...
 
virtual Double_t CLb () const
 Convert NullPValue into a "confidence level". More...
 
Double_t CLbError () const
 The error on the "confidence level" of the null hypothesis. More...
 
virtual Double_t CLs () const
 \(CL_{s}\) is simply \(CL_{s+b}/CL_{b}\) (not a method, but a quantity) More...
 
Double_t CLsError () const
 The error on the ratio \(CL_{s+b}/CL_{b}\). More...
 
virtual Double_t CLsplusb () const
 Convert AlternatePValue into a "confidence level". More...
 
Double_t CLsplusbError () const
 The error on the "confidence level" of the alternative hypothesis. More...
 
const RooArgListGetAllTestStatisticsData (void) const
 
RooDataSetGetAltDetailedOutput (void) const
 
SamplingDistributionGetAltDistribution (void) const
 
Bool_t GetBackGroundIsAlt (void) const
 
RooDataSetGetFitInfo (void) const
 
RooDataSetGetNullDetailedOutput (void) const
 
SamplingDistributionGetNullDistribution (void) const
 
Bool_t GetPValueIsRightTail (void) const
 
Double_t GetTestStatisticData (void) const
 
Bool_t HasTestStatisticData (void) const
 
Double_t NullPValueError () const
 The error on the Null p-value. More...
 
HypoTestResultoperator= (const HypoTestResult &other)
 assignment operator More...
 
void Print (const Option_t *="") const
 Print out some information about the results Note: use Alt/Null labels for the hypotheses here as the Null might be the s+b hypothesis. More...
 
void SetAllTestStatisticsData (const RooArgList *tsd)
 
void SetAltDetailedOutput (RooDataSet *d)
 
void SetAltDistribution (SamplingDistribution *alt)
 
void SetBackgroundAsAlt (Bool_t l=kTRUE)
 
void SetFitInfo (RooDataSet *d)
 
void SetNullDetailedOutput (RooDataSet *d)
 
void SetNullDistribution (SamplingDistribution *null)
 
void SetPValueIsRightTail (Bool_t pr)
 
void SetTestStatisticData (const Double_t tsd)
 
virtual Double_t Significance () const
 familiar name for the Null p-value in terms of 1-sided Gaussian significance More...
 
Double_t SignificanceError () const
 The error on the significance, computed from NullPValueError via error propagation. More...
 
- 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 ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 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...
 
TNamedoperator= (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...
 
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 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 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 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...
 
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 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
 
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). 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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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 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...
 
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...
 

Private Attributes

bool fComputationsAltDoneFlag
 
bool fComputationsNulDoneFlag
 
bool fSumLargerValues
 
std::vector< double > fTestStat_b
 
double fTestStat_data
 
std::vector< double > fTestStat_sb
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = 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 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 RooStats::HypoTestResult
const RooArgListfAllTestStatisticsData
 
RooDataSetfAltDetailedOutput
 
SamplingDistributionfAltDistr
 
Double_t fAlternatePValue
 
Double_t fAlternatePValueError
 
Bool_t fBackgroundIsAlt
 
RooDataSetfFitInfo
 
RooDataSetfNullDetailedOutput
 
SamplingDistributionfNullDistr
 
Double_t fNullPValue
 
Double_t fNullPValueError
 
Bool_t fPValueIsRightTail
 
Double_t fTestStatisticData
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <RooStats/HybridResult.h>

Inheritance diagram for RooStats::HybridResult:
[legend]

Constructor & Destructor Documentation

◆ HybridResult() [1/2]

HybridResult::HybridResult ( const char *  name = 0)
explicit

Default constructor.

Construtor.

Definition at line 54 of file HybridResult.cxx.

◆ HybridResult() [2/2]

HybridResult::HybridResult ( const char *  name,
const std::vector< double > &  testStat_sb_vals,
const std::vector< double > &  testStat_b_vals,
bool  sumLargerValues = true 
)

Constructor for HybridResult.

Construtor.

Definition at line 67 of file HybridResult.cxx.

◆ ~HybridResult()

HybridResult::~HybridResult ( )
virtual

Destructor of HybridResult.

HybridResult destructor.

Definition at line 98 of file HybridResult.cxx.

Member Function Documentation

◆ Add()

void HybridResult::Add ( HybridResult other)

add additional toy-MC experiments to the current results use the data test statistics of the added object if none is already present (otherwise, ignore the new one)

Definition at line 228 of file HybridResult.cxx.

◆ AlternatePValue()

double HybridResult::AlternatePValue ( ) const
virtual

Returns \(CL_{s+b}\) : the S+B p-value.

Reimplemented from RooStats::HypoTestResult.

Definition at line 149 of file HybridResult.cxx.

◆ CLbError()

Double_t HybridResult::CLbError ( ) const

The error on the "confidence level" of the null hypothesis.

Returns an estimate of the error on \(CL_{b}\) assuming a binomial error on \(CL_{b}\):

\[ \sigma_{CL_{b}} = \sqrt{CL_{b} \left( 1 - CL_{b} \right) / n_{toys}} \]

.

Definition at line 183 of file HybridResult.cxx.

◆ CLsError()

Double_t HybridResult::CLsError ( ) const

The error on the ratio \(CL_{s+b}/CL_{b}\).

Returns an estimate of the error on \(CL_{s}\) through combination of the errors on \(CL_{b}\) and \(CL_{s+b}\):

\[ \sigma_{CL_s} = CL_s \sqrt{\left( \frac{\sigma_{CL_{s+b}}}{CL_{s+b}} \right)^2 + \left( \frac{\sigma_{CL_{b}}}{CL_{b}} \right)^2} \]

.

Definition at line 209 of file HybridResult.cxx.

◆ CLsplusbError()

Double_t HybridResult::CLsplusbError ( ) const

The error on the "confidence level" of the alternative hypothesis.

Returns an estimate of the error on \(CL_{s+b}\) assuming a binomial error on \(CL_{s+b}\):

\[ \sigma_{CL_{s+b}} = \sqrt{CL_{s+b} \left( 1 - CL_{s+b} \right) / n_{toys}} \]

.

Definition at line 196 of file HybridResult.cxx.

◆ GetPlot()

HybridPlot * HybridResult::GetPlot ( const char *  name,
const char *  title,
int  n_bins 
)

prepare a plot showing a result and return a pointer to a HybridPlot object the needed arguments are: an object name, a title and the number of bins in the plot

Definition at line 253 of file HybridResult.cxx.

◆ GetTestStat_b()

std::vector<double> RooStats::HybridResult::GetTestStat_b ( )
inline

Get test statistics values for the b model.

Definition at line 54 of file HybridResult.h.

◆ GetTestStat_data()

double RooStats::HybridResult::GetTestStat_data ( )
inline

Get test statistics value for data.

Definition at line 57 of file HybridResult.h.

◆ GetTestStat_sb()

std::vector<double> RooStats::HybridResult::GetTestStat_sb ( )
inline

Get test statistics values for the sb model.

Definition at line 51 of file HybridResult.h.

◆ NullPValue()

double HybridResult::NullPValue ( ) const
virtual

Returns \(1 - CL_{b}\) : the B p-value.

Reimplemented from RooStats::HypoTestResult.

Definition at line 119 of file HybridResult.cxx.

◆ PrintMore()

void HybridResult::PrintMore ( const char *  options)

Print out some information about the results.

Definition at line 284 of file HybridResult.cxx.

◆ SetDataTestStatistics()

void HybridResult::SetDataTestStatistics ( double  testStat_data_val)

set the value of the test statistics on data

Definition at line 108 of file HybridResult.cxx.

Member Data Documentation

◆ fComputationsAltDoneFlag

bool RooStats::HybridResult::fComputationsAltDoneFlag
mutableprivate

Definition at line 81 of file HybridResult.h.

◆ fComputationsNulDoneFlag

bool RooStats::HybridResult::fComputationsNulDoneFlag
mutableprivate

Definition at line 80 of file HybridResult.h.

◆ fSumLargerValues

bool RooStats::HybridResult::fSumLargerValues
private

Definition at line 82 of file HybridResult.h.

◆ fTestStat_b

std::vector<double> RooStats::HybridResult::fTestStat_b
private

Definition at line 76 of file HybridResult.h.

◆ fTestStat_data

double RooStats::HybridResult::fTestStat_data
private

Definition at line 78 of file HybridResult.h.

◆ fTestStat_sb

std::vector<double> RooStats::HybridResult::fTestStat_sb
private

Definition at line 77 of file HybridResult.h.

Libraries for RooStats::HybridResult:
[legend]

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