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

#include <LauAbsCoeffSet.hh>

Inheritance diagram for LauAbsCoeffSet:

Public Member Functions
virtual	~LauAbsCoeffSet ()
	Destructor. More...

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

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

virtual void	printTableRow (std::ostream &stream)=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. More...

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

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

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

virtual void	setCoeffValues (const LauComplex &coeff, const LauComplex &coeffBar)=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, 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 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...

Protected Member Functions
	LauAbsCoeffSet (const TString &theName)
	Constructor. More...

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

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

Private Attributes
TString	name_
	The name of the coefficient set. More...

TString	basename_
	The base name of the coefficient set. More...

UInt_t	index_
	The index number of the coefficient set. More...

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 34 of file LauAbsCoeffSet.hh.

Constructor & Destructor Documentation

virtual LauAbsCoeffSet::~LauAbsCoeffSet ( )

inlinevirtual

Destructor.

Definition at line 38 of file LauAbsCoeffSet.hh.

LauAbsCoeffSet::LauAbsCoeffSet ( const TString & theName )

protected

Constructor.

Parameters

[in] theName the name of the coefficient set

Definition at line 23 of file LauAbsCoeffSet.cc.

Member Function Documentation

virtual LauParameter LauAbsCoeffSet::acp ( )

pure virtual

Calculate the CP asymmetry.

Returns: the CP asymmetry

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

void LauAbsCoeffSet::adjustName ( LauParameter & par )

protectedvirtual

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

Parameters

[out] par the parameter

Definition at line 44 of file LauAbsCoeffSet.cc.

void LauAbsCoeffSet::adjustName ( LauParameter * par )

protectedvirtual

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

Parameters

[out] par pointer to the parameter

Definition at line 52 of file LauAbsCoeffSet.cc.

virtual LauComplex LauAbsCoeffSet::antiparticleCoeff ( )

pure virtual

Retrieve the complex coefficient for an antiparticle.

Returns: the complex coefficient for an antiparticle

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

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

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 125 of file LauAbsCoeffSet.hh.

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

pure virtual

Create a clone of the coefficient set.

Parameters

[in]	newName	the clone's name
[in]	constFactor	a constant factor to multiply the clone's parameters by

Returns: a clone of the coefficient set

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

virtual void LauAbsCoeffSet::finaliseValues ( )

pure virtual

Make sure values are in "standard" ranges, e.g. phases should be between -pi and pi.

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

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 LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

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 131 of file LauAbsCoeffSet.hh.

void LauAbsCoeffSet::index ( UInt_t newIndex )

virtual

Set the index number of the coefficient set.

Parameters

[in] newIndex the new index

Definition at line 30 of file LauAbsCoeffSet.cc.

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 102 of file LauAbsCoeffSet.hh.

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 109 of file LauAbsCoeffSet.hh.

virtual LauComplex LauAbsCoeffSet::particleCoeff ( )

pure virtual

Retrieve the complex coefficient for a particle.

Returns: the complex coefficient for a particle

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

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

pure virtual

Print the column headings for a results table.

Parameters

[out] stream the stream to print to

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

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

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 LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

virtual void LauAbsCoeffSet::randomiseInitValues ( )

pure virtual

Randomise the starting values of the parameters for a fit.

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

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

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

Implemented in LauBelleCPCoeffSet, LauCleoCPCoeffSet, LauMagPhaseCPCoeffSet, LauCartesianCPCoeffSet, LauMagPhaseCoeffSet, and LauRealImagCoeffSet.

Member Data Documentation

TString LauAbsCoeffSet::basename_

private

The base name of the coefficient set.

Definition at line 163 of file LauAbsCoeffSet.hh.

UInt_t LauAbsCoeffSet::index_

private

The index number of the coefficient set.

Definition at line 166 of file LauAbsCoeffSet.hh.

TString LauAbsCoeffSet::name_

private

The name of the coefficient set.

Definition at line 160 of file LauAbsCoeffSet.hh.

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

inc/LauAbsCoeffSet.hh
src/LauAbsCoeffSet.cc

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation