LauParameter Class Reference

Class for defining the fit parameter objects. More...

#include <LauParameter.hh>

Inheritance diagram for LauParameter:

Public Member Functions
	LauParameter ()
	Default constructor.
	LauParameter (const TString &parName)
	Constructor for named parameter. More...
	LauParameter (Double_t parValue)
	Constructor for parameter value. More...
	LauParameter (Double_t parValue, Double_t min, Double_t max)
	Constructor double limit parameter. More...
	LauParameter (Double_t parValue, Double_t min, Double_t max, Bool_t parFixed)
	Constructor double limit fixed parameter. More...
	LauParameter (Double_t parValue, Double_t parError, Double_t min, Double_t max)
	Constructor for double error and limit parameter. More...
	LauParameter (const TString &parName, Double_t parValue)
	Constructor for parameter value and name. More...
	LauParameter (const TString &parName, Double_t parValue, Double_t min, Double_t max)
	Constructor double limit parameter and name. More...
	LauParameter (const TString &parName, Double_t parValue, Double_t min, Double_t max, Bool_t parFixed)
	Constructor double limit fixed parameter and name. More...
	LauParameter (const TString &parName, Double_t parValue, Double_t parError, Double_t min, Double_t max)
	Constructor double error and limit parameter and name. More...
	LauParameter (const LauParameter &rhs)
	Copy constructor. More...
LauParameter &	operator= (const LauParameter &rhs)
	Copy assignment operator. More...
const TString &	name () const
	The parameter name. More...
Bool_t	blind () const
	The blinding state. More...
const LauBlind *	blinder () const
	Access the blinder object. More...
Double_t	value () const
	The value of the parameter. More...
Double_t	unblindValue () const
	The unblinded value of the parameter. More...
Double_t	error () const
	The error on the parameter. More...
Double_t	negError () const
	The lower error on the parameter. More...
Double_t	posError () const
	The upper error on 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...
Double_t	minValue () const
	The minimum value allowed for the parameter. More...
Double_t	maxValue () const
	The maximum value allowed for the parameter. More...
Double_t	range () const
	The range allowed for the parameter. More...
Bool_t	fixed () const
	Check whether the parameter is fixed or floated. More...
Bool_t	secondStage () const
	Check whether the parameter should be floated only in the second stage of a two stage fit. 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...
Double_t	globalCorrelationCoeff () const
	The parameter global correlation coefficient. More...
Double_t	bias () const
	The bias in the parameter. More...
Double_t	pull () const
	The pull value for the parameter. More...
Bool_t	isLValue () const
	Boolean to say it is an L value. More...
std::vector< LauParameter * >	getPars ()
	Get the LauParameter itself. More...
void	name (const TString &newName)
	Set the parameter name. More...
void	value (Double_t newValue)
	Set the value of the parameter. More...
void	error (Double_t newError)
	Set the error on the parameter. More...
void	negError (Double_t newNegError)
	Set the lower error on the parameter. More...
void	posError (Double_t newPosError)
	Set the upper error on the parameter. More...
void	errors (Double_t newError, Double_t newNegError, Double_t newPosError)
	Set the error values on the parameter. More...
void	valueAndErrors (Double_t newValue, Double_t newError, Double_t newNegError=0.0, Double_t newPosError=0.0)
	Set the value and errors on the parameter. More...
void	globalCorrelationCoeff (Double_t newGCCValue)
	Set the global correlation coefficient. More...
void	genValue (Double_t newGenValue)
	Set the generated value for the parameter. More...
void	initValue (Double_t newInitValue)
	Set the inital value for the parameter. More...
void	minValue (Double_t newMinValue)
	Set the minimum value for the parameter. More...
void	maxValue (Double_t newMaxValue)
	Set the maximum value for the parameter. More...
void	range (Double_t newMinValue, Double_t newMaxValue)
	Set the range for the parameter. More...
void	valueAndRange (Double_t newValue, Double_t newMinValue, Double_t newMaxValue)
	Set the value and range for the parameter. More...
