HybridCalculatorOriginal class.

This class is deprecated and it is replaced by the HybridCalculator.

This is a fresh rewrite in RooStats of RooStatsCms/LimitCalculator developed by D. Piparo and 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 ( TH1 object could be used by using the RooHistPdf class)

The pdfs must be "extended": for more information please refer to http://roofit.sourceforge.net). The dataset can be entered as a RooAbsData objects.

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

Different test statistic can be used (likelihood ratio, number of events or profile likelihood ratio. The default is the likelihood ratio. See the method SetTestStatistic.

The number of toys to be generated is controlled by SetNumberOfToys(n).

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). see 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
TLimit

Definition at line 34 of file HybridCalculatorOriginal.h.

Public Member Functions
	HybridCalculatorOriginal (const char *name=0)
	Dummy Constructor with only name.

	HybridCalculatorOriginal (RooAbsData &data, const ModelConfig &sb_model, const ModelConfig &b_model, bool GenerateBinned=false, int testStatistics=1, int ntoys=1000)
	Constructor passing a ModelConfig for the SBmodel and a ModelConfig for the B Model.

	HybridCalculatorOriginal (RooAbsData &data, RooAbsPdf &sb_model, RooAbsPdf &b_model, const RooArgSet nuisance_parameters=0, RooAbsPdf prior_pdf=0, bool GenerateBinned=false, int testStatistics=1, int ntoys=1000)
	Constructor for HybridCalculator using a data set and pdf instances.

	HybridCalculatorOriginal (RooAbsPdf &sb_model, RooAbsPdf &b_model, RooArgList &observables, const RooArgSet nuisance_parameters=0, RooAbsPdf prior_pdf=0, bool GenerateBinned=false, int testStatistics=1, int ntoys=1000)
	Constructor for HybridCalculator from pdf instances but without a data-set.

virtual	~HybridCalculatorOriginal ()
	Destructor of HybridCalculator.

HybridResult *	Calculate (RooAbsData &data, unsigned int nToys, bool usePriors) const
	first compute the test statistics for data and then prepare and run the toy-MC experiments

HybridResult *	Calculate (TH1 &data, unsigned int nToys, bool usePriors) const
	first compute the test statistics for data and then prepare and run the toy-MC experiments

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

virtual HybridResult *	GetHypoTest () const
	inherited methods from HypoTestCalculator interface

unsigned int	GetNumberOfToys () const

void	PatchSetExtended (bool on=true)

void	PrintMore (const char *options) const
	Print out some information about the input models.

virtual void	SetAlternateModel (const ModelConfig &)
	Set the model describing the alternate hypothesis.

virtual void	SetAlternateParameters (const RooArgSet &)

virtual void	SetAlternatePdf (RooAbsPdf &pdf)

virtual void	SetCommonPdf (RooAbsPdf &pdf)

virtual void	SetData (RooAbsData &data)

void	SetGenerateBinned (bool on=true)

void	SetNuisanceParameters (const RooArgSet &params)

void	SetNuisancePdf (RooAbsPdf &prior_pdf)

virtual void	SetNullModel (const ModelConfig &)
	Set the model describing the null hypothesis.

virtual void	SetNullParameters (const RooArgSet &)

virtual void	SetNullPdf (RooAbsPdf &pdf)

void	SetNumberOfToys (unsigned int ntoys)

void	SetTestStatistic (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

void	UseNuisance (bool on=true)

Public Member Functions inherited from RooStats::HypoTestCalculator
virtual	~HypoTestCalculator ()

virtual void	SetCommonModel (const ModelConfig &model)

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.

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects.

virtual void	Copy (TObject &named) const
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

virtual const char *	GetName () const
	Returns name of object.

virtual const char *	GetTitle () const
	Returns title of object.

virtual ULong_t	Hash () const
	Return hash value for this object.

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

virtual void	Print (Option_t *option="") const
	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.

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 for instance with: `gROOT->SetSelectedPad(gPad)`.

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=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	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)

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.

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)
	Operator delete [].

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.

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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Private Member Functions
bool	DoCheckInputs () const

