laura is hosted by Hepforge, IPPP Durham
Laura++  3.6.0
A maximum likelihood fitting package for performing Dalitz-plot analysis.

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

#include <LauFormulaPar.hh>

Inheritance diagram for LauFormulaPar:
LauAbsRValue

Public Member Functions

 LauFormulaPar (const TString &forName, const TString &formula, const std::vector< LauParameter * > &params)
 Constructor. More...
 
 LauFormulaPar (const LauFormulaPar &rhs)
 Copy constructor.
 
LauFormulaParoperator= (const LauFormulaPar &rhs)
 Copy assignment operator.
 
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 constraintPenalty () const
 The penalty term from 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.
 
void generateConstraintMean ()
 Generate per-experiment constraint mean.
 
- Public Member Functions inherited from LauAbsRValue
 LauAbsRValue ()
 Constructor.
 
virtual ~LauAbsRValue ()
 Destructor.
 
 LauAbsRValue (const LauAbsRValue &)
 Copy constructor.
 
LauAbsRValueoperator= (const LauAbsRValue &)
 Copy assignment operator.
 

Private Attributes

TString name_
 The parameter name.
 
TFormula formula_
 The formula.
 
std::vector< LauParameter * > paramVec_
 Vector of LauParameters in the formula.
 
Double_t * paramArray_
 Array to hold parameter values to pass to formula.
 
Bool_t gaussConstraint_
 Choice to use Gaussian constraint.
 
Double_t constraintTrueMean_
 True mean of the Gaussian constraint.
 
Double_t constraintMean_
 Mean value of the Gaussian constraint.
 
Double_t constraintWidth_
 Width of the Gaussian constraint.
 

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::LauFormulaPar ( const TString &  forName,
const TString &  formula,
const std::vector< LauParameter * > &  params 
)

Constructor.

Parameters
[in]forNamethe name of the formula
[in]formulathe desired expression, using TFormula syntax
[in]paramsa vector of LauParameters used in the formula

Definition at line 43 of file LauFormulaPar.cc.

Member Function Documentation

◆ addGaussianConstraint()

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

Add a Gaussian constraint (or modify an existing one)

Parameters
[in]newGaussMeanthe new value of the Gaussian constraint mean
[in]newGaussWidththe new value of the Gaussian constraint width

Definition at line 204 of file LauFormulaPar.cc.

◆ blind()

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 192 of file LauFormulaPar.cc.

◆ constraintPenalty()

Double_t LauFormulaPar::constraintPenalty ( ) const
virtual

The penalty term from the Gaussian constraint.

Returns
the penalty term from the Gaussian constraint

Implements LauAbsRValue.

Definition at line 222 of file LauFormulaPar.cc.

◆ fixed()

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 180 of file LauFormulaPar.cc.

◆ gaussConstraint()

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 135 of file LauFormulaPar.hh.

◆ genValue()

Double_t LauFormulaPar::genValue ( ) const
virtual

The value generated for the parameter.

Returns
the value generated for the parameter

Implements LauAbsRValue.

Definition at line 156 of file LauFormulaPar.cc.

◆ getPars()

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

Get the LauParameters used in LauFormulaPar.

Returns
the list of LauParameters

Implements LauAbsRValue.

Definition at line 111 of file LauFormulaPar.hh.

◆ initValue()

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 168 of file LauFormulaPar.cc.

◆ isLValue()

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 117 of file LauFormulaPar.hh.

◆ name() [1/2]

const TString& LauFormulaPar::name ( ) const
inlinevirtual

The parameter name.

Returns
the name of the parameter

Implements LauAbsRValue.

Definition at line 99 of file LauFormulaPar.hh.

◆ name() [2/2]

void LauFormulaPar::name ( const TString &  newName)
inlinevirtual

Set the parameter name.

Parameters
[in]newNamethe name of the parameter

Implements LauAbsRValue.

Definition at line 105 of file LauFormulaPar.hh.

◆ unblindValue()

Double_t LauFormulaPar::unblindValue ( ) const
virtual

The unblinded value of the parameter.

Returns
the unblinded value of the parameter

Implements LauAbsRValue.

Definition at line 144 of file LauFormulaPar.cc.

◆ value()

Double_t LauFormulaPar::value ( ) const
virtual

Return the value of the LauFormalaPar.

Returns
the value of the formula

Implements LauAbsRValue.

Definition at line 132 of file LauFormulaPar.cc.


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