RooStats::LikelihoodInterval Class Reference

#include <LikelihoodInterval.h>

Inheritance diagram for RooStats::LikelihoodInterval:

List of all members.

Public Member Functions
	LikelihoodInterval (const char *name=0)
	LikelihoodInterval (const char *name, RooAbsReal *, const RooArgSet *, RooArgSet *=0)
virtual	~LikelihoodInterval ()
virtual Bool_t	IsInInterval (const RooArgSet &) const
virtual void	SetConfidenceLevel (Double_t cl)
virtual Double_t	ConfidenceLevel () const
virtual RooArgSet *	GetParameters () const
Bool_t	CheckParameters (const RooArgSet &) const
Double_t	LowerLimit (const RooRealVar &param)
Double_t	LowerLimit (const RooRealVar &param, bool &status)
Double_t	UpperLimit (const RooRealVar &param)
Double_t	UpperLimit (const RooRealVar &param, bool &status)
Bool_t	FindLimits (const RooRealVar &param, double &lower, double &upper)
Int_t	GetContourPoints (const RooRealVar &paramX, const RooRealVar &paramY, Double_t *x, Double_t *y, Int_t npoints=30)
RooAbsReal *	GetLikelihoodRatio ()
const RooArgSet *	GetBestFitParameters () const
	LikelihoodInterval (const char *name=0)
	LikelihoodInterval (const char *name, RooAbsReal *, const RooArgSet *, RooArgSet *=0)
virtual	~LikelihoodInterval ()
virtual Bool_t	IsInInterval (const RooArgSet &) const
virtual void	SetConfidenceLevel (Double_t cl)
virtual Double_t	ConfidenceLevel () const
virtual RooArgSet *	GetParameters () const
Bool_t	CheckParameters (const RooArgSet &) const
Double_t	LowerLimit (const RooRealVar &param)
Double_t	LowerLimit (const RooRealVar &param, bool &status)
Double_t	UpperLimit (const RooRealVar &param)
Double_t	UpperLimit (const RooRealVar &param, bool &status)
Bool_t	FindLimits (const RooRealVar &param, double &lower, double &upper)
Int_t	GetContourPoints (const RooRealVar &paramX, const RooRealVar &paramY, Double_t *x, Double_t *y, Int_t npoints=30)
RooAbsReal *	GetLikelihoodRatio ()
const RooArgSet *	GetBestFitParameters () const
Protected Member Functions
void	ResetLimits ()
bool	CreateMinimizer ()
void	ResetLimits ()
bool	CreateMinimizer ()
Private Attributes
RooArgSet	fParameters
RooArgSet *	fBestFitParams
RooAbsReal *	fLikelihoodRatio
Double_t	fConfidenceLevel
std::map< std::string, double >	fLowerLimits
std::map< std::string, double >	fUpperLimits
std::auto_ptr< ROOT::Math::Minimizer >	fMinimizer
std::auto_ptr< RooFunctor >	fFunctor
	transient pointer to minimizer class used to find limits and contour
std::auto_ptr< ROOT::Math::IMultiGenFunction >	fMinFunc
	transient pointer to functor class used by the minimizer
RooArgSet *	fBestFitParams
RooAbsReal *	fLikelihoodRatio
std::map< std::string, double >	fLowerLimits
std::map< std::string, double >	fUpperLimits
std::auto_ptr< ROOT::Math::Minimizer >	fMinimizer
std::auto_ptr< RooFunctor >	fFunctor
	transient pointer to minimizer class used to find limits and contour
std::auto_ptr< ROOT::Math::IMultiGenFunction >	fMinFunc
	transient pointer to functor class used by the minimizer

---

Detailed Description

Definition at line 41 of file LikelihoodInterval.h.

---

Constructor & Destructor Documentation

LikelihoodInterval::LikelihoodInterval

(

const char *

name = 0

)

[explicit]

Definition at line 87 of file LikelihoodInterval.cxx.

LikelihoodInterval::LikelihoodInterval	(	const char *	name,
		RooAbsReal *	,
		const RooArgSet *	,
		RooArgSet *	= 0
	)

construct the interval from a Profile Likelihood object, parameter of interest and optionally a snapshot of POI with their best fit values

Definition at line 94 of file LikelihoodInterval.cxx.

LikelihoodInterval::~LikelihoodInterval

(

)

[virtual]

Definition at line 107 of file LikelihoodInterval.cxx.

