HypoTestResult is a base class for results from hypothesis tests.
Any tool inheriting from HypoTestCalculator can return a HypoTestResult. As such, it stores a p-value for the null-hypothesis (eg. background-only) and an alternate hypothesis (eg. signal+background). The p-values can also be transformed into confidence levels ( \(CL_{b}\), \(CL_{s+b}\)) in a trivial way. The ratio of the \(CL_{s+b}\) to \(CL_{b}\) is often called \(CL_{s}\), and is considered useful, though it is not a probability. Finally, the p-value of the null can be transformed into a number of equivalent Gaussian sigma using the Significance method.
The p-value of the null for a given test statistic is rigorously defined and this is the starting point for the following conventions.
Conventions used in this class
The p-value for the null and alternate are on the same side of the observed value of the test statistic. This is the more standard convention and avoids confusion when doing inverted tests.
For exclusion, we also want the formula \(CL_{s} = CL_{s+b} / CL_{b}\) to hold which therefore defines our conventions for \(CL_{s+b}\) and \(CL_{b}\). \(CL_{s}\) was specifically invented for exclusion and therefore all quantities need be related through the assignments as they are for exclusion: \(CL_{s+b} = p_{s+b}\); \(CL_{b} = p_{b}\). This is derived by considering the scenarios of a powerful and not powerful inverted test, where for the not so powerful test, \(CL_{s}\) must be close to one.
For results of Hypothesis tests, \(CL_{s}\) has no similar direct interpretation as for exclusion and can be larger than one.
Definition at line 22 of file HypoTestResult.h.
|
| | 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 double | AlternatePValue () const |
| | Return p-value for alternate hypothesis.
|
| |
| 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.
|
| |
| TObject * | Clone (const char *newname=nullptr) const override |
| | clone method, required since some data members cannot rely on the streamers to copy them
|
| |
| 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 |
| |
| virtual double | NullPValue () const |
| | Return p-value for null hypothesis.
|
| |
| 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) |
| |
| | 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) |
| |
| | 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.
|
| |
Public Member Functions inherited from TNamed
