Logo ROOT   master
Reference Guide
RooStats::IntervalCalculator Class Referenceabstract

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 59 of file IntervalCalculator.h.

Public Member Functions

virtual ~IntervalCalculator ()
 
virtual Double_t ConfidenceLevel () const =0
 Get the Confidence level for the test. More...
 
virtual ConfIntervalGetInterval () const =0
 Main interface to get a ConfInterval, pure virtual. More...
 
virtual void SetConfidenceLevel (Double_t cl)=0
 set the confidence level for the interval (e.g. 0.95 for a 95% Confidence Interval) More...
 
virtual void SetData (RooAbsData &)=0
 Set the DataSet ( add to the the workspace if not already there ?) More...
 
virtual void SetModel (const ModelConfig &)=0
 Set the Model. More...
 
virtual void SetTestSize (Double_t size)=0
 set the size of the test (rate of Type I error) ( e.g. 0.05 for a 95% Confidence Interval) More...
 
virtual Double_t Size () const =0
 Get the size of the test (eg. rate of Type I error) More...
 

#include <RooStats/IntervalCalculator.h>

Inheritance diagram for RooStats::IntervalCalculator:
[legend]

Constructor & Destructor Documentation

◆ ~IntervalCalculator()

virtual RooStats::IntervalCalculator::~IntervalCalculator ( )
inlinevirtual

Definition at line 63 of file IntervalCalculator.h.

Member Function Documentation

◆ ConfidenceLevel()

virtual Double_t RooStats::IntervalCalculator::ConfidenceLevel ( ) const
pure virtual

◆ GetInterval()

◆ SetConfidenceLevel()

virtual void RooStats::IntervalCalculator::SetConfidenceLevel ( Double_t  cl)
pure virtual

◆ SetData()

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

◆ SetModel()

◆ SetTestSize()

virtual void RooStats::IntervalCalculator::SetTestSize ( Double_t  size)
pure virtual

◆ Size()

virtual Double_t RooStats::IntervalCalculator::Size ( ) const
pure virtual

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