Class for defining the abstract interface for complex coefficient classes. More...

#include <LauAbsCoeffSet.hh>

Inheritance diagram for LauAbsCoeffSet:

Public Types
enum	CloneOption { All, TiePhase, TieMagnitude, TieRealPart, TieImagPart, TieCPPars }
	Options for cloning operation. More...

Public Member Functions
virtual	~LauAbsCoeffSet ()
	Destructor.

virtual std::vector< LauParameter * >	getParameters ()=0
	Retrieve the parameters of the coefficient so that they can be loaded into a fit. More...

virtual void	printParValues () const =0
	Print the current values of the parameters.

virtual void	printTableHeading (std::ostream &stream) const =0
	Print the column headings for a results table. More...

virtual void	printTableRow (std::ostream &stream) const =0
	Print the parameters of the complex coefficient as a row in the results table. More...

virtual void	randomiseInitValues ()=0
	Randomise the starting values of the parameters for a fit.

virtual void	finaliseValues ()=0
	Make sure values are in "standard" ranges, e.g. phases should be between -pi and pi.

virtual const LauComplex &	particleCoeff ()=0
	Retrieve the complex coefficient for a particle. More...

virtual const LauComplex &	antiparticleCoeff ()=0
	Retrieve the complex coefficient for an antiparticle. More...

virtual void	setCoeffValues (const LauComplex &coeff, const LauComplex &coeffBar, Bool_t init)=0
	Set the parameters based on the complex coefficients for particles and antiparticles. More...

virtual LauParameter	acp ()=0
	Calculate the CP asymmetry. More...

virtual LauAbsCoeffSet *	createClone (const TString &newName, CloneOption cloneOption=All, Double_t constFactor=1.0)=0
	Create a clone of the coefficient set. More...

virtual TString	name () const
	Retrieve the name of the coefficient set. More...

virtual void	name (const TString &theName)
	Set the name of the coefficient set. More...

virtual const TString &	baseName () const
	Retrieve the base name of the coefficient set. More...

virtual void	baseName (const TString &theBasename)
	Set the base name of the coefficient set. More...

virtual UInt_t	index () const
	Retrieve the index number of the coefficient set. More...

virtual void	index (UInt_t newIndex)
	Set the index number of the coefficient set. More...

virtual void	setParameterValue (const TString &parName, Double_t value, Bool_t init)
	Set the value of the named parameter. More...

virtual void	setParameterError (const TString &parName, Double_t error)
	Set the error of the named parameter. More...

virtual void	fixParameter (const TString &parName)
	Set the named parameter to be fixed in the fit. More...

virtual void	floatParameter (const TString &parName)
	Set the named parameter to float in the fit. More...

virtual void	blindParameter (const TString &parName, const TString &blindingString, const Double_t width)
	Blind the named parameter. More...

virtual void	addGaussianConstraint (const TString &parName, const Double_t mean, const Double_t width)
	Add Gaussian constraint to the named parameter. More...

virtual void	addSuffixToParameterName (const TString &parName, const TString &suffix)
	Add suffix to the name of the given parameter. More...

Static Public Member Functions
static void	setMagnitudeRange (Double_t minMag, Double_t maxMag)
	Set the allowed range for magnitude parameters. More...

static void	setPhaseRange (Double_t minPhase, Double_t maxPhase)
	Set the allowed range for phase parameters. More...

static void	setRealImagRange (Double_t minPar, Double_t maxPar)
	Set the allowed range for real/imaginary part parameters. More...

static void	setCPParRange (Double_t minPar, Double_t maxPar)
	Set the allowed range for CP-violating parameters. More...

static void	setRandomiser (TRandom *randomiser)
	Set the randomiser. More...

static TRandom *	getRandomiser ()
	Access the randomiser. More...

Protected Member Functions
	LauAbsCoeffSet (const TString &theName, const TString &theBaseName="A")
	Constructor. More...

LauParameter *	findParameter (const TString &parName)
	Find the parameter with the given name. More...

virtual void	adjustName (LauParameter *par, const TString &oldBaseName)
	Prepend the base name and index to the name of a parameter. More...

	LauAbsCoeffSet (const LauAbsCoeffSet &rhs)
	Copy constructor. More...

LauAbsCoeffSet &	operator= (const LauAbsCoeffSet &rhs)
	Copy assignment operator. More...

Static Protected Attributes
static Double_t	minMagnitude_ = -10.0
	Minimum allowed value of magnitude parameters.

