class RooStats::CombinedCalculator: public RooStats::IntervalCalculator, public RooStats::HypoTestCalculator

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.

Function Members (Methods)

 
    This is an abstract class, constructors will not be documented.
    Look at the header to check for available constructors.
public:
virtual~CombinedCalculator()
static TClass*Class()
virtual Double_tConfidenceLevel() const
virtual RooStats::HypoTestResult*GetHypoTest() const
virtual RooStats::ConfInterval*GetInterval() const
virtual voidRooStats::HypoTestCalculator::Initialize(RooAbsData& data, RooAbsPdf& commonPdf, RooArgSet& nullParameters, RooArgSet& alternateParameters, RooArgSet* nuisanceParameters = 0, RooAbsPdf* nuisancePdf = 0)
virtual voidRooStats::HypoTestCalculator::Initialize(RooAbsData& data, RooAbsPdf& nullPdf, RooAbsPdf& alternatePdf, RooArgSet* nullParameters = 0, RooArgSet* alternateParameters = 0, RooArgSet* nuisanceParameters = 0, RooAbsPdf* nuisancePdf = 0)
virtual voidRooStats::HypoTestCalculator::Initialize(RooWorkspace& ws, const char* data, const char* commonPdf, RooArgSet& nullParameters, RooArgSet& alternateParameters, RooArgSet* nuisanceParameters = 0, const char* nuisancePdf = 0)
virtual voidRooStats::HypoTestCalculator::Initialize(RooWorkspace& ws, const char* data, const char* nullPdf, const char* alternatePdf, RooArgSet* nullParameters = 0, RooArgSet* alternateParameters = 0, RooArgSet* nuisanceParameters = 0, const char* nuisancePdf = 0)
virtual TClass*IsA() const
RooStats::IntervalCalculator&RooStats::IntervalCalculator::operator=(const RooStats::IntervalCalculator&)
virtual voidSetAlternateParameters(RooArgSet& set)
virtual voidSetAlternatePdf(RooAbsPdf& pdf)
virtual voidSetAlternatePdf(const char* name)
virtual voidSetCommonPdf(RooAbsPdf& pdf)
virtual voidSetCommonPdf(const char* name)
virtual voidSetConfidenceLevel(Double_t cl)
virtual voidSetData(RooAbsData& data)
virtual voidSetData(const char* name)
virtual voidSetNuisanceParameters(RooArgSet& set)
virtual voidRooStats::HypoTestCalculator::SetNuisancePdf(const char*)
virtual voidRooStats::HypoTestCalculator::SetNuisancePdf(RooAbsPdf&)
virtual voidSetNullParameters(RooArgSet& set)
virtual voidSetNullPdf(RooAbsPdf& pdf)
virtual voidSetNullPdf(const char* name)
virtual voidSetParameters(RooArgSet& set)
virtual voidSetPdf(RooAbsPdf& pdf)
virtual voidSetPdf(const char* name)
virtual voidSetSize(Double_t size)
virtual voidSetWorkspace(RooWorkspace& ws)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual Double_tSize() const
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)

Data Members

protected:
RooArgSet*fAlternateParamsRooArgSet specifying alternate parameters for hypothesis test
const char*fDataNamename of data set in workspace
RooArgSet*fNuisParamsRooArgSet specifying nuisance parameters for interval
RooArgSet*fNullParamsRooArgSet specifying null parameters for hypothesis test
Bool_tfOwnsWorkspace
RooArgSet*fPOIRooArgSet specifying parameters of interest for interval
const char*fPdfNamename of common PDF in workspace
Double_tfSizesize of the test (eg. specified rate of Type I error)
RooWorkspace*fWSa workspace that owns all the components to be used by the calculator

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

SetWorkspace(RooWorkspace& ws)
 alternate constructor
SetData(data)
SetPdf(pdf)
SetParameters(RooArgSet& set)
SetSize(Double_t size)
SetNullParameters(RooArgSet& set)
SetData(data)
SetPdf(pdf)
virtual ~CombinedCalculator()
 destructor.
ConfInterval* GetInterval() const
 Main interface to get a ConfInterval, pure virtual
HypoTestResult* GetHypoTest() const
void SetConfidenceLevel(Double_t cl)
 set the confidence level for the interval (eg. 0.95 for a 95% Confidence Interval)
{fSize = 1.-cl;}
Double_t Size() const
 Get the Confidence level for the test
{return fSize;}
Double_t ConfidenceLevel() const
{return 1.-fSize;}
void SetCommonPdf(RooAbsPdf& pdf)
 Set the Pdf, add to the the workspace if not already there
{ SetPdf(pdf);}
void SetNullPdf(RooAbsPdf& pdf)
 Set the Pdf, add to the the workspace if not already there
{ SetPdf(pdf);}
void SetAlternatePdf(RooAbsPdf& pdf)
{ SetPdf(pdf);}
void SetNuisanceParameters(RooArgSet& set)
 specify the nuisance parameters (eg. the rest of the parameters)
{fNuisParams = &set;}
void SetNullPdf(const char* name)
 from HypoTestCalculator
 set the PDF for the null hypothesis.  Needs to be the common one
{SetPdf(name);}
void SetAlternatePdf(const char* name)
 set a common PDF for both the null and alternate hypotheses
{SetPdf(name);}
void SetCommonPdf(const char* name)
 set parameter values for the null if using a common PDF
{SetPdf(name);}
void SetAlternateParameters(RooArgSet& set)
 set parameter values for the alternate if using a common PDF
{fAlternateParams = &set;}

Author: Kyle Cranmer, Lorenzo Moneta, Gregory Schott, Wouter Verkerke
Last change: root/roostats:$Id: CombinedCalculator.h 26964 2008-12-16 16:30:01Z moneta $
Last generated: 2008-12-17 08:53
Copyright (C) 1995-2008, Rene Brun and Fons Rademakers. *
This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.