LauFormulaPar Class Reference

Class for defining combinations of fit parameter objects. More...

#include <LauFormulaPar.hh>

Inheritance diagram for LauFormulaPar:

Public Member Functions
	LauFormulaPar (const TString &forName, const TString &formula, const std::vector< LauParameter * > &params)
	Constructor. More...
virtual	~LauFormulaPar ()
	LauFormulaPar (const LauFormulaPar &rhs)
	Copy constructor. More...
LauFormulaPar &	operator= (const LauFormulaPar &rhs)
	Copy assignment operator. More...
Double_t	value () const
	Return the value of the LauFormalaPar. More...
Double_t	unblindValue () const
	The unblinded value of the parameter. More...
Double_t	genValue () const
	The value generated for the parameter. More...
Double_t	initValue () const
	The initial value of the parameter. More...
const TString &	name () const
	The parameter name. More...
void	name (const TString &newName)
	Set the parameter name. More...
std::vector< LauParameter * >	getPars ()
	Get the LauParameters used in LauFormulaPar. More...
Bool_t	isLValue () const
	Boolean to say it is not an L value. More...
Bool_t	fixed () const
	Boolean to say if the LauFormulaPar is fixed. More...
Bool_t	blind () const
	The blinding state. More...
Bool_t	gaussConstraint () const
	Check whether a Gaussian constraints is applied. More...
Double_t	constraintMean () const
	The mean of the Gaussian constraint. More...
Double_t	constraintWidth () const
	The width of the Gaussian constraint. More...
void	addGaussianConstraint (Double_t newGaussMean, Double_t newGaussWidth)
	Add a Gaussian constraint (or modify an existing one) More...
void	removeGaussianConstraint ()
	Remove the Gaussian constraint. More...
Public Member Functions inherited from LauAbsRValue
	LauAbsRValue ()
	Constructor. More...
virtual	~LauAbsRValue ()
	Destructor. More...
	LauAbsRValue (const LauAbsRValue &)
	Copy constructor. More...
LauAbsRValue &	operator= (const LauAbsRValue &)
	Copy assignment operator. More...

Private Attributes
TString	name_
	The parameter name. More...
TFormula	formula_
	The formula. More...
std::vector< LauParameter * >	paramVec_
	Vector of LauParameters in the formula. More...
Double_t *	dummy_
	Array. More...
Double_t *	paramArray_
	Array. More...
Bool_t	gaussConstraint_
	Choice to use Gaussian constraint. More...
Double_t	constraintMean_
	Mean value of the Gaussian constraint. More...
Double_t	constraintWidth_
	Width of the Gaussian constraint. More...

Detailed Description

Class for defining combinations of fit parameter objects.

Allows for combinations of LauParameters to be passed to the fit models. Equations of the form [0]*2 + 3*[1] are accepted, with a vector of LauParameters to define inputs [0] and [1]. The parameter for [0] must be stored first in the vector, and so on.

Definition at line 49 of file LauFormulaPar.hh.

Constructor & Destructor Documentation

LauFormulaPar::LauFormulaPar	(	const TString &	forName,
		const TString &	formula,
		const std::vector< LauParameter * > &	params
	)

Constructor.

Parameters

[in]	forName	the name of the formula
[in]	formula	the desired expression, using TFormula syntax
[in]	params	a vector of LauParameters used in the formula

Definition at line 45 of file LauFormulaPar.cc.

LauFormulaPar::~LauFormulaPar ( )

virtual

Definition at line 74 of file LauFormulaPar.cc.

LauFormulaPar::LauFormulaPar

(

const LauFormulaPar &

rhs

)

Copy constructor.

Definition at line 80 of file LauFormulaPar.cc.

Member Function Documentation

void LauFormulaPar::addGaussianConstraint	(	Double_t	newGaussMean,
		Double_t	newGaussWidth
	)

Add a Gaussian constraint (or modify an existing one)

Parameters

[in]	newGaussMean	the new value of the Gaussian constraint mean
[in]	newGaussWidth	the new value of the Gaussian constraint width

Definition at line 197 of file LauFormulaPar.cc.

Bool_t LauFormulaPar::blind ( ) const

virtual

The blinding state.

Returns

kTRUE if any of the LauParameters in the formula are blinded, kFALSE otherwise

Implements LauAbsRValue.

Definition at line 189 of file LauFormulaPar.cc.

Double_t LauFormulaPar::constraintMean ( ) const

inlinevirtual

The mean of the Gaussian constraint.

Returns

the mean value of the Gaussian constraint

Implements LauAbsRValue.

Definition at line 139 of file LauFormulaPar.hh.

Double_t LauFormulaPar::constraintWidth ( ) const

inlinevirtual

The width of the Gaussian constraint.

Returns

the width of the Gaussian constraint

Implements LauAbsRValue.

Definition at line 145 of file LauFormulaPar.hh.

Bool_t LauFormulaPar::fixed ( ) const

virtual

Boolean to say if the LauFormulaPar is fixed.

Returns

kFALSE unless all LauParameters in the formula are fixed

Implements LauAbsRValue.

Definition at line 181 of file LauFormulaPar.cc.

Bool_t LauFormulaPar::gaussConstraint ( ) const

inlinevirtual

Check whether a Gaussian constraints is applied.

Returns

the boolean flag true/false whether a Gaussian constraint is applied

Implements LauAbsRValue.

Definition at line 133 of file LauFormulaPar.hh.

Double_t LauFormulaPar::genValue ( ) const

virtual

The value generated for the parameter.

Returns

the value generated for the parameter

Implements LauAbsRValue.

Definition at line 157 of file LauFormulaPar.cc.

std::vector<LauParameter*> LauFormulaPar::getPars ( )

inlinevirtual

Get the LauParameters used in LauFormulaPar.

Returns

the list of LauParameters

Implements LauAbsRValue.

Definition at line 109 of file LauFormulaPar.hh.

Double_t LauFormulaPar::initValue ( ) const

virtual

The initial value of the parameter.

Returns

the initial value of the parameter given to the fitter

Implements LauAbsRValue.

Definition at line 169 of file LauFormulaPar.cc.

Bool_t LauFormulaPar::isLValue ( ) const

inlinevirtual

Boolean to say it is not an L value.

Returns

kFALSE, LauFormulaPars are not L values

Implements LauAbsRValue.

Definition at line 115 of file LauFormulaPar.hh.

const TString& LauFormulaPar::name ( ) const

inlinevirtual

The parameter name.

Returns

the name of the parameter

Implements LauAbsRValue.

Definition at line 97 of file LauFormulaPar.hh.

void LauFormulaPar::name ( const TString &  newName )

inlinevirtual

Set the parameter name.

Parameters

[in]

newName

the name of the parameter

Implements LauAbsRValue.

Definition at line 103 of file LauFormulaPar.hh.

LauFormulaPar & LauFormulaPar::operator=

(

const LauFormulaPar &

rhs

)

Copy assignment operator.

Definition at line 109 of file LauFormulaPar.cc.

void LauFormulaPar::removeGaussianConstraint

(

)

Remove the Gaussian constraint.

Definition at line 204 of file LauFormulaPar.cc.

Double_t LauFormulaPar::unblindValue ( ) const

virtual

The unblinded value of the parameter.

Returns

the unblinded value of the parameter

Implements LauAbsRValue.

Definition at line 145 of file LauFormulaPar.cc.

Double_t LauFormulaPar::value ( ) const

virtual

Return the value of the LauFormalaPar.

Returns

the value of the formula

Implements LauAbsRValue.

Definition at line 133 of file LauFormulaPar.cc.

Member Data Documentation

Double_t LauFormulaPar::constraintMean_

private

Mean value of the Gaussian constraint.

Definition at line 177 of file LauFormulaPar.hh.

Double_t LauFormulaPar::constraintWidth_

private

Width of the Gaussian constraint.

Definition at line 179 of file LauFormulaPar.hh.

Double_t* LauFormulaPar::dummy_

private

Array.

Definition at line 170 of file LauFormulaPar.hh.

TFormula LauFormulaPar::formula_

mutableprivate

The formula.

Definition at line 164 of file LauFormulaPar.hh.

Bool_t LauFormulaPar::gaussConstraint_

private

Choice to use Gaussian constraint.

Definition at line 175 of file LauFormulaPar.hh.

TString LauFormulaPar::name_

private

The parameter name.

Definition at line 161 of file LauFormulaPar.hh.

Double_t* LauFormulaPar::paramArray_

private

Array.

Definition at line 172 of file LauFormulaPar.hh.

std::vector<LauParameter*> LauFormulaPar::paramVec_

private

Vector of LauParameters in the formula.

Definition at line 167 of file LauFormulaPar.hh.

---

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

• inc/LauFormulaPar.hh
• src/LauFormulaPar.cc