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

#include <LauCartesianCPCoeffSet.hh>

Inheritance diagram for LauCartesianCPCoeffSet:

Public Member Functions
	LauCartesianCPCoeffSet (const TString &compName, Double_t x, Double_t y, Double_t deltaX, Double_t deltaY, Bool_t xFixed, Bool_t yFixed, Bool_t deltaXFixed, Bool_t deltaYFixed, Bool_t deltaXSecondStage=kFALSE, Bool_t deltaYSecondStage=kFALSE)
	Constructor. More...

virtual	~LauCartesianCPCoeffSet ()
	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	printParValues () const
	Print the current values of the parameters. More...

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

virtual void	printTableRow (std::ostream &stream) const
	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 const LauComplex &	particleCoeff ()
	Retrieve the complex coefficient for a particle. More...

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

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

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

virtual LauAbsCoeffSet *	createClone (const TString &newName, CloneOption cloneOption=All, 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 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...

Private Member Functions
	LauCartesianCPCoeffSet (const LauCartesianCPCoeffSet &rhs, CloneOption cloneOption=All, Double_t constFactor=1.0)
	Copy constructor. More...

LauCartesianCPCoeffSet &	operator= (const LauCartesianCPCoeffSet &rhs)
	Copy assignment operator (not implemented) More...

Private Attributes
LauParameter *	x_
	The average real part. More...

LauParameter *	y_
	The average imaginary part. More...

LauParameter *	deltaX_
	The asymmetric real part. More...

LauParameter *	deltaY_
	The asymmetric imaginary part. More...

LauComplex	particleCoeff_
	The particle complex coefficient. More...

LauComplex	antiparticleCoeff_
	The antiparticle complex coefficient. More...

LauParameter	acp_
	The CP asymmetry. More...

Additional Inherited Members
Public Types inherited from LauAbsCoeffSet
enum	CloneOption { All, TiePhase, TieMagnitude, TieRealPart, TieImagPart, TieCPPars }
	Options for cloning operation. More...

Static Public Member Functions inherited from LauAbsCoeffSet
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 inherited from LauAbsCoeffSet
	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 inherited from LauAbsCoeffSet
static Double_t	minMagnitude_ = -10.0
	Minimum allowed value of magnitude parameters. More...

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

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

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

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

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

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

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

Detailed Description

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

Holds a set of real values that define the complex coefficient of an amplitude component. The amplitude has the form x +/- delta_x + i * ( y +/- delta_y ). [Phys.Rev. D78 (2008) 012004]

Definition at line 50 of file LauCartesianCPCoeffSet.hh.

Constructor & Destructor Documentation

LauCartesianCPCoeffSet::LauCartesianCPCoeffSet	(	const TString &	compName,
		Double_t	x,
		Double_t	y,
		Double_t	deltaX,
		Double_t	deltaY,
		Bool_t	xFixed,
		Bool_t	yFixed,
		Bool_t	deltaXFixed,
		Bool_t	deltaYFixed,
		Bool_t	deltaXSecondStage = `kFALSE`,
		Bool_t	deltaYSecondStage = `kFALSE`
	)

Constructor.

Parameters

[in]	compName	the name of the coefficient set
[in]	x	the average real part
[in]	y	the average imaginary part
[in]	deltaX	the asymmetric real part
[in]	deltaY	the asymmetric imaginary part
[in]	xFixed	whether x is fixed
[in]	yFixed	whether y is fixed
[in]	deltaXFixed	whether deltaX is fixed
[in]	deltaYFixed	whether deltaY is fixed
[in]	deltaXSecondStage	whether deltaX should be floated only in the second stage of the fit
[in]	deltaYSecondStage	whether deltaY should be floated only in the second stage of the fit

Definition at line 45 of file LauCartesianCPCoeffSet.cc.

virtual LauCartesianCPCoeffSet::~LauCartesianCPCoeffSet ( )

inlinevirtual

Destructor.

Definition at line 71 of file LauCartesianCPCoeffSet.hh.

LauCartesianCPCoeffSet::LauCartesianCPCoeffSet	(	const LauCartesianCPCoeffSet &	rhs,
		CloneOption	cloneOption = `All`,
		Double_t	constFactor = `1.0`
	)

private

Copy constructor.

This creates cloned parameters, not copies.

Parameters

[in]	rhs	the coefficient to clone
[in]	cloneOption	special option for the cloning operation
[in]	constFactor	a constant factor to multiply the clone's parameters by

Definition at line 66 of file LauCartesianCPCoeffSet.cc.

Member Function Documentation

LauParameter LauCartesianCPCoeffSet::acp ( )

virtual

Calculate the CP asymmetry.

Returns: the CP asymmetry

Implements LauAbsCoeffSet.

Definition at line 245 of file LauCartesianCPCoeffSet.cc.

const LauComplex & LauCartesianCPCoeffSet::antiparticleCoeff ( )

virtual

Retrieve the complex coefficient for an antiparticle.

Returns: the complex coefficient for an antiparticle

Implements LauAbsCoeffSet.

Definition at line 210 of file LauCartesianCPCoeffSet.cc.

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

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 to multiply the clone's parameters by

Returns: a clone of the coefficient set

Implements LauAbsCoeffSet.

Definition at line 269 of file LauCartesianCPCoeffSet.cc.

void LauCartesianCPCoeffSet::finaliseValues ( )

virtual

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

Implements LauAbsCoeffSet.

Definition at line 195 of file LauCartesianCPCoeffSet.cc.

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

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

private

Copy assignment operator (not implemented)

Parameters

[in] rhs the coefficient to clone

const LauComplex & LauCartesianCPCoeffSet::particleCoeff ( )

virtual

Retrieve the complex coefficient for a particle.

Returns: the complex coefficient for a particle

Implements LauAbsCoeffSet.

Definition at line 204 of file LauCartesianCPCoeffSet.cc.

void LauCartesianCPCoeffSet::printParValues ( ) const

virtual

Print the current values of the parameters.

Implements LauAbsCoeffSet.

Definition at line 130 of file LauCartesianCPCoeffSet.cc.

void LauCartesianCPCoeffSet::printTableHeading ( std::ostream & stream ) const

virtual

Print the column headings for a results table.

Parameters

[out] stream the stream to print to

Implements LauAbsCoeffSet.

Definition at line 139 of file LauCartesianCPCoeffSet.cc.

void LauCartesianCPCoeffSet::printTableRow ( std::ostream & stream ) const

virtual

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

Parameters

[out] stream the stream to print to

Implements LauAbsCoeffSet.

Definition at line 147 of file LauCartesianCPCoeffSet.cc.

void LauCartesianCPCoeffSet::randomiseInitValues ( )

virtual

Randomise the starting values of the parameters for a fit.

Implements LauAbsCoeffSet.

Definition at line 171 of file LauCartesianCPCoeffSet.cc.

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

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

Implements LauAbsCoeffSet.

Definition at line 216 of file LauCartesianCPCoeffSet.cc.

Member Data Documentation

LauParameter LauCartesianCPCoeffSet::acp_

private

The CP asymmetry.

Definition at line 168 of file LauCartesianCPCoeffSet.hh.

LauComplex LauCartesianCPCoeffSet::antiparticleCoeff_

private

The antiparticle complex coefficient.

Definition at line 165 of file LauCartesianCPCoeffSet.hh.

LauParameter* LauCartesianCPCoeffSet::deltaX_

private

The asymmetric real part.

Definition at line 158 of file LauCartesianCPCoeffSet.hh.

LauParameter* LauCartesianCPCoeffSet::deltaY_

private

The asymmetric imaginary part.

Definition at line 160 of file LauCartesianCPCoeffSet.hh.

LauComplex LauCartesianCPCoeffSet::particleCoeff_

private

The particle complex coefficient.

Definition at line 163 of file LauCartesianCPCoeffSet.hh.

LauParameter* LauCartesianCPCoeffSet::x_

private

The average real part.

Definition at line 154 of file LauCartesianCPCoeffSet.hh.

LauParameter* LauCartesianCPCoeffSet::y_

private

The average imaginary part.

Definition at line 156 of file LauCartesianCPCoeffSet.hh.

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

inc/LauCartesianCPCoeffSet.hh
src/LauCartesianCPCoeffSet.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation