A class representing a parameter of a model. More...

#include <BCParameter.h>

Public Member Functions
Constructors and destructors
	BCParameter ()

	BCParameter (const char name, double lowerlimit, double upperlimit, const char latexname="")

Member functions (get)
const std::string &	GetName () const

const std::string &	GetLatexName () const

double	GetLowerLimit () const

double	GetUpperLimit () const

double	GetRangeWidth () const

bool	FillHistograms () const

bool	Fixed () const

double	GetFixedValue () const

unsigned	GetNbins () const

Member functions (set)
void	SetName (const char *name)

void	SetLatexName (const char *latex_name)

void	SetLowerLimit (double limit=0)

void	SetUpperLimit (double limit=1)

void	SetLimits (double lowerlimit=0, double upperlimit=1)

void	Fix (double value)

void	Unfix ()

void	FillHistograms (bool flag)

void	SetNbins (unsigned nbins)

Member functions (miscellaneous methods)
bool	IsAtLimit (double value) const

bool	IsValid (double value) const

void	PrintSummary () const

Private Attributes
std::string	fName
	The name of the parameter. More...

double	fLowerLimit
	The lower limit of the parameter value. More...

double	fUpperLimit
	The upper limit of the parameter value. More...

std::string	fLatexName
	The latex name of the parameter. More...

bool	fFixed
	Flag to fix parameter; useful for example, for integration. More...

double	fFixedValue
	The fixed value of the parameter. More...

bool	fFillHistograms
	Flag to store MCMC samples in histograms. More...

unsigned	fNbins
	The number of equal-size bins used in histograms involving this parameter. More...

Detailed Description

A class representing a parameter of a model.

Author: Daniel Kollar; Kevin Kröninger

Version: 1.0

Date: 08.2008 This class represents a parameter of a model. It contains information about the name and the range of the parameter.

Definition at line 28 of file BCParameter.h.

Constructor & Destructor Documentation

BCParameter::BCParameter ( )

The default constructor.

Definition at line 21 of file BCParameter.cxx.

                         :
     fName("parameter"),
     fLowerLimit(0),
     fUpperLimit(1),
     fFixed(false),
     fFixedValue(-1.e+111),
     fFillHistograms(true),
     fNbins(100)
 {
 }

BCParameter::BCParameter	(	const char *	name,
		double	lowerlimit,
		double	upperlimit,
		const char *	latexname = `""`
	)

A constructor.

Parameters

name	The name of the parameter.
lowerlimit	The lower limit of the parameter values.
upperlimit	The upper limit of the parameter values.
latexname	The latex name of the parameter used in axis labeling.

Definition at line 34 of file BCParameter.cxx.

                                                                                                         :
     fName(name),
     fLowerLimit(lowerlimit),
     fUpperLimit(upperlimit),
     fLatexName(latexname),
     fFixed(false),
     fFixedValue(-1.e+111),
     fFillHistograms(true),
     fNbins(100)
 {
 }

Member Function Documentation

bool BCParameter::FillHistograms ( ) const

inline

Definition at line 80 of file BCParameter.h.

81 { return fFillHistograms; }

void BCParameter::FillHistograms ( bool flag)

inline

Definition at line 133 of file BCParameter.h.

134 { fFillHistograms = flag; }

void BCParameter::Fix ( double value)

inline

Definition at line 124 of file BCParameter.h.

       {
          fFixed = true;
          fFixedValue = value;
       }

bool BCParameter::Fixed ( ) const

inline

Definition at line 83 of file BCParameter.h.

84 { return fFixed; }

double BCParameter::GetFixedValue ( ) const

inline

Definition at line 86 of file BCParameter.h.

87 { return fFixedValue; }

const std::string& BCParameter::GetLatexName ( ) const

inline

Returns latex name if set, else identical to GetName().

Definition at line 60 of file BCParameter.h.

61 { return (fLatexName.empty()) ? fName : fLatexName; }

double BCParameter::GetLowerLimit ( ) const

inline

Returns: The lower limit of the parameter values.

Definition at line 65 of file BCParameter.h.

66 { return fLowerLimit; }

const std::string& BCParameter::GetName ( ) const

inline

Returns: The name of the parameter.

Definition at line 54 of file BCParameter.h.

55 { return fName; }

unsigned BCParameter::GetNbins ( ) const

inline

