Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooStats::SimpleLikelihoodRatioTestStat Class Reference

TestStatistic class that returns -log(L[null] / L[alt]) where L is the likelihood.

It is often called as the LEP Test statistic.

Definition at line 23 of file SimpleLikelihoodRatioTestStat.h.

Public Member Functions

 SimpleLikelihoodRatioTestStat ()=default
 Constructor for proof. Do not use.
 
 SimpleLikelihoodRatioTestStat (RooAbsPdf &nullPdf, RooAbsPdf &altPdf)
 Takes null and alternate parameters from PDF. Can be overridden.
 
 SimpleLikelihoodRatioTestStat (RooAbsPdf &nullPdf, RooAbsPdf &altPdf, const RooArgSet &nullParameters, const RooArgSet &altParameters)
 Takes null and alternate parameters from values in nullParameters and altParameters.
 
 ~SimpleLikelihoodRatioTestStat () override
 
virtual void EnableDetailedOutput (bool e=true)
 
double Evaluate (RooAbsData &data, RooArgSet &nullPOI) override
 Main interface to evaluate the test statistic on a dataset given the values for the Null Parameters Of Interest.
 
const RooArgSetGetDetailedOutput (void) const override
 return detailed output: for fits this can be pulls, processing time, ... The returned pointer will not loose validity until another call to Evaluate.
 
const TString GetVarName () const override
 
TClassIsA () const override
 
bool ParamsAreEqual ()
 this should be possible with RooAbsCollection
 
void SetAltParameters (const RooArgSet &altParameters)
 
void SetConditionalObservables (const RooArgSet &set) override
 set the conditional observables which will be used when creating the NLL so the pdf's will not be normalized on the conditional observables when computing the NLL
 
void SetGlobalObservables (const RooArgSet &set) override
 set the global observables which will be used when creating the NLL so the constraint pdf's will be normalized correctly on the global observables when computing the NLL
 
void SetNullParameters (const RooArgSet &nullParameters)
 
void SetReuseNLL (bool flag)
 
void Streamer (TBuffer &) override
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from RooStats::TestStatistic
virtual ~TestStatistic ()
 
virtual bool PValueIsRightTail (void) const
 Defines the sign convention of the test statistic. Overwrite function if necessary.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static void SetAlwaysReuseNLL (bool flag)
 
- Static Public Member Functions inherited from RooStats::TestStatistic
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 

Private Attributes

RooArgSetfAltParameters = nullptr
 
RooAbsPdffAltPdf = nullptr
 
RooArgSet fConditionalObs
 
std::unique_ptr< RooArgSetfDetailedOutput
 !
 
bool fDetailedOutputEnabled = false
 
bool fFirstEval = true
 
RooArgSet fGlobalObs
 
std::unique_ptr< RooAbsRealfNllAlt
 ! transient copy of the alt NLL
 
std::unique_ptr< RooAbsRealfNllNull
 ! transient copy of the null NLL
 
RooArgSetfNullParameters = nullptr
 
RooAbsPdffNullPdf = nullptr
 
bool fReuseNll = false
 

Static Private Attributes

static bool fgAlwaysReuseNll = true
 

#include <RooStats/SimpleLikelihoodRatioTestStat.h>

Inheritance diagram for RooStats::SimpleLikelihoodRatioTestStat:
[legend]

Constructor & Destructor Documentation

◆ SimpleLikelihoodRatioTestStat() [1/3]

RooStats::SimpleLikelihoodRatioTestStat::SimpleLikelihoodRatioTestStat ( )
default

Constructor for proof. Do not use.

◆ SimpleLikelihoodRatioTestStat() [2/3]

RooStats::SimpleLikelihoodRatioTestStat::SimpleLikelihoodRatioTestStat ( RooAbsPdf nullPdf,
RooAbsPdf altPdf 
)
inline

Takes null and alternate parameters from PDF. Can be overridden.

Definition at line 31 of file SimpleLikelihoodRatioTestStat.h.

◆ SimpleLikelihoodRatioTestStat() [3/3]

RooStats::SimpleLikelihoodRatioTestStat::SimpleLikelihoodRatioTestStat ( RooAbsPdf nullPdf,
RooAbsPdf altPdf,
const RooArgSet nullParameters,
const RooArgSet altParameters 
)
inline

Takes null and alternate parameters from values in nullParameters and altParameters.

Can be overridden.

Definition at line 44 of file SimpleLikelihoodRatioTestStat.h.

◆ ~SimpleLikelihoodRatioTestStat()

RooStats::SimpleLikelihoodRatioTestStat::~SimpleLikelihoodRatioTestStat ( )
inlineoverride

Definition at line 53 of file SimpleLikelihoodRatioTestStat.h.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 128 of file SimpleLikelihoodRatioTestStat.h.

◆ DeclFileName()

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

Definition at line 128 of file SimpleLikelihoodRatioTestStat.h.

◆ EnableDetailedOutput()

virtual void RooStats::SimpleLikelihoodRatioTestStat::EnableDetailedOutput ( bool  e = true)
inlinevirtual

Definition at line 102 of file SimpleLikelihoodRatioTestStat.h.

◆ Evaluate()

double RooStats::SimpleLikelihoodRatioTestStat::Evaluate ( RooAbsData data,
RooArgSet nullPOI 
)
overridevirtual

Main interface to evaluate the test statistic on a dataset given the values for the Null Parameters Of Interest.

Implements RooStats::TestStatistic.

Definition at line 30 of file SimpleLikelihoodRatioTestStat.cxx.

◆ GetDetailedOutput()

const RooArgSet * RooStats::SimpleLikelihoodRatioTestStat::GetDetailedOutput ( void  ) const
inlineoverridevirtual

return detailed output: for fits this can be pulls, processing time, ... The returned pointer will not loose validity until another call to Evaluate.