void	fixed (Bool_t parFixed)
	Fix or float the given parameter. More...
void	secondStage (Bool_t secondStagePar)
	Set parameter as second-stage or not of the fit. 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.
void	blindParameter (const TString &blindingString, const Double_t width)
	Blind the parameter. More...
Bool_t	clone () const
	Check whether is a clone or not. More...
LauParameter *	createClone (Double_t constFactor=1.0)
	Method to create a clone from the parent parameter using the copy constructor. More...
LauParameter *	createClone (const TString &newName, Double_t constFactor=1.0)
	Method to create a clone from the parent parameter using the copy constructor and setting a new name. More...
LauParameter *	parent () const
	The parent parameter. More...
void	updatePull ()
	Call to update the bias and pull values.
void	randomiseValue ()
	Randomise the value of the parameter (if it is floating). More...
void	randomiseValue (Double_t minVal, Double_t maxVal)
	Randomise the value of the parameter (if it is floating). More...
Public Member Functions inherited from LauAbsRValue
	LauAbsRValue ()
	Constructor.
virtual	~LauAbsRValue ()
	Destructor.
	LauAbsRValue (const LauAbsRValue &)
	Copy constructor.
LauAbsRValue &	operator= (const LauAbsRValue &)
	Copy assignment operator.

Protected Member Functions
void	checkRange (Double_t val, Double_t minVal, Double_t maxVal)
	Method to check whether value provided is within the range and that the minimum and maximum limits make sense. More...
void	checkRange ()
	Method to check whether value provided is whithin the range and that the minimum and maximum limits make sense.
void	clone (LauParameter *theparent)
	Mark this as a clone of the given parent. More...
void	wipeClones ()
	Method to clear the clone parameters.
void	updateClones (Bool_t justValue)
	Method to update clone values. More...

Private Attributes
TString	name_
	The parameter name.
Double_t	value_
	The parameter value.
Double_t	error_
	The error on the parameter.
Double_t	negError_
	The lower error on the parameter.
Double_t	posError_
	The upper error on the parameter.
Double_t	genValue_
	Toy generation value.
Double_t	initValue_
	Initial fit value.
Double_t	minValue_
	Minimum value for the parameter.
Double_t	maxValue_
	Maximum value for the parameter.
Bool_t	fixed_
	Fix/float option for parameter.
Bool_t	secondStage_
	Flag whether it is floated only in the second stage of the fit.
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.
Double_t	gcc_
	Global correlation coefficient.
Double_t	bias_
	Parameter bias.
Double_t	pull_
	Parameter pull.
Bool_t	clone_
	Flag whether the parameter is a clone.
LauParameter *	parent_
	The parent parameter.
std::map< LauParameter *, Double_t >	clones_
	The clones of this parameter.
LauBlind *	blinder_
	The blinding engine.

Friends
class	LauFitNtuple
	LauFitNtuple is a friend class.
class	LauFitObject
	LauFitObject is a friend class.

Detailed Description

Class for defining the fit parameter objects.

Holds all relevant information for the parameters for both generation and fitting step: current, initial and generated value, maximum and minimum range, error, asymmetric error, fix and float and etc.

Definition at line 49 of file LauParameter.hh.

Constructor & Destructor Documentation

LauParameter() [1/10]

LauParameter::LauParameter ( const TString &  parName )

explicit

Constructor for named parameter.

Parameters

[in]

parName

the parameter name

Definition at line 65 of file LauParameter.cc.

LauParameter() [2/10]

LauParameter::LauParameter ( Double_t  parValue )

explicit

Constructor for parameter value.

Parameters

[in]

parValue

the parameter value

Definition at line 90 of file LauParameter.cc.

LauParameter() [3/10]

LauParameter::LauParameter	(	Double_t	parValue,
		Double_t	min,
		Double_t	max
	)

Constructor double limit parameter.

Parameters

[in]	parValue	the parameter value
[in]	min	the minimum value of the parameter
[in]	max	the maximum value of the parameter

Definition at line 140 of file LauParameter.cc.

LauParameter() [4/10]

LauParameter::LauParameter	(	Double_t	parValue,
		Double_t	min,
		Double_t	max,
		Bool_t	parFixed
	)

Constructor double limit fixed parameter.

Parameters

[in]	parValue	the parameter value
[in]	min	the minimum value of the parameter
[in]	max	the maximum value of the parameter
[in]	parFixed	boolean flag to fix or float parameter

Definition at line 192 of file LauParameter.cc.

LauParameter() [5/10]

LauParameter::LauParameter	(	Double_t	parValue,
		Double_t	parError,
		Double_t	min,
		Double_t	max
	)

Constructor for double error and limit parameter.

Parameters

[in]	parValue	the parameter value
[in]	parError	the parameter error
[in]	min	the minimum value of the parameter
[in]	max	the maximum value of the parameter

Definition at line 166 of file LauParameter.cc.

LauParameter() [6/10]

LauParameter::LauParameter	(	const TString &	parName,
		Double_t	parValue
	)

Constructor for parameter value and name.

Parameters

[in]	parName	the parameter name
[in]	parValue	the parameter value

Definition at line 115 of file LauParameter.cc.

LauParameter() [7/10]

LauParameter::LauParameter	(	const TString &	parName,
		Double_t	parValue,
		Double_t	min,
		Double_t	max
	)

Constructor double limit parameter and name.

Parameters

[in]	parName	the parameter name
[in]	parValue	the parameter value
[in]	min	the minimum value of the parameter
[in]	max	the maximum value of the parameter

Definition at line 218 of file LauParameter.cc.

LauParameter() [8/10]

LauParameter::LauParameter	(	const TString &	parName,
		Double_t	parValue,
		Double_t	min,
		Double_t	max,
		Bool_t	parFixed
	)

Constructor double limit fixed parameter and name.

Parameters

[in]	parName	the parameter name
[in]	parValue	the parameter value
[in]	min	the minimum value of the parameter
[in]	max	the maximum value of the parameter
[in]	parFixed	boolean flag to fix (kTRUE) or float (kFALSE) the parameter

Definition at line 244 of file LauParameter.cc.

LauParameter() [9/10]

LauParameter::LauParameter	(	const TString &	parName,
		Double_t	parValue,
		Double_t	parError,
		Double_t	min,
		Double_t	max
	)

Constructor double error and limit parameter and name.

Parameters

[in]	parName	the parameter name
[in]	parValue	the parameter value
[in]	parError	the parameter error
[in]	min	the minimum value of the parameter
[in]	max	the maximum value of the parameter

Definition at line 274 of file LauParameter.cc.

LauParameter() [10/10]

LauParameter::LauParameter

(

const LauParameter &

rhs

)

Copy constructor.

Parameters

[in]

rhs

the parameter to be copied

Definition at line 304 of file LauParameter.cc.

Member Function Documentation

addGaussianConstraint()

void LauParameter::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 541 of file LauParameter.cc.

bias()

Double_t LauParameter::bias ( ) const

inline

The bias in the parameter.

Returns

the bias in the parameter, defined as the difference between the value and the generated value

Definition at line 265 of file LauParameter.hh.

blind()

Bool_t LauParameter::blind ( ) const

inlinevirtual

The blinding state.

Returns

the blinding state: kTRUE means that it is blinded, kFALSE that it is not blinded

Implements LauAbsRValue.

Definition at line 160 of file LauParameter.hh.

blinder()

const LauBlind* LauParameter::blinder ( ) const

inline

Access the blinder object.

Returns

the blinder

Definition at line 166 of file LauParameter.hh.

blindParameter()

void LauParameter::blindParameter	(	const TString &	blindingString,
		const Double_t	width
	)

Blind the parameter.

See LauBlind documentation for details of blinding procedure

Parameters

