Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
RooStats::HybridCalculator Class Reference
RooFit » RooStats

Same purpose as HybridCalculatorOriginal, but different implementation.

This class implements the Hypothesis test calculation using an hybrid (frequentist/bayesian) procedure.A frequentist sampling of the test statistic distribution is obtained but with marginalization of the nuisance parameters. The toys are generated by sampling the nuisance parameters according to their prior distribution.

The use of the of ToyMCSampler as the TestStatSampler is assumed.

Definition at line 22 of file HybridCalculator.h.

Public Member Functions

 HybridCalculator (const RooAbsData &data, const ModelConfig &altModel, const ModelConfig &nullModel, TestStatSampler *sampler=nullptr)
 ~HybridCalculator () override
virtual void ForcePriorNuisanceAlt (RooAbsPdf &priorNuisance)
virtual void ForcePriorNuisanceNull (RooAbsPdf &priorNuisance)
 Override the distribution used for marginalizing nuisance parameters that is inferred from ModelConfig.
const ModelConfig * GetAlternateModel (void) const
const RooAbsData * GetData (void) const
virtual const RooArgSet * GetFitInfo () const
HypoTestResult * GetHypoTest () const override
 inherited methods from HypoTestCalculator interface
const ModelConfig * GetNullModel (void) const
TestStatSampler * GetTestStatSampler (void) const
 Returns instance of TestStatSampler.
TClass * IsA () const override
void SetAlternateModel (const ModelConfig &altModel) override
 Set the model for the alternate hypothesis.
virtual void SetCommonModel (const ModelConfig &model)
 Set a common model for both the null and alternate, add to the workspace if not already there.
void SetData (RooAbsData &data) override
 Set the DataSet.
void SetNToysInTails (int toysNull, int toysAlt)
 set least number of toys in tails
void SetNullModel (const ModelConfig &nullModel) override
 Set the model for the null hypothesis.
void SetToys (int toysNull, int toysAlt)
 set number of toys
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.

Static Public Member Functions

static TClass * Class ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static const char * DeclFileName ()

Protected Member Functions

int CheckHook (void) const override
 check whether all input is consistent
virtual void PostHook () const
int PreAltHook (RooArgSet *, double obsTestStat) const override
 configure TestStatSampler for the Alt run
virtual void PreHook () const
int PreNullHook (RooArgSet *, double obsTestStat) const override
 configure TestStatSampler for the Null run

Protected Attributes

const ModelConfig * fAltModel
unsigned int fAltToysSeed
const RooAbsData * fData
TestStatSampler * fDefaultSampler
TestStatistic * fDefaultTestStat
int fNToysAlt
int fNToysAltTail
int fNToysNull
int fNToysNullTail
const ModelConfig * fNullModel
RooAbsPdf * fPriorNuisanceAlt
bool fPriorNuisanceAltExternal = false
RooAbsPdf * fPriorNuisanceNull
bool fPriorNuisanceNullExternal = false
TestStatSampler * fTestStatSampler

Private Member Functions

SamplingDistribution * GenerateSamplingDistribution (ModelConfig *thisModel, double obsTestStat, RooAbsPdf *impDens=nullptr, const RooArgSet *impSnapshot=nullptr) const
void SetAdaptiveLimits (double obsTestStat, bool forNull) const
void SetupSampler (const ModelConfig &model) const
 common setup for both models

#include <RooStats/HybridCalculator.h>

Inheritance diagram for RooStats::HybridCalculator:
RooStats::HypoTestCalculatorGeneric RooStats::HypoTestCalculator

Constructor & Destructor Documentation

◆ HybridCalculator()

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

Definition at line 25 of file HybridCalculator.h.

◆ ~HybridCalculator()

RooStats::HybridCalculator::~HybridCalculator ( )
inlineoverride

Definition at line 41 of file HybridCalculator.h.

Member Function Documentation

◆ CheckHook()

int HybridCalculator::CheckHook ( void ) const
overrideprotectedvirtual

check whether all input is consistent

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 36 of file HybridCalculator.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 107 of file HybridCalculator.h.

◆ DeclFileName()

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

Definition at line 107 of file HybridCalculator.h.

◆ ForcePriorNuisanceAlt()

virtual void RooStats::HybridCalculator::ForcePriorNuisanceAlt ( RooAbsPdf & priorNuisance)
inlinevirtual

Definition at line 53 of file HybridCalculator.h.

