CombinedCalculator is an interface class for a tools which can produce both RooStats HypoTestResults and ConfIntervals.

The interface currently assumes that any such calculator can be configured by specifying:

a model common model (eg. a family of specific models which includes both the null and alternate),
a data set,
a set of parameters of which specify the null (including values and const/non-const status),
a set of parameters of which specify the alternate (including values and const/non-const status),
a set of parameters of nuisance parameters (including values and const/non-const status).

The interface allows one to pass the model, data, and parameters via a workspace and then specify them with names. The interface also allows one to pass the model, data, and parameters without a workspace (which is created internally).

After configuring the calculator, one only needs to ask GetHypoTest() (which will return a HypoTestResult pointer) or GetInterval() (which will return an ConfInterval pointer).

The concrete implementations of this interface should deal with the details of how the nuisance parameters are dealt with (eg. integration vs. profiling) and which test-statistic is used (perhaps this should be added to the interface).

The motivation for this interface is that we hope to be able to specify the problem in a common way for several concrete calculators.

Definition at line 62 of file CombinedCalculator.h.

Public Member Functions
	CombinedCalculator ()

	CombinedCalculator (RooAbsData &data, const ModelConfig &model, Double_t size=0.05)
	constructor from data and model configuration

	CombinedCalculator (RooAbsData &data, RooAbsPdf &pdf, const RooArgSet &paramsOfInterest, Double_t size=0.05, const RooArgSet nullParams=0, const RooArgSet altParams=0, const RooArgSet *nuisParams=0)

virtual	~CombinedCalculator ()
	destructor.

virtual Double_t	ConfidenceLevel () const
	Get the Confidence level for the test.

virtual HypoTestResult *	GetHypoTest () const =0
	main interface to get a HypoTestResult, pure virtual

virtual ConfInterval *	GetInterval () const =0
	Main interface to get a ConfInterval, pure virtual.

virtual void	SetAlternateModel (const ModelConfig &)

virtual void	SetAlternateParameters (const RooArgSet &set)
	set parameter values for the alternate if using a common PDF

virtual void	SetConditionalObservables (const RooArgSet &set)
	set conditional observables needed for computing the NLL

virtual void	SetConfidenceLevel (Double_t cl)
	set the confidence level for the interval (eg. 0.95 for a 95% Confidence Interval)

virtual void	SetData (RooAbsData &data)
	Set the DataSet, add to the the workspace if not already there.

virtual void	SetGlobalObservables (const RooArgSet &set)
	set global observables needed for computing the NLL

virtual void	SetModel (const ModelConfig &model)
	set the model (in this case can set only the parameters for the null hypothesis)

virtual void	SetNuisanceParameters (const RooArgSet &set)
	specify the nuisance parameters (eg. the rest of the parameters)

virtual void	SetNullModel (const ModelConfig &)

virtual void	SetNullParameters (const RooArgSet &set)
	set parameter values for the null if using a common PDF

virtual void	SetParameters (const RooArgSet &set)
	specify the parameters of interest in the interval

virtual void	SetPdf (RooAbsPdf &pdf)
	Set the Pdf.

virtual void	SetTestSize (Double_t size)
	set the size of the test (rate of Type I error) ( Eg. 0.05 for a 95% Confidence Interval)

virtual Double_t	Size () const
	Get the size of the test (eg. rate of Type I error)

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

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

virtual void	SetCommonModel (const ModelConfig &model)

Protected Member Functions
RooAbsData *	GetData () const

RooAbsPdf *	GetPdf () const

Protected Attributes
RooArgSet	fAlternateParams

RooArgSet	fConditionalObs

RooAbsData *	fData

RooArgSet	fGlobalObs

RooArgSet	fNuisParams

RooArgSet	fNullParams

RooAbsPdf *	fPdf

RooArgSet	fPOI

Double_t	fSize

#include <RooStats/CombinedCalculator.h>

Inheritance diagram for RooStats::CombinedCalculator:

[legend]

Constructor & Destructor Documentation

◆ CombinedCalculator() [1/3]

RooStats::CombinedCalculator::CombinedCalculator ( )

inline

Definition at line 66 of file CombinedCalculator.h.

◆ CombinedCalculator() [2/3]

RooStats::CombinedCalculator::CombinedCalculator	(	RooAbsData &	data,
		RooAbsPdf &	pdf,
		const RooArgSet &	paramsOfInterest,
		Double_t	size = `0.05`,
		const RooArgSet *	nullParams = `0`,
		const RooArgSet *	altParams = `0`,
		const RooArgSet *	nuisParams = `0`
	)

inline

Definition at line 72 of file CombinedCalculator.h.

◆ CombinedCalculator() [3/3]

RooStats::CombinedCalculator::CombinedCalculator	(	RooAbsData &	data,
		const ModelConfig &	model,
		Double_t	size = `0.05`
	)

inline

constructor from data and model configuration

Definition at line 86 of file CombinedCalculator.h.

◆ ~CombinedCalculator()

virtual RooStats::CombinedCalculator::~CombinedCalculator ( )

inlinevirtual

destructor.

Definition at line 97 of file CombinedCalculator.h.

Member Function Documentation

◆ ConfidenceLevel()

virtual Double_t RooStats::CombinedCalculator::ConfidenceLevel ( ) const

inlinevirtual

Get the Confidence level for the test.

Implements RooStats::IntervalCalculator.

Definition at line 113 of file CombinedCalculator.h.

◆ GetData()

RooAbsData * RooStats::CombinedCalculator::GetData ( ) const

inlineprotected

Definition at line 162 of file CombinedCalculator.h.

◆ GetHypoTest()

virtual HypoTestResult * RooStats::CombinedCalculator::GetHypoTest ( ) const

pure virtual

main interface to get a HypoTestResult, pure virtual

Implements RooStats::HypoTestCalculator.

Implemented in RooStats::ProfileLikelihoodCalculator.

◆ GetInterval()

virtual ConfInterval * RooStats::CombinedCalculator::GetInterval ( ) const

pure virtual

Main interface to get a ConfInterval, pure virtual.

Implements RooStats::IntervalCalculator.

Implemented in RooStats::ProfileLikelihoodCalculator.

◆ GetPdf()

RooAbsPdf * RooStats::CombinedCalculator::GetPdf ( ) const

inlineprotected

Definition at line 161 of file CombinedCalculator.h.

◆ SetAlternateModel()

virtual void RooStats::CombinedCalculator::SetAlternateModel ( const ModelConfig & )

inlinevirtual

Implements RooStats::HypoTestCalculator.

Definition at line 132 of file CombinedCalculator.h.

◆ SetAlternateParameters()

virtual void RooStats::CombinedCalculator::SetAlternateParameters ( const RooArgSet & set )

inlinevirtual

set parameter values for the alternate if using a common PDF

Definition at line 150 of file CombinedCalculator.h.

◆ SetConditionalObservables()

virtual void RooStats::CombinedCalculator::SetConditionalObservables ( const RooArgSet & set )

inlinevirtual

set conditional observables needed for computing the NLL

Definition at line 153 of file CombinedCalculator.h.

◆ SetConfidenceLevel()

virtual void RooStats::CombinedCalculator::SetConfidenceLevel ( Double_t cl )

inlinevirtual

set the confidence level for the interval (eg. 0.95 for a 95% Confidence Interval)

Implements RooStats::IntervalCalculator.

Definition at line 109 of file CombinedCalculator.h.

◆ SetData()

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

inlinevirtual

Set the DataSet, add to the the workspace if not already there.

Implements RooStats::IntervalCalculator.

Definition at line 116 of file CombinedCalculator.h.

◆ SetGlobalObservables()

virtual void RooStats::CombinedCalculator::SetGlobalObservables ( const RooArgSet & set )

inlinevirtual

set global observables needed for computing the NLL

Definition at line 156 of file CombinedCalculator.h.

◆ SetModel()

virtual void RooStats::CombinedCalculator::SetModel ( const ModelConfig & model )

inlinevirtual

set the model (in this case can set only the parameters for the null hypothesis)

Implements RooStats::IntervalCalculator.

Definition at line 121 of file CombinedCalculator.h.

◆ SetNuisanceParameters()

virtual void RooStats::CombinedCalculator::SetNuisanceParameters ( const RooArgSet & set )

