A Class to store the Monte Carlo particle information. More...

#include <MCParticle.h>

Inheritance diagram for MCParticle:

Public Types
enum	StatusBit { c_PrimaryParticle = 1 << 0 , c_StableInGenerator = 1 << 1 , c_LeftDetector = 1 << 2 , c_StoppedInDetector = 1 << 3 , c_IsVirtual = 1 << 4 , c_Initial = 1 << 5 , c_IsISRPhoton = 1 << 6 , c_IsFSRPhoton = 1 << 7 , c_IsPHOTOSPhoton = 1 << 8 , c_IsRadiativePhoton = c_IsISRPhoton \| c_IsFSRPhoton \| c_IsPHOTOSPhoton }
	Exception is thrown if the requested index for the last child is out of range. More...

Public Member Functions
	MCParticle ()
	Default constructor for ROOT.

	MCParticle (TClonesArray *plist, const MCParticle &p)
	Construct MCParticle from a another MCParticle and the TClonesArray it is stored in.

int	getPDG () const
	Return PDG code of particle.

unsigned int	getStatus (unsigned short int bitmask=USHRT_MAX) const
	Return status code of particle.

bool	hasStatus (unsigned short int bitmask) const
	Return if specific status bit is set.

float	getMass () const
	Return the particle mass in GeV.

float	getCharge () const
	Return the particle charge defined in TDatabasePDG.

float	getEnergy () const
	Return particle energy in GeV.

bool	hasValidVertex () const
	Indication whether vertex and time information is useful or just default.

float	getProductionTime () const
	Return production time in ns.

float	getDecayTime () const
	Return the decay time in ns.

float	getLifetime () const
	Return the lifetime in ns.

ROOT::Math::XYZVector	getVertex () const
	Return production vertex position, shorthand for getProductionVertex().

ROOT::Math::XYZVector	getProductionVertex () const
	Return production vertex position.

ROOT::Math::XYZVector	getMomentum () const
	Return momentum.

ROOT::Math::PxPyPzEVector	get4Vector () const
	Return 4Vector of particle.

ROOT::Math::XYZVector	getDecayVertex () const
	Return decay vertex.

int	getIndex () const
	Get 1-based index of the particle in the corresponding MCParticle list.

int	getArrayIndex () const
	Get 0-based index of the particle in the corresponding MCParticle list.

int	getFirstDaughter () const
	Get 1-based index of first daughter, 0 if no daughters.

int	getLastDaughter () const
	Get 1-based index of last daughter, 0 if no daughters.

std::vector< Belle2::MCParticle * >	getDaughters () const
	Get vector of all daughter particles, empty vector if none.

const MCParticle *	getDaughter (int i) const
	Return i-th daughter.

int	getNDaughters () const
	Return number of daughter MCParticles.

MCParticle *	getMother () const
	Returns a pointer to the mother particle.

int	getSecondaryPhysicsProcess () const
	Returns the physics process type of a secondary particle.

Const::DetectorSet	getSeenInDetector () const
	Return the seen-in flags of the entire Belle II subdetectors for an MC particle.

bool	hasSeenInDetector (Const::DetectorSet set) const
	Return if the seen-in flag for a specific subdetector is set or not.

bool	isVirtual () const
	Check if particle is virtual.

bool	isInitial () const
	Check if particle is an initial particle such as ISR.

bool	isPrimaryParticle () const
	Check if particle is a primary particle which was created by the generator (and not, for example material interaction)

void	setPDG (int pdg)
	Set PDG code of the particle.

void	setMassFromPDG ()
	Sets the mass for the particle from the particle's PDG code.

void	setStatus (unsigned short int status)
	Set Status code for the particle.

void	addStatus (unsigned short int bitmask)
	Add bitmask to current status.

void	removeStatus (unsigned short int bitmask)
	Remove bitmask from current status.

void	setMass (float mass)
	Set particle mass.

void	setEnergy (float energy)
	Set energy.

void	setValidVertex (bool valid)
	Set indication whether vertex and time information is valid or just default.

void	setProductionTime (float time)
	Set production time.

void	setDecayTime (float time)
	Set decay time.

void	setProductionVertex (const ROOT::Math::XYZVector &vertex)
	Set production vertex position.

void	setProductionVertex (float x, float y, float z)
	Set production vertex position.

void	setMomentum (const ROOT::Math::XYZVector &momentum)
	Set particle momentum.

void	setMomentum (float px, float py, float pz)
	Set particle momentum.

void	set4Vector (const ROOT::Math::PxPyPzEVector &p4)
	Sets the 4Vector of particle.

void	setDecayVertex (const ROOT::Math::XYZVector &vertex)
	Set decay vertex.

void	setDecayVertex (float x, float y, float z)
	Set decay vertex.

void	setSecondaryPhysicsProcess (int physicsProcess)
	Sets the physics process type of a secondary particle.

void	setSeenInDetector (Const::DetectorSet set)
	Set the seen-in flags for the entire Belle II subdetectors for an Monte Carlo particle.

void	addSeenInDetector (Const::DetectorSet set)
	Flag/Add a bit if the MC particle is seen in a specific subdetector.