References fBestFitParams, and fLikelihoodRatio.

RooStats::LikelihoodInterval::LikelihoodInterval

(

const char *

name = 0

)

[explicit]

RooStats::LikelihoodInterval::LikelihoodInterval	(	const char *	name,
		RooAbsReal *	,
		const RooArgSet *	,
		RooArgSet *	= 0
	)

construct the interval from a Profile Likelihood object, parameter of interest and optionally a snapshot of POI with their best fit values

virtual RooStats::LikelihoodInterval::~LikelihoodInterval

(

)

[virtual]

---

Member Function Documentation

Bool_t LikelihoodInterval::IsInInterval

(

const RooArgSet &

)

const [virtual]

Implements RooStats::ConfInterval.

Definition at line 116 of file LikelihoodInterval.cxx.

References RooFit::FATAL, fConfidenceLevel, fLikelihoodRatio, RooAbsCollection::getSize(), RooAbsReal::getVal(), RooAbsArg::getVariables(), RooMsgService::globalKillBelow(), RooMsgService::instance(), TMath::Prob(), RooMsgService::setGlobalKillBelow(), and RooStats::SetParameters().

Referenced by IntervalExamples().

virtual void RooStats::LikelihoodInterval::SetConfidenceLevel

(

Double_t

cl

)

[inline, virtual]

Implements RooStats::ConfInterval.

Definition at line 59 of file LikelihoodInterval.h.

References fConfidenceLevel, and ResetLimits().

Referenced by RooStats::ProfileLikelihoodCalculator::GetInterval().

virtual Double_t RooStats::LikelihoodInterval::ConfidenceLevel

(

)

const [inline, virtual]

Implements RooStats::ConfInterval.

Definition at line 62 of file LikelihoodInterval.h.

References fConfidenceLevel.

Referenced by RooStats::LikelihoodIntervalPlot::Draw(), FindLimits(), and GetContourPoints().

RooArgSet * LikelihoodInterval::GetParameters

(

)

const [virtual]

Implements RooStats::ConfInterval.

Definition at line 165 of file LikelihoodInterval.cxx.

References fParameters.

Referenced by RooStats::LikelihoodIntervalPlot::LikelihoodIntervalPlot(), and RooStats::LikelihoodIntervalPlot::SetLikelihoodInterval().

Bool_t LikelihoodInterval::CheckParameters

(

const RooArgSet &

)

const [virtual]

Implements RooStats::ConfInterval.

Definition at line 172 of file LikelihoodInterval.cxx.

References RooAbsCollection::equals(), fParameters, and RooAbsCollection::getSize().

Double_t RooStats::LikelihoodInterval::LowerLimit

(

const RooRealVar &

param

)

[inline]

Definition at line 72 of file LikelihoodInterval.h.

References ok.

Referenced by RooStats::LikelihoodIntervalPlot::Draw(), FourBinInstructional(), IntervalExamples(), LowerLimit(), and StandardProfileLikelihoodDemo().

Double_t LikelihoodInterval::LowerLimit	(	const RooRealVar &	param,
		bool &	status
	)

Definition at line 190 of file LikelihoodInterval.cxx.

References FindLimits().

Double_t RooStats::LikelihoodInterval::UpperLimit

(

const RooRealVar &

param

)

[inline]

Definition at line 76 of file LikelihoodInterval.h.

References ok.

Referenced by RooStats::LikelihoodIntervalPlot::Draw(), FourBinInstructional(), IntervalExamples(), RooStats::UpperLimitMCSModule::processBetweenGenAndFit(), StandardProfileLikelihoodDemo(), and UpperLimit().

Double_t LikelihoodInterval::UpperLimit	(	const RooRealVar &	param,
		bool &	status
	)

Definition at line 204 of file LikelihoodInterval.cxx.

References FindLimits().

bool LikelihoodInterval::FindLimits	(	const RooRealVar &	param,
		double &	lower,
		double &	upper
	)

Definition at line 293 of file LikelihoodInterval.cxx.

References ccoutE, ccoutW, TMath::ChisquareQuantile(), ConfidenceLevel(), CreateMinimizer(), RooFit::Eval, fLikelihoodRatio, fLowerLimits, fMinimizer, fUpperLimits, RooAbsArg::getVariables(), RooFit::InputArguments, RooFit::Minimization, params, and RooStats::RemoveConstantParameters().

Referenced by LowerLimit(), and UpperLimit().