[in]	blindingString	the unique blinding string used to seed the random number generator
[in]	width	the width of the Gaussian from which the offset should be sampled

Definition at line 583 of file LauParameter.cc.

checkRange()

void LauParameter::checkRange ( Double_t  val, Double_t  minVal, Double_t  maxVal  )

protected

Method to check whether value provided is within the range and that the minimum and maximum limits make sense.

Parameters

[in]	val	the value of the parameter
[in]	minVal	the minimum value allowed
[in]	maxVal	the maximum value allowed

Definition at line 636 of file LauParameter.cc.

clone() [1/2]

Bool_t LauParameter::clone ( ) const

inline

Check whether is a clone or not.

Returns

true/false whether is a clone

Definition at line 422 of file LauParameter.hh.

clone() [2/2]

void LauParameter::clone ( LauParameter *  theparent )

inlineprotected

Mark this as a clone of the given parent.

Parameters

theparent

the parent parameter

Definition at line 484 of file LauParameter.hh.

constraintPenalty()

Double_t LauParameter::constraintPenalty ( ) const

virtual

The penalty term from the Gaussian constraint.

Returns

the penalty term from the Gaussian constraint

Implements LauAbsRValue.

Definition at line 574 of file LauParameter.cc.

createClone() [1/2]

LauParameter * LauParameter::createClone	(	const TString &	newName,
		Double_t	constFactor = 1.0
	)

Method to create a clone from the parent parameter using the copy constructor and setting a new name.

Parameters

[in]	newName	the new name of the cloned parameter
[in]	constFactor	the optional constant factor by which the clone shold be multiplied

Returns

the cloned parameter

Definition at line 698 of file LauParameter.cc.

createClone() [2/2]

LauParameter * LauParameter::createClone

(

Double_t

constFactor = 1.0

)

Method to create a clone from the parent parameter using the copy constructor.

Parameters

[in]

constFactor

the optional constant factor by which the clone shold be multiplied

Returns

the cloned parameter

Definition at line 677 of file LauParameter.cc.

error() [1/2]

Double_t LauParameter::error ( ) const

inline

The error on the parameter.

Returns

the error on the parameter

Definition at line 187 of file LauParameter.hh.

error() [2/2]

void LauParameter::error

(

Double_t

newError

)

Set the error on the parameter.

Parameters

[in]

newError

the error on the parameter

Definition at line 386 of file LauParameter.cc.

errors()

void LauParameter::errors	(	Double_t	newError,
		Double_t	newNegError,
		Double_t	newPosError
	)

Set the error values on the parameter.

Parameters

[in]	newError	the error on the parameter
[in]	newNegError	the lower error on the parameter
[in]	newPosError	the upper error on the parameter

Definition at line 416 of file LauParameter.cc.

fixed() [1/2]

Bool_t LauParameter::fixed ( ) const

inlinevirtual

Check whether the parameter is fixed or floated.

Returns

the boolean flag true/false whether the parameter is fixed

Implements LauAbsRValue.

Definition at line 235 of file LauParameter.hh.

fixed() [2/2]

void LauParameter::fixed

(

Bool_t

parFixed

)

Fix or float the given parameter.

Parameters

[in]

parFixed

boolean flag to fix or float the parameter

Definition at line 521 of file LauParameter.cc.

gaussConstraint()

Bool_t LauParameter::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 247 of file LauParameter.hh.

genValue() [1/2]

Double_t LauParameter::genValue ( ) const

inlinevirtual

The value generated for the parameter.

Returns

the value generated for the parameter

Implements LauAbsRValue.

Definition at line 205 of file LauParameter.hh.

genValue() [2/2]

void LauParameter::genValue

(

Double_t

newGenValue

)

Set the generated value for the parameter.

Parameters

[in]

newGenValue

the generated value for the parameter

Definition at line 454 of file LauParameter.cc.

getPars()

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

virtual

Get the LauParameter itself.

Returns

a vector of the LauParameter

Implements LauAbsRValue.

Definition at line 369 of file LauParameter.cc.

globalCorrelationCoeff() [1/2]

Double_t LauParameter::globalCorrelationCoeff ( ) const

inline

The parameter global correlation coefficient.

Returns

the global correlation coefficient

Definition at line 259 of file LauParameter.hh.

globalCorrelationCoeff() [2/2]

void LauParameter::globalCorrelationCoeff

(

Double_t

newGCCValue

)

Set the global correlation coefficient.

Parameters

[in]

newGCCValue

the value of the coefficient

Definition at line 444 of file LauParameter.cc.

initValue() [1/2]

Double_t LauParameter::initValue ( ) const

inlinevirtual

The initial value of the parameter.

Returns

the initial value of the parameter given to the fitter

Implements LauAbsRValue.

Definition at line 211 of file LauParameter.hh.

initValue() [2/2]

void LauParameter::initValue

(

Double_t

newInitValue

)

Set the inital value for the parameter.

Parameters

[in]

newInitValue

the initial value for the parameter

Definition at line 464 of file LauParameter.cc.

isLValue()

Bool_t LauParameter::isLValue ( ) const

inlinevirtual

Boolean to say it is an L value.

Returns

kTRUE, LauParameters are L values

Implements LauAbsRValue.

Definition at line 277 of file LauParameter.hh.

maxValue() [1/2]

Double_t LauParameter::maxValue ( ) const

inline

The maximum value allowed for the parameter.

Returns

the maximum value allowed for the parameter

Definition at line 223 of file LauParameter.hh.

maxValue() [2/2]

void LauParameter::maxValue

(

Double_t

newMaxValue

)

Set the maximum value for the parameter.

Parameters

[in]

newMaxValue

the maximum value for the parameter

Definition at line 484 of file LauParameter.cc.

minValue() [1/2]

Double_t LauParameter::minValue ( ) const

inline

The minimum value allowed for the parameter.

Returns

the minimum value allowed for the parameter

Definition at line 217 of file LauParameter.hh.

minValue() [2/2]

void LauParameter::minValue

(

Double_t

newMinValue

)

Set the minimum value for the parameter.

Parameters

[in]

newMinValue

the minimum value for the parameter

Definition at line 474 of file LauParameter.cc.

name() [1/2]

const TString& LauParameter::name ( ) const

inlinevirtual

The parameter name.

Returns

the name of the parameter

Implements LauAbsRValue.

Definition at line 154 of file LauParameter.hh.

name() [2/2]

void LauParameter::name ( const TString &  newName )

virtual

Set the parameter name.

Parameters

[in]

newName

the name of the parameter

Implements LauAbsRValue.

Definition at line 514 of file LauParameter.cc.

negError() [1/2]

Double_t LauParameter::negError ( ) const

inline

The lower error on the parameter.

Returns

the lower error on the parameter

Definition at line 193 of file LauParameter.hh.

negError() [2/2]

void LauParameter::negError

(

Double_t

newNegError

)

Set the lower error on the parameter.

Parameters

[in]

newNegError

the lower error on the parameter

Definition at line 396 of file LauParameter.cc.

operator=()

LauParameter & LauParameter::operator=

(

const LauParameter &

rhs

)

Copy assignment operator.

Parameters

[in]

rhs

the parameter to be copied

Definition at line 332 of file LauParameter.cc.

parent()

LauParameter* LauParameter::parent ( ) const

inline

The parent parameter.

Returns

the parent parameter

Definition at line 443 of file LauParameter.hh.

posError() [1/2]

Double_t LauParameter::posError ( ) const

inline

The upper error on the parameter.

Returns

the upper error on the parameter

Definition at line 199 of file LauParameter.hh.

posError() [2/2]

void LauParameter::posError

(

Double_t

newPosError

)

Set the upper error on the parameter.

Parameters

[in]

newPosError

the upper error on the parameter

Definition at line 406 of file LauParameter.cc.

pull()

Double_t LauParameter::pull ( ) const

inline