◆ ForcePriorNuisanceNull()

virtual void RooStats::HybridCalculator::ForcePriorNuisanceNull ( RooAbsPdf & priorNuisance)
inlinevirtual

Override the distribution used for marginalizing nuisance parameters that is inferred from ModelConfig.

Definition at line 48 of file HybridCalculator.h.

◆ GenerateSamplingDistribution()

SamplingDistribution * RooStats::HypoTestCalculatorGeneric::GenerateSamplingDistribution ( ModelConfig * thisModel,
double obsTestStat,
RooAbsPdf * impDens = nullptr,
const RooArgSet * impSnapshot = nullptr ) const
privateinherited

◆ GetAlternateModel()

const ModelConfig * RooStats::HypoTestCalculatorGeneric::GetAlternateModel ( void ) const
inlineinherited

Definition at line 57 of file HypoTestCalculatorGeneric.h.

◆ GetData()

const RooAbsData * RooStats::HypoTestCalculatorGeneric::GetData ( void ) const
inlineinherited

Definition at line 52 of file HypoTestCalculatorGeneric.h.

◆ GetFitInfo()

virtual const RooArgSet * RooStats::HypoTestCalculatorGeneric::GetFitInfo ( ) const
inlinevirtualinherited

Reimplemented in RooStats::FrequentistCalculator.

Definition at line 54 of file HypoTestCalculatorGeneric.h.

◆ GetHypoTest()

HypoTestResult * HypoTestCalculatorGeneric::GetHypoTest ( ) const
overridevirtualinherited

inherited methods from HypoTestCalculator interface

several possibilities: no prior nuisance given and no nuisance parameters: ok no prior nuisance given but nuisance parameters: error prior nuisance given for some nuisance parameters:

  • nuisance parameters are constant, so they don't float in test statistic
  • nuisance parameters are floating, so they do float in test statistic

Implements RooStats::HypoTestCalculator.

Definition at line 117 of file HypoTestCalculatorGeneric.cxx.

◆ GetNullModel()

const ModelConfig * RooStats::HypoTestCalculatorGeneric::GetNullModel ( void ) const
inlineinherited

Definition at line 53 of file HypoTestCalculatorGeneric.h.

◆ GetTestStatSampler()

TestStatSampler * RooStats::HypoTestCalculatorGeneric::GetTestStatSampler ( void ) const
inlineinherited

Returns instance of TestStatSampler.

Use to change properties of TestStatSampler, e.g. GetTestStatSampler.SetTestSize(double size);

Definition at line 63 of file HypoTestCalculatorGeneric.h.

◆ IsA()

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

Reimplemented from RooStats::HypoTestCalculator.

Definition at line 107 of file HybridCalculator.h.

◆ PostHook()

virtual void RooStats::HypoTestCalculatorGeneric::PostHook ( ) const
inlineprotectedvirtualinherited

Reimplemented in RooStats::FrequentistCalculator.

Definition at line 77 of file HypoTestCalculatorGeneric.h.

◆ PreAltHook()

int HybridCalculator::PreAltHook ( RooArgSet * ,
double obsTestStat ) const
overrideprotectedvirtual

configure TestStatSampler for the Alt run

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 102 of file HybridCalculator.cxx.

◆ PreHook()

virtual void RooStats::HypoTestCalculatorGeneric::PreHook ( ) const
inlineprotectedvirtualinherited

Reimplemented in RooStats::FrequentistCalculator.

Definition at line 76 of file HypoTestCalculatorGeneric.h.

◆ PreNullHook()

int HybridCalculator::PreNullHook ( RooArgSet * ,
double obsTestStat ) const
overrideprotectedvirtual

configure TestStatSampler for the Null run

Reimplemented from RooStats::HypoTestCalculatorGeneric.

Definition at line 52 of file HybridCalculator.cxx.

◆ SetAdaptiveLimits()

void RooStats::HypoTestCalculatorGeneric::SetAdaptiveLimits ( double obsTestStat,
bool forNull ) const
privateinherited

◆ SetAlternateModel()

void RooStats::HybridCalculator::SetAlternateModel ( const ModelConfig & model)
inlineoverridevirtual

Set the model for the alternate hypothesis.

Implements RooStats::HypoTestCalculator.

Definition at line 66 of file HybridCalculator.h.

◆ SetCommonModel()

virtual void RooStats::HypoTestCalculator::SetCommonModel ( const ModelConfig & model)
inlinevirtualinherited

