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 real and imaginary parts. More...

#include <LauRealImagCoeffSet.hh>

Inheritance diagram for LauRealImagCoeffSet:
LauAbsCoeffSet

Public Member Functions

 LauRealImagCoeffSet (const TString &compName, Double_t x, Double_t y, Bool_t xFixed, Bool_t yFixed)
 Constructor. More...
 
virtual ~LauRealImagCoeffSet ()
 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

 LauRealImagCoeffSet (const LauRealImagCoeffSet &rhs, Double_t constFactor=1.0)
 Copy constructor. More...
 
LauRealImagCoeffSetoperator= (const LauRealImagCoeffSet &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 minPar_
 The minimum allowed value for parameters. More...
 
Double_t maxPar_
 The maximum allowed value for parameters. More...
 
LauParameterx_
 The real part. More...
 
LauParametery_
 The imaginary part. More...
 

Detailed Description

Class for defining a complex coefficient using real and imaginary parts.

Holds a set of real values that define the complex coefficient of an amplitude component. The amplitude has the form x + i*y.

Definition at line 36 of file LauRealImagCoeffSet.hh.

Constructor & Destructor Documentation

LauRealImagCoeffSet::LauRealImagCoeffSet ( const TString &  compName,
Double_t  x,
Double_t  y,
Bool_t  xFixed,
Bool_t  yFixed 
)

Constructor.

Parameters
[in]compNamethe name of the coefficient set
[in]xthe real part
[in]ythe imaginary part
[in]xFixedwhether x is fixed
[in]yFixedwhether y is fixed

Definition at line 35 of file LauRealImagCoeffSet.cc.

virtual LauRealImagCoeffSet::~LauRealImagCoeffSet ( )
inlinevirtual

Destructor.

Definition at line 50 of file LauRealImagCoeffSet.hh.

LauRealImagCoeffSet::LauRealImagCoeffSet ( const LauRealImagCoeffSet 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 46 of file LauRealImagCoeffSet.cc.

Member Function Documentation

LauParameter LauRealImagCoeffSet::acp ( )
virtual

Calculate the CP asymmetry.

Returns
the CP asymmetry (zero by design)

Implements LauAbsCoeffSet.

Definition at line 140 of file LauRealImagCoeffSet.cc.

LauComplex LauRealImagCoeffSet::antiparticleCoeff ( )
virtual

Retrieve the complex coefficient for an antiparticle.

Returns
the complex coefficient for an antiparticle

Implements LauAbsCoeffSet.

Definition at line 125 of file LauRealImagCoeffSet.cc.

LauAbsCoeffSet * LauRealImagCoeffSet::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 146 of file LauRealImagCoeffSet.cc.

void LauRealImagCoeffSet::finaliseValues ( )
virtual

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

Implements LauAbsCoeffSet.

Definition at line 113 of file LauRealImagCoeffSet.cc.

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

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

Copy assignment operator.

This creates cloned parameters, not copies.

Parameters
[in]rhsthe coefficient to clone

Definition at line 54 of file LauRealImagCoeffSet.cc.

LauComplex LauRealImagCoeffSet::particleCoeff ( )
virtual

Retrieve the complex coefficient for a particle.

Returns
the complex coefficient for a particle

Implements LauAbsCoeffSet.

Definition at line 119 of file LauRealImagCoeffSet.cc.

void LauRealImagCoeffSet::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 75 of file LauRealImagCoeffSet.cc.

void LauRealImagCoeffSet::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 83 of file LauRealImagCoeffSet.cc.

void LauRealImagCoeffSet::randomiseInitValues ( )
virtual

Randomise the starting values of the parameters for a fit.

Implements LauAbsCoeffSet.

Definition at line 99 of file LauRealImagCoeffSet.cc.

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

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

This class does not support CP violation so this method takes the average of the two inputs.

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

Implements LauAbsCoeffSet.

Definition at line 130 of file LauRealImagCoeffSet.cc.

Member Data Documentation

Double_t LauRealImagCoeffSet::maxPar_
private

The maximum allowed value for parameters.

Definition at line 131 of file LauRealImagCoeffSet.hh.

Double_t LauRealImagCoeffSet::minPar_
private

The minimum allowed value for parameters.

Definition at line 129 of file LauRealImagCoeffSet.hh.

LauParameter* LauRealImagCoeffSet::x_
private

The real part.

Definition at line 136 of file LauRealImagCoeffSet.hh.

LauParameter* LauRealImagCoeffSet::y_
private

The imaginary part.

Definition at line 138 of file LauRealImagCoeffSet.hh.


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