Logo ROOT  
Reference Guide
RooStats::ProfileLikelihoodTestStat Class Reference

ProfileLikelihoodTestStat is an implementation of the TestStatistic interface that calculates the profile likelihood ratio at a particular parameter point given a dataset.

It does not constitute a statistical test, for that one may either use:

Definition at line 32 of file ProfileLikelihoodTestStat.h.

Public Member Functions

 ProfileLikelihoodTestStat ()
 
 ProfileLikelihoodTestStat (RooAbsPdf &pdf)
 
virtual ~ProfileLikelihoodTestStat ()
 
virtual void EnableDetailedOutput (bool e=true, bool withErrorsAndPulls=false)
 
virtual Double_t Evaluate (RooAbsData &data, RooArgSet &paramsOfInterest)
 Main interface to evaluate the test statistic on a dataset given the values for the Null Parameters Of Interest. More...
 
virtual Double_t EvaluateProfileLikelihood (int type, RooAbsData &data, RooArgSet &paramsOfInterest)
 internal function to evaluate test statistics can do depending on type: More...
 
virtual const RooArgSetGetDetailedOutput (void) 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 RooAbsPdfGetPdf () const
 
virtual const TString GetVarName () const
 
bool IsOneSidedDiscovery () const
 
bool IsTwoSided () const
 
virtual void SetConditionalObservables (const RooArgSet &set)
 interface to set conditional observables. If a test statistics needs them it will re-implement this function More...
 
virtual void SetGlobalObservables (const RooArgSet &set)
 interface to set global observables. If a test statistics needs them it will re-implement this function More...
 
void SetLOffset (Bool_t flag=kTRUE)
 
void SetMinimizer (const char *minimizer)
 
void SetOneSided (Bool_t flag=true)
 
void SetOneSidedDiscovery (Bool_t flag=true)
 
void SetPrintLevel (Int_t printlevel)
 
void SetReuseNLL (Bool_t flag)
 
void SetSigned (Bool_t flag=true)
 
void SetStrategy (Int_t strategy)
 
void SetTolerance (double tol)
 
virtual void SetVarName (const char *name)
 
- 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. More...
 

Static Public Member Functions

static void SetAlwaysReuseNLL (Bool_t flag)
 

Private Types

enum  LimitType { twoSided, oneSided, oneSidedDiscovery }
 

Private Member Functions

RooFitResultGetMinNLL ()
 find minimum of NLL using RooMinimizer More...
 

Private Attributes

const RooArgSetfCachedBestFitParams
 
RooArgSet fConditionalObs
 
RooArgSetfDetailedOutput
 
bool fDetailedOutputEnabled
 
bool fDetailedOutputWithErrorsAndPulls
 
RooArgSet fGlobalObs
 
RooAbsDatafLastData
 
LimitType fLimitType
 
Bool_t fLOffset
 
TString fMinimizer
 
RooAbsRealfNll
 
RooAbsPdffPdf
 
Int_t fPrintLevel
 
Bool_t fReuseNll
 
Bool_t fSigned
 
Int_t fStrategy
 
Double_t fTolerance
 
TString fVarName
 

Static Private Attributes

static Bool_t fgAlwaysReuseNll = kTRUE
 

#include <RooStats/ProfileLikelihoodTestStat.h>

Inheritance diagram for RooStats::ProfileLikelihoodTestStat:
[legend]

Member Enumeration Documentation

◆ LimitType

Enumerator
twoSided 
oneSided 
oneSidedDiscovery 

Definition at line 34 of file ProfileLikelihoodTestStat.h.

Constructor & Destructor Documentation

◆ ProfileLikelihoodTestStat() [1/2]

RooStats::ProfileLikelihoodTestStat::ProfileLikelihoodTestStat ( )
inline

Definition at line 37 of file ProfileLikelihoodTestStat.h.

◆ ProfileLikelihoodTestStat() [2/2]

RooStats::ProfileLikelihoodTestStat::ProfileLikelihoodTestStat ( RooAbsPdf pdf)
inline

Definition at line 58 of file ProfileLikelihoodTestStat.h.

◆ ~ProfileLikelihoodTestStat()

virtual RooStats::ProfileLikelihoodTestStat::~ProfileLikelihoodTestStat ( )
inlinevirtual

Definition at line 79 of file ProfileLikelihoodTestStat.h.

Member Function Documentation

◆ EnableDetailedOutput()

virtual void RooStats::ProfileLikelihoodTestStat::EnableDetailedOutput ( bool  e = true,
bool  withErrorsAndPulls = false 
)
inlinevirtual

