Logo ROOT  
Reference Guide
RooStats::FrequentistCalculator Class Reference

Does a frequentist hypothesis test.

Hypothesis Test Calculator using a full frequentist procedure for sampling the test statistic distribution. The nuisance parameters are fixed to their MLEs. The use of ToyMCSampler as the TestStatSampler is assumed.

Definition at line 25 of file FrequentistCalculator.h.

Public Member Functions

 FrequentistCalculator (const RooAbsData &data, const ModelConfig &altModel, const ModelConfig &nullModel, TestStatSampler *sampler=nullptr)
 
 ~FrequentistCalculator () override
 
const RooArgSetGetFitInfo () const override
 
TClassIsA () const override
 
void SetConditionalMLEsAlt (const RooArgSet *c)
 set given nuisance parameters to a specific value that will be used instead of their profiled value for Alternate toys More...
 
void SetConditionalMLEsNull (const RooArgSet *c)
 set given nuisance parameters to a specific value that will be used instead of their profiled value for Null toys More...
 
void SetNToysInTails (int toysNull, int toysAlt)
 set least number of toys in tails More...
 
void SetToys (int toysNull, int toysAlt)
 set number of toys More...
 
void StoreFitInfo (bool val=true)
 
void Streamer (TBuffer &) override
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from RooStats::HypoTestCalculatorGeneric
 HypoTestCalculatorGeneric (const RooAbsData &data, const ModelConfig &altModel, const ModelConfig &nullModel, TestStatSampler *sampler=nullptr)
 Constructor. More...
 
 ~HypoTestCalculatorGeneric () override
 
const ModelConfigGetAlternateModel (void) const
 
const RooAbsDataGetData (void) const
 
virtual const RooArgSetGetFitInfo () const
 
HypoTestResultGetHypoTest () const override
 inherited methods from HypoTestCalculator interface More...
 
const ModelConfigGetNullModel (void) const
 
TestStatSamplerGetTestStatSampler (void) const
 Returns instance of TestStatSampler. More...
 
TClassIsA () const override
 
void SetAlternateModel (const ModelConfig &altModel) override
 Set the model for the alternate hypothesis (S+B) More...
 
void SetData (RooAbsData &data) override
 Set the DataSet. More...
 
void SetNullModel (const ModelConfig &nullModel) override
 set the model for the null hypothesis (only B) More...
 
void Streamer (TBuffer &) override
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void UseSameAltToys ()
 Set this for re-using always the same toys for alternate hypothesis in case of calls at different null parameter points This is useful to get more stable bands when running the HypoTest inversion. More...
 
- Public Member Functions inherited from RooStats::HypoTestCalculator
virtual ~HypoTestCalculator ()
 
virtual HypoTestResultGetHypoTest () const =0
 main interface to get a HypoTestResult, pure virtual More...
 
virtual TClassIsA () const
 
virtual void SetAlternateModel (const ModelConfig &model)=0
 Set the model for the alternate hypothesis. More...
 
virtual void SetCommonModel (const ModelConfig &model)
 Set a common model for both the null and alternate, add to the workspace if not already there. More...
 
virtual void SetData (RooAbsData &data)=0
 Set the DataSet. More...
 
virtual void SetNullModel (const ModelConfig &model)=0
 Set the model for the null hypothesis. More...
 
virtual void Streamer (TBuffer &)
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from RooStats::HypoTestCalculatorGeneric
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from RooStats::HypoTestCalculator
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 

Protected Member Functions

void PostHook () const override
 
int PreAltHook (RooArgSet *parameterPoint, double obsTestStat) const override
 configure TestStatSampler for the Alt run More...
 
void PreHook () const override
 
int PreNullHook (RooArgSet *parameterPoint, double obsTestStat) const override
 configure TestStatSampler for the Null run More...
 
- Protected Member Functions inherited from RooStats::HypoTestCalculatorGeneric
virtual int CheckHook (void) const
 
virtual void PostHook () const
 
virtual int PreAltHook (RooArgSet *, double) const
 
virtual void PreHook () const
 
virtual int PreNullHook (RooArgSet *, double) const
 

Protected Attributes

const RooArgSetfConditionalMLEsAlt
 
const RooArgSetfConditionalMLEsNull
 
int fNToysAlt
 
int fNToysAltTail
 
int fNToysNull
 
int fNToysNullTail
 
- Protected Attributes inherited from RooStats::HypoTestCalculatorGeneric
const ModelConfigfAltModel
 
unsigned int fAltToysSeed
 
const RooAbsDatafData
 
TestStatSamplerfDefaultSampler
 
TestStatisticfDefaultTestStat
 
const ModelConfigfNullModel
 
TestStatSamplerfTestStatSampler
 

Private Attributes

RooArgSetfFitInfo
 
bool fStoreFitInfo
 

#include <RooStats/FrequentistCalculator.h>

Inheritance diagram for RooStats::FrequentistCalculator:
[legend]