void	removeSeenInDetector (Const::DetectorSet set)
	Unflag/Remove the bit if the MC particle is not seen in a specific subdetector.

void	fixParticleList () const
	Search the DataStore for the corresponding MCParticle array.

void	setVirtual ()
	Set particle to virtual.

void	setInitial ()
	Set particle to initial.

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

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

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

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).

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).

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

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.

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.

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.

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

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

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.

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.

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.

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.

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

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

Protected Member Functions
	ClassDefOverride (MCParticle, 6)
	A Class to store the Monte Carlo particle information.

TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Protected Attributes
TClonesArray *	m_plist = nullptr
	Internal pointer to DataStore Array containing particles belonging to this collection.

float	m_productionTime = 0
	transient pointer to particle list

float	m_productionVertex_x = 0
	production vertex of particle, x component

float	m_productionVertex_y = 0
	production vertex of particle, y component

float	m_productionVertex_z = 0
	production vertex of particle, z component

float	m_decayTime = 0
	decay time

float	m_decayVertex_x = 0
	decay vertex of particle, x component

float	m_decayVertex_y = 0
	decay vertex of particle, y component

float	m_decayVertex_z = 0
	decay vertex of particle, z component

int	m_pdg = 0
	PDG-Code of the particle.

float	m_mass = 0
	mass of the particle

float	m_energy = 0
	energy of the particle

float	m_momentum_x = 0
	momentum of particle, x component

float	m_momentum_y = 0
	momentum of particle, y component

float	m_momentum_z = 0
	momentum of particle, z component

int	m_index = 0
	1-based index of the particle, will be set automatically after deserialisation if needed.

int	m_mother = 0
	transient 1-based index of particle

int	m_firstDaughter = 0
	1-based index of first daughter particle in collection, 0 if no daughters

int	m_lastDaughter = 0
	1-based index of last daughter particle in collection, 0 if no daughters

int	m_secondaryPhysicsProcess = 0
	physics process type of a secondary particle

unsigned short int	m_status = 0
	status code

bool	m_validVertex = false
	indication whether vertex and time information is useful or just default

Const::DetectorSet	m_seenIn
	Each bit is a seen-in flag for the corresoponding subdetector of Belle II.

Static Protected Attributes
static const double	c_epsilon = 10e-7
	limit of precision for two doubles to be the same.

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

Private Attributes
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	FixMergedObjectsModule

Detailed Description

A Class to store the Monte Carlo particle information.

Definition at line 32 of file MCParticle.h.

Member Enumeration Documentation

◆ StatusBit

enum StatusBit

Exception is thrown if the requested index for the last child is out of range.

Exception is thrown if no pointer to the particle list was set. Exception is thrown if the pdg value of the MCParticle is not known to the internal database (TDatabasePDG). The status information for the MCParticle.

Enumerator
c_PrimaryParticle	bit 0: Particle is primary particle. For example, All the particles from the generator.
c_StableInGenerator	bit 1: Particle is stable, i.e., not decaying in the generator.
c_LeftDetector	bit 2: Particle left the detector (the simulation volume).
c_StoppedInDetector	bit 3: Particle was stopped in the detector (the simulation volume).
c_IsVirtual	bit 4: Particle is virtual and not going to Geant4. Exchange boson, off-shell, unknown to Geant4, etc.
c_Initial	bit 5: Particle is initial such as e+ or e- and not going to Geant4
c_IsISRPhoton	bit 6: Particle is from initial state radiation
c_IsFSRPhoton	bit 7: Particle is from final state radiation
c_IsPHOTOSPhoton	bit 8: Particle is an radiative photon from PHOTOS
c_IsRadiativePhoton	combined flag to test whether the particle is radiative

Definition at line 45 of file MCParticle.h.

                   {
      c_PrimaryParticle   = 1 << 0,
      c_StableInGenerator = 1 << 1,
      c_LeftDetector      = 1 << 2,
      c_StoppedInDetector = 1 << 3,
      c_IsVirtual         = 1 << 4,
      c_Initial           = 1 << 5,
      c_IsISRPhoton       = 1 << 6,
      c_IsFSRPhoton       = 1 << 7,
      c_IsPHOTOSPhoton    = 1 << 8,
      c_IsRadiativePhoton = c_IsISRPhoton | c_IsFSRPhoton | c_IsPHOTOSPhoton,
    };

Constructor & Destructor Documentation

◆ MCParticle() [1/2]

MCParticle ( )

inline

Default constructor for ROOT.

Definition at line 72 of file MCParticle.h.

72{}

◆ MCParticle() [2/2]

MCParticle	(	TClonesArray *	plist,
		const MCParticle &	p
	)

inline

Construct MCParticle from a another MCParticle and the TClonesArray it is stored in.

Used by MCParticleGraph to build a valid tree of MCParticles from particle and decay information

See also: class MCParticleGraph

