Logo ROOT  
Reference Guide
TConfidenceLevel Class Reference

Class to compute 95% CL limits.

Definition at line 20 of file TConfidenceLevel.h.

Public Member Functions

 TConfidenceLevel ()
 Default constructor. More...
 
 TConfidenceLevel (Int_t mc, bool onesided=kTRUE)
 Constructor that fix some conventions. More...
 
virtual ~TConfidenceLevel ()
 The destructor. More...
 
Double_t CLb (bool use_sMC=kFALSE) const
 Get the Confidence Level for the background only. More...
 
Double_t CLs (bool use_sMC=kFALSE) const
 Get the Confidence Level defined by CLs = CLsb/CLb. More...
 
Double_t CLsb (bool use_sMC=kFALSE) const
 Get the Confidence Level for the signal plus background hypothesis. More...
 
void Draw (const Option_t *option="")
 Display sort of a "canonical" -2lnQ plot. More...
 
Double_t Get3sProbability () const
 Get 3s probability. More...
 
Double_t Get5sProbability () const
 Get 5s probability. More...
 
Double_t GetAverageCLs () const
 Get average CLs. More...
 
Double_t GetAverageCLsb () const
 Get average CLsb. More...
 
Double_t GetBtot () const
 
Int_t GetDtot () const
 
Double_t GetExpectedCLb_b (Int_t sigma=0) const
 Get the expected Confidence Level for the background only if there is only background. More...
 
Double_t GetExpectedCLb_sb (Int_t sigma=0) const
 Get the expected Confidence Level for the background only if there is signal and background. More...
 
Double_t GetExpectedCLs_b (Int_t sigma=0) const
 
Double_t GetExpectedCLsb_b (Int_t sigma=0) const
 Get the expected Confidence Level for the signal plus background hypothesis if there is only background. More...
 
Double_t GetExpectedStatistic_b (Int_t sigma=0) const
 Get the expected statistic value in the background only hypothesis. More...
 
Double_t GetExpectedStatistic_sb (Int_t sigma=0) const
 Get the expected statistic value in the signal plus background hypothesis. More...
 
Double_t GetStatistic () const
 
Double_t GetStot () const
 
void SetBtot (Double_t in)
 
void SetDtot (Int_t in)
 
void SetLRB (Double_t *in)
 
void SetLRS (Double_t *in)
 
void SetStot (Double_t in)
 
void SetTSB (Double_t *in)
 Set the TSB. More...
 
void SetTSD (Double_t in)
 
void SetTSS (Double_t *in)
 Set the TSS. 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 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 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...
 
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 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 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

Double_t fBtot
 
Int_t fDtot
 
Int_tfISB
 
Int_tfISS
 
Double_tfLRB
 
Double_tfLRS
 
Double_t fMCL3S
 
Double_t fMCL5S
 
Double_t fNMC
 
Int_t fNNMC
 
Double_t fStot
 
Double_tfTSB
 
Double_t fTSD
 
Double_tfTSS
 

Static Private Attributes

static const Double_t fgMCL3S1S = 2.6998E-3
 
static const Double_t fgMCL3S2S = 1.349898E-3
 
static const Double_t fgMCL5S1S = 5.7330E-7
 
static const Double_t fgMCL5S2S = 2.866516E-7
 
static const Double_t fgMCLM1S = 0.16
 
static const Double_t fgMCLM2S = 0.025
 
static const Double_t fgMCLMED = 0.5
 
static const Double_t fgMCLP1S = 0.84
 
static const Double_t fgMCLP2S = 0.975
 

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 ()
 

#include <TConfidenceLevel.h>

Inheritance diagram for TConfidenceLevel:
[legend]

Constructor & Destructor Documentation

◆ TConfidenceLevel() [1/2]

TConfidenceLevel::TConfidenceLevel ( )

Default constructor.

Definition at line 39 of file TConfidenceLevel.cxx.

◆ TConfidenceLevel() [2/2]

TConfidenceLevel::TConfidenceLevel ( Int_t  mc,
bool  onesided = kTRUE 
)

Constructor that fix some conventions.

Parameters
mcis the number of Monte Carlo experiments
onesidedspecifies if the intervals are one-sided or not.

Definition at line 63 of file TConfidenceLevel.cxx.

◆ ~TConfidenceLevel()

TConfidenceLevel::~TConfidenceLevel ( )
virtual

The destructor.

Definition at line 85 of file TConfidenceLevel.cxx.

Member Function Documentation