static Double_t	maxMagnitude_ = 10.0
	Maximum allowed value of magnitude parameters.

static Double_t	minPhase_ = -LauConstants::threePi
	Minimum allowed value of phase parameters.

static Double_t	maxPhase_ = LauConstants::threePi
	Maximum allowed value of phase parameters.

static Double_t	minRealImagPart_ = -10.0
	Minimum allowed value of real/imaginary part parameters.

static Double_t	maxRealImagPart_ = 10.0
	Maximum allowed value of real/imaginary part parameters.

static Double_t	minDelta_ = -2.0
	Minimum allowed value of CP-violating real/imaginary part parameters.

static Double_t	maxDelta_ = 2.0
	Maximum allowed value of CP-violating real/imaginary part parameters.

Private Attributes
TString	name_
	The name of the coefficient set.

TString	basename_
	The base name of the coefficient set.

UInt_t	index_
	The index number of the coefficient set.

Static Private Attributes
static TRandom *	randomiser_ = 0
	Random number generator to use for randomising parameter starting values.

Detailed Description

Class for defining the abstract interface for complex coefficient classes.

Class for defining the abstract interface for complex coefficient classes. Some common code is implemented but most methods are not.

Definition at line 48 of file LauAbsCoeffSet.hh.

Member Enumeration Documentation

◆ CloneOption

enum LauAbsCoeffSet::CloneOption

Options for cloning operation.

Enumerator
All	no special operation, all parameters cloned
TiePhase	phase cloned, magnitude free to vary
TieMagnitude	magnitude cloned, phase free to vary
TieRealPart	real part cloned, imaginary part free to vary
TieImagPart	imaginary part cloned, real part free to vary
TieCPPars	CP-violating parameters cloned, CP-conserving ones free to vary

Definition at line 52 of file LauAbsCoeffSet.hh.

Constructor & Destructor Documentation

◆ LauAbsCoeffSet() [1/2]

LauAbsCoeffSet::LauAbsCoeffSet	(	const TString &	theName,
		const TString &	theBaseName = `"A"`
	)

protected

Constructor.

Parameters

[in]	theName	the name of the coefficient set
[in]	theBaseName	the single character base for the parameter names

Definition at line 49 of file LauAbsCoeffSet.cc.

◆ LauAbsCoeffSet() [2/2]

LauAbsCoeffSet::LauAbsCoeffSet ( const LauAbsCoeffSet & rhs )

protected

Copy constructor.

Parameters

[in] rhs the coefficient to clone

Definition at line 56 of file LauAbsCoeffSet.cc.

Member Function Documentation

◆ acp()

virtual LauParameter LauAbsCoeffSet::acp ( )

pure virtual

Calculate the CP asymmetry.

Returns: the CP asymmetry

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ addGaussianConstraint()

void LauAbsCoeffSet::addGaussianConstraint	(	const TString &	parName,
		const Double_t	mean,
		const Double_t	width
	)

virtual

Add Gaussian constraint to the named parameter.

Parameters

[in]	parName	the name of the parameter to adjust
[in]	mean	the mean of the Gaussian constraint
[in]	width	the width of the Gaussian constraint

Definition at line 176 of file LauAbsCoeffSet.cc.

◆ addSuffixToParameterName()

void LauAbsCoeffSet::addSuffixToParameterName	(	const TString &	parName,
		const TString &	suffix
	)

virtual

Add suffix to the name of the given parameter.

Parameters

[in]	parName	the name of the parameter to adjust
[in]	suffix	the suffix to add to the parameter name

Definition at line 190 of file LauAbsCoeffSet.cc.

◆ adjustName()

void LauAbsCoeffSet::adjustName	(	LauParameter *	par,
		const TString &	oldBaseName
	)

protectedvirtual

Prepend the base name and index to the name of a parameter.

Parameters

[in,out]	par	pointer to the parameter
[in]	oldBaseName	the old base name, which might need to be removed before adding the new one

Reimplemented in LauPolarGammaCPCoeffSet.

Definition at line 100 of file LauAbsCoeffSet.cc.

◆ antiparticleCoeff()

virtual const LauComplex& LauAbsCoeffSet::antiparticleCoeff ( )

pure virtual

Retrieve the complex coefficient for an antiparticle.

Returns: the complex coefficient for an antiparticle

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ baseName() [1/2]

virtual const TString& LauAbsCoeffSet::baseName ( ) const

inlinevirtual

Retrieve the base name of the coefficient set.