void	RunToys (std::vector< double > &bVals, std::vector< double > &sbVals, unsigned int nToys, bool usePriors) const
	do the actual run-MC processing

Private Attributes
RooAbsPdf *	fBModel

RooAbsData *	fData

bool	fGenerateBinned

unsigned int	fNToys

const RooArgSet *	fNuisanceParameters

RooArgList *	fObservables

RooAbsPdf *	fPriorPdf

RooAbsPdf *	fSbModel

unsigned int	fTestStatisticsIdx

bool	fTmpDoExtended

bool	fUsePriorPdf

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.

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.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(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 TNamed
TString	fName

TString	fTitle

#include <RooStats/HybridCalculatorOriginal.h>

Inheritance diagram for RooStats::HybridCalculatorOriginal:

[legend]

Constructor & Destructor Documentation

◆ HybridCalculatorOriginal() [1/4]

HybridCalculatorOriginal::HybridCalculatorOriginal ( const char * name = 0 )

explicit

Dummy Constructor with only name.

constructor with name and title

Definition at line 93 of file HybridCalculatorOriginal.cxx.

◆ HybridCalculatorOriginal() [2/4]

HybridCalculatorOriginal::HybridCalculatorOriginal	(	RooAbsPdf &	sb_model,
		RooAbsPdf &	b_model,
		RooArgList &	observables,
		const RooArgSet *	nuisance_parameters = `0`,
		RooAbsPdf *	prior_pdf = `0`,
		bool	GenerateBinned = `false`,
		int	testStatistics = `1`,
		int	ntoys = `1000`
	)

Constructor for HybridCalculator from pdf instances but without a data-set.

HybridCalculatorOriginal constructor without specifying a data set 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.

Definition at line 115 of file HybridCalculatorOriginal.cxx.

◆ HybridCalculatorOriginal() [3/4]

HybridCalculatorOriginal::HybridCalculatorOriginal	(	RooAbsData &	data,
		RooAbsPdf &	sbModel,
		RooAbsPdf &	bModel,
		const RooArgSet *	nuisance_parameters = `0`,
		RooAbsPdf *	priorPdf = `0`,
		bool	GenerateBinned = `false`,
		int	testStatistics = `1`,
		int	numToys = `1000`
	)

Constructor for HybridCalculator using a data set and pdf instances.

HybridCalculatorOriginal 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

Definition at line 156 of file HybridCalculatorOriginal.cxx.

◆ HybridCalculatorOriginal() [4/4]

HybridCalculatorOriginal::HybridCalculatorOriginal	(	RooAbsData &	data,
		const ModelConfig &	sbModel,
		const ModelConfig &	bModel,
		bool	GenerateBinned = `false`,
		int	testStatistics = `1`,
		int	numToys = `1000`
	)

Constructor passing a ModelConfig for the SBmodel and a ModelConfig for the B Model.

Constructor with a ModelConfig object representing the signal + background model and another model config representig the background only model a Prior pdf for the nuiscane parameter of the signal and background can be specified in the s+b model or the b model.

If it is specified in the s+b model, the one of the s+b model will be used

Definition at line 188 of file HybridCalculatorOriginal.cxx.

◆ ~HybridCalculatorOriginal()

HybridCalculatorOriginal::~HybridCalculatorOriginal ( )

virtual

Destructor of HybridCalculator.

HybridCalculatorOriginal destructor.

Definition at line 214 of file HybridCalculatorOriginal.cxx.

Member Function Documentation

◆ Calculate() [1/3]

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

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

Definition at line 270 of file HybridCalculatorOriginal.cxx.

◆ Calculate() [2/3]

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

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

Definition at line 255 of file HybridCalculatorOriginal.cxx.

◆ Calculate() [3/3]

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

Definition at line 324 of file HybridCalculatorOriginal.cxx.

◆ DoCheckInputs()

bool HybridCalculatorOriginal::DoCheckInputs ( ) const

private

Definition at line 596 of file HybridCalculatorOriginal.cxx.

◆ GetHypoTest()

HybridResult * HybridCalculatorOriginal::GetHypoTest ( ) const

virtual

inherited methods from HypoTestCalculator interface

implementation of inherited methods from HypoTestCalculator

Implements RooStats::HypoTestCalculator.

Definition at line 581 of file HybridCalculatorOriginal.cxx.

◆ GetNumberOfToys()

unsigned int RooStats::HybridCalculatorOriginal::GetNumberOfToys ( ) const

inline

Definition at line 112 of file HybridCalculatorOriginal.h.

◆ PatchSetExtended()

void RooStats::HybridCalculatorOriginal::PatchSetExtended ( bool on = true )

inline

Definition at line 132 of file HybridCalculatorOriginal.h.

◆ PrintMore()

void HybridCalculatorOriginal::PrintMore ( const char * options ) const

Print out some information about the input models.

Definition at line 547 of file HybridCalculatorOriginal.cxx.

◆ RunToys()

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

private

do the actual run-MC processing

Definition at line 349 of file HybridCalculatorOriginal.cxx.

◆ SetAlternateModel()

void HybridCalculatorOriginal::SetAlternateModel ( const ModelConfig & model )

virtual

Set the model describing the alternate hypothesis.

Implements RooStats::HypoTestCalculator.

Definition at line 233 of file HybridCalculatorOriginal.cxx.

◆ SetAlternateParameters()

virtual void RooStats::HybridCalculatorOriginal::SetAlternateParameters ( const RooArgSet & )

inlinevirtual

Definition at line 96 of file HybridCalculatorOriginal.h.

◆ SetAlternatePdf()

virtual void RooStats::HybridCalculatorOriginal::SetAlternatePdf ( RooAbsPdf & pdf )

inlinevirtual

Definition at line 88 of file HybridCalculatorOriginal.h.

◆ SetCommonPdf()

virtual void RooStats::HybridCalculatorOriginal::SetCommonPdf ( RooAbsPdf & pdf )

inlinevirtual

Definition at line 84 of file HybridCalculatorOriginal.h.

◆ SetData()

virtual void RooStats::HybridCalculatorOriginal::SetData ( RooAbsData & data )

inlinevirtual

Implements RooStats::HypoTestCalculator.

Definition at line 91 of file HybridCalculatorOriginal.h.

◆ SetGenerateBinned()

void RooStats::HybridCalculatorOriginal::SetGenerateBinned ( bool on = true )

inline

Definition at line 118 of file HybridCalculatorOriginal.h.

◆ SetNuisanceParameters()

void RooStats::HybridCalculatorOriginal::SetNuisanceParameters ( const RooArgSet & params )

inline

Definition at line 106 of file HybridCalculatorOriginal.h.

◆ SetNuisancePdf()

void RooStats::HybridCalculatorOriginal::SetNuisancePdf ( RooAbsPdf & prior_pdf )

inline

Definition at line 100 of file HybridCalculatorOriginal.h.

◆ SetNullModel()

void HybridCalculatorOriginal::SetNullModel ( const ModelConfig & model )

virtual

Set the model describing the null hypothesis.

Implements RooStats::HypoTestCalculator.

Definition at line 222 of file HybridCalculatorOriginal.cxx.

◆ SetNullParameters()

virtual void RooStats::HybridCalculatorOriginal::SetNullParameters ( const RooArgSet & )

inlinevirtual

Definition at line 94 of file HybridCalculatorOriginal.h.

◆ SetNullPdf()

virtual void RooStats::HybridCalculatorOriginal::SetNullPdf ( RooAbsPdf & pdf )

inlinevirtual

Definition at line 86 of file HybridCalculatorOriginal.h.

◆ SetNumberOfToys()

void RooStats::HybridCalculatorOriginal::SetNumberOfToys ( unsigned int ntoys )

inline

Definition at line 109 of file HybridCalculatorOriginal.h.

◆ SetTestStatistic()

void HybridCalculatorOriginal::SetTestStatistic ( 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

set the desired test statistics:

index=1 : likelihood ratio: 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

Definition at line 247 of file HybridCalculatorOriginal.cxx.