Reimplemented from RooStats::TestStatistic.

Definition at line 103 of file SimpleLikelihoodRatioTestStat.h.

◆ GetVarName()

const TString RooStats::SimpleLikelihoodRatioTestStat::GetVarName ( ) const
inlineoverridevirtual

Implements RooStats::TestStatistic.

Definition at line 105 of file SimpleLikelihoodRatioTestStat.h.

◆ IsA()

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

Reimplemented from RooStats::TestStatistic.

Definition at line 128 of file SimpleLikelihoodRatioTestStat.h.

◆ ParamsAreEqual()

bool RooStats::SimpleLikelihoodRatioTestStat::ParamsAreEqual ( )
inline

this should be possible with RooAbsCollection

Definition at line 75 of file SimpleLikelihoodRatioTestStat.h.

◆ SetAltParameters()

void RooStats::SimpleLikelihoodRatioTestStat::SetAltParameters ( const RooArgSet altParameters)
inline

Definition at line 68 of file SimpleLikelihoodRatioTestStat.h.

◆ SetAlwaysReuseNLL()

void RooStats::SimpleLikelihoodRatioTestStat::SetAlwaysReuseNLL ( bool  flag)
static

Definition at line 28 of file SimpleLikelihoodRatioTestStat.cxx.

◆ SetConditionalObservables()

void RooStats::SimpleLikelihoodRatioTestStat::SetConditionalObservables ( const RooArgSet set)
inlineoverridevirtual

set the conditional observables which will be used when creating the NLL so the pdf's will not be normalized on the conditional observables when computing the NLL

Reimplemented from RooStats::TestStatistic.

Definition at line 94 of file SimpleLikelihoodRatioTestStat.h.

◆ SetGlobalObservables()

void RooStats::SimpleLikelihoodRatioTestStat::SetGlobalObservables ( const RooArgSet set)
inlineoverridevirtual

set the global observables which will be used when creating the NLL so the constraint pdf's will be normalized correctly on the global observables when computing the NLL

Reimplemented from RooStats::TestStatistic.

Definition at line 98 of file SimpleLikelihoodRatioTestStat.h.

◆ SetNullParameters()

void RooStats::SimpleLikelihoodRatioTestStat::SetNullParameters ( const RooArgSet nullParameters)
inline

Definition at line 62 of file SimpleLikelihoodRatioTestStat.h.

◆ SetReuseNLL()

void RooStats::SimpleLikelihoodRatioTestStat::SetReuseNLL ( bool  flag)
inline

Definition at line 60 of file SimpleLikelihoodRatioTestStat.h.

◆ Streamer()

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

Reimplemented from RooStats::TestStatistic.

◆ StreamerNVirtual()

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

Definition at line 128 of file SimpleLikelihoodRatioTestStat.h.

Member Data Documentation

◆ fAltParameters

RooArgSet* RooStats::SimpleLikelihoodRatioTestStat::fAltParameters = nullptr
private

Definition at line 114 of file SimpleLikelihoodRatioTestStat.h.

◆ fAltPdf

RooAbsPdf* RooStats::SimpleLikelihoodRatioTestStat::fAltPdf = nullptr
private

Definition at line 112 of file SimpleLikelihoodRatioTestStat.h.

◆ fConditionalObs

RooArgSet RooStats::SimpleLikelihoodRatioTestStat::fConditionalObs
private

Definition at line 115 of file SimpleLikelihoodRatioTestStat.h.

◆ fDetailedOutput

std::unique_ptr<RooArgSet> RooStats::SimpleLikelihoodRatioTestStat::fDetailedOutput
private

!

Definition at line 120 of file SimpleLikelihoodRatioTestStat.h.

◆ fDetailedOutputEnabled

bool RooStats::SimpleLikelihoodRatioTestStat::fDetailedOutputEnabled = false
private

Definition at line 119 of file SimpleLikelihoodRatioTestStat.h.

◆ fFirstEval

bool RooStats::SimpleLikelihoodRatioTestStat::fFirstEval = true
private

Definition at line 117 of file SimpleLikelihoodRatioTestStat.h.

◆ fgAlwaysReuseNll

bool RooStats::SimpleLikelihoodRatioTestStat::fgAlwaysReuseNll = true
staticprivate

Definition at line 124 of file SimpleLikelihoodRatioTestStat.h.

◆ fGlobalObs

RooArgSet RooStats::SimpleLikelihoodRatioTestStat::fGlobalObs
private

Definition at line 116 of file SimpleLikelihoodRatioTestStat.h.

◆ fNllAlt

std::unique_ptr<RooAbsReal> RooStats::SimpleLikelihoodRatioTestStat::fNllAlt
private

! transient copy of the alt NLL

Definition at line 123 of file SimpleLikelihoodRatioTestStat.h.

◆ fNllNull

std::unique_ptr<RooAbsReal> RooStats::SimpleLikelihoodRatioTestStat::fNllNull
private

! transient copy of the null NLL

Definition at line 122 of file SimpleLikelihoodRatioTestStat.h.

◆ fNullParameters

RooArgSet* RooStats::SimpleLikelihoodRatioTestStat::fNullParameters = nullptr
private

Definition at line 113 of file SimpleLikelihoodRatioTestStat.h.

◆ fNullPdf

RooAbsPdf* RooStats::SimpleLikelihoodRatioTestStat::fNullPdf = nullptr
private

Definition at line 111 of file SimpleLikelihoodRatioTestStat.h.

◆ fReuseNll

bool RooStats::SimpleLikelihoodRatioTestStat::fReuseNll = false
private

Definition at line 125 of file SimpleLikelihoodRatioTestStat.h.

Libraries for RooStats::SimpleLikelihoodRatioTestStat:

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