Definition at line 113 of file ProfileLikelihoodTestStat.h.

◆ Evaluate()

virtual Double_t RooStats::ProfileLikelihoodTestStat::Evaluate ( RooAbsData data,
RooArgSet nullPOI 
)
inlinevirtual

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 106 of file ProfileLikelihoodTestStat.h.

◆ EvaluateProfileLikelihood()

Double_t RooStats::ProfileLikelihoodTestStat::EvaluateProfileLikelihood ( int  type,
RooAbsData data,
RooArgSet paramsOfInterest 
)
virtual

internal function to evaluate test statistics can do depending on type:

  • type = 0 standard evaluation,
  • type = 1 find only unconditional NLL minimum,
  • type = 2 conditional MLL

Definition at line 56 of file ProfileLikelihoodTestStat.cxx.

◆ GetDetailedOutput()

virtual const RooArgSet* RooStats::ProfileLikelihoodTestStat::GetDetailedOutput ( void  ) const
inlinevirtual

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 119 of file ProfileLikelihoodTestStat.h.

◆ GetMinNLL()

RooFitResult * RooStats::ProfileLikelihoodTestStat::GetMinNLL ( )
private

find minimum of NLL using RooMinimizer

Definition at line 300 of file ProfileLikelihoodTestStat.cxx.

◆ GetPdf()

virtual RooAbsPdf* RooStats::ProfileLikelihoodTestStat::GetPdf ( ) const
inlinevirtual

Definition at line 140 of file ProfileLikelihoodTestStat.h.

◆ GetVarName()

virtual const TString RooStats::ProfileLikelihoodTestStat::GetVarName ( ) const
inlinevirtual

Implements RooStats::TestStatistic.

Definition at line 138 of file ProfileLikelihoodTestStat.h.

◆ IsOneSidedDiscovery()

bool RooStats::ProfileLikelihoodTestStat::IsOneSidedDiscovery ( ) const
inline

Definition at line 93 of file ProfileLikelihoodTestStat.h.

◆ IsTwoSided()

bool RooStats::ProfileLikelihoodTestStat::IsTwoSided ( ) const
inline

Definition at line 92 of file ProfileLikelihoodTestStat.h.

◆ SetAlwaysReuseNLL()

void RooStats::ProfileLikelihoodTestStat::SetAlwaysReuseNLL ( Bool_t  flag)
static

Definition at line 47 of file ProfileLikelihoodTestStat.cxx.

◆ SetConditionalObservables()

virtual void RooStats::ProfileLikelihoodTestStat::SetConditionalObservables ( const RooArgSet )
inlinevirtual

interface to set conditional observables. If a test statistics needs them it will re-implement this function

Reimplemented from RooStats::TestStatistic.

Definition at line 131 of file ProfileLikelihoodTestStat.h.

◆ SetGlobalObservables()

virtual void RooStats::ProfileLikelihoodTestStat::SetGlobalObservables ( const RooArgSet )
inlinevirtual

interface to set global observables. If a test statistics needs them it will re-implement this function

Reimplemented from RooStats::TestStatistic.

Definition at line 135 of file ProfileLikelihoodTestStat.h.

◆ SetLOffset()

void RooStats::ProfileLikelihoodTestStat::SetLOffset ( Bool_t  flag = kTRUE)
inline

Definition at line 98 of file ProfileLikelihoodTestStat.h.

◆ SetMinimizer()

void RooStats::ProfileLikelihoodTestStat::SetMinimizer ( const char *  minimizer)
inline

Definition at line 100 of file ProfileLikelihoodTestStat.h.

◆ SetOneSided()

void RooStats::ProfileLikelihoodTestStat::SetOneSided ( Bool_t  flag = true)
inline

Definition at line 87 of file ProfileLikelihoodTestStat.h.

◆ SetOneSidedDiscovery()

void RooStats::ProfileLikelihoodTestStat::SetOneSidedDiscovery ( Bool_t  flag = true)
inline

Definition at line 88 of file ProfileLikelihoodTestStat.h.

◆ SetPrintLevel()

void RooStats::ProfileLikelihoodTestStat::SetPrintLevel ( Int_t  printlevel)
inline

Definition at line 103 of file ProfileLikelihoodTestStat.h.

◆ SetReuseNLL()

void RooStats::ProfileLikelihoodTestStat::SetReuseNLL ( Bool_t  flag)
inline

Definition at line 97 of file ProfileLikelihoodTestStat.h.

