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

Class for defining a complex coefficient using seperate magnitudes and phases for particles and antiparticles. More...

#include <LauMagPhaseCPCoeffSet.hh>

Inheritance diagram for LauMagPhaseCPCoeffSet:
LauAbsCoeffSet

Public Member Functions

 LauMagPhaseCPCoeffSet (const TString &compName, Double_t mag, Double_t phase, Double_t magBar, Double_t phaseBar, Bool_t magFixed, Bool_t phaseFixed, Bool_t magBarFixed, Bool_t phaseBarFixed)
 Constructor. More...
 
virtual ~LauMagPhaseCPCoeffSet ()
 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

 LauMagPhaseCPCoeffSet (const LauMagPhaseCPCoeffSet &rhs, Double_t constFactor=1.0)
 Copy constructor. More...
 
LauMagPhaseCPCoeffSetoperator= (const LauMagPhaseCPCoeffSet &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...
 
LauParametermag_
 The magnitude for particles. More...
 
LauParameterphase_
 The phase for particles. More...
 
LauParametermagBar_
 The magnitude for antiparticles. More...
 
LauParameterphaseBar_
 The phase for antiparticles. More...
 
LauParameter acp_
 The CP asymmetry. More...
 

Detailed Description

Class for defining a complex coefficient using seperate magnitudes and phases for particles and antiparticles.

Holds a set of real values that define the complex coefficient of an amplitude component. The amplitude has the form mag*exp(i*phase) for particles and magBar*exp(i*phaseBar) for antiparticles where mag and magBar are the magnitudes for particles and antiparticles respectively and phase and phaseBar are the phases for particles and antiparticles respectively.

Definition at line 39 of file LauMagPhaseCPCoeffSet.hh.

Constructor & Destructor Documentation

LauMagPhaseCPCoeffSet::LauMagPhaseCPCoeffSet ( const TString &  compName,
Double_t  mag,
Double_t  phase,
Double_t  magBar,
Double_t  phaseBar,
Bool_t  magFixed,
Bool_t  phaseFixed,
Bool_t  magBarFixed,
Bool_t  phaseBarFixed 
)

Constructor.

Parameters
[in]compNamethe name of the coefficient set
[in]magthe magnitude for particles
[in]phasethe phase for particles
[in]magBarthe magnitude for antiparticles
[in]phaseBarthe phase for antiparticles
[in]magFixedwhether mag is fixed
[in]phaseFixedwhether phase is fixed
[in]magBarFixedwhether magBar is fixed
[in]phaseBarFixedwhether phaseBar is fixed

Definition at line 35 of file LauMagPhaseCPCoeffSet.cc.

virtual LauMagPhaseCPCoeffSet::~LauMagPhaseCPCoeffSet ( )
inlinevirtual

Destructor.

Definition at line 58 of file LauMagPhaseCPCoeffSet.hh.

LauMagPhaseCPCoeffSet::LauMagPhaseCPCoeffSet ( const LauMagPhaseCPCoeffSet 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 54 of file LauMagPhaseCPCoeffSet.cc.

Member Function Documentation

LauParameter LauMagPhaseCPCoeffSet::acp ( )
virtual

Calculate the CP asymmetry.

Returns
the CP asymmetry

Implements LauAbsCoeffSet.

Definition at line 245 of file LauMagPhaseCPCoeffSet.cc.

LauComplex LauMagPhaseCPCoeffSet::antiparticleCoeff ( )
virtual

Retrieve the complex coefficient for an antiparticle.

Returns
the complex coefficient for an antiparticle

Implements LauAbsCoeffSet.

Definition at line 231 of file LauMagPhaseCPCoeffSet.cc.

LauAbsCoeffSet * LauMagPhaseCPCoeffSet::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 269 of file LauMagPhaseCPCoeffSet.cc.

void LauMagPhaseCPCoeffSet::finaliseValues ( )
virtual

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

Implements LauAbsCoeffSet.

Definition at line 151 of file LauMagPhaseCPCoeffSet.cc.

std::vector< LauParameter * > LauMagPhaseCPCoeffSet::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 85 of file LauMagPhaseCPCoeffSet.cc.

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

Copy assignment operator.

This creates cloned parameters, not copies.

Parameters
[in]rhsthe coefficient to clone

Definition at line 67 of file LauMagPhaseCPCoeffSet.cc.

LauComplex LauMagPhaseCPCoeffSet::particleCoeff ( )
virtual

Retrieve the complex coefficient for a particle.

Returns
the complex coefficient for a particle

Implements LauAbsCoeffSet.

Definition at line 226 of file LauMagPhaseCPCoeffSet.cc.

void LauMagPhaseCPCoeffSet::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 95 of file LauMagPhaseCPCoeffSet.cc.

void LauMagPhaseCPCoeffSet::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 103 of file LauMagPhaseCPCoeffSet.cc.

void LauMagPhaseCPCoeffSet::randomiseInitValues ( )
virtual

Randomise the starting values of the parameters for a fit.

Implements LauAbsCoeffSet.

Definition at line 127 of file LauMagPhaseCPCoeffSet.cc.

void LauMagPhaseCPCoeffSet::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 LauMagPhaseCPCoeffSet.cc.

Member Data Documentation

LauParameter LauMagPhaseCPCoeffSet::acp_
private

The CP asymmetry.

Definition at line 155 of file LauMagPhaseCPCoeffSet.hh.

LauParameter* LauMagPhaseCPCoeffSet::mag_
private

The magnitude for particles.

Definition at line 146 of file LauMagPhaseCPCoeffSet.hh.

LauParameter* LauMagPhaseCPCoeffSet::magBar_
private

The magnitude for antiparticles.

Definition at line 150 of file LauMagPhaseCPCoeffSet.hh.

Double_t LauMagPhaseCPCoeffSet::maxMag_
private

The maximum allowed value for magnitudes.

Definition at line 137 of file LauMagPhaseCPCoeffSet.hh.

Double_t LauMagPhaseCPCoeffSet::maxPhase_
private

The maximum allowed value for phases.

Definition at line 141 of file LauMagPhaseCPCoeffSet.hh.

Double_t LauMagPhaseCPCoeffSet::minMag_
private

The minimum allowed value for magnitudes.

Definition at line 135 of file LauMagPhaseCPCoeffSet.hh.

Double_t LauMagPhaseCPCoeffSet::minPhase_
private

The minimum allowed value for phases.

Definition at line 139 of file LauMagPhaseCPCoeffSet.hh.

LauParameter* LauMagPhaseCPCoeffSet::phase_
private

The phase for particles.

Definition at line 148 of file LauMagPhaseCPCoeffSet.hh.

LauParameter* LauMagPhaseCPCoeffSet::phaseBar_
private

The phase for antiparticles.

Definition at line 152 of file LauMagPhaseCPCoeffSet.hh.


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