Int_t LikelihoodInterval::GetContourPoints	(	const RooRealVar &	paramX,
		const RooRealVar &	paramY,
		Double_t *	x,
		Double_t *	y,
		Int_t	npoints = 30
	)

return the 2D-contour points for the given subset of parameters by default make the contour using 30 points. The User has to preallocate the x and y array which will return the set of x and y points defining the contour. The return value of the funciton specify the number of contour point found. In case of error a zero is returned

Definition at line 368 of file LikelihoodInterval.cxx.

References ccoutE, ccoutW, TMath::ChisquareQuantile(), ConfidenceLevel(), CreateMinimizer(), RooFit::Eval, fLikelihoodRatio, fMinimizer, TNamed::GetName(), RooAbsArg::getVariables(), RooFit::InputArguments, RooFit::Minimization, params, and RooStats::RemoveConstantParameters().

Referenced by RooStats::LikelihoodIntervalPlot::Draw().

RooAbsReal* RooStats::LikelihoodInterval::GetLikelihoodRatio

(

)

[inline]

Definition at line 93 of file LikelihoodInterval.h.

References fLikelihoodRatio.

Referenced by RooStats::LikelihoodIntervalPlot::Draw().

const RooArgSet* RooStats::LikelihoodInterval::GetBestFitParameters

(

)

const [inline]

Definition at line 96 of file LikelihoodInterval.h.

References fBestFitParams.

Referenced by RooStats::LikelihoodIntervalPlot::Draw().

void LikelihoodInterval::ResetLimits

(

)

[protected]

Definition at line 218 of file LikelihoodInterval.cxx.

References fLowerLimits, and fUpperLimits.

Referenced by SetConfidenceLevel().

bool LikelihoodInterval::CreateMinimizer

(

)

[protected]

Definition at line 225 of file LikelihoodInterval.cxx.

References ccoutE, ROOT::Math::Factory::CreateMinimizer(), ROOT::Math::MinimizerOptions::DefaultMinimizerType(), fBestFitParams, fFunctor, RooAbsCollection::find(), fLikelihoodRatio, fMinFunc, fMinimizer, RooRealVar::getError(), RooRealVar::getVal(), RooAbsArg::getVariables(), i, RooFit::InputArguments, int, RooFit::Minimization, RooProfileLL::nll(), par, params, and RooStats::RemoveConstantParameters().

Referenced by FindLimits(), and GetContourPoints().

virtual Bool_t RooStats::LikelihoodInterval::IsInInterval

(

const RooArgSet &

)

const [virtual]

Implements RooStats::ConfInterval.

virtual void RooStats::LikelihoodInterval::SetConfidenceLevel

(

Double_t

cl

)

[inline, virtual]

Implements RooStats::ConfInterval.

Definition at line 59 of file LikelihoodInterval.h.

References fConfidenceLevel, and ResetLimits().

virtual Double_t RooStats::LikelihoodInterval::ConfidenceLevel

(

)

const [inline, virtual]

Implements RooStats::ConfInterval.

Definition at line 62 of file LikelihoodInterval.h.

References fConfidenceLevel.

virtual RooArgSet* RooStats::LikelihoodInterval::GetParameters

(

)

const [virtual]

Implements RooStats::ConfInterval.

Bool_t RooStats::LikelihoodInterval::CheckParameters

(

const RooArgSet &

)

const [virtual]

Implements RooStats::ConfInterval.

Double_t RooStats::LikelihoodInterval::LowerLimit

(

const RooRealVar &

param

)

[inline]

Definition at line 72 of file LikelihoodInterval.h.

References LowerLimit(), and ok.

Double_t RooStats::LikelihoodInterval::LowerLimit	(	const RooRealVar &	param,
		bool &	status
	)

Double_t RooStats::LikelihoodInterval::UpperLimit

(

const RooRealVar &

param

)

[inline]

Definition at line 76 of file LikelihoodInterval.h.

References ok, and UpperLimit().

Double_t RooStats::LikelihoodInterval::UpperLimit	(	const RooRealVar &	param,
		bool &	status
	)

Bool_t RooStats::LikelihoodInterval::FindLimits	(	const RooRealVar &	param,
		double &	lower,
		double &	upper
	)

Int_t RooStats::LikelihoodInterval::GetContourPoints	(	const RooRealVar &	paramX,
		const RooRealVar &	paramY,
		Double_t *	x,
		Double_t *	y,
		Int_t	npoints = 30
	)

