Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file viewVC header viewVC source

Sections: class description function members data members class charts

ROOT » ROOFIT » ROOSTATS » RooStats::HybridCalculator

class RooStats::HybridCalculator: public RooStats::HypoTestCalculator, public TNamed


HybridCalculator class: this class is a fresh rewrite in RooStats of
	RooStatsCms/LimitCalculator developped by D. Piparo and G. Schott
Authors: D. Piparo, G. Schott - Universitaet Karlsruhe

The class is born from the need to have an implementation of the CLs
method that could take advantage from the RooFit Package.
The basic idea is the following:
- Instantiate an object specifying a signal+background model, a background model and a dataset.
- Perform toy MC experiments to know the distributions of -2lnQ
- Calculate the CLsb and CLs values as "integrals" of these distributions.

The class allows the user to input models as RooAbsPdf or TH1 object
pointers (the pdfs must be "extended": for more information please refer to
http://roofit.sourceforge.net). The dataset can be entered as a
RooAbsData or TH1 object pointer.

Unlike the TLimit Class a complete MC generation is performed at each step
and not a simple Poisson fluctuation of the contents of the bins.
Another innovation is the treatment of the nuisance parameters. The user
can input in the constructor nuisance parameters.
To include the information that we have about the nuisance parameters a prior
PDF (RooAbsPdf) should be specified

The result of the calculations is returned as a HybridResult object pointer.

see also the following interesting references:
- Alex Read, "Presentation of search results: the CLs technique" Journal of Physics G: Nucl. // Part. Phys. 28 2693-2704 (2002). http://www.iop.org/EJ/abstract/0954-3899/28/10/313/

- Alex Read, "Modified Frequentist Analysis of Search Results (The CLs Method)" CERN 2000-005 (30 May 2000)

- V. Bartsch, G.Quast, "Expected signal observability at future experiments" CMS NOTE 2005/004

- http://root.cern.ch/root/html/src/TLimit.html

Function Members (Methods)

public:

virtual	~HybridCalculator()
void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
RooStats::HybridResult*	Calculate(unsigned int nToys, bool usePriors) const
RooStats::HybridResult*	Calculate(TH1& data, unsigned int nToys, bool usePriors) const
RooStats::HybridResult*	Calculate(RooAbsData& data, unsigned int nToys, bool usePriors) const
static TClass*	Class()
static TClass*	TNamed::Class()
static TClass*	TObject::Class()
static TClass*	RooStats::HypoTestCalculator::Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
virtual void	TObject::Clear(Option_t* = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual Int_t	TObject::Compare(const TObject* obj) const
virtual void	TNamed::Copy(TObject& named) 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 void	TNamed::FillBuffer(char*& buffer)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual RooStats::HybridResult*	GetHypoTest() const
virtual RooStats::HypoTestResult*	RooStats::HypoTestCalculator::GetHypoTest() const
virtual const char*	TObject::GetIconName() const
virtual const char*	TNamed::GetName() const
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
virtual const char*	TNamed::GetTitle() const
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TNamed::Hash() const
virtual ULong_t	TObject::Hash() const
RooStats::HybridCalculator	HybridCalculator(const RooStats::HybridCalculator&)
RooStats::HybridCalculator	HybridCalculator(const char* name = 0, const char* title = 0)
RooStats::HybridCalculator	HybridCalculator(RooAbsData& data, RooAbsPdf& sb_model, RooAbsPdf& b_model, RooArgSet* nuisance_parameters = 0, RooAbsPdf* prior_pdf = 0)
RooStats::HybridCalculator	HybridCalculator(const char* name, const char* title, RooAbsPdf& sb_model, RooAbsPdf& b_model, RooArgList& observables, RooArgSet* nuisance_parameters = 0, RooAbsPdf* prior_pdf = 0)
RooStats::HybridCalculator	HybridCalculator(const char* name, const char* title, RooAbsData& data, RooAbsPdf& sb_model, RooAbsPdf& b_model, RooArgSet* nuisance_parameters = 0, RooAbsPdf* prior_pdf = 0)
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	RooStats::HypoTestCalculator::Initialize(RooAbsData& data, RooAbsPdf& commonPdf, RooArgSet& nullParameters, RooArgSet& alternateParameters, RooArgSet* nuisanceParameters = 0, RooAbsPdf* nuisancePdf = 0)
virtual void	RooStats::HypoTestCalculator::Initialize(RooAbsData& data, RooAbsPdf& nullPdf, RooAbsPdf& alternatePdf, RooArgSet* nullParameters = 0, RooArgSet* alternateParameters = 0, RooArgSet* nuisanceParameters = 0, RooAbsPdf* nuisancePdf = 0)
virtual void	RooStats::HypoTestCalculator::Initialize(RooWorkspace& ws, const char* data, const char* commonPdf, RooArgSet& nullParameters, RooArgSet& alternateParameters, RooArgSet* nuisanceParameters = 0, const char* nuisancePdf = 0)
virtual void	RooStats::HypoTestCalculator::Initialize(RooWorkspace& ws, const char* data, const char* nullPdf, const char* alternatePdf, RooArgSet* nullParameters = 0, RooArgSet* alternateParameters = 0, RooArgSet* nuisanceParameters = 0, const char* nuisancePdf = 0)
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual TClass*	TNamed::IsA() const
virtual TClass*	TObject::IsA() const
virtual TClass*	RooStats::HypoTestCalculator::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	TNamed::IsSortable() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TNamed::ls(Option_t* option = "") const
virtual void	TObject::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static 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)
RooStats::HybridCalculator&	operator=(const RooStats::HybridCalculator&)
TNamed&	TNamed::operator=(const TNamed& rhs)
TObject&	TObject::operator=(const TObject& rhs)
RooStats::HypoTestCalculator&	RooStats::HypoTestCalculator::operator=(const RooStats::HypoTestCalculator&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TNamed::Print(Option_t* option = "") const
virtual void	TObject::Print(Option_t* option = "") const
void	PrintMore(const char* options) 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(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
virtual void	SetAlternateParameters(RooArgSet&)
virtual void	RooStats::HypoTestCalculator::SetAlternateParameters(RooArgSet&)
virtual void	SetAlternatePdf(RooAbsPdf& pdf)
virtual void	RooStats::HypoTestCalculator::SetAlternatePdf(const char* name)
virtual void	RooStats::HypoTestCalculator::SetAlternatePdf(RooAbsPdf& pdf)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	SetCommonPdf(RooAbsPdf& pdf)
virtual void	RooStats::HypoTestCalculator::SetCommonPdf(const char* name)
virtual void	RooStats::HypoTestCalculator::SetCommonPdf(RooAbsPdf& pdf)
virtual void	SetData(const char* name)
virtual void	SetData(RooAbsData& data)
virtual void	RooStats::HypoTestCalculator::SetData(const char* name)
virtual void	RooStats::HypoTestCalculator::SetData(RooAbsData& data)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
virtual void	SetNuisanceParameters(RooArgSet& params)
virtual void	RooStats::HypoTestCalculator::SetNuisanceParameters(RooArgSet&)
virtual void	SetNuisancePdf(RooAbsPdf& prior_pdf)
virtual void	SetNuisancePdf(const char* name)
virtual void	RooStats::HypoTestCalculator::SetNuisancePdf(const char*)
virtual void	RooStats::HypoTestCalculator::SetNuisancePdf(RooAbsPdf&)
virtual void	SetNullParameters(RooArgSet&)
virtual void	RooStats::HypoTestCalculator::SetNullParameters(RooArgSet&)
virtual void	SetNullPdf(RooAbsPdf& pdf)
void	SetNumberOfToys(unsigned int ntoys)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetTestStatistics(int index)
virtual void	TNamed::SetTitle(const char* title = "")MENU
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	RooStats::HypoTestCalculator::SetWorkspace(RooWorkspace& ws)
virtual void	ShowMembers(TMemberInspector& insp, char* parent)
virtual void	TNamed::ShowMembers(TMemberInspector& insp, char* parent)
virtual void	RooStats::HypoTestCalculator::ShowMembers(TMemberInspector& insp, char* parent)
virtual Int_t	TNamed::Sizeof() const
virtual void	Streamer(TBuffer& b)
virtual void	TNamed::Streamer(TBuffer& b)
virtual void	TObject::Streamer(TBuffer& b)
virtual void	RooStats::HypoTestCalculator::Streamer(TBuffer& b)
void	StreamerNVirtual(TBuffer& b)
void	TNamed::StreamerNVirtual(TBuffer& b)
void	TObject::StreamerNVirtual(TBuffer& b)
void	RooStats::HypoTestCalculator::StreamerNVirtual(TBuffer& 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
virtual void	TObject::UseCurrentStyle()
void	UseNuisance(bool on = true)
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:

bool	DoCheckInputs() const
bool	DoInitializeFromWS()
RooStats::HybridCalculator	HybridCalculator(RooWorkspace& wks, const char* data, const char* sb_model, const char* b_model, RooArgSet* nuisance_parameters, const char* prior_pdf)
RooStats::HybridCalculator	HybridCalculator(const char* name, const char* title, RooWorkspace& wks, const char* data, const char* sb_model, const char* b_model, RooArgSet* nuisance_parameters, const char* prior_pdf)
void	RunToys(vector<double>& bVals, vector<double>& sbVals, unsigned int nToys, bool usePriors) const
virtual void	SetAlternatePdf(const char* name)
virtual void	SetCommonPdf(const char* name)
virtual void	SetNullPdf(const char* name)
virtual void	SetWorkspace(RooWorkspace& ws)

Data Members

private:

enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

protected:

TString	TNamed::fName	object identifier
TString	TNamed::fTitle	object title

private:

RooAbsPdf*	fBModel	The pdf of the background model
TString	fBModelName	name of pdf of the background model
RooAbsData*	fData	pointer to the data sets
TString	fDataName	name of the dataset in the workspace
unsigned int	fNToys	number of Toys MC
RooArgList*	fObservables	Collection of the observables of the model
RooArgSet*	fParameters	Collection of the nuisance parameters in the model
RooAbsPdf*	fPriorPdf	Prior PDF of the nuisance parameters
TString	fPriorPdfName	name of pdf of the background model
RooAbsPdf*	fSbModel	The pdf of the signal+background model
TString	fSbModelName	name of pdf of the signal+background model
unsigned int	fTestStatisticsIdx	Index of the test statistics to use
bool	fUsePriorPdf	use a prior for nuisance parameters
RooWorkspace*	fWS	a workspace that owns all the components to be used by the calculator

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

HybridCalculator(const char* name = 0, const char* title = 0)

 constructor with name and title
 set default parameters

HybridCalculator( const char *name, const char *title, RooAbsPdf& sbModel, RooAbsPdf& bModel, RooArgList& observables, RooArgSet* nuisance_parameters, RooAbsPdf* priorPdf )

 specific HybridCalculator constructor:
 the user need to specify the models in the S+B case and B-only case,
 the list of observables of the model(s) (for MC-generation), the list of parameters
 that are marginalised and the prior distribution of those parameters

HybridCalculator(RooAbsData& data, RooAbsPdf& sb_model, RooAbsPdf& b_model, RooArgSet* nuisance_parameters = 0, RooAbsPdf* prior_pdf = 0)

 HybridCalculator constructor for performing hypotesis test
 the user need to specify the data set, the models in the S+B case and B-only case.
 In case of treatment of nuisance parameter, the user need to specify the
 the list of parameters  that are marginalised and the prior distribution of those parameters

HybridCalculator( const char *name, const char *title, RooAbsData & data, RooAbsPdf& sbModel, RooAbsPdf& bModel, RooArgSet* nuisance_parameters, RooAbsPdf* priorPdf )

 HybridCalculator constructor for performing hypotesis test
 the user need to specify the data set, the models in the S+B case and B-only case.
 In case of treatment of nuisance parameter, the user need to specify the
 the list of parameters  that are marginalised and the prior distribution of those parameters

HybridCalculator(RooWorkspace& wks, const char* data, const char* sb_model, const char* b_model, RooArgSet* nuisance_parameters, const char* prior_pdf)

 HybridCalculator constructor for performing hypotesis test from a Workspace
 the user need to specify the data set, the models in the S+B case and B-only case.
 In case of treatment of nuisance parameter, the user need to specify the
 the list of parameters  that are marginalised and the prior distribution of those parameters

HybridCalculator(const char* name, const char* title, RooWorkspace& wks, const char* data, const char* sb_model, const char* b_model, RooArgSet* nuisance_parameters, const char* prior_pdf)

 HybridCalculator constructor for performing hypotesis test from a Workspace
 the user need to specify the data set, the models in the S+B case and B-only case.
 In case of treatment of nuisance parameter, the user need to specify the
 the list of parameters  that are marginalised and the prior distribution of those parameters

~HybridCalculator()

 HybridCalculator destructor
if( fOwnsWorkspace && fWS) delete fWS;

void SetTestStatistics(int index)

 set the desired test statistics:
 index=1 : 2 * log( L_sb / L_b )  (DEFAULT)
 index=2 : number of generated events
 index=3 : profiled likelihood ratio
 if the index is different to any of those values, the default is used

HybridResult* Calculate(TH1& data, unsigned int nToys, bool usePriors)

 first compute the test statistics for data and then prepare and run the toy-MC experiments

HybridResult* Calculate(RooAbsData& data, unsigned int nToys, bool usePriors)

 first compute the test statistics for data and then prepare and run the toy-MC experiments

HybridResult* Calculate(unsigned int nToys, bool usePriors) const

void RunToys(vector<double>& bVals, vector<double>& sbVals, unsigned int nToys, bool usePriors) const

 do the actual run-MC processing

void PrintMore(const char* options) const

 Print out some information about the input models

HybridResult* GetHypoTest() const

 perform the hypothesis test and return result of hypothesis test

bool DoInitializeFromWS()

bool DoCheckInputs() const

void SetWorkspace(RooWorkspace& ws)

 set an external workspace containing data and pdf's
 if a workspace already esists merge with existing one
 one needs to set later pdf names and data names

HybridCalculator(const char* name = 0, const char* title = 0)

 Constructor with only name and title

void SetNullPdf(const char* name)

 set the PDF for the null hypothesis (only B)

{ fBModelName = name; }

void SetAlternatePdf(const char* name )

 set a common PDF for both the null and alternate hypotheses

{ fSbModelName = name;}

void SetCommonPdf(const char* name)

{fSbModelName = name; }

void SetCommonPdf(RooAbsPdf & pdf)

 Set a common PDF for both the null and alternate

{ fSbModel = &pdf; }

void SetNullPdf(RooAbsPdf& pdf)

 Set the PDF for the alternate hypothesis ( i.e. S+B)

{ fBModel = &pdf; }

void SetAlternatePdf(RooAbsPdf& pdf)

{ fSbModel = &pdf; }

void SetData(const char* name)

 specify the name of the dataset in the workspace to be used

{ fDataName = name; }

void SetData(RooAbsData& data)

{ fData = &data; }

void SetNullParameters(RooArgSet& )

 set parameter values for the null if using a common PDF

{ }

void SetAlternateParameters(RooArgSet& )

{}

void SetNuisancePdf(RooAbsPdf & prior_pdf)

 additional methods specific for HybridCalculator
 set a  prior pdf for the nuisance parameters

void SetNuisancePdf(const char * name)

 set name of a  prior pdf for the nuisance parameters in the previously given workspace

void SetNuisanceParameters(RooArgSet& params)

 set the nuisance parameters to be marginalized

{ fParameters = &params; }

void SetNumberOfToys(unsigned int ntoys)

 set number of toy MC

{ fNToys = ntoys; }

void UseNuisance(bool on = true)

 control use of the pdf for the nuisance parameter and marginalize them

{ fUsePriorPdf = on; }