Logo ROOT  
Reference Guide
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 ()
 Constructor for proof. Do not use. More...
 
 SimpleLikelihoodRatioTestStat (RooAbsPdf &nullPdf, RooAbsPdf &altPdf)
 Takes null and alternate parameters from PDF. Can be overridden. More...
 
 SimpleLikelihoodRatioTestStat (RooAbsPdf &nullPdf, RooAbsPdf &altPdf, const RooArgSet &nullParameters, const RooArgSet &altParameters)
 Takes null and alternate parameters from values in nullParameters and altParameters. More...
 
 ~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. More...
 
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. More...
 
const TString GetVarName () const override
 
TClassIsA () const override
 
bool ParamsAreEqual ()
 this should be possible with RooAbsCollection More...
 
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 More...
 
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 More...
 
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 double Evaluate (RooAbsData &data, RooArgSet &nullPOI)=0
 Main interface to evaluate the test statistic on a dataset given the values for the Null Parameters Of Interest. More...
 
virtual const RooArgSetGetDetailedOutput () const
 return detailed output: for fits this can be pulls, processing time, ... The returned pointer will not loose validity until another call to Evaluate. More...
 
virtual const TString GetVarName () const =0
 
virtual TClassIsA () const
 
virtual bool PValueIsRightTail (void) const
 Defines the sign convention of the test statistic. Overwrite function if necessary. More...
 
virtual void SetConditionalObservables (const RooArgSet &)
 interface to set conditional observables. If a test statistics needs them it will re-implement this function More...
 
virtual void SetGlobalObservables (const RooArgSet &)
 interface to set global observables. If a test statistics needs them it will re-implement this function 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 void SetAlwaysReuseNLL (bool flag)
 
- Static Public Member Functions inherited from RooStats::TestStatistic
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 

Private Attributes

RooArgSetfAltParameters
 
RooAbsPdffAltPdf
 
RooArgSet fConditionalObs
 
RooArgSetfDetailedOutput
 ! More...
 
bool fDetailedOutputEnabled
 
bool fFirstEval
 
RooArgSet fGlobalObs
 
RooAbsRealfNllAlt
 ! transient copy of the alt NLL More...
 
RooAbsRealfNllNull
 ! transient copy of the null NLL More...
 
RooArgSetfNullParameters
 
RooAbsPdffNullPdf
 
bool fReuseNll
 

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 ( )
inline

Constructor for proof. Do not use.

Definition at line 28 of file SimpleLikelihoodRatioTestStat.h.

◆ SimpleLikelihoodRatioTestStat() [2/3]

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

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

Definition at line 42 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 69 of file SimpleLikelihoodRatioTestStat.h.

◆ ~SimpleLikelihoodRatioTestStat()

RooStats::SimpleLikelihoodRatioTestStat::~SimpleLikelihoodRatioTestStat ( )
inlineoverride

Definition at line 91 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 Version_t RooStats::SimpleLikelihoodRatioTestStat::Class_Version ( )
inlinestatic
Returns
Version of this class

Definition at line 170 of file SimpleLikelihoodRatioTestStat.h.

◆ DeclFileName()

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

Definition at line 170 of file SimpleLikelihoodRatioTestStat.h.

◆ EnableDetailedOutput()

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

Definition at line 143 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 144 of file SimpleLikelihoodRatioTestStat.h.

◆ GetVarName()

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

Implements RooStats::TestStatistic.

Definition at line 146 of file SimpleLikelihoodRatioTestStat.h.

◆ IsA()

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

Reimplemented from RooStats::TestStatistic.

Definition at line 170 of file SimpleLikelihoodRatioTestStat.h.

◆ ParamsAreEqual()

bool RooStats::SimpleLikelihoodRatioTestStat::ParamsAreEqual ( )
inline

this should be possible with RooAbsCollection

Definition at line 116 of file SimpleLikelihoodRatioTestStat.h.

◆ SetAltParameters()

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

Definition at line 109 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 135 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 139 of file SimpleLikelihoodRatioTestStat.h.

◆ SetNullParameters()

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

Definition at line 103 of file SimpleLikelihoodRatioTestStat.h.

◆ SetReuseNLL()

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

Definition at line 101 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 170 of file SimpleLikelihoodRatioTestStat.h.

Member Data Documentation

◆ fAltParameters

RooArgSet* RooStats::SimpleLikelihoodRatioTestStat::fAltParameters
private

Definition at line 155 of file SimpleLikelihoodRatioTestStat.h.

◆ fAltPdf

RooAbsPdf* RooStats::SimpleLikelihoodRatioTestStat::fAltPdf
private

Definition at line 153 of file SimpleLikelihoodRatioTestStat.h.

◆ fConditionalObs

RooArgSet RooStats::SimpleLikelihoodRatioTestStat::fConditionalObs
private

Definition at line 156 of file SimpleLikelihoodRatioTestStat.h.

◆ fDetailedOutput

RooArgSet* RooStats::SimpleLikelihoodRatioTestStat::fDetailedOutput
private

!

Definition at line 161 of file SimpleLikelihoodRatioTestStat.h.

◆ fDetailedOutputEnabled

bool RooStats::SimpleLikelihoodRatioTestStat::fDetailedOutputEnabled
private

Definition at line 160 of file SimpleLikelihoodRatioTestStat.h.

◆ fFirstEval

bool RooStats::SimpleLikelihoodRatioTestStat::fFirstEval
private

Definition at line 158 of file SimpleLikelihoodRatioTestStat.h.

◆ fgAlwaysReuseNll

bool RooStats::SimpleLikelihoodRatioTestStat::fgAlwaysReuseNll = true
staticprivate

Definition at line 165 of file SimpleLikelihoodRatioTestStat.h.

◆ fGlobalObs

RooArgSet RooStats::SimpleLikelihoodRatioTestStat::fGlobalObs
private

Definition at line 157 of file SimpleLikelihoodRatioTestStat.h.

◆ fNllAlt

RooAbsReal* RooStats::SimpleLikelihoodRatioTestStat::fNllAlt
private

! transient copy of the alt NLL

Definition at line 164 of file SimpleLikelihoodRatioTestStat.h.

◆ fNllNull

RooAbsReal* RooStats::SimpleLikelihoodRatioTestStat::fNllNull
private

! transient copy of the null NLL

Definition at line 163 of file SimpleLikelihoodRatioTestStat.h.

◆ fNullParameters

RooArgSet* RooStats::SimpleLikelihoodRatioTestStat::fNullParameters
private

Definition at line 154 of file SimpleLikelihoodRatioTestStat.h.

◆ fNullPdf

RooAbsPdf* RooStats::SimpleLikelihoodRatioTestStat::fNullPdf
private

Definition at line 152 of file SimpleLikelihoodRatioTestStat.h.

◆ fReuseNll

bool RooStats::SimpleLikelihoodRatioTestStat::fReuseNll
private

Definition at line 166 of file SimpleLikelihoodRatioTestStat.h.

Libraries for RooStats::SimpleLikelihoodRatioTestStat:
[legend]

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