The base name is generally of the form "Ai", where i is an integer. This is used in the fit results ntuple.

Returns: the base name of the coefficient set

Definition at line 151 of file LauAbsCoeffSet.hh.

◆ baseName() [2/2]

virtual void LauAbsCoeffSet::baseName ( const TString & theBasename )

inlinevirtual

Set the base name of the coefficient set.

The base name is generally of the form "Ai", where i is an integer. This is used in the fit results ntuple.

Parameters

[in] theBasename the base name to set

Definition at line 160 of file LauAbsCoeffSet.hh.

◆ blindParameter()

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

virtual

Blind the named parameter.

See LauBlind documentation for details of blinding procedure

Parameters

[in]	parName	the name of the parameter to adjust
[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 162 of file LauAbsCoeffSet.cc.

◆ createClone()

virtual LauAbsCoeffSet* LauAbsCoeffSet::createClone	(	const TString &	newName,
		CloneOption	cloneOption = `All`,
		Double_t	constFactor = `1.0`
	)

pure virtual

Create a clone of the coefficient set.

Parameters

[in]	newName	the clone's name
[in]	cloneOption	special option for the cloning operation
[in]	constFactor	a constant factor by which to multiply the cloned parameters

Returns: a clone of the coefficient set

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ findParameter()

LauParameter * LauAbsCoeffSet::findParameter ( const TString & parName )

protected

Find the parameter with the given name.

Parameters

[in] parName the name of the parameter to be found return the retrieved parameter

Definition at line 207 of file LauAbsCoeffSet.cc.

◆ fixParameter()

void LauAbsCoeffSet::fixParameter ( const TString & parName )

virtual

Set the named parameter to be fixed in the fit.

Parameters

[in] parName the name of the parameter to adjust

Definition at line 138 of file LauAbsCoeffSet.cc.

◆ floatParameter()

void LauAbsCoeffSet::floatParameter ( const TString & parName )

virtual

Set the named parameter to float in the fit.

Parameters

[in] parName the name of the parameter to adjust

Definition at line 150 of file LauAbsCoeffSet.cc.

◆ getParameters()

virtual std::vector<LauParameter*> LauAbsCoeffSet::getParameters ( )

pure virtual

Retrieve the parameters of the coefficient so that they can be loaded into a fit.

Returns: the parameters of the coefficient

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ getRandomiser()

TRandom * LauAbsCoeffSet::getRandomiser ( )

static

Access the randomiser.

Returns: the random number generator to use for randomising parameter starting values

Definition at line 73 of file LauAbsCoeffSet.cc.

◆ index() [1/2]

virtual UInt_t LauAbsCoeffSet::index ( ) const

inlinevirtual

Retrieve the index number of the coefficient set.

Returns: the index number of the coefficient set

Definition at line 166 of file LauAbsCoeffSet.hh.

◆ index() [2/2]

void LauAbsCoeffSet::index ( UInt_t newIndex )

virtual

Set the index number of the coefficient set.

Parameters

[in] newIndex the new index

Definition at line 81 of file LauAbsCoeffSet.cc.

◆ name() [1/2]

virtual TString LauAbsCoeffSet::name ( ) const

inlinevirtual

Retrieve the name of the coefficient set.

The name should correspond to the name of the resonance in the model.

Returns: the name of the coefficient set

Definition at line 134 of file LauAbsCoeffSet.hh.

◆ name() [2/2]

virtual void LauAbsCoeffSet::name ( const TString & theName )

inlinevirtual

Set the name of the coefficient set.

The name should correspond to the name of the resonance in the model.

Parameters

[in] theName the name to set

Definition at line 142 of file LauAbsCoeffSet.hh.

◆ operator=()

LauAbsCoeffSet & LauAbsCoeffSet::operator= ( const LauAbsCoeffSet & rhs )

protected

Copy assignment operator.

Parameters

[in] rhs the coefficient to clone

Definition at line 63 of file LauAbsCoeffSet.cc.

◆ particleCoeff()

virtual const LauComplex& LauAbsCoeffSet::particleCoeff ( )

pure virtual

Retrieve the complex coefficient for a particle.

Returns: the complex coefficient for a particle

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ printTableHeading()

virtual void LauAbsCoeffSet::printTableHeading ( std::ostream & stream ) const

pure virtual

Print the column headings for a results table.

Parameters

[out] stream the stream to print to

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ printTableRow()

virtual void LauAbsCoeffSet::printTableRow ( std::ostream & stream ) const

pure virtual

Print the parameters of the complex coefficient as a row in the results table.

Parameters

[out] stream the stream to print to

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ setCoeffValues()

virtual void LauAbsCoeffSet::setCoeffValues	(	const LauComplex &	coeff,
		const LauComplex &	coeffBar,
		Bool_t	init
	)

pure virtual

Set the parameters based on the complex coefficients for particles and antiparticles.

Parameters

[in]	coeff	the complex coefficient for a particle
[in]	coeffBar	the complex coefficient for an antiparticle
[in]	init	whether or not the initial and generated values should also be adjusted

Implemented in LauPolarGammaCPCoeffSet, LauCartesianGammaCPCoeffSet, LauRealImagGammaCPCoeffSet, LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCPCoeffSet, LauRealImagCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

◆ setCPParRange()

static void LauAbsCoeffSet::setCPParRange	(	Double_t	minPar,
		Double_t	maxPar
	)

inlinestatic

Set the allowed range for CP-violating parameters.

Parameters

[in]	minPar	the lower edge of the range
[in]	maxPar	the upper edge of the range

Definition at line 270 of file LauAbsCoeffSet.hh.

◆ setMagnitudeRange()

static void LauAbsCoeffSet::setMagnitudeRange	(	Double_t	minMag,
		Double_t	maxMag
	)

inlinestatic

Set the allowed range for magnitude parameters.

Parameters

[in]	minMag	the lower edge of the range
[in]	maxMag	the upper edge of the range

Definition at line 237 of file LauAbsCoeffSet.hh.

◆ setParameterError()

void LauAbsCoeffSet::setParameterError	(	const TString &	parName,
		Double_t	error
	)

virtual

Set the error of the named parameter.

This is particularly useful for tuning the step size used by MINUIT

Parameters

[in]	parName	the name of the parameter to adjust
[in]	error	the new error value for the parameter to take

Definition at line 126 of file LauAbsCoeffSet.cc.

◆ setParameterValue()

void LauAbsCoeffSet::setParameterValue	(	const TString &	parName,
		Double_t	value,
		Bool_t	init
	)

virtual

Set the value of the named parameter.

Parameters

[in]	parName	the name of the parameter to adjust
[in]	value	the new value for the parameter to take
[in]	init	whether or not the initial and generated values should also be adjusted

Definition at line 110 of file LauAbsCoeffSet.cc.

◆ setPhaseRange()

static void LauAbsCoeffSet::setPhaseRange	(	Double_t	minPhase,
		Double_t	maxPhase
	)

inlinestatic

Set the allowed range for phase parameters.

Parameters

[in]	minPhase	the lower edge of the range
[in]	maxPhase	the upper edge of the range

Definition at line 248 of file LauAbsCoeffSet.hh.

◆ setRandomiser()

static void LauAbsCoeffSet::setRandomiser ( TRandom * randomiser )

inlinestatic

Set the randomiser.

Set the random number generator to use for randomising parameter starting values. Will default to LauRandom::zeroSeedRandom if not explicitly supplied via this function.

Parameters

[in] randomiser the random number generator to use for randomising parameter starting values

Definition at line 283 of file LauAbsCoeffSet.hh.

◆ setRealImagRange()

static void LauAbsCoeffSet::setRealImagRange	(	Double_t	minPar,
		Double_t	maxPar
	)

inlinestatic

Set the allowed range for real/imaginary part parameters.

Parameters

[in]	minPar	the lower edge of the range
[in]	maxPar	the upper edge of the range

Definition at line 259 of file LauAbsCoeffSet.hh.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CloneOption

Constructor & Destructor Documentation

◆ LauAbsCoeffSet() [1/2]

◆ LauAbsCoeffSet() [2/2]

Member Function Documentation

◆ acp()

◆ addGaussianConstraint()

◆ addSuffixToParameterName()

◆ adjustName()

◆ antiparticleCoeff()

◆ baseName() [1/2]

◆ baseName() [2/2]

◆ blindParameter()

◆ createClone()

◆ findParameter()

◆ fixParameter()

◆ floatParameter()

◆ getParameters()

◆ getRandomiser()

◆ index() [1/2]

◆ index() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ operator=()

◆ particleCoeff()

◆ printTableHeading()

◆ printTableRow()

◆ setCoeffValues()

◆ setCPParRange()

◆ setMagnitudeRange()

◆ setParameterError()

◆ setParameterValue()

◆ setPhaseRange()

◆ setRandomiser()

◆ setRealImagRange()