inlinevirtual

specify the nuisance parameters (eg. the rest of the parameters)

Definition at line 144 of file CombinedCalculator.h.

◆ SetNullModel()

virtual void RooStats::CombinedCalculator::SetNullModel ( const ModelConfig & )

inlinevirtual

Implements RooStats::HypoTestCalculator.

Definition at line 130 of file CombinedCalculator.h.

◆ SetNullParameters()

virtual void RooStats::CombinedCalculator::SetNullParameters ( const RooArgSet & set )

inlinevirtual

set parameter values for the null if using a common PDF

Definition at line 147 of file CombinedCalculator.h.

◆ SetParameters()

virtual void RooStats::CombinedCalculator::SetParameters ( const RooArgSet & set )

inlinevirtual

specify the parameters of interest in the interval

Definition at line 141 of file CombinedCalculator.h.

◆ SetPdf()

virtual void RooStats::CombinedCalculator::SetPdf ( RooAbsPdf & pdf )

inlinevirtual

Set the Pdf.

Definition at line 138 of file CombinedCalculator.h.

◆ SetTestSize()

virtual void RooStats::CombinedCalculator::SetTestSize ( Double_t size )

inlinevirtual

set the size of the test (rate of Type I error) ( Eg. 0.05 for a 95% Confidence Interval)

Implements RooStats::IntervalCalculator.

Definition at line 107 of file CombinedCalculator.h.

◆ Size()

virtual Double_t RooStats::CombinedCalculator::Size ( ) const

inlinevirtual

Get the size of the test (eg. rate of Type I error)

Implements RooStats::IntervalCalculator.

Definition at line 111 of file CombinedCalculator.h.

Member Data Documentation

◆ fAlternateParams

RooArgSet RooStats::CombinedCalculator::fAlternateParams

protected

Definition at line 170 of file CombinedCalculator.h.

◆ fConditionalObs

RooArgSet RooStats::CombinedCalculator::fConditionalObs

protected

Definition at line 172 of file CombinedCalculator.h.

◆ fData

RooAbsData* RooStats::CombinedCalculator::fData

protected

Definition at line 167 of file CombinedCalculator.h.

◆ fGlobalObs

RooArgSet RooStats::CombinedCalculator::fGlobalObs

protected

Definition at line 173 of file CombinedCalculator.h.

◆ fNuisParams

RooArgSet RooStats::CombinedCalculator::fNuisParams

protected

Definition at line 171 of file CombinedCalculator.h.

◆ fNullParams

RooArgSet RooStats::CombinedCalculator::fNullParams

protected

Definition at line 169 of file CombinedCalculator.h.

◆ fPdf

RooAbsPdf* RooStats::CombinedCalculator::fPdf

protected

Definition at line 166 of file CombinedCalculator.h.

◆ fPOI

RooArgSet RooStats::CombinedCalculator::fPOI

protected

Definition at line 168 of file CombinedCalculator.h.

◆ fSize

Double_t RooStats::CombinedCalculator::fSize

protected

Definition at line 164 of file CombinedCalculator.h.

Libraries for RooStats::CombinedCalculator:

[legend]

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

roofit/roostats/inc/RooStats/CombinedCalculator.h

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ CombinedCalculator() [1/3]

◆ CombinedCalculator() [2/3]

◆ CombinedCalculator() [3/3]

◆ ~CombinedCalculator()

Member Function Documentation

◆ ConfidenceLevel()

◆ GetData()

◆ GetHypoTest()

◆ GetInterval()

◆ GetPdf()

◆ SetAlternateModel()

◆ SetAlternateParameters()

◆ SetConditionalObservables()

◆ SetConfidenceLevel()

◆ SetData()

◆ SetGlobalObservables()

◆ SetModel()

◆ SetNuisanceParameters()

◆ SetNullModel()

◆ SetNullParameters()

◆ SetParameters()

◆ SetPdf()

◆ SetTestSize()

◆ Size()

Member Data Documentation

◆ fAlternateParams

◆ fConditionalObs

◆ fData

◆ fGlobalObs

◆ fNuisParams

◆ fNullParams

◆ fPdf

◆ fPOI

◆ fSize