Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Static Public Member Functions | List of all members
RooStats::TestStatSampler Class Referenceabstract
RooFit package » RooStats

TestStatSampler is an interface class for a tools which produce RooStats SamplingDistributions.

Tools that implement this interface are expected to be used for coverage studies, the Neyman Construction, etc.

Definition at line 39 of file TestStatSampler.h.

Public Member Functions

virtual ~TestStatSampler ()
 
virtual double ConfidenceLevel () const =0
 Get the Confidence level for the test.
 
virtual double EvaluateTestStatistic (RooAbsData &data, RooArgSet &paramsOfInterest)=0
 Main interface to evaluate the test statistic on a dataset.
 
virtual SamplingDistribution * GetSamplingDistribution (RooArgSet &paramsOfInterest)=0
 Main interface to get a ConfInterval, pure virtual.
 
virtual TestStatistic * GetTestStatistic () const =0
 Get the TestStatistic.
 
virtual void Initialize (RooAbsArg &testStatistic, RooArgSet &paramsOfInterest, RooArgSet &nuisanceParameters)=0
 Common Initialization.
 
virtual TClass * IsA () const
 
virtual void SetConfidenceLevel (double cl)=0
 set the confidence level for the interval (eg. 0.95 for a 95% Confidence Interval)
 
virtual void SetGlobalObservables (const RooArgSet &)=0
 specify the conditional observables
 
virtual void SetNuisanceParameters (const RooArgSet &)=0
 specify the nuisance parameters (eg. the rest of the parameters)
 
virtual void SetObservables (const RooArgSet &)=0
 specify the observables in the dataset (needed to evaluate the test statistic)
 
virtual void SetParametersForTestStat (const RooArgSet &)=0
 specify the values of parameters used when evaluating test statistic
 
virtual void SetPdf (RooAbsPdf &)=0
 Set the Pdf, add to the workspace if not already there.
 
virtual void SetPriorNuisance (RooAbsPdf *)=0
 How to randomize the prior. Set to nullptr to deactivate randomization.
 
virtual void SetSamplingDistName (const char *name)=0
 Set the name of the sampling distribution used for plotting.
 
virtual void SetTestSize (double size)=0
 set the size of the test (rate of Type I error) ( Eg. 0.05 for a 95% Confidence Interval)
 
virtual void SetTestStatistic (TestStatistic *testStatistic)=0
 Set the TestStatistic (want the argument to be a function of the data & parameter points.
 
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/TestStatSampler.h>

Inheritance diagram for RooStats::TestStatSampler:
[legend]

Constructor & Destructor Documentation

◆ ~TestStatSampler()

virtual RooStats::TestStatSampler::~TestStatSampler ( )
inlinevirtual

Definition at line 42 of file TestStatSampler.h.

Member Function Documentation

◆ Class()

static TClass * RooStats::TestStatSampler::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooStats::TestStatSampler::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t RooStats::TestStatSampler::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 88 of file TestStatSampler.h.

◆ ConfidenceLevel()

virtual double RooStats::TestStatSampler::ConfidenceLevel ( ) const
pure virtual

Get the Confidence level for the test.

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ DeclFileName()

static const char * RooStats::TestStatSampler::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 88 of file TestStatSampler.h.

◆ EvaluateTestStatistic()

virtual double RooStats::TestStatSampler::EvaluateTestStatistic ( RooAbsData &  data,
RooArgSet &  paramsOfInterest 
)
pure virtual

Main interface to evaluate the test statistic on a dataset.

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ GetSamplingDistribution()

virtual SamplingDistribution * RooStats::TestStatSampler::GetSamplingDistribution ( RooArgSet &  paramsOfInterest)
pure virtual

Main interface to get a ConfInterval, pure virtual.

Implemented in RooStats::ToyMCSampler, and RooStats::DebuggingSampler.

◆ GetTestStatistic()

virtual TestStatistic * RooStats::TestStatSampler::GetTestStatistic ( ) const
pure virtual

Get the TestStatistic.

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ Initialize()

virtual void RooStats::TestStatSampler::Initialize ( RooAbsArg &  testStatistic,
RooArgSet &  paramsOfInterest,
RooArgSet &  nuisanceParameters 
)
pure virtual

Common Initialization.

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ IsA()

virtual TClass * RooStats::TestStatSampler::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Reimplemented in RooStats::DebuggingSampler, RooStats::ToyMCImportanceSampler, and RooStats::ToyMCSampler.

Definition at line 88 of file TestStatSampler.h.

◆ SetConfidenceLevel()

virtual void RooStats::TestStatSampler::SetConfidenceLevel ( double  cl)
pure virtual

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

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ SetGlobalObservables()

virtual void RooStats::TestStatSampler::SetGlobalObservables ( const RooArgSet &  )
pure virtual

specify the conditional observables

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ SetNuisanceParameters()

virtual void RooStats::TestStatSampler::SetNuisanceParameters ( const RooArgSet &  )
pure virtual

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

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ SetObservables()

virtual void RooStats::TestStatSampler::SetObservables ( const RooArgSet &  )
pure virtual

specify the observables in the dataset (needed to evaluate the test statistic)

Implemented in RooStats::ToyMCSampler.

◆ SetParametersForTestStat()

virtual void RooStats::TestStatSampler::SetParametersForTestStat ( const RooArgSet &  )
pure virtual

specify the values of parameters used when evaluating test statistic

Implemented in RooStats::DebuggingSampler, RooStats::ToyMCImportanceSampler, and RooStats::ToyMCSampler.

◆ SetPdf()

virtual void RooStats::TestStatSampler::SetPdf ( RooAbsPdf &  )
pure virtual

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

Implemented in RooStats::DebuggingSampler, RooStats::ToyMCImportanceSampler, and RooStats::ToyMCSampler.

◆ SetPriorNuisance()

virtual void RooStats::TestStatSampler::SetPriorNuisance ( RooAbsPdf *  )
pure virtual

How to randomize the prior. Set to nullptr to deactivate randomization.

Implemented in RooStats::ToyMCSampler.

◆ SetSamplingDistName()

virtual void RooStats::TestStatSampler::SetSamplingDistName ( const char *  name)
pure virtual

Set the name of the sampling distribution used for plotting.

Implemented in RooStats::ToyMCSampler.

◆ SetTestSize()

virtual void RooStats::TestStatSampler::SetTestSize ( double  size)
pure virtual

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

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ SetTestStatistic()

virtual void RooStats::TestStatSampler::SetTestStatistic ( TestStatistic *  testStatistic)
pure virtual

Set the TestStatistic (want the argument to be a function of the data & parameter points.

Implemented in RooStats::DebuggingSampler, and RooStats::ToyMCSampler.

◆ Streamer()

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

Reimplemented in RooStats::DebuggingSampler, RooStats::ToyMCImportanceSampler, and RooStats::ToyMCSampler.

◆ StreamerNVirtual()

void RooStats::TestStatSampler::StreamerNVirtual ( TBuffer &  ClassDef_StreamerNVirtual_b)
inline

Definition at line 88 of file TestStatSampler.h.

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