Class to store reconstructed particles. More...

#include <Particle.h>

Inheritance diagram for Particle:

Collaboration diagram for Particle:

[legend]

Public Types
enum	EParticleSourceObject { c_Undefined = 0 , c_Track = 1 , c_ECLCluster = 2 , c_KLMCluster = 3 , c_V0 = 4 , c_MCParticle = 5 , c_Composite = 6 , c_NoMDSTSource = 7 }
	particle source enumerators

enum	EFlavorType { c_Unflavored = 0 , c_Flavored = 1 }
	describes flavor type, see getFlavorType(). More...

enum	{ c_DimPosition = 3 , c_DimMomentum = 4 , c_DimMatrix = 7 , c_SizeMatrix = c_DimMatrix * (c_DimMatrix + 1) / 2 }
	error matrix dimensions and size of 1D representation

enum	{ c_Px , c_Py , c_Pz , c_E , c_X , c_Y , c_Z }
	enumerator used for error matrix handling, shows also in which order the rows (columns) are defined

enum	PropertyFlags { c_Ordinary = 0 , c_IsUnspecified = 1 , c_IsIgnoreRadiatedPhotons = 2 , c_IsIgnoreIntermediate = 4 , c_IsIgnoreMassive = 8 , c_IsIgnoreNeutrino = 16 , c_IsIgnoreGamma = 32 , c_IsIgnoreBrems = 64 , c_IsIgnoreMisID = 128 , c_IsIgnoreDecayInFlight = 256 }
	Flags that describe the particle property, which are used in the MC matching. More...

Public Member Functions
	Particle ()
	Default constructor. More...

	Particle (const ROOT::Math::PxPyPzEVector &momentum, const int pdgCode)
	Constructor from a Lorentz vector and PDG code. More...

	Particle (const ROOT::Math::PxPyPzEVector &momentum, const int pdgCode, EFlavorType flavorType, const EParticleSourceObject particleType, const unsigned mdstIndex)
	Constructor for final state particles. More...

	Particle (const ROOT::Math::PxPyPzEVector &momentum, const int pdgCode, EFlavorType flavorType, const std::vector< int > &daughterIndices, TClonesArray *arrayPointer=nullptr)
	Constructor for composite particles. More...

	Particle (const ROOT::Math::PxPyPzEVector &momentum, const int pdgCode, EFlavorType flavorType, const std::vector< int > &daughterIndices, int properties, TClonesArray *arrayPointer=nullptr)
	Constructor for composite particles. More...

	Particle (const ROOT::Math::PxPyPzEVector &momentum, const int pdgCode, EFlavorType flavorType, const std::vector< int > &daughterIndices, int properties, const std::vector< int > &daughterProperties, TClonesArray *arrayPointer=nullptr)
	Constructor for composite particles. More...

	Particle (const Track *track, const Const::ChargedStable &chargedStable)
	Constructor from a reconstructed track (mdst object Track);. More...

	Particle (int trackArrayIndex, const TrackFitResult *trackFit, const Const::ChargedStable &chargedStable)
	Constructor from a reconstructed Track given as TrackFitResult. More...

	Particle (const ECLCluster *eclCluster, const Const::ParticleType &type=Const::photon)
	Constructor of a photon from a reconstructed ECL cluster that is not matched to any charged track. More...

	Particle (const KLMCluster *klmCluster, const int pdgCode=Const::Klong.getPDGCode())
	Constructor from a reconstructed KLM cluster. More...

	Particle (const MCParticle *MCparticle)
	Constructor from MC particle (mdst object MCParticle) More...

	~Particle ()
	Destructor.

void	setPDGCode (const int pdg)
	Sets PDG code. More...

void	set4Vector (const ROOT::Math::PxPyPzEVector &p4)
	Sets Lorentz vector. More...

void	set4VectorDividingByMomentumScaling (const ROOT::Math::PxPyPzEVector &p4)
	Sets Lorentz vector dividing by the momentum scaling factor. More...

void	setVertex (const ROOT::Math::XYZVector &vertex)
	Sets position (decay vertex) More...

void	setMomentumScalingFactor (double momentumScalingFactor)
	Sets momentum scaling. More...