Definition at line 82 of file MCParticle.h.

                                                        :
      m_plist(plist),
      m_productionTime(p.m_productionTime), m_productionVertex_x(p.m_productionVertex_x),
      m_productionVertex_y(p.m_productionVertex_y), m_productionVertex_z(p.m_productionVertex_z),
      m_decayTime(p.m_decayTime), m_decayVertex_x(p.m_decayVertex_x),
      m_decayVertex_y(p.m_decayVertex_y), m_decayVertex_z(p.m_decayVertex_z),
      m_pdg(p.m_pdg), m_mass(p.m_mass), m_energy(p.m_energy),
      m_momentum_x(p.m_momentum_x), m_momentum_y(p.m_momentum_y), m_momentum_z(p.m_momentum_z),
      m_index(p.m_index),
      m_mother(p.m_mother), m_firstDaughter(p.m_firstDaughter), m_lastDaughter(p.m_lastDaughter),
      m_secondaryPhysicsProcess(p.m_secondaryPhysicsProcess),
      m_status(p.m_status),
      m_validVertex(p.m_validVertex),
      m_seenIn(p.m_seenIn) {}

Member Function Documentation

◆ addRelationTo() [1/2]

void addRelationTo	(	const RelationsInterface< BASE > *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

◆ addRelationTo() [2/2]

void addRelationTo	(	const TObject *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

◆ addSeenInDetector()

void addSeenInDetector ( Const::DetectorSet set )

inline

Flag/Add a bit if the MC particle is seen in a specific subdetector.

Parameters

set	The ID for Belle II subdetector(s), in either Const::DetectorSet or Const::EDetector format

Definition at line 469 of file MCParticle.h.

469{ m_seenIn += set; }

◆ addStatus()

void addStatus ( unsigned short int bitmask )

inline

Add bitmask to current status.

Parameters

bitmask The status code which should be added to the existing MonteCarlo particle status code.

Definition at line 342 of file MCParticle.h.

342{ m_status |= bitmask; }

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

◆ fixParticleList()

void fixParticleList ( ) const

Search the DataStore for the corresponding MCParticle array.

This function should not be needed by normal users and is called automatically if the pointer to the particle list is not set when needed, e.g. after deserialization.

Definition at line 82 of file MCParticle.cc.

{
  if (m_plist != 0) return;
 
  TClonesArray* plist(0);
 
  //Search default location
  //TODO: this could be replaced with RelationsObject::getArrayIndex()/getArrayName()
  StoreArray<MCParticle> MCParticles;
  if (MCParticles && MCParticles.getPtr()->IndexOf(this) >= 0) {
    plist = MCParticles.getPtr();
  } else {
    //Search all StoreArrays which happen to store MCParticles
    const DataStore::StoreEntryMap& map = DataStore::Instance().getStoreEntryMap(DataStore::c_Event);
    for (DataStore::StoreEntryConstIter iter = map.begin(); iter != map.end(); ++iter) {
      TClonesArray* value = dynamic_cast<TClonesArray*>(iter->second.ptr);
      if (value && value->GetClass() == Class() && value->IndexOf(this) >= 0) {
        plist = value;
        break;
      }
    }
  }
  //Could not find any collection, raise exception
  if (!plist) {
    B2ERROR("Could not determine StoreArray the MCParticle belongs to !");
    throw NoParticleListSetError();
  }
 
  //Set plist pointer and index for whole array
  for (int i = 0; i < plist->GetEntriesFast(); i++) {
    MCParticle& mc = *(static_cast<MCParticle*>(plist->At(i)));
    mc.m_plist = plist;
    mc.m_index = i + 1;
  }
}

◆ get4Vector()

ROOT::Math::PxPyPzEVector get4Vector ( ) const

inline

Return 4Vector of particle.

Returns: The 4-vector of the MonteCarlo particle.

Definition at line 196 of file MCParticle.h.

    {
      return ROOT::Math::PxPyPzEVector(m_momentum_x, m_momentum_y, m_momentum_z, m_energy);
    }

◆ getArrayIndex()

int getArrayIndex ( ) const

inline

Get 0-based index of the particle in the corresponding MCParticle list.

This is the function for users who want to use the indices of the TClonesArray. To get the corresponding mother and daughter indices use ->getMother()->getArrayIndex().

Returns: The index of the MonteCarlo particle in the corresponding MCParticle array Careful: These indices do not follow the standard from (Fortran) generators, where the first particle has index 1. In the array the first particle has index 0.

Definition at line 233 of file MCParticle.h.

233{ fixParticleList(); return m_index - 1; }

Belle2::MCParticle::fixParticleList

void fixParticleList() const

Search the DataStore for the corresponding MCParticle array.

Definition: MCParticle.cc:82

◆ getArrayName()

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

◆ getArrayPointer()

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

◆ getCharge()

float getCharge ( ) const

Return the particle charge defined in TDatabasePDG.

Returns: The charge of the particle in units of q(positron).

Definition at line 36 of file MCParticle.cc.

{
  // Geant4 "optical photon" (m_pdg == 0) is not known to TDatabasePDG::Instance().
  if (m_pdg == 0) {
    return 0.0;
  }
 
  if (TDatabasePDG::Instance()->GetParticle(m_pdg) == nullptr) {
    B2ERROR("PDG=" << m_pdg << " ***code unknown to TDatabasePDG");
    return 0.0;
  }
 
  return TDatabasePDG::Instance()->GetParticle(m_pdg)->Charge() / 3.0;
}

◆ getDaughter()

const MCParticle * getDaughter ( int i ) const

Return i-th daughter.

Definition at line 67 of file MCParticle.cc.

{
  if (i >= getNDaughters()) {
    return nullptr;
  }
  return getDaughters().at(i);
}

◆ getDaughters()

vector< MCParticle * > getDaughters ( ) const

Get vector of all daughter particles, empty vector if none.

Throws an exception of type LastChildIndexOutOfRangError if the last daughter is out of the index range.

Returns: A list of all daughter particles. The list is empty if the MonteCarlo particle doesn't have any daughters.

Definition at line 52 of file MCParticle.cc.

{
  vector<MCParticle*> result;
  if (m_firstDaughter > 0) {
    fixParticleList();
    if (m_lastDaughter > m_plist->GetEntriesFast()) throw LastChildIndexOutOfRangError();
    TClonesArray& plist = *m_plist;
    result.reserve(m_lastDaughter - m_firstDaughter + 1);
    for (int i = m_firstDaughter - 1; i < m_lastDaughter; i++) {
      result.push_back(static_cast<MCParticle*>(plist[i]));
    }
  }
  return result;
}

◆ getDecayTime()

float getDecayTime ( ) const

inline

Return the decay time in ns.

Returns: The timestamp of the decay of the MonteCarlo particle in ns. If the particle is stable the time is set to infinity. If the particle crosses the simulation volume boundary, it is set to the crossing time.

Definition at line 157 of file MCParticle.h.

157{ return m_decayTime; }

◆ getDecayVertex()

ROOT::Math::XYZVector getDecayVertex ( ) const

inline

Return decay vertex.

Returns: The decay vertex of the MonteCarlo particle in cm. If the particle crosses the simulation volume boundary, it is set to the crossing position.

Definition at line 208 of file MCParticle.h.

    {
      return ROOT::Math::XYZVector(m_decayVertex_x, m_decayVertex_y, m_decayVertex_z);
    }

◆ getEnergy()

float getEnergy ( ) const

inline

Return particle energy in GeV.

Returns: Returns the particle energy in GeV.

Definition at line 136 of file MCParticle.h.

136{ return m_energy; }

◆ getFirstDaughter()

int getFirstDaughter ( ) const

inline

Get 1-based index of first daughter, 0 if no daughters.

Returns: The index of the first daughter of the MonteCarlo particle. The index is 0 if the MonteCarlo particle doesn't have any daughters.

Definition at line 240 of file MCParticle.h.

240{ return m_firstDaughter; }

◆ getIndex()

int getIndex ( ) const

inline

Get 1-based index of the particle in the corresponding MCParticle list.

This is used by the MCParticle Graph.

Returns: The index of the MonteCarlo particle in the corresponding MCParticle list (starts with 1)

Definition at line 219 of file MCParticle.h.

219{ fixParticleList(); return m_index; }

◆ getInfo()

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note: : You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

◆ getInfoHTML()

std::string getInfoHTML ( ) const

overridevirtual

Return a short summary of this object's contents in HTML format.

Reimplemented from RelationsInterface< BASE >.

Definition at line 125 of file MCParticle.cc.

{
  std::stringstream out;
  out << "<b>Charge</b>=" << (int)getCharge();
  out << ", <b>PDG</b>=" << getPDG();
  out << " (" << getName() << ")";
  out << "<br>";
  out << "<b>isPrimaryParticle</b>=" << isPrimaryParticle();
  out << ",<b>isInitial</b>=" << isInitial();
  out << ",<b>isVirtual</b>=" << isVirtual();
  out << "<br>";
 
  out << "<b>pT</b>=" << getMomentum().Rho();
  out << ", <b>pZ</b>=" << m_momentum_z;
  out << "<br>";
  std::string unitType = HTML::chooseUnitOfLength(getProductionVertex());
  int precision = 3;
  out << "<b>V</b>=" << HTML::getStringConvertToUnit(getProductionVertex(), precision, unitType);
 
  const MCParticle* mom = getMother();
  if (mom) {
    out << "<br>";
    out << "<b>Mother</b>: " << mom->getArrayName() << "[" << mom->getArrayIndex() << "] (" << mom->getName() << ")";
  }
  return out.str();
}

◆ getLastDaughter()

int getLastDaughter ( ) const

inline

Get 1-based index of last daughter, 0 if no daughters.

Returns: The index of the last daughter of the MonteCarlo particle. The index is 0 if the MonteCarlo particle doesn't have any daughters.

Definition at line 248 of file MCParticle.h.

248{ return m_lastDaughter; }

◆ getLifetime()

float getLifetime ( ) const

inline

Return the lifetime in ns.

A convenient method to get the lifetime of the MonteCarlo particle.

Returns: The lifetime of the MonteCarlo particle in ns. If the particle crosses the simulation volume boundary, it is set to the time spent inside the volume.

Definition at line 166 of file MCParticle.h.

166{ return m_decayTime - m_productionTime; }

◆ getMass()

float getMass ( ) const

inline

Return the particle mass in GeV.

Returns: The mass of the particle in GeV.

Definition at line 124 of file MCParticle.h.

124{ return m_mass; }

◆ getMomentum()

ROOT::Math::XYZVector getMomentum ( ) const

inline

Return momentum.

Returns: The momentum of the MonteCarlo particle in GeV.

Definition at line 187 of file MCParticle.h.

    {
      return ROOT::Math::XYZVector(m_momentum_x, m_momentum_y, m_momentum_z);
    }

◆ getName()

std::string getName ( ) const

overridevirtual

Return name of this particle.

Reimplemented from RelationsInterface< BASE >.

Definition at line 117 of file MCParticle.cc.

{
  const TParticlePDG* p = TDatabasePDG::Instance()->GetParticle(m_pdg);
  if (p)
    return p->GetName();
  else //handle unknown PDG codes
    return std::to_string(m_pdg);
}

◆ getNDaughters()

int getNDaughters ( ) const

Return number of daughter MCParticles.

Definition at line 75 of file MCParticle.cc.

{
  if (getFirstDaughter() == 0) //no daughters
    return 0;
  return getLastDaughter() - getFirstDaughter() + 1;
}

◆ getParticleFromGeneralizedIndexString()

const MCParticle * getParticleFromGeneralizedIndexString ( const std::string & generalizedIndex ) const

Explores the decay tree of the MC particle and returns the (grand^n)daughter identified by a generalized index.

The generalized index consists of a colon-separated list of daughter indexes, starting from the root particle: 0:1:3 identifies the fourth daughter (3) of the second daughter (1) of the first daughter (0) of the mother particle. This method mirrors the method used in the Particle class.

Parameters

generalizedIndex the generalized index of the particle to be returned

Returns: a particle in the decay tree of the root particle.

Definition at line 152 of file MCParticle.cc.

{
  // Split the generalizedIndex string in a vector of strings.
  std::vector<std::string> generalizedIndexes;
  boost::split(generalizedIndexes, generalizedIndex, boost::is_any_of(":"));
 
  if (generalizedIndexes.empty()) {
    B2WARNING("Generalized index of MC daughter particle is empty. Skipping.");
    return nullptr;
  }
 
  // To explore a decay tree of unknown depth, we need a place to store
  // both the root particle and the daughter particle at each iteration
  const MCParticle* dauPart =
    nullptr; // This will be eventually returned
  const MCParticle* currentPart = this; // This is the root particle of the next iteration
 
  // Loop over the generalizedIndexes until you get to the particle you want
  for (auto& indexString : generalizedIndexes) {
    // indexString is a string. First try to convert it into an int
    int dauIndex = 0;
    try {
      dauIndex = Belle2::convertString<int>(indexString);
    } catch (std::invalid_argument&) {
      B2WARNING("Found the string " << indexString << "instead of a daughter index.");
      return nullptr;
    }
 
    // Check that the daughter index is smaller than the number of daughters of the current root particle
    if (dauIndex >= int(currentPart->getNDaughters()) or dauIndex < 0) {
      B2WARNING("Daughter index out of range" << LogVar("daughter index", dauIndex));
      B2WARNING("Trying to access non-existing particle.");
      return nullptr;
    } else {
      dauPart = currentPart->getDaughter(dauIndex); // Pick the particle indicated by the generalizedIndex
      currentPart = dauPart;
    }
  }
  return dauPart;
}

◆ getPDG()

int getPDG ( ) const

inline

Return PDG code of particle.

Returns: The PDG code of the MonteCarlo particle.

Definition at line 101 of file MCParticle.h.

101{ return m_pdg; }

◆ getProductionTime()

float getProductionTime ( ) const

inline

Return production time in ns.

Returns: The timestamp of the MonteCarlo particle production in ns.

Definition at line 148 of file MCParticle.h.

148{ return m_productionTime; }

◆ getProductionVertex()

ROOT::Math::XYZVector getProductionVertex ( ) const

inline

Return production vertex position.

Returns: The production vertex of the MonteCarlo particle in cm.

Definition at line 178 of file MCParticle.h.

    {
      return ROOT::Math::XYZVector(m_productionVertex_x, m_productionVertex_y, m_productionVertex_z);
    }

◆ getRelated()

T * getRelated	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

◆ getRelatedFrom()

FROM * getRelatedFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

◆ getRelatedFromWithWeight()

std::pair< FROM *, float > getRelatedFromWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

◆ getRelatedTo()

TO * getRelatedTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

◆ getRelatedToWithWeight()

std::pair< TO *, float > getRelatedToWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

◆ getRelatedWithWeight()

std::pair< T *, float > getRelatedWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

◆ getRelationsFrom()

RelationVector< FROM > getRelationsFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

◆ getRelationsTo()

RelationVector< TO > getRelationsTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

◆ getRelationsWith()

RelationVector< T > getRelationsWith	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

◆ getSecondaryPhysicsProcess()

int getSecondaryPhysicsProcess ( ) const

inline

Returns the physics process type of a secondary particle.

Returns: Returns an integer indicating the physics process type of a secondary particle. 0 if the particle is primary. -1 if no information is found. For the details, see the Geant4 package: (*G4Track)->GetCreatorProcess()->GetProcessSubType() processes/electromagnetic/utils/include/G4EmProcessSubType.hh processes/hadronic/management/include/G4HadronicProcessType.hh processes/decay/include/G4DecayProcessType.hh

Definition at line 286 of file MCParticle.h.

286{return m_secondaryPhysicsProcess;}

◆ getSeenInDetector()

Const::DetectorSet getSeenInDetector ( ) const

inline

Return the seen-in flags of the entire Belle II subdetectors for an MC particle.

Returns: Returns the entire seen-in flags

Definition at line 292 of file MCParticle.h.

292{ return m_seenIn; }

◆ getStatus()

unsigned int getStatus ( unsigned short int bitmask = USHRT_MAX ) const

inline

Return status code of particle.

Parameters

bitmask Takes an optional bitmask that is compared to the status of the particle.

Returns: Returns the status code of the particle. If a bitmask is given and it matches the the status it returns the value of the bitmask and 0 if not.

Definition at line 111 of file MCParticle.h.

111{ return m_status & bitmask; }

◆ getVertex()

ROOT::Math::XYZVector getVertex ( ) const

inline

Return production vertex position, shorthand for getProductionVertex().

Returns: The production vertex of the MonteCarlo particle in cm.

Definition at line 172 of file MCParticle.h.

172{ return getProductionVertex(); }

◆ hasSeenInDetector()

bool hasSeenInDetector ( Const::DetectorSet set ) const

inline

Return if the seen-in flag for a specific subdetector is set or not.

Parameters

set	The ID for Belle II subdetector(s), in either Const::DetectorSet or Const::EDetector format.

Returns: Returns true if the corresponding bit is set.

Definition at line 299 of file MCParticle.h.

299{ return m_seenIn.contains(set); }

Belle2::Const::DetectorSet::contains

bool contains(const DetectorSet &set) const

Check whether this set contains another set.

Definition: Const.h:235

◆ hasStatus()

bool hasStatus ( unsigned short int bitmask ) const

inline

Return if specific status bit is set.

Parameters

bitmask The bitmask which is compared to the status of the particle.

Returns: Returns true if the bitmask matches the status code of the particle.

Definition at line 118 of file MCParticle.h.

118{ return (m_status & bitmask) == bitmask; }

◆ hasValidVertex()

bool hasValidVertex ( ) const

inline

Indication whether vertex and time information is useful or just default.

Returns: Returns True if the vertex and time information is useful.

Definition at line 142 of file MCParticle.h.

142{ return m_validVertex; }

◆ removeSeenInDetector()

void removeSeenInDetector ( Const::DetectorSet set )

inline

Unflag/Remove the bit if the MC particle is not seen in a specific subdetector.

Parameters

set	The ID for Belle II subdetector(s), in either Const::DetectorSet or Const::EDetector format

Definition at line 475 of file MCParticle.h.

475{ m_seenIn -= set; }

◆ removeStatus()

void removeStatus ( unsigned short int bitmask )

inline

Remove bitmask from current status.

Parameters

bitmask The status code which should be removed from the existing MonteCarlo particle status code.

Definition at line 349 of file MCParticle.h.

349{ m_status &= (~bitmask); }

◆ set4Vector()

void set4Vector ( const ROOT::Math::PxPyPzEVector & p4 )

inline

Sets the 4Vector of particle.

Parameters

p4 4Vector

Definition at line 427 of file MCParticle.h.

    {
      m_momentum_x = p4.px(); m_momentum_y = p4.py(); m_momentum_z = p4.pz(); m_energy = p4.energy();
    }

◆ setDecayTime()

void setDecayTime ( float time )

inline

Set decay time.

Parameters

time	The timestamp of the decay of the MonteCarlo time.

Definition at line 379 of file MCParticle.h.

379{ m_decayTime = time; }

◆ setDecayVertex() [1/2]

void setDecayVertex ( const ROOT::Math::XYZVector & vertex )

inline

Set decay vertex.

Parameters

vertex The position of the decay vertex given as XYZVector.

Definition at line 436 of file MCParticle.h.

    {
      m_decayVertex_x = vertex.X(); m_decayVertex_y = vertex.Y(), m_decayVertex_z = vertex.Z();
    }

◆ setDecayVertex() [2/2]

void setDecayVertex	(	float	x,
		float	y,
		float	z
	)

inline

Set decay vertex.

The position of the decay vertex is given as three float parameters.

Parameters

x	The x position of the decay vertex.
y	The y position of the decay vertex.
z	The z position of the decay vertex.

Definition at line 448 of file MCParticle.h.

    {
      m_decayVertex_x = x; m_decayVertex_y = y; m_decayVertex_z = z;
    }

◆ setEnergy()

void setEnergy ( float energy )

inline

Set energy.

Parameters

energy The energy of the MonteCarlo particle.

Definition at line 361 of file MCParticle.h.

361{ m_energy = energy; }

◆ setInitial()

void setInitial ( )

inline

Set particle to initial.

(A bit more convenient)

Definition at line 494 of file MCParticle.h.

494{ addStatus(c_Initial); }

Belle2::MCParticle::addStatus

void addStatus(unsigned short int bitmask)

Add bitmask to current status.

Definition: MCParticle.h:342

◆ setMass()

void setMass ( float mass )

inline

Set particle mass.

Parameters

mass	The MonteCarlo particle mass.

Definition at line 355 of file MCParticle.h.

355{ m_mass = mass; }

◆ setMassFromPDG()

void setMassFromPDG ( )

Sets the mass for the particle from the particle's PDG code.

Definition at line 28 of file MCParticle.cc.

{
  if (TDatabasePDG::Instance()->GetParticle(m_pdg) == nullptr)
    throw(ParticlePDGNotKnownError() << m_pdg);
  m_mass = TDatabasePDG::Instance()->GetParticle(m_pdg)->Mass();
}

◆ setMomentum() [1/2]

void setMomentum ( const ROOT::Math::XYZVector & momentum )

inline

Set particle momentum.

Parameters

momentum The momentum of the MonteCarlo particle given as XYZVector.

Definition at line 406 of file MCParticle.h.

    {
      m_momentum_x = momentum.X(); m_momentum_y = momentum.Y(), m_momentum_z = momentum.Z();
    }

◆ setMomentum() [2/2]

void setMomentum	(	float	px,
		float	py,
		float	pz
	)

inline

Set particle momentum.

The momentum of the MonteCarlo particle is given as three float parameters.

Parameters

px	The x component of the momentum vector.
py	The y component of the momentum vector.
pz	The z component of the momentum vector.

Definition at line 418 of file MCParticle.h.

    {
      m_momentum_x = px, m_momentum_y = py; m_momentum_z = pz;
    }

◆ setPDG()

void setPDG ( int pdg )

inline

Set PDG code of the particle.

Parameters

pdg	The PDG code of the MonteCarlo particle.

Definition at line 324 of file MCParticle.h.

324{ m_pdg = pdg; }

◆ setProductionTime()

void setProductionTime ( float time )

inline

Set production time.

Parameters

time	The timestamp of the production of the MonteCarlo particle.

Definition at line 373 of file MCParticle.h.

373{ m_productionTime = time; }

◆ setProductionVertex() [1/2]

void setProductionVertex ( const ROOT::Math::XYZVector & vertex )

inline

Set production vertex position.

Parameters

vertex The position of the production vertex given as XYZVector.

Definition at line 385 of file MCParticle.h.

    {
      m_productionVertex_x = vertex.X(); m_productionVertex_y = vertex.Y(), m_productionVertex_z = vertex.Z();
    }

◆ setProductionVertex() [2/2]

void setProductionVertex	(	float	x,
		float	y,
		float	z
	)

inline

Set production vertex position.

The position of the production vertex is given as three float parameters.

Parameters

x	The x position of the production vertex.
y	The y position of the production vertex.
z	The z position of the production vertex.

Definition at line 397 of file MCParticle.h.

    {
      m_productionVertex_x = x; m_productionVertex_y = y; m_productionVertex_z = z;
    }

◆ setSecondaryPhysicsProcess()

void setSecondaryPhysicsProcess ( int physicsProcess )

inline

Sets the physics process type of a secondary particle.

Parameters

physicsProcess physics process type as an integer number for a secondary particle.

Definition at line 457 of file MCParticle.h.

457{ m_secondaryPhysicsProcess = physicsProcess; }

◆ setSeenInDetector()

void setSeenInDetector ( Const::DetectorSet set )

inline

Set the seen-in flags for the entire Belle II subdetectors for an Monte Carlo particle.

Parameters

set	The ID for Belle II subdetector(s), in either Const::DetectorSet or Const::EDetector format

Definition at line 463 of file MCParticle.h.

463{ m_seenIn = set; }

◆ setStatus()

void setStatus ( unsigned short int status )

inline

Set Status code for the particle.

Parameters

status The status code of the MonteCarlo particle.

Definition at line 335 of file MCParticle.h.

335{ m_status = status; }

◆ setValidVertex()

void setValidVertex ( bool valid )

inline

Set indication whether vertex and time information is valid or just default.

Parameters

valid Set to true if the vertex is valid.

Definition at line 367 of file MCParticle.h.

367{ m_validVertex = valid; }

◆ setVirtual()

void setVirtual ( )

inline

Set particle to virtual.

(A bit more convenient)

Definition at line 489 of file MCParticle.h.

489{ addStatus(c_IsVirtual); }

Friends And Related Function Documentation

◆ FixMergedObjectsModule

friend class FixMergedObjectsModule

friend

Definition at line 561 of file MCParticle.h.

Member Data Documentation

◆ c_epsilon

const double c_epsilon = 10e-7

staticprotected

limit of precision for two doubles to be the same.

Definition at line 555 of file MCParticle.h.

◆ m_cacheArrayIndex

int m_cacheArrayIndex

mutableprivateinherited

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

Definition at line 432 of file RelationsObject.h.

◆ m_cacheDataStoreEntry

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

◆ m_decayTime

float m_decayTime = 0

protected

decay time

Definition at line 528 of file MCParticle.h.

◆ m_decayVertex_x

float m_decayVertex_x = 0

protected

decay vertex of particle, x component

Definition at line 529 of file MCParticle.h.

◆ m_decayVertex_y

float m_decayVertex_y = 0

protected

decay vertex of particle, y component

Definition at line 530 of file MCParticle.h.

◆ m_decayVertex_z

float m_decayVertex_z = 0

protected

decay vertex of particle, z component

Definition at line 531 of file MCParticle.h.

◆ m_energy

float m_energy = 0

protected

energy of the particle

Definition at line 535 of file MCParticle.h.

◆ m_firstDaughter

int m_firstDaughter = 0

protected

1-based index of first daughter particle in collection, 0 if no daughters

Definition at line 547 of file MCParticle.h.

◆ m_index

int m_index = 0

protected

1-based index of the particle, will be set automatically after deserialisation if needed.

Definition at line 544 of file MCParticle.h.

◆ m_lastDaughter

int m_lastDaughter = 0

protected

1-based index of last daughter particle in collection, 0 if no daughters

Definition at line 548 of file MCParticle.h.

◆ m_mass

float m_mass = 0

protected

mass of the particle

Definition at line 534 of file MCParticle.h.

◆ m_momentum_x

float m_momentum_x = 0

protected

momentum of particle, x component

Definition at line 536 of file MCParticle.h.

◆ m_momentum_y

float m_momentum_y = 0

protected

momentum of particle, y component

Definition at line 537 of file MCParticle.h.

◆ m_momentum_z

float m_momentum_z = 0

protected

momentum of particle, z component

Definition at line 538 of file MCParticle.h.

◆ m_mother

int m_mother = 0

protected

transient 1-based index of particle

1-based index of the mother particle

Definition at line 546 of file MCParticle.h.

◆ m_pdg

int m_pdg = 0

protected

PDG-Code of the particle.

Definition at line 533 of file MCParticle.h.

◆ m_plist

TClonesArray* m_plist = nullptr

protected

Internal pointer to DataStore Array containing particles belonging to this collection.

This is a transient member and will not be written to file. The pointer will be set correctly on first access after deserialisation

Definition at line 521 of file MCParticle.h.

◆ m_productionTime

float m_productionTime = 0

protected

transient pointer to particle list

production time

Definition at line 523 of file MCParticle.h.

◆ m_productionVertex_x

float m_productionVertex_x = 0

protected

production vertex of particle, x component

Definition at line 524 of file MCParticle.h.

◆ m_productionVertex_y

float m_productionVertex_y = 0

protected

production vertex of particle, y component

Definition at line 525 of file MCParticle.h.

◆ m_productionVertex_z

float m_productionVertex_z = 0

protected

production vertex of particle, z component

Definition at line 526 of file MCParticle.h.

◆ m_secondaryPhysicsProcess

int m_secondaryPhysicsProcess = 0

protected

physics process type of a secondary particle

Definition at line 550 of file MCParticle.h.

◆ m_seenIn

Const::DetectorSet m_seenIn

protected

Each bit is a seen-in flag for the corresoponding subdetector of Belle II.

Definition at line 557 of file MCParticle.h.

◆ m_status

unsigned short int m_status = 0

protected

status code

Definition at line 552 of file MCParticle.h.

◆ m_validVertex

bool m_validVertex = false

protected

indication whether vertex and time information is useful or just default

Definition at line 554 of file MCParticle.h.

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

mdst/dataobjects/include/MCParticle.h
mdst/dataobjects/src/MCParticle.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ StatusBit

Constructor & Destructor Documentation

◆ MCParticle() [1/2]

◆ MCParticle() [2/2]

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ addSeenInDetector()

◆ addStatus()

◆ copyRelations()

◆ fixParticleList()

◆ get4Vector()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getCharge()

◆ getDaughter()

◆ getDaughters()

◆ getDecayTime()

◆ getDecayVertex()

◆ getEnergy()

◆ getFirstDaughter()

◆ getIndex()

◆ getInfo()

◆ getInfoHTML()

◆ getLastDaughter()

◆ getLifetime()

◆ getMass()

◆ getMomentum()

◆ getName()

◆ getNDaughters()

◆ getParticleFromGeneralizedIndexString()

◆ getPDG()

◆ getProductionTime()

◆ getProductionVertex()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getSecondaryPhysicsProcess()

◆ getSeenInDetector()

◆ getStatus()

◆ getVertex()

◆ hasSeenInDetector()

◆ hasStatus()

◆ hasValidVertex()

◆ removeSeenInDetector()

◆ removeStatus()

◆ set4Vector()

◆ setDecayTime()

◆ setDecayVertex() [1/2]

◆ setDecayVertex() [2/2]

◆ setEnergy()

◆ setInitial()

◆ setMass()

◆ setMassFromPDG()

◆ setMomentum() [1/2]

◆ setMomentum() [2/2]

◆ setPDG()

◆ setProductionTime()

◆ setProductionVertex() [1/2]

◆ setProductionVertex() [2/2]

◆ setSecondaryPhysicsProcess()

◆ setSeenInDetector()

◆ setStatus()