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

Public Member Functions
	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)

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

virtual	~CombinedCalculator ()
	destructor. More...

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

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

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) More...

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

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

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

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

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

virtual void	SetNullModel (const ModelConfig &)

virtual void	SetAlternateModel (const ModelConfig &)

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

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

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

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

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

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

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
RooAbsPdf *	GetPdf () const

RooAbsData *	GetData () const

Protected Attributes
Double_t	fSize

RooAbsPdf *	fPdf

RooAbsData *	fData

RooArgSet	fPOI

RooArgSet	fNullParams

RooArgSet	fAlternateParams

RooArgSet	fNuisParams

RooArgSet	fConditionalObs

#include <RooStats/CombinedCalculator.h>

Inheritance diagram for RooStats::CombinedCalculator:

[legend]

Constructor & Destructor Documentation

RooStats::CombinedCalculator::CombinedCalculator ( )

inline

Definition at line 75 of file CombinedCalculator.h.

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

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

inline

constructor from data and model configuration

Definition at line 95 of file CombinedCalculator.h.

virtual RooStats::CombinedCalculator::~CombinedCalculator ( )

inlinevirtual

destructor.

Definition at line 106 of file CombinedCalculator.h.

Member Function Documentation

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

inlinevirtual

Get the Confidence level for the test.

Implements RooStats::IntervalCalculator.

Definition at line 122 of file CombinedCalculator.h.

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

inlineprotected

Definition at line 167 of file CombinedCalculator.h.

Referenced by RooStats::ProfileLikelihoodCalculator::DoGlobalFit(), RooStats::ProfileLikelihoodCalculator::GetHypoTest(), and RooStats::ProfileLikelihoodCalculator::GetInterval().

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

pure virtual

main interface to get a HypoTestResult, pure virtual

Implements RooStats::HypoTestCalculator.

Implemented in RooStats::ProfileLikelihoodCalculator.

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

pure virtual

Main interface to get a ConfInterval, pure virtual.

Implements RooStats::IntervalCalculator.

Implemented in RooStats::ProfileLikelihoodCalculator.

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

inlineprotected

Definition at line 166 of file CombinedCalculator.h.

Referenced by RooStats::ProfileLikelihoodCalculator::DoGlobalFit(), RooStats::ProfileLikelihoodCalculator::GetHypoTest(), and RooStats::ProfileLikelihoodCalculator::GetInterval().

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

inlinevirtual

Implements RooStats::HypoTestCalculator.

Definition at line 140 of file CombinedCalculator.h.

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

inlinevirtual

set parameter values for the alternate if using a common PDF

Definition at line 158 of file CombinedCalculator.h.

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

inlinevirtual

set conditional observables needed for computing the NLL

Definition at line 161 of file CombinedCalculator.h.

Referenced by SetModel().

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

Referenced by FourBinInstructional(), IntervalExamples(), MultivariateGaussianTest(), and StandardProfileLikelihoodDemo().

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

inlinevirtual

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

Implements RooStats::HypoTestCalculator.

Definition at line 125 of file CombinedCalculator.h.

Referenced by DoHypothesisTest().

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

Referenced by CombinedCalculator(), and DoHypothesisTest().

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

inlinevirtual

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

Definition at line 152 of file CombinedCalculator.h.

Referenced by SetModel().

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

inlinevirtual

Implements RooStats::HypoTestCalculator.

Definition at line 138 of file CombinedCalculator.h.

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

inlinevirtual

set parameter values for the null if using a common PDF

Definition at line 155 of file CombinedCalculator.h.

Referenced by DoHypothesisTest(), and SetModel().

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

inlinevirtual

specify the parameters of interest in the interval

Definition at line 149 of file CombinedCalculator.h.

Referenced by SetModel().

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

inlinevirtual

Set the Pdf.

Definition at line 146 of file CombinedCalculator.h.

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

Referenced by CombinedCalculator(), RooStats::UpperLimitMCSModule::processBetweenGenAndFit(), rs101_limitexample(), and rs401d_FeldmanCousins().

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

Member Data Documentation

RooArgSet RooStats::CombinedCalculator::fAlternateParams

protected

Definition at line 175 of file CombinedCalculator.h.

Referenced by CombinedCalculator(), and SetAlternateParameters().

RooArgSet RooStats::CombinedCalculator::fConditionalObs

protected

Definition at line 177 of file CombinedCalculator.h.

Referenced by RooStats::ProfileLikelihoodCalculator::DoGlobalFit(), and SetConditionalObservables().

RooAbsData* RooStats::CombinedCalculator::fData

protected

Definition at line 172 of file CombinedCalculator.h.

Referenced by GetData(), and SetData().

RooArgSet RooStats::CombinedCalculator::fNuisParams

protected

Definition at line 176 of file CombinedCalculator.h.

Referenced by CombinedCalculator(), and SetNuisanceParameters().

RooArgSet RooStats::CombinedCalculator::fNullParams

protected

Definition at line 174 of file CombinedCalculator.h.

Referenced by CombinedCalculator(), RooStats::ProfileLikelihoodCalculator::GetHypoTest(), and SetNullParameters().

RooAbsPdf* RooStats::CombinedCalculator::fPdf

protected

Definition at line 171 of file CombinedCalculator.h.

Referenced by GetPdf(), SetModel(), and SetPdf().

RooArgSet RooStats::CombinedCalculator::fPOI

protected

Definition at line 173 of file CombinedCalculator.h.

Referenced by RooStats::ProfileLikelihoodCalculator::GetInterval(), and SetParameters().

Double_t RooStats::CombinedCalculator::fSize

protected

Definition at line 169 of file CombinedCalculator.h.

Referenced by ConfidenceLevel(), RooStats::ProfileLikelihoodCalculator::GetInterval(), SetConfidenceLevel(), SetTestSize(), and Size().

Collaboration diagram 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

Member Function Documentation

Member Data Documentation