Definition at line 89 of file BCParameter.h.

90 { return fNbins; }

double BCParameter::GetRangeWidth ( ) const

inline

Returns the range width of the parameter values. It is always a positive value.

Returns: The range width of the parameter values.

Definition at line 77 of file BCParameter.h.

78 { return (fUpperLimit > fLowerLimit) ? fUpperLimit - fLowerLimit : fLowerLimit - fUpperLimit; }

double BCParameter::GetUpperLimit ( ) const

inline

Returns: The upper limit of the parameter values.

Definition at line 70 of file BCParameter.h.

71 { return fUpperLimit; }

bool BCParameter::IsAtLimit ( double value) const

Returns true if the value is at a parameter limit.

Returns: flag States if value is at parameter limit.

Definition at line 58 of file BCParameter.cxx.

 {
    if (fLowerLimit == fUpperLimit)
       return false;
 
    if ( ( (value-fLowerLimit)*(value-fLowerLimit)/fLowerLimit/fLowerLimit <= 1e-10) ||
          ( (value-fUpperLimit)*(value-fUpperLimit)/fUpperLimit/fUpperLimit <= 1e-10))
       return true;
    else
       return false;
 }

bool BCParameter::IsValid ( double value) const

inline

Definition at line 148 of file BCParameter.h.

149 { return (fLowerLimit <= value) && (value <= fUpperLimit) ? true : false; }

void BCParameter::PrintSummary ( ) const

Prints a parameter summary on the screen.

Definition at line 48 of file BCParameter.cxx.

 {
    BCLog::OutSummary("Parameter summary:");
    BCLog::OutSummary(Form("Parameter   : %s", fName.c_str()));
    BCLog::OutSummary(Form("Lower limit : %f", fLowerLimit));
    BCLog::OutSummary(Form("Upper limit : %f", fUpperLimit));
 }

void BCParameter::SetLatexName ( const char * latex_name)

inline

Definition at line 102 of file BCParameter.h.

103 { fLatexName = latex_name; }

void BCParameter::SetLimits	(	double	lowerlimit = `0`,
		double	upperlimit = `1`
	)

inline

Set the limits of the parameter values.

Parameters

lowerlimit	The lower limit of the parameter values.
upperlimit	The upper limit of the parameter values.

Definition at line 121 of file BCParameter.h.

122 { fLowerLimit = lowerlimit; fUpperLimit = upperlimit; }

void BCParameter::SetLowerLimit ( double limit = 0)

inline

Set the lower limit of the parameter values.

Parameters

limit The lower limit of the parameter values.

Definition at line 108 of file BCParameter.h.

109 { fLowerLimit = limit; }

void BCParameter::SetName ( const char * name)

inline

Parameters

name	The name of the parameter.

Definition at line 99 of file BCParameter.h.

100 { fName = name; }

void BCParameter::SetNbins ( unsigned nbins)

inline

Definition at line 136 of file BCParameter.h.

137 { fNbins = nbins; }

void BCParameter::SetUpperLimit ( double limit = 1)

inline

Set the upper limit of the parameter values.

Parameters

limit The upper limit of the parameter values.

Definition at line 114 of file BCParameter.h.

115 { fUpperLimit = limit; }

void BCParameter::Unfix ( )

inline

Definition at line 130 of file BCParameter.h.

131 { fFixed = false; }

Member Data Documentation

bool BCParameter::fFillHistograms

private

Flag to store MCMC samples in histograms.

Definition at line 177 of file BCParameter.h.

bool BCParameter::fFixed

private

Flag to fix parameter; useful for example, for integration.

Definition at line 171 of file BCParameter.h.

double BCParameter::fFixedValue

private

The fixed value of the parameter.

Definition at line 174 of file BCParameter.h.

std::string BCParameter::fLatexName

private

The latex name of the parameter.

Definition at line 168 of file BCParameter.h.

double BCParameter::fLowerLimit

private

The lower limit of the parameter value.

Definition at line 162 of file BCParameter.h.

std::string BCParameter::fName

private

The name of the parameter.

Definition at line 159 of file BCParameter.h.

unsigned BCParameter::fNbins

private

The number of equal-size bins used in histograms involving this parameter.

Definition at line 180 of file BCParameter.h.

double BCParameter::fUpperLimit

private

The upper limit of the parameter value.

Definition at line 165 of file BCParameter.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation