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

Class for defining a complex coefficient using the Cleo CP convention. More...

#include <LauCleoCPCoeffSet.hh>

Inheritance diagram for LauCleoCPCoeffSet:
LauAbsCoeffSet

Public Member Functions

 LauCleoCPCoeffSet (const TString &compName, Double_t a, Double_t delta, Double_t b, Double_t phi, Bool_t aFixed, Bool_t deltaFixed, Bool_t bFixed, Bool_t phiFixed)
 Constructor. More...
 
virtual ~LauCleoCPCoeffSet ()
 Destructor. More...
 
virtual std::vector
< LauParameter * > 
getParameters ()
 Retrieve the parameters of the coefficient, e.g. so that they can be loaded into a fit. More...
 
virtual void printTableHeading (std::ostream &stream)
 Print the column headings for a results table. More...
 
virtual void printTableRow (std::ostream &stream)
 Print the parameters of the complex coefficient as a row in the results table. More...
 
virtual void randomiseInitValues ()
 Randomise the starting values of the parameters for a fit. More...
 
virtual void finaliseValues ()
 Make sure values are in "standard" ranges, e.g. phases should be between -pi and pi. More...
 
virtual LauComplex particleCoeff ()
 Retrieve the complex coefficient for a particle. More...
 
virtual LauComplex antiparticleCoeff ()
 Retrieve the complex coefficient for an antiparticle. More...
 
virtual void setCoeffValues (const LauComplex &coeff, const LauComplex &coeffBar)
 Set the parameters based on the complex coefficients for particles and antiparticles. More...
 
virtual LauParameter acp ()
 Calculate the CP asymmetry. More...
 
virtual LauAbsCoeffSetcreateClone (const TString &newName, Double_t constFactor=1.0)
 Create a clone of the coefficient set. More...
 
- Public Member Functions inherited from LauAbsCoeffSet
virtual ~LauAbsCoeffSet ()
 Destructor. 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

 LauCleoCPCoeffSet (const LauCleoCPCoeffSet &rhs, Double_t constFactor=1.0)
 Copy constructor. More...
 
LauCleoCPCoeffSetoperator= (const LauCleoCPCoeffSet &rhs)
 Copy assignment operator. More...
 
- Protected Member Functions inherited from LauAbsCoeffSet
 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

Double_t minMag_
 The minimum allowed value for magnitudes. More...
 
Double_t maxMag_
 The maximum allowed value for magnitudes. More...
 
Double_t minPhase_
 The minimum allowed value for phases. More...
 
Double_t maxPhase_
 The maximum allowed value for phases. More...
 
LauParametera_
 The magnitude a. More...
 
LauParameterb_
 The magnitude b. More...
 
LauParameterdelta_
 The strong phase. More...
 
LauParameterphi_
 The weak phase. More...
 
LauParameter acp_
 The CP asymmetry. More...
 

Detailed Description

Class for defining a complex coefficient using the Cleo CP convention.

Holds a set of real values that define the complex coefficient of an amplitude component. The amplitude has the form (a +/- b) * exp( i*(delta +/- phi) ) where a is the average magnitude, b is the asymmetric magnitude, delta is the strong phase and phi is the weak phase. TODO - add reference

Definition at line 41 of file LauCleoCPCoeffSet.hh.

Constructor & Destructor Documentation

LauCleoCPCoeffSet::LauCleoCPCoeffSet ( const TString &  compName,
Double_t  a,
Double_t  delta,
Double_t  b,
Double_t  phi,
Bool_t  aFixed,
Bool_t  deltaFixed,
Bool_t  bFixed,
Bool_t  phiFixed 
)

Constructor.

Parameters
[in]compNamethe name of the coefficient set
[in]athe magnitude a
[in]deltathe strong phase
[in]bthe magnitude b
[in]phithe weak phase
[in]aFixedwhether a is fixed
[in]deltaFixedwhether delta is fixed
[in]bFixedwhether b is fixed
[in]phiFixedwhether phi is fixed

Definition at line 35 of file LauCleoCPCoeffSet.cc.

virtual LauCleoCPCoeffSet::~LauCleoCPCoeffSet ( )
inlinevirtual

Destructor.

Definition at line 60 of file LauCleoCPCoeffSet.hh.

LauCleoCPCoeffSet::LauCleoCPCoeffSet ( const LauCleoCPCoeffSet rhs,
Double_t  constFactor = 1.0 
)
protected

Copy constructor.

This creates cloned parameters, not copies.