◆ CLb()

Double_t TConfidenceLevel::CLb ( bool  use_sMC = kFALSE) const

Get the Confidence Level for the background only.

Definition at line 149 of file TConfidenceLevel.cxx.

◆ CLs()

Double_t TConfidenceLevel::CLs ( bool  use_sMC = kFALSE) const

Get the Confidence Level defined by CLs = CLsb/CLb.

This quantity is stable w.r.t. background fluctuations.

Definition at line 188 of file TConfidenceLevel.cxx.

◆ CLsb()

Double_t TConfidenceLevel::CLsb ( bool  use_sMC = kFALSE) const

Get the Confidence Level for the signal plus background hypothesis.

Definition at line 168 of file TConfidenceLevel.cxx.

◆ Draw()

void TConfidenceLevel::Draw ( const Option_t option = "")

Display sort of a "canonical" -2lnQ plot.

This results in a plot with 2 elements:

  • The histogram of -2lnQ for background hypothesis (full)
  • The histogram of -2lnQ for signal and background hypothesis (dashed)

The 2 histograms are respectively named b_hist and sb_hist.

Definition at line 414 of file TConfidenceLevel.cxx.

◆ Get3sProbability()

Double_t TConfidenceLevel::Get3sProbability ( ) const

Get 3s probability.

Definition at line 376 of file TConfidenceLevel.cxx.

◆ Get5sProbability()

Double_t TConfidenceLevel::Get5sProbability ( ) const

Get 5s probability.

Definition at line 392 of file TConfidenceLevel.cxx.

◆ GetAverageCLs()

Double_t TConfidenceLevel::GetAverageCLs ( ) const

Get average CLs.

Definition at line 361 of file TConfidenceLevel.cxx.

◆ GetAverageCLsb()

Double_t TConfidenceLevel::GetAverageCLsb ( ) const

Get average CLsb.

Definition at line 346 of file TConfidenceLevel.cxx.

◆ GetBtot()

Double_t TConfidenceLevel::GetBtot ( ) const
inline

Definition at line 50 of file TConfidenceLevel.h.

◆ GetDtot()

Int_t TConfidenceLevel::GetDtot ( ) const
inline

Definition at line 48 of file TConfidenceLevel.h.

◆ GetExpectedCLb_b()

Double_t TConfidenceLevel::GetExpectedCLb_b ( Int_t  sigma = 0) const

Get the expected Confidence Level for the background only if there is only background.

Definition at line 299 of file TConfidenceLevel.cxx.

◆ GetExpectedCLb_sb()

Double_t TConfidenceLevel::GetExpectedCLb_sb ( Int_t  sigma = 0) const

Get the expected Confidence Level for the background only if there is signal and background.

Definition at line 250 of file TConfidenceLevel.cxx.

◆ GetExpectedCLs_b()

Double_t TConfidenceLevel::GetExpectedCLs_b ( Int_t  sigma = 0) const
inline

Definition at line 43 of file TConfidenceLevel.h.

◆ GetExpectedCLsb_b()

Double_t TConfidenceLevel::GetExpectedCLsb_b ( Int_t  sigma = 0) const

Get the expected Confidence Level for the signal plus background hypothesis if there is only background.

Definition at line 201 of file TConfidenceLevel.cxx.

◆ GetExpectedStatistic_b()

Double_t TConfidenceLevel::GetExpectedStatistic_b ( Int_t  sigma = 0) const

Get the expected statistic value in the background only hypothesis.

Definition at line 105 of file TConfidenceLevel.cxx.

◆ GetExpectedStatistic_sb()

Double_t TConfidenceLevel::GetExpectedStatistic_sb ( Int_t  sigma = 0) const

Get the expected statistic value in the signal plus background hypothesis.

Definition at line 127 of file TConfidenceLevel.cxx.

◆ GetStatistic()

Double_t TConfidenceLevel::GetStatistic ( ) const
inline

Definition at line 33 of file TConfidenceLevel.h.

◆ GetStot()

Double_t TConfidenceLevel::GetStot ( ) const
inline

Definition at line 49 of file TConfidenceLevel.h.

◆ SetBtot()

void TConfidenceLevel::SetBtot ( Double_t  in)
inline

Definition at line 30 of file TConfidenceLevel.h.

◆ SetDtot()

void TConfidenceLevel::SetDtot ( Int_t  in)
inline

Definition at line 32 of file TConfidenceLevel.h.

◆ SetLRB()

void TConfidenceLevel::SetLRB ( Double_t in)
inline

