BCParameter Class Reference

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

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.

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.

Member Function Documentation

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

inline

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

Definition at line 60 of file BCParameter.h.

double BCParameter::GetLowerLimit ( ) const

inline

Returns

The lower limit of the parameter values.

Definition at line 65 of file BCParameter.h.

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

inline

Returns

The name of the parameter.

Definition at line 54 of file BCParameter.h.

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.

double BCParameter::GetUpperLimit ( ) const

inline

Returns

The upper limit of the parameter values.

Definition at line 70 of file BCParameter.h.

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.

void BCParameter::PrintSummary

(

)

const

Prints a parameter summary on the screen.

Definition at line 48 of file BCParameter.cxx.

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.

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.

void BCParameter::SetName ( const char *  name )

inline

Parameters

name	The name of the parameter.

Definition at line 99 of file BCParameter.h.

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.

---

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

• /home/beaujean/workspace/bat/BAT/BCParameter.h
• /home/beaujean/workspace/bat/src/BCParameter.cxx