void	setMomentumSmearingFactor (double momentumSmearingFactor)
	Sets momentum smearing. More...

void	setJacobiMatrix (const TMatrixF &jacobiMatrix)
	Sets 4x6 jacobi matrix. More...

void	setMomentumVertexErrorMatrix (const TMatrixFSym &errMatrix)
	Sets 7x7 error matrix. More...

void	setPValue (double pValue)
	Sets chi^2 probability of fit. More...

void	setProperty (const int properties)
	sets m_properties

void	updateMomentum (const ROOT::Math::PxPyPzEVector &p4, const ROOT::Math::XYZVector &vertex, const TMatrixFSym &errMatrix, double pValue)
	Sets Lorentz vector, position, 7x7 error matrix and p-value. More...

void	updateMass (const int pdgCode)
	Updates particle mass with the mass of the particle corresponding to the given PDG. More...

void	appendDaughter (const Particle *daughter, const bool updateType=true, const int daughterProperty=c_Ordinary)
	Appends index of daughter to daughters index array. More...

void	appendDaughter (int particleIndex, const bool updateType=true)
	Appends index of daughter to daughters index array. More...

void	removeDaughter (const Particle *daughter, const bool updateType=true)
	Removes index of daughter from daughters index array. More...

bool	replaceDaughter (const Particle oldDaughter, Particle newDaughter)
	Replace index of given daughter with new daughter, return true if a replacement is made. More...

bool	replaceDaughterRecursively (const Particle oldDaughter, Particle newDaughter)
	Apply replaceDaughter to all Particles in the decay tree by looping recursively through it, return true if a replacement is made. More...

int	getPDGCode (void) const
	Returns PDG code. More...

double	getCharge (void) const
	Returns particle charge. More...

EFlavorType	getFlavorType () const
	Returns flavor type of the decay (for FS particles: flavor type of particle) More...

EParticleSourceObject	getParticleSource () const
	Returns particle source as defined with enum EParticleSourceObject. More...

unsigned	getMdstArrayIndex (void) const
	Returns 0-based index of MDST store array object (0 for composite particles) More...

int	getProperty () const
	Returns particle property as a bit pattern The values are defined in the PropertyFlags enum and described in detail there. More...

double	getMass () const
	Returns invariant mass (= nominal for FS particles) More...

double	getPDGMass (void) const
	Returns uncertainty on the invariant mass (requires valid momentum error matrix) More...

double	getPDGLifetime () const
	Returns particle nominal lifetime. More...

double	getEnergy () const
	Returns total energy. More...

ROOT::Math::PxPyPzEVector	get4Vector () const
	Returns Lorentz vector. More...

ROOT::Math::XYZVector	getMomentum () const
	Returns momentum vector. More...

double	getMomentumMagnitude () const
	Returns momentum magnitude. More...

double	getP () const
	Returns momentum magnitude (same as getMomentumMagnitude but with shorter name) More...

double	getPx () const
	Returns x component of momentum. More...

double	getPy () const
	Returns y component of momentum. More...

double	getPz () const
	Returns z component of momentum. More...

double	getEffectiveMomentumScale () const
	Returns effective momentum scale which is the product of the momentum scaling and smearing factors. More...

ROOT::Math::XYZVector	getVertex () const
	Returns vertex position (POCA for charged, IP for neutral FS particles) More...

double	getX () const
	Returns x component of vertex position. More...

double	getY () const
	Returns y component of vertex position. More...

double	getZ () const
	Returns z component of vertex position. More...

double	getPValue () const
	Returns chi^2 probability of fit if done or -1. More...

TMatrixFSym	getMomentumVertexErrorMatrix () const
	Returns 7x7 error matrix. More...

TMatrixFSym	getMomentumErrorMatrix () const
	Returns the 4x4 momentum error matrix. More...

TMatrixFSym	getVertexErrorMatrix () const
	Returns the 3x3 position error sub-matrix. More...

double	getCosHelicity (const Particle *mother=nullptr) const
	Returns cosine of the helicity angle The helicity angle is defined in the rest frame of the particle as the angle between the negative momentum of the mother and. More...

double	getCosHelicityDaughter (unsigned iDaughter, unsigned iGrandDaughter=0) const
	Returns cosine of the helicity angle of the given daughter defined by given grand daughter. More...

double	getAcoplanarity () const
	Returns acoplanarity angle defined as the angle between the decay planes of the grand daughters in the particle's rest frame This assumes that the particle and its daughters have two daughters each. More...

int	getMdstSource () const
	Returns unique identifier of final state particle (needed in particle combiner) More...

unsigned	getNDaughters (void) const
	Returns number of daughter particles. More...

const std::vector< int > &	getDaughterIndices () const
	Returns a vector of store array indices of daughter particles. More...

const std::vector< int > &	getDaughterProperties () const
	Returns a vector of properties of daughter particles. More...

const Particle *	getDaughter (unsigned i) const
	Returns a pointer to the i-th daughter particle. More...

bool	forEachDaughter (const std::function< bool(const Particle *)> &function, bool recursive=true, bool includeSelf=true) const
	Apply a function to all daughters of this particle. More...

std::vector< Belle2::Particle * >	getDaughters () const
	Returns a vector of pointers to daughter particles. More...

std::vector< const Belle2::Particle * >	getFinalStateDaughters () const
	Returns a vector of pointers to Final State daughter particles. More...

std::vector< const Belle2::Particle * >	getAllDaughters () const
	Returns a vector of pointers to all generations' daughter particles. More...

std::vector< int >	getMdstArrayIndices (EParticleSourceObject type) const
	Returns a vector of StoreArray indices of given MDST dataobjects. More...

bool	overlapsWith (const Particle *oParticle) const
	Returns true if final state ancestors of oParticle overlap. More...

bool	isCopyOf (const Particle *oParticle, bool doDetailedComparison=false) const
	Returns true if this Particle and oParticle are copies of each other. More...

const Track *	getTrack () const
	Returns the pointer to the Track object that was used to create this Particle (ParticleType == c_Track). More...

const TrackFitResult *	getTrackFitResult () const
	Returns the pointer to the TrackFitResult that was used to create this Particle (ParticleType == c_Track). More...

const V0 *	getV0 () const
	Returns the pointer to the V0 object that was used to create this Particle (if ParticleType == c_V0). More...

const PIDLikelihood *	getPIDLikelihood () const
	Returns the pointer to the PIDLikelihood object that is related to the Track, which was used to create this Particle (ParticleType == c_Track). More...

const ECLCluster *	getECLCluster () const
	Returns the pointer to the ECLCluster object that was used to create this Particle (if ParticleType == c_ECLCluster). More...

double	getECLClusterEnergy () const
	Returns the energy of the ECLCluster for the particle. More...

const KLMCluster *	getKLMCluster () const
	Returns the pointer to the KLMCluster object that was used to create this Particle (ParticleType == c_KLMCluster). More...

const MCParticle *	getMCParticle () const
	Returns the pointer to the MCParticle object that was used to create this Particle (ParticleType == c_MCParticle). More...

std::string	getName () const override
	Return name of this particle.

std::string	getInfoHTML () const override
	Return a short summary of this object's contents in HTML format.

void	print () const
	Prints the contents of a Particle object to standard output.

std::vector< std::string >	getExtraInfoNames () const
	get a list of the extra info names

void	removeExtraInfo ()
	Remove all stored extra info fields.

double	getExtraInfo (const std::string &name) const
	Return given value if set. More...

bool	hasExtraInfo (const std::string &name) const
	Return whether the extra info with the given name is set.

int	getExtraInfoMap () const
	Return the id of the associated ParticleExtraInfoMap or -1 if no map is set.

unsigned int	getExtraInfoSize () const
	Return the size of the extra info array.

void	writeExtraInfo (const std::string &name, const double value)
	Sets the user defined extraInfo. More...

void	setExtraInfo (const std::string &name, double value)
	Sets the user-defined data of given name to the given value. More...

void	addExtraInfo (const std::string &name, double value)
	Sets the user-defined data of given name to the given value. More...

TClonesArray *	getArrayPointer () const
	Returns the pointer to the store array which holds the daughter particles. More...