Definition at line 29 of file TConfidenceLevel.h.

◆ SetLRS()

void TConfidenceLevel::SetLRS ( Double_t in)
inline

Definition at line 28 of file TConfidenceLevel.h.

◆ SetStot()

void TConfidenceLevel::SetStot ( Double_t  in)
inline

Definition at line 31 of file TConfidenceLevel.h.

◆ SetTSB()

void TConfidenceLevel::SetTSB ( Double_t in)

Set the TSB.

Definition at line 437 of file TConfidenceLevel.cxx.

◆ SetTSD()

void TConfidenceLevel::SetTSD ( Double_t  in)
inline

Definition at line 25 of file TConfidenceLevel.h.

◆ SetTSS()

void TConfidenceLevel::SetTSS ( Double_t in)

Set the TSS.

Definition at line 447 of file TConfidenceLevel.cxx.

Member Data Documentation

◆ fBtot

Double_t TConfidenceLevel::fBtot
private

Definition at line 56 of file TConfidenceLevel.h.

◆ fDtot

Int_t TConfidenceLevel::fDtot
private

Definition at line 54 of file TConfidenceLevel.h.

◆ fgMCL3S1S

Double_t const TConfidenceLevel::fgMCL3S1S = 2.6998E-3
staticprivate

Definition at line 73 of file TConfidenceLevel.h.

◆ fgMCL3S2S

Double_t const TConfidenceLevel::fgMCL3S2S = 1.349898E-3
staticprivate

Definition at line 75 of file TConfidenceLevel.h.

◆ fgMCL5S1S

Double_t const TConfidenceLevel::fgMCL5S1S = 5.7330E-7
staticprivate

Definition at line 74 of file TConfidenceLevel.h.

◆ fgMCL5S2S

Double_t const TConfidenceLevel::fgMCL5S2S = 2.866516E-7
staticprivate

Definition at line 76 of file TConfidenceLevel.h.

◆ fgMCLM1S

Double_t const TConfidenceLevel::fgMCLM1S = 0.16
staticprivate

Definition at line 69 of file TConfidenceLevel.h.

◆ fgMCLM2S

Double_t const TConfidenceLevel::fgMCLM2S = 0.025
staticprivate

Definition at line 68 of file TConfidenceLevel.h.

◆ fgMCLMED

Double_t const TConfidenceLevel::fgMCLMED = 0.5
staticprivate

Definition at line 70 of file TConfidenceLevel.h.

◆ fgMCLP1S

Double_t const TConfidenceLevel::fgMCLP1S = 0.84
staticprivate

Definition at line 71 of file TConfidenceLevel.h.

◆ fgMCLP2S

Double_t const TConfidenceLevel::fgMCLP2S = 0.975
staticprivate

Definition at line 72 of file TConfidenceLevel.h.

◆ fISB

Int_t* TConfidenceLevel::fISB
private

Definition at line 66 of file TConfidenceLevel.h.

◆ fISS

Int_t* TConfidenceLevel::fISS
private

Definition at line 65 of file TConfidenceLevel.h.

◆ fLRB

Double_t* TConfidenceLevel::fLRB
private

Definition at line 64 of file TConfidenceLevel.h.

◆ fLRS

Double_t* TConfidenceLevel::fLRS
private

Definition at line 63 of file TConfidenceLevel.h.

◆ fMCL3S

Double_t TConfidenceLevel::fMCL3S
private

Definition at line 59 of file TConfidenceLevel.h.

◆ fMCL5S

Double_t TConfidenceLevel::fMCL5S
private

Definition at line 60 of file TConfidenceLevel.h.

◆ fNMC

Double_t TConfidenceLevel::fNMC
private

Definition at line 58 of file TConfidenceLevel.h.

◆ fNNMC

Int_t TConfidenceLevel::fNNMC
private

Definition at line 53 of file TConfidenceLevel.h.

◆ fStot

Double_t TConfidenceLevel::fStot
private

Definition at line 55 of file TConfidenceLevel.h.

◆ fTSB

Double_t* TConfidenceLevel::fTSB
private

Definition at line 61 of file TConfidenceLevel.h.

◆ fTSD

Double_t TConfidenceLevel::fTSD
private

Definition at line 57 of file TConfidenceLevel.h.

◆ fTSS

Double_t* TConfidenceLevel::fTSS
private

Definition at line 62 of file TConfidenceLevel.h.

Libraries for TConfidenceLevel:
[legend]

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