YAP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
BreitWigner Class Reference

Class for Breit-Wigner resonance shape. More...

#include <BreitWigner.h>

Inheritance diagram for BreitWigner:
MassShapeWithNominalMass MassShape RecalculableAmplitudeComponent AmplitudeComponent RecalculableDataAccessor DataAccessor RelativisticBreitWigner

Public Member Functions

 BreitWigner (double mass=-1, double w=-1)
 
virtual void setParameters (const ParticleTableEntry &entry) override
 
std::shared_ptr< RealParameter > width ()
 Get width.
 
const std::shared_ptr
< RealParameter > 
width () const
 Get width (const)
 
virtual bool consistent () const override
 Check consistency of object.
 
- Public Member Functions inherited from MassShapeWithNominalMass
 MassShapeWithNominalMass (double m=-1)
 
std::shared_ptr< RealParameter > mass ()
 Get mass.
 
const std::shared_ptr
< RealParameter > 
mass () const
 Get mass (const)
 
- Public Member Functions inherited from MassShape
 MassShape ()
 Constructor.
 
virtual const std::complex
< double > 
value (const DataPoint &d, const std::shared_ptr< ParticleCombination > &pc) const overridefinal
 
virtual void calculate (DataPartition &D) const overridefinal
 
Resonance * resonance () const
 get raw pointer to owning resonance
 
virtual void updateCalculationStatus (StatusManager &D) const overridefinal
 update the calculationStatus for a DataPartition
 
const Model * model () const override
 get raw pointer to Model through resonance
 
virtual void checkDecayChannel (const DecayChannel &c) const
 Check if a DecayChannel is valid for this MassShape; will throw if invalid.
 
- Public Member Functions inherited from RecalculableAmplitudeComponent
 RecalculableAmplitudeComponent (const ParticleCombinationEqualTo &equal)
 
virtual const bool validFor (const std::shared_ptr< ParticleCombination > &pc) const override
 
virtual const VariableStatus status () const override
 calls variable_status on parameters of object
 
- Public Member Functions inherited from RecalculableDataAccessor
 RecalculableDataAccessor (const ParticleCombinationEqualTo &equal)
 
void setParameterFlagsToUnchanged ()
 set VariableStatus of all Parameters to unchanged (or leave fixed)
 
const ParameterSet & parameters () const
 
- Public Member Functions inherited from DataAccessor
 DataAccessor (const ParticleCombinationEqualTo &equal)
 
const ParticleCombinationEqualTo & equal () const
 
int index () const
 
unsigned symmetrizationIndex (const std::shared_ptr< ParticleCombination > &c) const
 
const ParticleCombinationMap
< unsigned > & 
symmetrizationIndices () const
 
const unsigned nSymmetrizationIndices () const
 
void printParticleCombinations () const
 print ParticleCombination map
 
const CachedValueSet & CachedValues () const
 
const unsigned size () const
 
const bool requiresStorage () const
 
bool consistent () const
 Check consistency of object.
 

Protected Member Functions

virtual void calculateT (DataPartition &D, const std::shared_ptr< ParticleCombination > &pc, unsigned si) const override
 
- Protected Member Functions inherited from MassShape
virtual void setResonance (Resonance *r)
 Set raw pointer to owning Resonance.
 
virtual void addDecayChannel (std::shared_ptr< DecayChannel > c)
 
std::shared_ptr
< ComplexCachedValue > 
T ()
 access cached dynamic amplitude
 
const std::shared_ptr
< ComplexCachedValue > 
T () const
 access cached dynamic amplitude (const)
 
- Protected Member Functions inherited from RecalculableDataAccessor
virtual void registerWithModel () override
 register with Model
 
void addParameter (std::shared_ptr< ParameterBase > p)
 add a parameter for evaluating variableStatus
 
- Protected Member Functions inherited from DataAccessor
void addCachedValue (std::shared_ptr< CachedValue > c)
 add CachedValue
 
virtual void addParticleCombination (std::shared_ptr< ParticleCombination > pc)
 add ParticleCombination to SymmetrizationIndices_
 
virtual void pruneSymmetrizationIndices ()
 prune SymmetrizationIndices_ to only contain ParticleCombination's tracing back up the ISP
 
void setIndex (size_t i)
 set storage index used in DataPoint. Must be unique.
 

Private Attributes

std::shared_ptr< RealParameter > Width_
 Width [GeV].
 

Additional Inherited Members

- Public Attributes inherited from DataAccessor
friend Model
 grant friend status to Model to access CachedValues_
 
friend CachedValue
 grant friend status to CachedValue to call addCachedValue
 

Detailed Description

Class for Breit-Wigner resonance shape.

Author
Daniel Greenwald

Amplitude is 1 / (mass^2 - s - i*mass*width)

Constructor & Destructor Documentation

BreitWigner ( double  mass = -1,
double  w = -1 
)

Constructor

Parameters
massMass of resonance [GeV]
widthWidth of resonance [GeV]

Member Function Documentation

void calculateT ( DataPartition &  D,
const std::shared_ptr< ParticleCombination > &  pc,
unsigned  si 
) const
overrideprotectedvirtual

Calculate dynamic amplitude T for and store in each DataPoint in DataPartition

Parameters
DDataPartition to calculate on
pcParticleCombination to calculate for
siSymmetrizationIndec to calculate for

Implements MassShape.

Reimplemented in RelativisticBreitWigner.

void setParameters ( const ParticleTableEntry &  entry)
overridevirtual

Set parameters from ParticleTableEntry

Parameters
entryParticleTableEntry containing information to create mass shape object

Reimplemented from MassShapeWithNominalMass.


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