int	getPDGCodeUsedForFit () const
	Return the always positive PDG code which was used for the track fit (if there was a track fit) of this particle. More...

bool	wasExactFitHypothesisUsed () const
	Returns true if the type represented by this Particle object was used use as a mass hypothesis during the track of this Particle's parameters.

bool	isMostLikely () const
	Returns true if the (track-based) particle is created with its most likely mass hypothesis based on PID likelihood.

std::pair< Const::ChargedStable, const TrackFitResult * >	getMostLikelyTrackFitResult () const
	For a (track-based) particle, returns the charged stable mass hypothesis associated to the most probable TrackFitResult, and the TrackFitResult itself.

bool	isMostLikelyTrackFitResult () const
	Returns true if the (track-based) particle is created with its most likely mass hypothesis based on TrackFitResult.

ECLCluster::EHypothesisBit	getECLClusterEHypothesisBit () const
	Returns the ECLCluster EHypothesisBit for this Particle.

const Particle *	getParticleFromGeneralizedIndexString (const std::string &generalizedIndex) const
	Explores the decay tree of the particle and returns the (grand^n)daughter identified by a generalized index. More...

void	updateJacobiMatrix ()
	Propagate the photon energy scaling to jacobian elements that were calculated using energy.

void	fillFSPDaughters (std::vector< const Belle2::Particle * > &fspDaughters) const
	Fill final state particle daughters into a vector. More...

void	fillAllDaughters (std::vector< const Belle2::Particle * > &allDaughters) const
	Fill all generations' daughters into a vector. More...

void	addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching). More...

void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow). More...

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights). More...

template<class TO >
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array. More...

template<class FROM >
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object. More...

template<class T >
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array. More...

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation. More...

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation. More...

template<class T >
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation. More...

template<class TO >
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array. More...

template<class FROM >
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array. More...

template<class T >
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array. More...

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format. More...

std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.

int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.

Private Member Functions
void	setMomentumPositionErrorMatrix (const TrackFitResult *trackFit)
	Sets the momentum, position and error matrix for this particle (created from charged Track)

void	resetErrorMatrix ()
	Resets 7x7 error matrix All elements are set to 0.0.

void	resetJacobiMatrix ()
	Resets 4x6 error matrix All elements are set to 0.0.

void	storeErrorMatrix (const TMatrixFSym &errMatrix)
	Stores 7x7 error matrix into private member m_errMatrix. More...

void	storeJacobiMatrix (const TMatrixF &jacobiMatrix)
	Stores 4x6 Jacobi matrix into private member m_jacobiMatrix. More...

void	fillDecayChain (std::vector< int > &decayChain) const
	Fill vector with (PDGCode, MdstSource) pairs for the entire decay chain. More...

void	setFlavorType ()
	sets m_flavorType using m_pdgCode

void	setMdstArrayIndex (const int arrayIndex)
	set mdst array index

int	generatePDGCodeFromCharge (const int chargedSign, const Const::ChargedStable &chargedStable)
	Generate the PDG code with correct sign, using the charge. More...

	ClassDefOverride (Particle, 16)
	Class to store reconstructed particles.

	ClassDef (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

Private Attributes
int	m_pdgCode
	PDG code.

int	m_pdgCodeUsedForFit = 0
	PDG code used for the track fit.

double	m_mass
	particle (invariant) mass

double	m_px
	momentum component x

double	m_py
	momentum component y

double	m_pz
	momentum component z

double	m_momentumScale = 1.0
	effective momentum scale factor

double	m_momentumScalingFactor = 1.0
	momentum scaling factor

double	m_momentumSmearingFactor = 1.0
	momentum smearing factor

double	m_x
	position component x

double	m_y
	position component y

double	m_z
	position component z

double	m_errMatrix [c_SizeMatrix] = {}
	error matrix (1D representation)

double	m_jacobiMatrix [c_SizeMatrix] = {}
	error matrix (1D representation)

double	m_pValue
	chi^2 probability of the fit. More...

std::vector< int >	m_daughterIndices
	daughter particle indices

EFlavorType	m_flavorType
	flavor type.

EParticleSourceObject	m_particleSource
	(mdst) source of particle

unsigned	m_mdstIndex
	0-based index of MDST store array object

int	m_properties
	particle property

std::vector< int >	m_daughterProperties
	daughter particle properties

int	m_identifier = -1
	Identifier that can be used to identify whether the particle is unique or is a copy or representation of another. More...

std::vector< double >	m_extraInfo
	Stores associated user defined values. More...

TClonesArray *	m_arrayPointer
	Internal pointer to DataStore array containing the daughters of this particle. More...

DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

Friends
class	ParticleSubset

Detailed Description

Class to store reconstructed particles.

This class is a common representation of all particle types, e.g.:

final state particles (FS particles):
- charged kaons/pions/electrons/muons/protons reconstructed as Track
- photons reconstructed as ECLCluster (without associated Track)
- long lived neutral kaons reconstructed in KLM (as KLMCluster without associated Track)
composite particles:
- pre-reconstructed V0 particles: Kshort, Lambda baryon, converted photon, ...
- reconstructed in decays (via combinations)

Private members are limited to those which completely define the particle and that are common to all particle types. These are:

particle mass
- nominal for FS particles
- invariant for composite particles
momentum vector (px, py, pz)
position (x, y, z)
- POCA for charged FS particles
- IP for photons, Klong and pi0
- decay vertex for composite particles
7x7 error matrix (order is: px, py, pz, E, x, y, z)
chi^2 probability of the fit (track fit, pi0 mass-constr. fit or vertex fit)
PDG code
vector of StoreArray<Particle> indices of daughter particles

Additional private members are needed in order to make composite particles (via combinations):

mdst index of an object from which the FS particle is created
source of the object from which the particle is created (see EParticleSourceObject)
flavor type (unflavored/flavored) of a decay or flavor type of FS particle

Finally, it is possible to store user-defined floating-point values using addExtraInfo() and getExtraInfo(), identified by a string key. These are general purpose functions for collecting additional information about reconstructed particles that can not be included into any existing data object. Different Particle objects can store different sets of values, and there are no hard-coded limitations on the number of values stored.

Definition at line 75 of file Particle.h.

Member Enumeration Documentation

◆ EFlavorType

enum EFlavorType

describes flavor type, see getFlavorType().

Enumerator
c_Unflavored	Is its own antiparticle or we don't know whether it is a particle/antiparticle.
c_Flavored	Is either particle or antiparticle.

Definition at line 94 of file Particle.h.

                      {
       c_Unflavored = 0, 
       c_Flavored = 1, 
     };

◆ PropertyFlags

enum PropertyFlags

Flags that describe the particle property, which are used in the MC matching.

Enumerator
c_IsUnspecified	Ordinary particles. Is the particle unspecified by marking @ ?
c_IsIgnoreRadiatedPhotons	Is the particle MC matched with the ignore radiated photon flag set?
c_IsIgnoreIntermediate	Is the particle MC matched with the ignore intermediate resonances flag set?
c_IsIgnoreMassive	Is the particle MC matched with the ignore missing massive particle flag set?
c_IsIgnoreNeutrino	Is the particle MC matched with the ignore missing neutrino flag set?
c_IsIgnoreGamma	Is the particle MC matched with the ignore missing gamma flag set?
c_IsIgnoreBrems	Is the particle MC matched with the ignore added Brems gamma flag set?
c_IsIgnoreMisID	Is the particle MC matched with the ignore MisID flag set?
c_IsIgnoreDecayInFlight	Is the particle MC matched with the ignore DecayInFlight flag set?

Definition at line 116 of file Particle.h.

Constructor & Destructor Documentation

◆ Particle() [1/11]

Particle ( )

Default constructor.

All private members are set to 0. Particle type is set to c_Undefined.

Definition at line 45 of file Particle.cc.

                    :
   m_pdgCode(0), m_mass(0), m_px(0), m_py(0), m_pz(0), m_x(0), m_y(0), m_z(0),
   m_pValue(nan("")), m_flavorType(c_Unflavored), m_particleSource(c_Undefined), m_mdstIndex(0), m_properties(0),
   m_arrayPointer(nullptr)
 {
   resetErrorMatrix();
 }