Parameters
[in]rhsthe coefficient to clone
[in]constFactora constant factor to multiply the clone's parameters by

Definition at line 53 of file LauCleoCPCoeffSet.cc.

Member Function Documentation

LauParameter LauCleoCPCoeffSet::acp ( )
virtual

Calculate the CP asymmetry.

Returns
the CP asymmetry

Implements LauAbsCoeffSet.

Definition at line 250 of file LauCleoCPCoeffSet.cc.

LauComplex LauCleoCPCoeffSet::antiparticleCoeff ( )
virtual

Retrieve the complex coefficient for an antiparticle.

Returns
the complex coefficient for an antiparticle

Implements LauAbsCoeffSet.

Definition at line 228 of file LauCleoCPCoeffSet.cc.

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

Create a clone of the coefficient set.

Parameters
[in]newNamethe clone's name
[in]constFactora constant factor to multiply the clone's parameters by
Returns
a clone of the coefficient set

Implements LauAbsCoeffSet.

Definition at line 274 of file LauCleoCPCoeffSet.cc.

void LauCleoCPCoeffSet::finaliseValues ( )
virtual

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

Implements LauAbsCoeffSet.

Definition at line 150 of file LauCleoCPCoeffSet.cc.

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

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

Returns
the parameters of the coefficient

Implements LauAbsCoeffSet.

Definition at line 84 of file LauCleoCPCoeffSet.cc.

LauCleoCPCoeffSet & LauCleoCPCoeffSet::operator= ( const LauCleoCPCoeffSet rhs)
protected

Copy assignment operator.

This creates cloned parameters, not copies.

Parameters
[in]rhsthe coefficient to clone

Definition at line 66 of file LauCleoCPCoeffSet.cc.

LauComplex LauCleoCPCoeffSet::particleCoeff ( )
virtual

Retrieve the complex coefficient for a particle.

Returns
the complex coefficient for a particle

Implements LauAbsCoeffSet.

Definition at line 220 of file LauCleoCPCoeffSet.cc.

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

Print the column headings for a results table.

Parameters
[out]streamthe stream to print to

Implements LauAbsCoeffSet.

Definition at line 94 of file LauCleoCPCoeffSet.cc.

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

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

Parameters
[out]streamthe stream to print to

Implements LauAbsCoeffSet.

Definition at line 102 of file LauCleoCPCoeffSet.cc.

void LauCleoCPCoeffSet::randomiseInitValues ( )
virtual

Randomise the starting values of the parameters for a fit.

Implements LauAbsCoeffSet.

Definition at line 126 of file LauCleoCPCoeffSet.cc.

void LauCleoCPCoeffSet::setCoeffValues ( const LauComplex coeff,
const LauComplex coeffBar 
)
virtual

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

Parameters
[in]coeffthe complex coefficient for a particle
[in]coeffBarthe complex coefficient for an antiparticle

Implements LauAbsCoeffSet.

Definition at line 236 of file LauCleoCPCoeffSet.cc.

Member Data Documentation

LauParameter* LauCleoCPCoeffSet::a_
private

The magnitude a.

Definition at line 149 of file LauCleoCPCoeffSet.hh.

LauParameter LauCleoCPCoeffSet::acp_
private

The CP asymmetry.

Definition at line 158 of file LauCleoCPCoeffSet.hh.

LauParameter* LauCleoCPCoeffSet::b_
private

The magnitude b.

Definition at line 151 of file LauCleoCPCoeffSet.hh.

LauParameter* LauCleoCPCoeffSet::delta_
private

The strong phase.

Definition at line 153 of file LauCleoCPCoeffSet.hh.

Double_t LauCleoCPCoeffSet::maxMag_
private

The maximum allowed value for magnitudes.

Definition at line 140 of file LauCleoCPCoeffSet.hh.

Double_t LauCleoCPCoeffSet::maxPhase_
private

The maximum allowed value for phases.

Definition at line 144 of file LauCleoCPCoeffSet.hh.

Double_t LauCleoCPCoeffSet::minMag_
private

The minimum allowed value for magnitudes.

Definition at line 138 of file LauCleoCPCoeffSet.hh.

Double_t LauCleoCPCoeffSet::minPhase_
private

The minimum allowed value for phases.

Definition at line 142 of file LauCleoCPCoeffSet.hh.

LauParameter* LauCleoCPCoeffSet::phi_
private

The weak phase.

Definition at line 155 of file LauCleoCPCoeffSet.hh.


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