◆ SetSigned()

void RooStats::ProfileLikelihoodTestStat::SetSigned ( Bool_t  flag = true)
inline

Definition at line 89 of file ProfileLikelihoodTestStat.h.

◆ SetStrategy()

void RooStats::ProfileLikelihoodTestStat::SetStrategy ( Int_t  strategy)
inline

Definition at line 101 of file ProfileLikelihoodTestStat.h.

◆ SetTolerance()

void RooStats::ProfileLikelihoodTestStat::SetTolerance ( double  tol)
inline

Definition at line 102 of file ProfileLikelihoodTestStat.h.

◆ SetVarName()

virtual void RooStats::ProfileLikelihoodTestStat::SetVarName ( const char *  name)
inlinevirtual

Definition at line 137 of file ProfileLikelihoodTestStat.h.

Member Data Documentation

◆ fCachedBestFitParams

const RooArgSet* RooStats::ProfileLikelihoodTestStat::fCachedBestFitParams
private

Definition at line 153 of file ProfileLikelihoodTestStat.h.

◆ fConditionalObs

RooArgSet RooStats::ProfileLikelihoodTestStat::fConditionalObs
private

Definition at line 164 of file ProfileLikelihoodTestStat.h.

◆ fDetailedOutput

RooArgSet* RooStats::ProfileLikelihoodTestStat::fDetailedOutput
private

Definition at line 163 of file ProfileLikelihoodTestStat.h.

◆ fDetailedOutputEnabled

bool RooStats::ProfileLikelihoodTestStat::fDetailedOutputEnabled
private

Definition at line 161 of file ProfileLikelihoodTestStat.h.

◆ fDetailedOutputWithErrorsAndPulls

bool RooStats::ProfileLikelihoodTestStat::fDetailedOutputWithErrorsAndPulls
private

Definition at line 162 of file ProfileLikelihoodTestStat.h.

◆ fgAlwaysReuseNll

Bool_t RooStats::ProfileLikelihoodTestStat::fgAlwaysReuseNll = kTRUE
staticprivate

Definition at line 169 of file ProfileLikelihoodTestStat.h.

◆ fGlobalObs

RooArgSet RooStats::ProfileLikelihoodTestStat::fGlobalObs
private

Definition at line 165 of file ProfileLikelihoodTestStat.h.

◆ fLastData

RooAbsData* RooStats::ProfileLikelihoodTestStat::fLastData
private

Definition at line 154 of file ProfileLikelihoodTestStat.h.

◆ fLimitType

LimitType RooStats::ProfileLikelihoodTestStat::fLimitType
private

Definition at line 156 of file ProfileLikelihoodTestStat.h.

◆ fLOffset

Bool_t RooStats::ProfileLikelihoodTestStat::fLOffset
private

Definition at line 175 of file ProfileLikelihoodTestStat.h.

◆ fMinimizer

TString RooStats::ProfileLikelihoodTestStat::fMinimizer
private

Definition at line 171 of file ProfileLikelihoodTestStat.h.

◆ fNll

RooAbsReal* RooStats::ProfileLikelihoodTestStat::fNll
private

Definition at line 152 of file ProfileLikelihoodTestStat.h.

◆ fPdf

RooAbsPdf* RooStats::ProfileLikelihoodTestStat::fPdf
private

Definition at line 151 of file ProfileLikelihoodTestStat.h.

◆ fPrintLevel

Int_t RooStats::ProfileLikelihoodTestStat::fPrintLevel
private

Definition at line 174 of file ProfileLikelihoodTestStat.h.

◆ fReuseNll

Bool_t RooStats::ProfileLikelihoodTestStat::fReuseNll
private

Definition at line 170 of file ProfileLikelihoodTestStat.h.

◆ fSigned

Bool_t RooStats::ProfileLikelihoodTestStat::fSigned
private

Definition at line 157 of file ProfileLikelihoodTestStat.h.

◆ fStrategy

Int_t RooStats::ProfileLikelihoodTestStat::fStrategy
private

Definition at line 172 of file ProfileLikelihoodTestStat.h.

◆ fTolerance

Double_t RooStats::ProfileLikelihoodTestStat::fTolerance
private

Definition at line 173 of file ProfileLikelihoodTestStat.h.

◆ fVarName

TString RooStats::ProfileLikelihoodTestStat::fVarName
private

Definition at line 167 of file ProfileLikelihoodTestStat.h.

Libraries for RooStats::ProfileLikelihoodTestStat:
[legend]

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