return the 2D-contour points for the given subset of parameters by default make the contour using 30 points. The User has to preallocate the x and y array which will return the set of x and y points defining the contour. The return value of the funciton specify the number of contour point found. In case of error a zero is returned

RooAbsReal* RooStats::LikelihoodInterval::GetLikelihoodRatio

(

)

[inline]

Definition at line 93 of file LikelihoodInterval.h.

References fLikelihoodRatio.

const RooArgSet* RooStats::LikelihoodInterval::GetBestFitParameters

(

)

const [inline]

Definition at line 96 of file LikelihoodInterval.h.

References fBestFitParams.

void RooStats::LikelihoodInterval::ResetLimits

(

)

[protected]

bool RooStats::LikelihoodInterval::CreateMinimizer

(

)

[protected]

---

Member Data Documentation

RooArgSet RooStats::LikelihoodInterval::fParameters [private]

Definition at line 108 of file LikelihoodInterval.h.

Referenced by CheckParameters(), and GetParameters().

RooArgSet* RooStats::LikelihoodInterval::fBestFitParams [private]

Definition at line 109 of file LikelihoodInterval.h.

Referenced by CreateMinimizer(), GetBestFitParameters(), and ~LikelihoodInterval().

RooAbsReal* RooStats::LikelihoodInterval::fLikelihoodRatio [private]

Definition at line 110 of file LikelihoodInterval.h.

Referenced by CreateMinimizer(), FindLimits(), GetContourPoints(), GetLikelihoodRatio(), IsInInterval(), and ~LikelihoodInterval().

Double_t RooStats::LikelihoodInterval::fConfidenceLevel [private]

Definition at line 111 of file LikelihoodInterval.h.

Referenced by ConfidenceLevel(), IsInInterval(), and SetConfidenceLevel().

std::map<std::string, double> RooStats::LikelihoodInterval::fLowerLimits [private]

Definition at line 112 of file LikelihoodInterval.h.

Referenced by FindLimits(), and ResetLimits().

std::map<std::string, double> RooStats::LikelihoodInterval::fUpperLimits [private]

Definition at line 113 of file LikelihoodInterval.h.

Referenced by FindLimits(), and ResetLimits().

std::auto_ptr<ROOT::Math::Minimizer > RooStats::LikelihoodInterval::fMinimizer [private]

Definition at line 114 of file LikelihoodInterval.h.

Referenced by CreateMinimizer(), FindLimits(), and GetContourPoints().

std::auto_ptr<RooFunctor> RooStats::LikelihoodInterval::fFunctor [private]

transient pointer to minimizer class used to find limits and contour

Definition at line 115 of file LikelihoodInterval.h.

Referenced by CreateMinimizer().

std::auto_ptr<ROOT::Math::IMultiGenFunction> RooStats::LikelihoodInterval::fMinFunc [private]

transient pointer to functor class used by the minimizer

Definition at line 116 of file LikelihoodInterval.h.

Referenced by CreateMinimizer().

RooArgSet* RooStats::LikelihoodInterval::fBestFitParams [private]

Definition at line 109 of file LikelihoodInterval.h.

RooAbsReal* RooStats::LikelihoodInterval::fLikelihoodRatio [private]

Definition at line 110 of file LikelihoodInterval.h.

std::map<std::string, double> RooStats::LikelihoodInterval::fLowerLimits [private]

Definition at line 112 of file LikelihoodInterval.h.

std::map<std::string, double> RooStats::LikelihoodInterval::fUpperLimits [private]

Definition at line 113 of file LikelihoodInterval.h.

std::auto_ptr<ROOT::Math::Minimizer > RooStats::LikelihoodInterval::fMinimizer [private]

Definition at line 114 of file LikelihoodInterval.h.

std::auto_ptr<RooFunctor> RooStats::LikelihoodInterval::fFunctor [private]

transient pointer to minimizer class used to find limits and contour

Definition at line 115 of file LikelihoodInterval.h.

std::auto_ptr<ROOT::Math::IMultiGenFunction> RooStats::LikelihoodInterval::fMinFunc [private]

transient pointer to functor class used by the minimizer

Definition at line 116 of file LikelihoodInterval.h.

---

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

• include/RooStats/LikelihoodInterval.h
• roofit/roostats/inc/LikelihoodInterval.h
• roofit/roostats/src/LikelihoodInterval.cxx

---