Constructor & Destructor Documentation

◆ FrequentistCalculator()

RooStats::FrequentistCalculator::FrequentistCalculator ( const RooAbsData data,
const ModelConfig altModel,
const ModelConfig nullModel,
TestStatSampler sampler = nullptr 
)
inline

Definition at line 28 of file FrequentistCalculator.h.

◆ ~FrequentistCalculator()

RooStats::FrequentistCalculator::~FrequentistCalculator ( )
inlineoverride

Definition at line 46 of file FrequentistCalculator.h.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

static Version_t RooStats::FrequentistCalculator::Class_Version ( )
inlinestatic
Returns
Version of this class

Definition at line 113 of file FrequentistCalculator.h.

◆ DeclFileName()

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

Definition at line 113 of file FrequentistCalculator.h.

◆ GetFitInfo()

const RooArgSet * RooStats::FrequentistCalculator::GetFitInfo ( ) const
inlineoverridevirtual

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 81 of file FrequentistCalculator.h.

◆ IsA()

TClass * RooStats::FrequentistCalculator::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from RooStats::HypoTestCalculator.

Definition at line 113 of file FrequentistCalculator.h.

◆ PostHook()

void FrequentistCalculator::PostHook ( ) const
overrideprotectedvirtual

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 49 of file FrequentistCalculator.cxx.

◆ PreAltHook()

int FrequentistCalculator::PreAltHook ( RooArgSet parameterPoint,
double  obsTestStat 
) const
overrideprotectedvirtual

configure TestStatSampler for the Alt run

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 171 of file FrequentistCalculator.cxx.

◆ PreHook()

void FrequentistCalculator::PreHook ( ) const
overrideprotectedvirtual

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 37 of file FrequentistCalculator.cxx.

◆ PreNullHook()

int FrequentistCalculator::PreNullHook ( RooArgSet parameterPoint,
double  obsTestStat 
) const
overrideprotectedvirtual

configure TestStatSampler for the Null run

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 54 of file FrequentistCalculator.cxx.

◆ SetConditionalMLEsAlt()

void RooStats::FrequentistCalculator::SetConditionalMLEsAlt ( const RooArgSet c)
inline

set given nuisance parameters to a specific value that will be used instead of their profiled value for Alternate toys

Definition at line 70 of file FrequentistCalculator.h.

◆ SetConditionalMLEsNull()

void RooStats::FrequentistCalculator::SetConditionalMLEsNull ( const RooArgSet c)
inline

set given nuisance parameters to a specific value that will be used instead of their profiled value for Null toys

Definition at line 61 of file FrequentistCalculator.h.

◆ SetNToysInTails()

void RooStats::FrequentistCalculator::SetNToysInTails ( int  toysNull,
int  toysAlt 
)
inline

set least number of toys in tails

Definition at line 57 of file FrequentistCalculator.h.

◆ SetToys()

void RooStats::FrequentistCalculator::SetToys ( int  toysNull,
int  toysAlt 
)
inline

set number of toys

Definition at line 54 of file FrequentistCalculator.h.

◆ StoreFitInfo()

void RooStats::FrequentistCalculator::StoreFitInfo ( bool  val = true)
inline

Definition at line 77 of file FrequentistCalculator.h.

◆ Streamer()

void RooStats::FrequentistCalculator::Streamer ( TBuffer )
overridevirtual

Reimplemented from RooStats::HypoTestCalculator.

◆ StreamerNVirtual()

void RooStats::FrequentistCalculator::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 113 of file FrequentistCalculator.h.

Member Data Documentation

◆ fConditionalMLEsAlt

const RooArgSet* RooStats::FrequentistCalculator::fConditionalMLEsAlt
protected

Definition at line 98 of file FrequentistCalculator.h.

◆ fConditionalMLEsNull

const RooArgSet* RooStats::FrequentistCalculator::fConditionalMLEsNull
protected

Definition at line 97 of file FrequentistCalculator.h.

◆ fFitInfo

RooArgSet* RooStats::FrequentistCalculator::fFitInfo
mutableprivate

Definition at line 109 of file FrequentistCalculator.h.

◆ fNToysAlt

int RooStats::FrequentistCalculator::fNToysAlt
protected

Definition at line 102 of file FrequentistCalculator.h.

◆ fNToysAltTail

int RooStats::FrequentistCalculator::fNToysAltTail
protected

Definition at line 106 of file FrequentistCalculator.h.

◆ fNToysNull

int RooStats::FrequentistCalculator::fNToysNull
protected

Definition at line 101 of file FrequentistCalculator.h.

◆ fNToysNullTail

int RooStats::FrequentistCalculator::fNToysNullTail
protected

Definition at line 105 of file FrequentistCalculator.h.

◆ fStoreFitInfo

bool RooStats::FrequentistCalculator::fStoreFitInfo
private

Definition at line 110 of file FrequentistCalculator.h.

Libraries for RooStats::FrequentistCalculator:
[legend]

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