Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file inheritance tree (.pdf)

Sections: class description function members data members class charts

class TRolke: public TObject


  TRolke

  This class computes confidence intervals for the rate of a Poisson
  in the presence of background and efficiency with a fully frequentist
  treatment of the uncertainties in the efficiency and background estimate
  using the profile likelihood method.

      Author: Jan Conrad (CERN) 2004
      Updated: Johan Lundberg (CERN) 2009

      Copyright CERN 2004,2009           Jan.Conrad@cern.ch,
                                     Johan.Lundberg@cern.ch

  For information about the statistical meaning of the parameters
  and the syntax, consult TRolke.cxx


  Examples are found in the file Rolke.C

Function Members (Methods)

public:

virtual	~TRolke()
void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
Double_t	CalculateInterval(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
virtual void	TObject::Copy(TObject& object) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
bool	GetBounding() const
Double_t	GetCL() const
bool	GetCriticalNumber(Int_t& ncrit, Int_t maxtry = -1)
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	TObject::GetIconName() const
bool	GetLimits(Double_t& low, Double_t& high)
bool	GetLimitsML(Double_t& low, Double_t& high, Int_t& out_x)
bool	GetLimitsQuantile(Double_t& low, Double_t& high, Int_t& out_x, Double_t integral = 0.5)
Double_t	GetLowerLimit()
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
bool	GetSensitivity(Double_t& low, Double_t& high, Double_t pPrecision = 1.0000000000000001E-5)
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
Double_t	GetUpperLimit()
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
TRolke&	operator=(const TRolke&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	Print(Option_t*) const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
void	SetBounding(const bool bnd)
void	SetCL(Double_t CL)
void	SetCLSigmas(Double_t CLsigmas)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	SetGaussBkgGaussEff(Int_t x, Double_t bm, Double_t em, Double_t sde, Double_t sdb)
void	SetGaussBkgKnownEff(Int_t x, Double_t bm, Double_t sdb, Double_t e)
void	SetKnownBkgBinomEff(Int_t x, Int_t z, Int_t m, Double_t b)
void	SetKnownBkgGaussEff(Int_t x, Double_t em, Double_t sde, Double_t b)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetPoissonBkgBinomEff(Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)
void	SetPoissonBkgGaussEff(Int_t x, Int_t y, Double_t em, Double_t tau, Double_t sde)
void	SetPoissonBkgKnownEff(Int_t x, Int_t y, Double_t tau, Double_t e)
void	SetSwitch(bool bnd)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
	TRolke(const TRolke&)
	TRolke(Double_t CL = 0.90000000000000002, Option_t* option = "")
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()

private:

Double_t	ComputeInterval(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)
Double_t	EvalLikeMod1(Double_t mu, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m, Int_t what)
Double_t	EvalLikeMod2(Double_t mu, Int_t x, Int_t y, Double_t em, Double_t sde, Double_t tau, Int_t what)
Double_t	EvalLikeMod3(Double_t mu, Int_t x, Double_t bm, Double_t em, Double_t sde, Double_t sdb, Int_t what)
Double_t	EvalLikeMod4(Double_t mu, Int_t x, Int_t y, Double_t tau, Int_t what)
Double_t	EvalLikeMod5(Double_t mu, Int_t x, Double_t bm, Double_t sdb, Int_t what)
Double_t	EvalLikeMod6(Double_t mu, Int_t x, Int_t z, Double_t b, Int_t m, Int_t what)
Double_t	EvalLikeMod7(Double_t mu, Int_t x, Double_t em, Double_t sde, Double_t b, Int_t what)
static Double_t	EvalMonomial(Double_t x, const Int_t[] coef, Int_t N)
static Double_t	EvalPolynomial(Double_t x, const Int_t[] coef, Int_t N)
Double_t	GetBackground()
Double_t	Interval(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)
Double_t	LikeGradMod1(Double_t e, Double_t mu, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)
Double_t	Likelihood(Double_t mu, Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m, Int_t what)
Double_t	LikeMod1(Double_t mu, Double_t b, Double_t e, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)
Double_t	LikeMod2(Double_t mu, Double_t b, Double_t e, Int_t x, Int_t y, Double_t em, Double_t tau, Double_t v)
Double_t	LikeMod3(Double_t mu, Double_t b, Double_t e, Int_t x, Double_t bm, Double_t em, Double_t u, Double_t v)
Double_t	LikeMod4(Double_t mu, Double_t b, Int_t x, Int_t y, Double_t tau)
Double_t	LikeMod5(Double_t mu, Double_t b, Int_t x, Double_t bm, Double_t u)
Double_t	LikeMod6(Double_t mu, Double_t b, Double_t e, Int_t x, Int_t z, Int_t m)
Double_t	LikeMod7(Double_t mu, Double_t b, Double_t e, Int_t x, Double_t em, Double_t v)
Double_t	LogFactorial(Int_t n)
void	ProfLikeMod1(Double_t mu, Double_t& b, Double_t& e, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)
void	SetModelParameters()
void	SetModelParameters(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TObject::EStatusBits	TObject::kHasUUID
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static TObject::(anonymous)	TObject::kSingleKey
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

private:

bool	fBounding	false for unbounded likelihood
Double_t	fCL	confidence level as a fraction [0.9 for 90% ]
Double_t	fLowerLimit	the calculated lower limit
Int_t	fNumWarningsDeprecated1
Int_t	fNumWarningsDeprecated2
Double_t	fUpperLimit	the calculated upper limit
Double_t	f_b
Double_t	f_bm
Double_t	f_e
Double_t	f_em
Int_t	f_m
Int_t	f_mid
Double_t	f_sdb
Double_t	f_sde
Double_t	f_tau
Int_t	f_x
Int_t	f_y
Int_t	f_z

Class Charts

Inheritance Chart:

TObject

←

TRolke

Function documentation

Double_t Interval(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)

Internal helper functions and methods
 The Calculator

Double_t Likelihood(Double_t mu, Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m, Int_t what)

 LIKELIHOOD ROUTINE

Double_t EvalLikeMod1(Double_t mu, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m, Int_t what)

MODEL 1

Double_t LikeMod1(Double_t mu, Double_t b, Double_t e, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)

void ProfLikeMod1(Double_t mu, Double_t& b, Double_t& e, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)

Double_t LikeGradMod1(Double_t e, Double_t mu, Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)

Double_t EvalLikeMod2(Double_t mu, Int_t x, Int_t y, Double_t em, Double_t sde, Double_t tau, Int_t what)

MODEL 2

Double_t LikeMod2(Double_t mu, Double_t b, Double_t e, Int_t x, Int_t y, Double_t em, Double_t tau, Double_t v)

Double_t EvalLikeMod3(Double_t mu, Int_t x, Double_t bm, Double_t em, Double_t sde, Double_t sdb, Int_t what)

MODEL 3

Double_t LikeMod3(Double_t mu, Double_t b, Double_t e, Int_t x, Double_t bm, Double_t em, Double_t u, Double_t v)

Double_t EvalLikeMod4(Double_t mu, Int_t x, Int_t y, Double_t tau, Int_t what)

MODEL 4

Double_t LikeMod4(Double_t mu, Double_t b, Int_t x, Int_t y, Double_t tau)

Double_t EvalLikeMod5(Double_t mu, Int_t x, Double_t bm, Double_t sdb, Int_t what)

MODEL 5

Double_t LikeMod5(Double_t mu, Double_t b, Int_t x, Double_t bm, Double_t u)

Double_t EvalLikeMod6(Double_t mu, Int_t x, Int_t z, Double_t b, Int_t m, Int_t what)

MODEL 6

Double_t LikeMod6(Double_t mu, Double_t b, Double_t e, Int_t x, Int_t z, Int_t m)

Double_t EvalLikeMod7(Double_t mu, Int_t x, Double_t em, Double_t sde, Double_t b, Int_t what)

MODEL 7

Double_t LikeMod7(Double_t mu, Double_t b, Double_t e, Int_t x, Double_t em, Double_t v)

Double_t EvalPolynomial(Double_t x, const Int_t[] coef, Int_t N)

MISC

Double_t EvalMonomial(Double_t x, const Int_t[] coef, Int_t N)

Double_t LogFactorial(Int_t n)

Double_t ComputeInterval(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)

void SetModelParameters(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)

void SetModelParameters()

Double_t GetBackground()

TRolke(Double_t CL = 0.90000000000000002, Option_t* option = "")

Constructor

virtual ~TRolke()

Destructor

Double_t GetCL() const

Get and set the Confidence Level

void SetCL(Double_t CL)

void SetCLSigmas(Double_t CLsigmas)

Set the Confidence Level in terms of Sigmas.

void SetPoissonBkgBinomEff(Int_t x, Int_t y, Int_t z, Double_t tau, Int_t m)

 The Set methods for the different models are described in Rolke.cxx
 model 1

void SetPoissonBkgGaussEff(Int_t x, Int_t y, Double_t em, Double_t tau, Double_t sde)

 model 2

void SetGaussBkgGaussEff(Int_t x, Double_t bm, Double_t em, Double_t sde, Double_t sdb)

 model 3

void SetPoissonBkgKnownEff(Int_t x, Int_t y, Double_t tau, Double_t e)

 model 4

void SetGaussBkgKnownEff(Int_t x, Double_t bm, Double_t sdb, Double_t e)

 model 5

void SetKnownBkgBinomEff(Int_t x, Int_t z, Int_t m, Double_t b)

 model 6

void SetKnownBkgGaussEff(Int_t x, Double_t em, Double_t sde, Double_t b)

 model 7

Double_t CalculateInterval(Int_t x, Int_t y, Int_t z, Double_t bm, Double_t em, Double_t e, Int_t mid, Double_t sde, Double_t sdb, Double_t tau, Double_t b, Int_t m)

Deprecated interface method (read Rolke.cxx). May be removed from future releases

bool GetLimits(Double_t& low, Double_t& high)

 get the upper and lower limits based on the specified model

Double_t GetUpperLimit()

Double_t GetLowerLimit()

bool GetSensitivity(Double_t& low, Double_t& high, Double_t pPrecision = 1.0000000000000001E-5)

 get the upper and lower average limits

bool GetLimitsQuantile(Double_t& low, Double_t& high, Int_t& out_x, Double_t integral = 0.5)

 get the upper and lower limits for the outcome corresponding to
 a given quantile.

bool GetLimitsML(Double_t& low, Double_t& high, Int_t& out_x)

 get the upper and lower limits for the most likely outcome.

bool GetCriticalNumber(Int_t& ncrit, Int_t maxtry = -1)

 get the value of x corresponding to rejection of the null hypothesis.

bool GetBounding() const

 Get the bounding mode flag. True activates bounded mode. Read
TRolke.cxx and the references therein for details.

void SetBounding(const bool bnd)

 Get the bounding mode flag. True activates bounded mode. Read
TRolke.cxx and the references therein for details.

void SetSwitch(bool bnd)

Deprecated name for SetBounding.

void Print(Option_t* ) const

Dump internals. Option is not used