Set a common model for both the null and alternate, add to the workspace if not already there.

Definition at line 70 of file HypoTestCalculator.h.

◆ SetData()

void RooStats::HypoTestCalculatorGeneric::SetData ( RooAbsData & data)
inlineoverridevirtualinherited

Set the DataSet.

Implements RooStats::HypoTestCalculator.

Definition at line 59 of file HypoTestCalculatorGeneric.h.

◆ SetNToysInTails()

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

set least number of toys in tails

Definition at line 77 of file HybridCalculator.h.

◆ SetNullModel()

void RooStats::HybridCalculator::SetNullModel ( const ModelConfig & model)
inlineoverridevirtual

Set the model for the null hypothesis.

Implements RooStats::HypoTestCalculator.

Definition at line 59 of file HybridCalculator.h.

◆ SetToys()

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

set number of toys

Definition at line 74 of file HybridCalculator.h.

◆ SetupSampler()

void HypoTestCalculatorGeneric::SetupSampler ( const ModelConfig & model) const
privateinherited

common setup for both models

Definition at line 88 of file HypoTestCalculatorGeneric.cxx.

◆ Streamer()

void RooStats::HybridCalculator::Streamer ( TBuffer & )
overridevirtual

Reimplemented from RooStats::HypoTestCalculator.

◆ StreamerNVirtual()

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

Definition at line 107 of file HybridCalculator.h.

◆ UseSameAltToys()

void HypoTestCalculatorGeneric::UseSameAltToys ( )
inherited

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.

to re-use same toys for alternate hypothesis

Definition at line 276 of file HypoTestCalculatorGeneric.cxx.

Member Data Documentation

◆ fAltModel

const ModelConfig* RooStats::HypoTestCalculatorGeneric::fAltModel
protectedinherited

Definition at line 80 of file HypoTestCalculatorGeneric.h.

◆ fAltToysSeed

unsigned int RooStats::HypoTestCalculatorGeneric::fAltToysSeed
protectedinherited

Definition at line 87 of file HypoTestCalculatorGeneric.h.

◆ fData

const RooAbsData* RooStats::HypoTestCalculatorGeneric::fData
protectedinherited

Definition at line 82 of file HypoTestCalculatorGeneric.h.

◆ fDefaultSampler

TestStatSampler* RooStats::HypoTestCalculatorGeneric::fDefaultSampler
protectedinherited

Definition at line 84 of file HypoTestCalculatorGeneric.h.

◆ fDefaultTestStat

TestStatistic* RooStats::HypoTestCalculatorGeneric::fDefaultTestStat
protectedinherited

Definition at line 85 of file HypoTestCalculatorGeneric.h.

◆ fNToysAlt

int RooStats::HybridCalculator::fNToysAlt
protected

Definition at line 100 of file HybridCalculator.h.

◆ fNToysAltTail

int RooStats::HybridCalculator::fNToysAltTail
protected

Definition at line 104 of file HybridCalculator.h.

◆ fNToysNull

int RooStats::HybridCalculator::fNToysNull
protected

Definition at line 99 of file HybridCalculator.h.

◆ fNToysNullTail

int RooStats::HybridCalculator::fNToysNullTail
protected

Definition at line 103 of file HybridCalculator.h.

◆ fNullModel

const ModelConfig* RooStats::HypoTestCalculatorGeneric::fNullModel
protectedinherited

Definition at line 81 of file HypoTestCalculatorGeneric.h.

◆ fPriorNuisanceAlt

RooAbsPdf* RooStats::HybridCalculator::fPriorNuisanceAlt
protected

Definition at line 91 of file HybridCalculator.h.

◆ fPriorNuisanceAltExternal

bool RooStats::HybridCalculator::fPriorNuisanceAltExternal = false
protected

Definition at line 96 of file HybridCalculator.h.

◆ fPriorNuisanceNull

RooAbsPdf* RooStats::HybridCalculator::fPriorNuisanceNull
protected

Definition at line 90 of file HybridCalculator.h.

◆ fPriorNuisanceNullExternal

bool RooStats::HybridCalculator::fPriorNuisanceNullExternal = false
protected

Definition at line 95 of file HybridCalculator.h.

◆ fTestStatSampler

TestStatSampler* RooStats::HypoTestCalculatorGeneric::fTestStatSampler
protectedinherited

Definition at line 83 of file HypoTestCalculatorGeneric.h.

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