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)
	BCParameter (const BCParameter &parameter)
	~BCParameter ()
Assignment operators

BCParameter &	operator= (const BCParameter &parameter)
Member functions (get)

std::string	GetName ()
int	GetIndex ()
double	GetLowerLimit ()
double	GetUpperLimit ()
double	GetRangeWidth ()
Member functions (set)

void	SetName (const char *name)
void	SetIndex (int index)
void	SetLowerLimit (double limit=0)
void	SetUpperLimit (double limit=1)
void	SetLimits (double lowerlimit=0, double upperlimit=1)
void	SetNuisance (int nuisance=1)
Member functions (miscellaneous methods)

double	IsNuisance ()
bool	IsAtLimit (double value)
void	PrintSummary ()
Private Member Functions
void	Copy (BCParameter &parameter) const
Private Attributes
int	fIndex
double	fLowerLimit
std::string	fName
int	fNuisance
double	fUpperLimit

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 29 of file BCParameter.h.

Constructor & Destructor Documentation

BCParameter::BCParameter ( )

The default constructor.

Definition at line 17 of file BCParameter.cxx.

{
   fName       = "parameter";
   fLowerLimit = 0.;
   fUpperLimit = 1.;
   fNuisance   = 0;
}

BCParameter::BCParameter	(	const char *	name,
		double	lowerlimit,
		double	upperlimit
	)

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.

Definition at line 27 of file BCParameter.cxx.

{
   fName       = "parameter";
   fLowerLimit = 0.;
   fUpperLimit = 1.;
   fNuisance   = 0;

   fName       = name;
   fLowerLimit = lowerlimit;
   fUpperLimit = upperlimit;
}

BCParameter::BCParameter ( const BCParameter & parameter )

The default copy constructor.

Definition at line 41 of file BCParameter.cxx.

{
   parameter.Copy(*this);
}

BCParameter::~BCParameter ( )

The default destructor.

Definition at line 58 of file BCParameter.cxx.

{}

Member Function Documentation

void BCParameter::Copy ( BCParameter & parameter ) const [private]

Definition at line 82 of file BCParameter.cxx.

{
   parameter.fName       = this -> fName;
   parameter.fIndex      = this -> fIndex;
   parameter.fLowerLimit = this -> fLowerLimit;
   parameter.fUpperLimit = this -> fUpperLimit;
   parameter.fNuisance   = this -> fNuisance;
}

int BCParameter::GetIndex ( ) [inline]

Returns the index of the parameter within the parameter container of a BCModel.

Returns:: The index of the parameter in the model.

Definition at line 79 of file BCParameter.h.

         { return fIndex; };

double BCParameter::GetLowerLimit ( ) [inline]

Returns:: The lower limit of the parameter values.

Definition at line 84 of file BCParameter.h.

         { return fLowerLimit; };

std::string BCParameter::GetName ( ) [inline]

Returns:: The name of the parameter.

Definition at line 72 of file BCParameter.h.

         { return fName; };

double BCParameter::GetRangeWidth ( ) [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 96 of file BCParameter.h.

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

double BCParameter::GetUpperLimit ( ) [inline]

Returns:: The upper limit of the parameter values.

Definition at line 89 of file BCParameter.h.

         { return fUpperLimit; };

bool BCParameter::IsAtLimit ( double value )

Returns true if the value is at a parameter limit.

Returns:: flag States if value is at parameter limit.

Definition at line 93 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;
}

double BCParameter::IsNuisance ( ) [inline]

Returns 1 if parameter is a nuisance parameter or 0 if not.

Returns:: 1 - is nuisance paramete, 0 - is not nuisance parameter

Definition at line 149 of file BCParameter.h.

         { return fNuisance; };

BCParameter & BCParameter::operator= ( const BCParameter & parameter )

The defaut assignment operator.

Definition at line 48 of file BCParameter.cxx.

{
   if (this != &parameter)
      parameter.Copy(* this);

   return * this;
}

void BCParameter::PrintSummary ( )

Prints a parameter summary on the screen.

Definition at line 63 of file BCParameter.cxx.

{
   std::cout
      <<"       > Parameter   : "<< fName << std::endl
      <<"         Index       : "<< fIndex << std::endl
      <<"         Lower Limit : "<< fLowerLimit << std::endl
      <<"         Upper Limit : "<< fUpperLimit << std::endl
      <<"         Nuisance    : ";

   if(fNuisance)
      std::cout<<"Yes"<<std::endl;
   else
      std::cout<<"No"<<std::endl;

   std::cout << std::endl;
}

void BCParameter::SetIndex ( int index ) [inline]

Set the index of the parameter within the parameter container of a BCModel.

Parameters:

index

The index of the parameter.

Definition at line 113 of file BCParameter.h.

         { fIndex = index; };

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 132 of file BCParameter.h.

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

         { fLowerLimit = limit; };

void BCParameter::SetName ( const char * name ) [inline]

Parameters:

name

The name of the parameter.

Definition at line 106 of file BCParameter.h.

         { fName = name; };

void BCParameter::SetNuisance ( int nuisance = 1 ) [inline]

Set parameter to be nuisance.

Parameters:

nuisance

1 - nuisance, 0 - not nuisance

Definition at line 138 of file BCParameter.h.

         { fNuisance = nuisance; };

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 125 of file BCParameter.h.

         { fUpperLimit = limit; };

Member Data Documentation

int BCParameter::fIndex [private]

The index of the parameter within the BCParameterSet of a BCModel.

Definition at line 175 of file BCParameter.h.

double BCParameter::fLowerLimit [private]

The lower limit of the parameter value.

Definition at line 179 of file BCParameter.h.

std::string BCParameter::fName [private]

The name of the parameter.

Definition at line 171 of file BCParameter.h.

int BCParameter::fNuisance [private]

Flag to specify whether to integrate over this parameter or not.

Definition at line 187 of file BCParameter.h.

double BCParameter::fUpperLimit [private]

The upper limit of the parameter value.

Definition at line 183 of file BCParameter.h.

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

BCParameter Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation