RooStats::IntervalCalculator Class Reference

IntervalCalculator is an interface class for a tools which produce RooStats ConfIntervals.

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

• a model,
• a data set,
• a set of parameters of interest,
• a set of nuisance parameters (eg. parameters on which the model depends, but are not of interest), and
• a confidence level or size of the test (eg. rate of Type I error).

The interface allows one to pass the model, data, and parameters via a workspace and then specify them with names. The interface will be extended so that one does not need to use a workspace.

After configuring the calculator, one only needs to ask GetInterval, which will return a 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 55 of file IntervalCalculator.h.

Public Member Functions
virtual	~IntervalCalculator ()
virtual double	ConfidenceLevel () const =0
	Get the Confidence level for the test.
virtual ConfInterval *	GetInterval () const =0
	Main interface to get a ConfInterval, pure virtual.
virtual TClass *	IsA () const
virtual void	SetConfidenceLevel (double cl)=0
	set the confidence level for the interval (e.g. 0.95 for a 95% Confidence Interval)
virtual void	SetData (RooAbsData &)=0
	Set the DataSet ( add to the workspace if not already there ?)
virtual void	SetModel (const ModelConfig &)=0
	Set the Model.
virtual void	SetTestSize (double size)=0
	set the size of the test (rate of Type I error) ( e.g. 0.05 for a 95% Confidence Interval)
virtual double	Size () const =0
	Get the size of the test (eg. rate of Type I error)
virtual void	Streamer (TBuffer &)
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 ()

#include <RooStats/IntervalCalculator.h>

Inheritance diagram for RooStats::IntervalCalculator:

Constructor & Destructor Documentation

~IntervalCalculator()

virtual RooStats::IntervalCalculator::~IntervalCalculator ( )

inlinevirtual

Definition at line 59 of file IntervalCalculator.h.

Member Function Documentation

Class()

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

static

Returns

TClass describing this class

Class_Name()

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

static

Returns

Name of this class

Class_Version()

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

inlinestaticconstexpr

Returns

Version of this class

Definition at line 83 of file IntervalCalculator.h.

ConfidenceLevel()

virtual double RooStats::IntervalCalculator::ConfidenceLevel ( ) const

pure virtual

Get the Confidence level for the test.

Implemented in RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::MCMCCalculator, and RooStats::NeymanConstruction.

DeclFileName()

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

inlinestatic

Returns

Name of the file containing the class declaration

Definition at line 83 of file IntervalCalculator.h.

GetInterval()

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

pure virtual

Main interface to get a ConfInterval, pure virtual.

Implemented in RooStats::BayesianCalculator, RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::MCMCCalculator, RooStats::NeymanConstruction, RooStats::ProfileLikelihoodCalculator, and RooStats::CombinedCalculator.

IsA()

virtual TClass * RooStats::IntervalCalculator::IsA ( ) const

inlinevirtual

Returns

TClass describing current object

Reimplemented in RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::MCMCCalculator, RooStats::NeymanConstruction, and RooStats::ProfileLikelihoodCalculator.

Definition at line 83 of file IntervalCalculator.h.

SetConfidenceLevel()

virtual void RooStats::IntervalCalculator::SetConfidenceLevel ( double  cl )

pure virtual

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

Implemented in RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::MCMCCalculator, and RooStats::NeymanConstruction.

SetData()

virtual void RooStats::IntervalCalculator::SetData ( RooAbsData &  )

pure virtual

Set the DataSet ( add to the workspace if not already there ?)

Implemented in RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::MCMCCalculator, and RooStats::NeymanConstruction.

SetModel()

virtual void RooStats::IntervalCalculator::SetModel ( const ModelConfig &  )

pure virtual

Set the Model.

Implemented in RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::MCMCCalculator, and RooStats::NeymanConstruction.

SetTestSize()

virtual void RooStats::IntervalCalculator::SetTestSize ( double  size )

pure virtual

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

Implemented in RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::MCMCCalculator, and RooStats::NeymanConstruction.

Size()

virtual double RooStats::IntervalCalculator::Size ( ) const

pure virtual

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

Implemented in RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::MCMCCalculator, and RooStats::NeymanConstruction.

Streamer()

virtual void RooStats::IntervalCalculator::Streamer ( TBuffer &  )

virtual

Reimplemented in RooStats::BayesianCalculator, RooStats::CombinedCalculator, RooStats::FeldmanCousins, RooStats::HypoTestInverter, RooStats::MCMCCalculator, RooStats::NeymanConstruction, and RooStats::ProfileLikelihoodCalculator.

StreamerNVirtual()

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

inline

Definition at line 83 of file IntervalCalculator.h.

---

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

• roofit/roostats/inc/RooStats/IntervalCalculator.h