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 27 of file HybridResult.h.
Public Member Functions | |
HybridResult (const char *name, const std::vector< double > &testStat_sb_vals, const std::vector< double > &testStat_b_vals, bool sumLargerValues=true) | |
Constructor for HybridResult. | |
HybridResult (const char *name=nullptr) | |
Default constructor. | |
~HybridResult () override | |
Destructor of HybridResult. | |
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) | |
double | AlternatePValue () const override |
Returns \(CL_{s+b}\) : the S+B p-value. | |
double | CLbError () const |
The error on the "confidence level" of the null hypothesis. | |
double | CLsError () const |
The error on the ratio \(CL_{s+b}/CL_{b}\). | |
double | CLsplusbError () const |
The error on the "confidence level" of the alternative hypothesis. | |
HybridPlot * | 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 | |
std::vector< double > | GetTestStat_b () |
Get test statistics values for the b model. | |
double | GetTestStat_data () |
Get test statistics value for data. | |
std::vector< double > | GetTestStat_sb () |
Get test statistics values for the sb model. | |
TClass * | IsA () const override |
double | NullPValue () const override |
Returns \(1 - CL_{b}\) : the B p-value. | |
void | PrintMore (const char *options) |
Print out some information about the results. | |
void | SetDataTestStatistics (double testStat_data_val) |
set the value of the test statistics on data | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from RooStats::HypoTestResult | |
HypoTestResult (const char *name, double nullp, double altp) | |
constructor from name, null and alternate p values | |
HypoTestResult (const char *name=nullptr) | |
default constructor | |
HypoTestResult (const HypoTestResult &other) | |
copy constructor | |
~HypoTestResult () override | |
destructor | |
virtual void | Append (const HypoTestResult *other) |
add values from another HypoTestResult | |
virtual double | CLb () const |
Convert NullPValue into a "confidence level". | |
double | CLbError () const |
The error on the "confidence level" of the null hypothesis. | |
virtual double | CLs () const |
\(CL_{s}\) is simply \(CL_{s+b}/CL_{b}\) (not a method, but a quantity) | |
double | CLsError () const |
The error on the ratio \(CL_{s+b}/CL_{b}\). | |
virtual double | CLsplusb () const |
Convert AlternatePValue into a "confidence level". | |
double | CLsplusbError () const |
The error on the "confidence level" of the alternative hypothesis. | |
const RooArgList * | GetAllTestStatisticsData (void) const |
RooDataSet * | GetAltDetailedOutput (void) const |
SamplingDistribution * | GetAltDistribution (void) const |
bool | GetBackGroundIsAlt (void) const |
RooDataSet * | GetFitInfo () const |
RooDataSet * | GetNullDetailedOutput (void) const |
SamplingDistribution * | GetNullDistribution (void) const |
bool | GetPValueIsRightTail (void) const |
double | GetTestStatisticData (void) const |
bool | HasTestStatisticData (void) const |
TClass * | IsA () const override |
double | NullPValueError () const |
The error on the Null p-value. | |
HypoTestResult & | operator= (const HypoTestResult &other) |
assignment operator | |
void | Print (const Option_t *="") const override |
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. | |
void | SetAllTestStatisticsData (const RooArgList *tsd) |
void | SetAltDetailedOutput (RooDataSet *d) |
void | SetAltDistribution (SamplingDistribution *alt) |
void | SetAltPValue (double pvalue) |
void | SetAltPValueError (double err) |
void | SetBackgroundAsAlt (bool l=true) |
void | SetFitInfo (RooDataSet *d) |
void | SetNullDetailedOutput (RooDataSet *d) |
void | SetNullDistribution (SamplingDistribution *null) |
void | SetNullPValue (double pvalue) |
void | SetNullPValueError (double err) |
void | SetPValueIsRightTail (bool pr) |
void | SetTestStatisticData (const double tsd) |
virtual double | Significance () const |
familiar name for the Null p-value in terms of 1-sided Gaussian significance | |
double | SignificanceError () const |
The error on the significance, computed from NullPValueError via error propagation. | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
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 (""). | |
TObject * | Clone (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. | |
TClass * | IsA () const override |
Bool_t | IsSortable () const override |
void | ls (Option_t *option="") const override |
List TNamed name and title. | |
TNamed & | operator= (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 | Streamer (TBuffer &) override |
Stream an object of class 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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () 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_t * | GetOption () 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 (the base implementation is no-op). | |
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, void *vp) |
Only called by placement new when throwing an exception. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void | operator delete[] (void *ptr, void *vp) |
Only called by placement new[] when throwing an exception. | |
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. | |
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 TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from RooStats::HypoTestResult | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TNamed | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
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 | |
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 = (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 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 RooStats::HypoTestResult | |
const RooArgList * | fAllTestStatisticsData |
for the case of multiple test statistics, holds all the results | |
RooDataSet * | fAltDetailedOutput |
SamplingDistribution * | fAltDistr |
double | fAlternatePValue |
p-value for the alternate hypothesis (small number means disfavoured) | |
double | fAlternatePValueError |
error of p-value for the alternate hypothesis (small number means disfavoured) | |
bool | fBackgroundIsAlt |
std::unique_ptr< RooDataSet > | fFitInfo |
RooDataSet * | fNullDetailedOutput |
SamplingDistribution * | fNullDistr |
double | fNullPValue |
p-value for the null hypothesis (small number means disfavoured) | |
double | fNullPValueError |
error of p-value for the null hypothesis (small number means disfavoured) | |
bool | fPValueIsRightTail |
double | fTestStatisticData |
result of the test statistic evaluated on data | |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
#include <RooStats/HybridResult.h>
|
explicit |
|
override |
Destructor of HybridResult.
HybridResult destructor.
Definition at line 98 of file HybridResult.cxx.
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.
|
overridevirtual |
Returns \(CL_{s+b}\) : the S+B p-value.
Reimplemented from RooStats::HypoTestResult.
Definition at line 149 of file HybridResult.cxx.
|
static |
|
inlinestaticconstexpr |
Definition at line 88 of file HybridResult.h.
double 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.
double 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.
double 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.
|
inlinestatic |
Definition at line 88 of file HybridResult.h.
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.
|
inline |
Get test statistics values for the b model.
Definition at line 56 of file HybridResult.h.
|
inline |
Get test statistics value for data.
Definition at line 59 of file HybridResult.h.
|
inline |
Get test statistics values for the sb model.
Definition at line 53 of file HybridResult.h.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 88 of file HybridResult.h.
|
overridevirtual |
Returns \(1 - CL_{b}\) : the B p-value.
Reimplemented from RooStats::HypoTestResult.
Definition at line 119 of file HybridResult.cxx.
void HybridResult::PrintMore | ( | const char * | options | ) |
Print out some information about the results.
Definition at line 284 of file HybridResult.cxx.
void HybridResult::SetDataTestStatistics | ( | double | testStat_data_val | ) |
set the value of the test statistics on data
Definition at line 108 of file HybridResult.cxx.
|
overridevirtual |
|
inline |
Definition at line 88 of file HybridResult.h.
|
mutableprivate |
Definition at line 83 of file HybridResult.h.
|
mutableprivate |
Definition at line 82 of file HybridResult.h.
|
private |
Definition at line 84 of file HybridResult.h.
|
private |
Definition at line 78 of file HybridResult.h.
|
private |
Definition at line 80 of file HybridResult.h.
|
private |
Definition at line 79 of file HybridResult.h.