A class to represent a constant prior of a parameter. More...

#include <BCConstantPrior.h>

Inheritance diagram for BCConstantPrior:

Collaboration diagram for BCConstantPrior:

Public Member Functions
virtual BCPrior *	Clone () const
	Clone function.

virtual double	GetIntegral (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())

virtual double	GetLogPrior (double)

virtual double	GetMode (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Return mode of prior (in range) — center of interval for constant prior. More...

virtual double	GetRandomValue (double xmin, double xmax, TRandom *const R=NULL)

virtual double	GetRawMoment (unsigned n, double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())

virtual bool	IsValid () const

Constructors and destructor
	BCConstantPrior ()
	Constructor for constant unit prior.

	BCConstantPrior (double range_width)
	Constructor for constant 1/range prior.

	BCConstantPrior (double xmin, double xmax)
	Constructor for constant 1/range prior.

virtual	~BCConstantPrior ()
	Destructor.

Public Member Functions inherited from BCPrior
	BCPrior ()
	Empty constructor.

	BCPrior (const BCPrior &other)
	Copy constructor.

virtual	~BCPrior ()
	Destructor.

virtual double	GetLogNormalizedPrior (double x)
	Get log of normalized prior. More...

virtual double	GetPrior (double x, bool normalize=false)
	Get prior. More...

virtual TF1 &	GetFunction ()
	Return back ROOT TF1 evaluating BCPrior::GetPrior.

virtual const TF1 &	GetFunction () const
	Return back ROOT TF1 evaluating BCPrior::GetPrior.

virtual void	SetFunctionRange (double xmin, double xmax)
	Set range of ROOT TF1 function. More...

virtual double	GetCentralMoment (unsigned n, double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Get central moment of prior distrubion. More...

virtual double	GetStandardizedMoment (unsigned n, double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Get standardised moment of prior distrubion. More...

virtual double	GetMean (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Get mean of prior. More...

virtual double	GetVariance (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Get variance of prior. More...

virtual double	GetStandardDeviation (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Get standard deviation of prior. More...

virtual double	GetSkewness (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Get skewness of prior. More...

virtual double	GetKurtosis (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Get kurtosis of prior. More...

virtual double	GetPriorForROOT (double x, double )
	For accessing prior as ROOT TF1.

virtual double	GetNormalizedPriorForROOT (double x, double )
	For accessing normalized prior as ROOT TF1.

virtual double	GetLogPriorForROOT (double x, double )
	For accessing log(prior) as ROOT TF1.

virtual double	GetNormalizedLogPriorForROOT (double x, double )
	For accessing normalized log(prior) as ROOT TF1.

virtual double	CalculateAndStoreIntegral (double xmin=-std::numeric_limits< double >::infinity(), double xmax=std::numeric_limits< double >::infinity())
	Calculate and store integral for use in normalized TF1s.

virtual void	StoreIntegral (double I)
	Store integral;.

virtual void	StoreLogIntegral (double logI)
	Store log(integral);.

virtual double	GetStoredIntegral () const
	Get stored integral. More...

virtual double	GetStoredLogIntegral () const
	Get stored integral. More...

virtual void	FillHistogramByCenterValue (TH1 *h)
	Fill histogram by prior evaluated at bin center. More...

virtual void	FillHistogramByIntegral (TH1 *h)
	Fill histogram by integrating prior over bin and dividing by bin width. More...

virtual BCH1D	GetBCH1D (TH1 *bins, const std::string &name="prior")
	Get BCH1D object for prior. More...

virtual BCH2D	GetBCH2D (BCPrior ordinate, TH2 bins, const std::string &name="prior")
	Get BCH2D object for prior. More...

Protected Attributes
double	fLogRangeWidth
	log of the width of the parameter range

Protected Attributes inherited from BCPrior
double	fLogIntegral
	Log of integral of unnormalized pdf over the range.

TF1	fPriorFunction

Detailed Description

A class to represent a constant prior of a parameter.

Author: Daniel Greenwald

Version: 1.0

Date: 01.2015

Definition at line 33 of file BCConstantPrior.h.

Member Function Documentation

virtual double BCConstantPrior::GetIntegral	(	double	xmin = `-std::numeric_limits<double>::infinity()`,
		double	xmax = `std::numeric_limits<double>::infinity()`
	)

inlinevirtual

Returns: integral = 1

Reimplemented from BCPrior.

Definition at line 78 of file BCConstantPrior.h.

virtual double BCConstantPrior::GetLogPrior ( double )

inlinevirtual

Returns: constant log(prior)

Implements BCPrior.

Definition at line 59 of file BCConstantPrior.h.

double BCConstantPrior::GetMode	(	double	xmin = `-std::numeric_limits<double>::infinity()`,
		double	xmax = `std::numeric_limits<double>::infinity()`
	)

virtual

Return mode of prior (in range) — center of interval for constant prior.

Parameters

xmin	lower limit of range to evaluate over
xmax	upper limit of range to evaluate over

Returns: mode of prior in range.

Reimplemented from BCPrior.

Definition at line 39 of file BCConstantPrior.cxx.

double BCConstantPrior::GetRandomValue	(	double	xmin,
		double	xmax,
		TRandom *const	R = `NULL`
	)

virtual

Returns: a random value distributed according to the prior.

Parameters

xmin	lower limit of range to generate value in
xmax	upper limit of range to generate value in
R	Pointer to the random generator to be used, if needed.

Returns: random value.

Reimplemented from BCPrior.

Definition at line 91 of file BCConstantPrior.cxx.

double BCConstantPrior::GetRawMoment	(	unsigned	n,
		double	xmin = `-std::numeric_limits<double>::infinity()`,
		double	xmax = `std::numeric_limits<double>::infinity()`
	)

virtual

Returns: raw moments of uniform continuous distribtion.

Reimplemented from BCPrior.

Definition at line 62 of file BCConstantPrior.cxx.

virtual bool BCConstantPrior::IsValid ( ) const

inlinevirtual

Returns: Whether everything needed for prior is set and prior can be used.

Implements BCPrior.

Definition at line 64 of file BCConstantPrior.h.

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

/root/bat/BAT/BCConstantPrior.h
/root/bat/src/BCConstantPrior.cxx

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation