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

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

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

double	ConfidenceLevel () const override
	Get the Confidence level for the test.

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

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

TClass *	IsA () const override

void	SetAlternateModel (const ModelConfig &) override
	Set the model for the alternate hypothesis.

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

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

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

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

void	SetModel (const ModelConfig &model) override
	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)

void	SetNullModel (const ModelConfig &) override
	Set the model for the null hypothesis.

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.

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

double	Size () const override
	Get the size of the test (eg. rate of Type I error)

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

virtual void	SetCommonModel (const ModelConfig &model)
	Set a common model for both the null and alternate, add to the workspace if not already there.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from RooStats::IntervalCalculator
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from RooStats::HypoTestCalculator
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Protected Member Functions
RooAbsData *	GetData () const

RooAbsPdf *	GetPdf () const

Protected Attributes
RooArgSet	fAlternateParams
	RooArgSet specifying alternate parameters for hypothesis test.

RooArgSet	fConditionalObs
	RooArgSet specifying the conditional observables.

RooAbsData *	fData = nullptr

RooArgSet	fGlobalObs
	RooArgSet specifying the global observables.

RooArgSet	fNuisParams
	RooArgSet specifying nuisance parameters for interval.

RooArgSet	fNullParams
	RooArgSet specifying null parameters for hypothesis test.

RooAbsPdf *	fPdf = nullptr

RooArgSet	fPOI
	RooArgSet specifying parameters of interest for interval.

double	fSize = 0.0
	size of the test (eg. specified rate of Type I error)

#include <RooStats/CombinedCalculator.h>

Inheritance diagram for RooStats::CombinedCalculator:

[legend]

Constructor & Destructor Documentation

◆ CombinedCalculator() [1/3]

RooStats::CombinedCalculator::CombinedCalculator ( )

default

◆ CombinedCalculator() [2/3]

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

inline

Definition at line 68 of file CombinedCalculator.h.

◆ CombinedCalculator() [3/3]

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

inline

constructor from data and model configuration

Definition at line 82 of file CombinedCalculator.h.

Member Function Documentation

◆ Class()

static TClass * RooStats::CombinedCalculator::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooStats::CombinedCalculator::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooStats::CombinedCalculator::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 166 of file CombinedCalculator.h.

◆ ConfidenceLevel()

double RooStats::CombinedCalculator::ConfidenceLevel ( ) const

inlineoverridevirtual

Get the Confidence level for the test.

Implements RooStats::IntervalCalculator.

Definition at line 103 of file CombinedCalculator.h.

◆ DeclFileName()

static const char * RooStats::CombinedCalculator::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 166 of file CombinedCalculator.h.

◆ GetData()

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

inlineprotected

Definition at line 152 of file CombinedCalculator.h.

◆ GetHypoTest()

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

overridepure virtual

main interface to get a HypoTestResult, pure virtual

Implements RooStats::HypoTestCalculator.

Implemented in RooStats::ProfileLikelihoodCalculator.

◆ GetInterval()

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

overridepure 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 151 of file CombinedCalculator.h.

◆ IsA()

TClass * RooStats::CombinedCalculator::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from RooStats::IntervalCalculator.

Reimplemented in RooStats::ProfileLikelihoodCalculator.

Definition at line 166 of file CombinedCalculator.h.

◆ SetAlternateModel()

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

inlineoverridevirtual

Set the model for the alternate hypothesis.

Implements RooStats::HypoTestCalculator.

Definition at line 122 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 140 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 143 of file CombinedCalculator.h.

◆ SetConfidenceLevel()

void RooStats::CombinedCalculator::SetConfidenceLevel ( double cl )

inlineoverridevirtual

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

Implements RooStats::IntervalCalculator.

Definition at line 99 of file CombinedCalculator.h.

◆ SetData()

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

inlineoverridevirtual

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

Implements RooStats::IntervalCalculator.

Definition at line 106 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 146 of file CombinedCalculator.h.

◆ SetModel()

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

inlineoverridevirtual

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

Implements RooStats::IntervalCalculator.

Definition at line 111 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 134 of file CombinedCalculator.h.

◆ SetNullModel()

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

inlineoverridevirtual

Set the model for the null hypothesis.

Implements RooStats::HypoTestCalculator.

Definition at line 120 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 137 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 131 of file CombinedCalculator.h.

◆ SetPdf()

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

inlinevirtual

Set the Pdf.

Definition at line 128 of file CombinedCalculator.h.

◆ SetTestSize()

void RooStats::CombinedCalculator::SetTestSize ( double size )

inlineoverridevirtual

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 97 of file CombinedCalculator.h.

◆ Size()

double RooStats::CombinedCalculator::Size ( ) const

inlineoverridevirtual

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

Implements RooStats::IntervalCalculator.

Definition at line 101 of file CombinedCalculator.h.

◆ Streamer()

void RooStats::CombinedCalculator::Streamer ( TBuffer & )

overridevirtual

Reimplemented from RooStats::IntervalCalculator.

Reimplemented in RooStats::ProfileLikelihoodCalculator.

◆ StreamerNVirtual()

void RooStats::CombinedCalculator::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 166 of file CombinedCalculator.h.

Member Data Documentation

◆ fAlternateParams

RooArgSet RooStats::CombinedCalculator::fAlternateParams

protected

RooArgSet specifying alternate parameters for hypothesis test.

Definition at line 160 of file CombinedCalculator.h.

◆ fConditionalObs

RooArgSet RooStats::CombinedCalculator::fConditionalObs

protected

RooArgSet specifying the conditional observables.

Definition at line 162 of file CombinedCalculator.h.

◆ fData

RooAbsData* RooStats::CombinedCalculator::fData = nullptr

protected

Definition at line 157 of file CombinedCalculator.h.

◆ fGlobalObs

RooArgSet RooStats::CombinedCalculator::fGlobalObs

protected

RooArgSet specifying the global observables.

Definition at line 163 of file CombinedCalculator.h.

◆ fNuisParams

RooArgSet RooStats::CombinedCalculator::fNuisParams

protected

RooArgSet specifying nuisance parameters for interval.

Definition at line 161 of file CombinedCalculator.h.

◆ fNullParams

RooArgSet RooStats::CombinedCalculator::fNullParams

protected

RooArgSet specifying null parameters for hypothesis test.

Definition at line 159 of file CombinedCalculator.h.

◆ fPdf

RooAbsPdf* RooStats::CombinedCalculator::fPdf = nullptr

protected

Definition at line 156 of file CombinedCalculator.h.

◆ fPOI

RooArgSet RooStats::CombinedCalculator::fPOI

protected

RooArgSet specifying parameters of interest for interval.

Definition at line 158 of file CombinedCalculator.h.

◆ fSize

double RooStats::CombinedCalculator::fSize = 0.0

protected

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

Definition at line 154 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

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ CombinedCalculator() [1/3]

◆ CombinedCalculator() [2/3]

◆ CombinedCalculator() [3/3]

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ConfidenceLevel()

◆ DeclFileName()

◆ GetData()

◆ GetHypoTest()

◆ GetInterval()

◆ GetPdf()

◆ IsA()

◆ SetAlternateModel()

◆ SetAlternateParameters()

◆ SetConditionalObservables()

◆ SetConfidenceLevel()

◆ SetData()

◆ SetGlobalObservables()

◆ SetModel()

◆ SetNuisanceParameters()

◆ SetNullModel()

◆ SetNullParameters()

◆ SetParameters()

◆ SetPdf()

◆ SetTestSize()

◆ Size()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fAlternateParams

◆ fConditionalObs

◆ fData

◆ fGlobalObs

◆ fNuisParams

◆ fNullParams

◆ fPdf

◆ fPOI

◆ fSize