The pull value for the parameter.

Returns

the pull value for the parameter, defined as the bias divided by the error

Definition at line 271 of file LauParameter.hh.

randomiseValue() [1/2]

void LauParameter::randomiseValue

(

)

Randomise the value of the parameter (if it is floating).

The pre-defined parameter range is used as the randomisation range.

Definition at line 743 of file LauParameter.cc.

randomiseValue() [2/2]

void LauParameter::randomiseValue	(	Double_t	minVal,
		Double_t	maxVal
	)

Randomise the value of the parameter (if it is floating).

Use the given range unless either of the given values are outside the range of the parameter, in which case that value will be altered to the current max or min.

Parameters

[in]	minVal	the minimum value for the parameter
[in]	maxVal	the maximum value for the parameter

Definition at line 748 of file LauParameter.cc.

range() [1/2]

Double_t LauParameter::range ( ) const

inline

The range allowed for the parameter.

Returns

the range allowed for the parameters, defined as the difference between the max and min value

Definition at line 229 of file LauParameter.hh.

range() [2/2]

void LauParameter::range	(	Double_t	newMinValue,
		Double_t	newMaxValue
	)

Set the range for the parameter.

Parameters

[in]	newMinValue	the minimum value for the parameter
[in]	newMaxValue	the maximum value for the parameter

Definition at line 494 of file LauParameter.cc.

secondStage() [1/2]

Bool_t LauParameter::secondStage ( ) const

inline

Check whether the parameter should be floated only in the second stage of a two stage fit.

Returns

the boolean flag true/false whether it floats only in the second stage

Definition at line 241 of file LauParameter.hh.

secondStage() [2/2]

void LauParameter::secondStage

(

Bool_t

secondStagePar

)

Set parameter as second-stage or not of the fit.

Parameters

[in]

secondStagePar

boolean flag to check whether is a second-stage parameter

Definition at line 531 of file LauParameter.cc.

unblindValue()

Double_t LauParameter::unblindValue ( ) const

inlinevirtual

The unblinded value of the parameter.

Returns

the unblinded value of the parameter

Implements LauAbsRValue.

Definition at line 178 of file LauParameter.hh.

updateClones()

void LauParameter::updateClones ( Bool_t  justValue )

protected

Method to update clone values.

Parameters

[in]

justValue

boolean flag to determine whether it is necessary to update all the parameter settings or only its value.

Definition at line 708 of file LauParameter.cc.

value() [1/2]

Double_t LauParameter::value ( ) const

inlinevirtual

The value of the parameter.

Returns

the value of the parameter

Implements LauAbsRValue.

Definition at line 172 of file LauParameter.hh.

value() [2/2]

void LauParameter::value

(

Double_t

newValue

)

Set the value of the parameter.

Parameters

[in]

newValue

the value of the parameter

Definition at line 376 of file LauParameter.cc.

valueAndErrors()

void LauParameter::valueAndErrors	(	Double_t	newValue,
		Double_t	newError,
		Double_t	newNegError = 0.0,
		Double_t	newPosError = 0.0
	)

Set the value and errors on the parameter.

Parameters

[in]	newValue	the value of the parameter
[in]	newError	the error on the parameter
[in]	newNegError	the lower error on the parameter (default set to zero)
[in]	newPosError	the upper error on the parameter (default set to zero)

Definition at line 428 of file LauParameter.cc.

valueAndRange()

void LauParameter::valueAndRange	(	Double_t	newValue,
		Double_t	newMinValue,
		Double_t	newMaxValue
	)

Set the value and range for the parameter.

Parameters

[in]	newValue	the value of the parameter
[in]	newMinValue	the minimum value for the parameter
[in]	newMaxValue	the maximum value for the parameter

Definition at line 504 of file LauParameter.cc.

---

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

• /home/epp/phsdba/Development/Laura++/master-dev/laura/inc/LauParameter.hh
• /home/epp/phsdba/Development/Laura++/master-dev/laura/src/LauParameter.cc