#include "MCParticle.h"

Collaboration diagram for pandora::MCParticle:

[legend]

Public Member Functions
bool	IsRootParticle () const
	Whether the mc particle is a root particle.

bool	IsPfoTarget () const
	Whether the mc particle is a pfo target.

float	GetEnergy () const
	Get energy of mc particle, units GeV.

const CartesianVector &	GetMomentum () const
	Get momentum of mc particle, units GeV.

const CartesianVector &	GetVertex () const
	Get the production vertex of the mc particle, units mm.

const CartesianVector &	GetEndpoint () const
	Get the endpoint of the mc particle, units mm.

float	GetInnerRadius () const
	Get inner radius of mc particle, units mm.

float	GetOuterRadius () const
	Get outer radius of mc particle, units mm.

int	GetParticleId () const
	Get the PDG code of the mc particle.

MCParticleType	GetMCParticleType () const
	Get the type of the mc particle, e.g. vertex, 2D-projection, etc.

bool	IsPfoTargetSet () const
	Whether the pfo target been set.

const MCParticle *	GetPfoTarget () const
	Get pfo target particle.

Uid	GetUid () const
	Get the mc particle unique identifier.

const MCParticleList &	GetParentList () const
	Get list of parents of mc particle.

const MCParticleList &	GetDaughterList () const
	Get list of daughters of mc particle.

bool	operator< (const MCParticle &rhs) const
	operator< sorting by vertex position, then energy

Protected Member Functions
	MCParticle (const object_creation::MCParticle::Parameters &parameters)
	Constructor.

virtual	~MCParticle ()
	Destructor.

StatusCode	AddDaughter (const MCParticle *const pMCParticle)
	Add daughter particle.

StatusCode	AddParent (const MCParticle *const pMCParticle)
	Add parent particle.

StatusCode	RemoveDaughter (const MCParticle *const pMCParticle)
	Remove daughter particle.

StatusCode	RemoveParent (const MCParticle *const pMCParticle)
	Remove parent particle.

StatusCode	SetPfoTarget (const MCParticle *const pMCParticle)
	Set pfo target particle.

StatusCode	RemovePfoTarget ()
	Remove pfo target particle.

Protected Attributes
const Uid	m_uid
	Unique identifier for the mc particle.

const float	m_energy
	The energy of the mc particle, units GeV.

const CartesianVector	m_momentum
	The momentum of the mc particle, units GeV.

const CartesianVector	m_vertex
	The production vertex of the mc particle, units mm.

const CartesianVector	m_endpoint
	The endpoint of the mc particle, units mm.

const float	m_innerRadius
	Inner radius of the particle's path, units mm.

const float	m_outerRadius
	Outer radius of the particle's path, units mm.

const int	m_particleId
	The PDG code of the mc particle.

const MCParticleType	m_mcParticleType
	The type of the mc particle, e.g. vertex, 2D-projection, etc.

const MCParticle *	m_pPfoTarget
	The address of the pfo target.

MCParticleList	m_daughterList
	The list of mc daughter particles.

MCParticleList	m_parentList
	The list of mc parent particles.

Friends
class	MCManager

class	InputObjectManager< MCParticle >

class	PandoraObjectFactory< object_creation::MCParticle::Parameters, object_creation::MCParticle::Object >

Detailed Description

MCParticle class.

Definition at line 25 of file MCParticle.h.

Constructor & Destructor Documentation

◆ MCParticle()

pandora::MCParticle::MCParticle ( const object_creation::MCParticle::Parameters & parameters )

protected

Constructor.

Parameters

parameters the mc particle parameters

Definition at line 44 of file MCParticle.cc.

◆ ~MCParticle()

pandora::MCParticle::~MCParticle ( )

protectedvirtual

Destructor.

Definition at line 60 of file MCParticle.cc.

Member Function Documentation

◆ AddDaughter()

StatusCode pandora::MCParticle::AddDaughter ( const MCParticle *const pMCParticle )

protected

Add daughter particle.

Parameters

mcParticle the daughter particle

Definition at line 66 of file MCParticle.cc.

◆ AddParent()

StatusCode pandora::MCParticle::AddParent ( const MCParticle *const pMCParticle )

protected

Add parent particle.

Parameters

mcParticle the parent particle

Definition at line 77 of file MCParticle.cc.

◆ GetDaughterList()

const MCParticleList & pandora::MCParticle::GetDaughterList ( ) const

inline

Get list of daughters of mc particle.

Returns: the mc daughter particle list

Definition at line 306 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetEndpoint()

const CartesianVector & pandora::MCParticle::GetEndpoint ( ) const

inline

Get the endpoint of the mc particle, units mm.

Returns: the endpoint of the mc particle

Definition at line 264 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetEnergy()

float pandora::MCParticle::GetEnergy ( ) const

inline

Get energy of mc particle, units GeV.

Returns: the mc particle energy

Definition at line 243 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetInnerRadius()

float pandora::MCParticle::GetInnerRadius ( ) const

inline

Get inner radius of mc particle, units mm.

Returns: the mc particle inner radius

Definition at line 271 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetMCParticleType()

MCParticleType pandora::MCParticle::GetMCParticleType ( ) const

inline

Get the type of the mc particle, e.g. vertex, 2D-projection, etc.

Returns: the type of the mc particle

Definition at line 292 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetMomentum()

const CartesianVector & pandora::MCParticle::GetMomentum ( ) const

inline

Get momentum of mc particle, units GeV.

Returns: the mc particle momentum

Definition at line 250 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetOuterRadius()

float pandora::MCParticle::GetOuterRadius ( ) const

inline

Get outer radius of mc particle, units mm.

Returns: the mc particle outer radius

Definition at line 278 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetParentList()

const MCParticleList & pandora::MCParticle::GetParentList ( ) const

inline

Get list of parents of mc particle.

Returns: the mc parent particle list

Definition at line 299 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetParticleId()

int pandora::MCParticle::GetParticleId ( ) const

inline

Get the PDG code of the mc particle.

Returns: the PDG code of the mc particle

Definition at line 285 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetPfoTarget()

const MCParticle * pandora::MCParticle::GetPfoTarget ( ) const

Get pfo target particle.

Returns: the address of the pfo target

Definition at line 16 of file MCParticle.cc.

◆ GetUid()

Uid pandora::MCParticle::GetUid ( ) const

inline

Get the mc particle unique identifier.

Returns: the mc particle unique identifier

Definition at line 236 of file MCParticle.h.

Here is the caller graph for this function:

◆ GetVertex()

const CartesianVector & pandora::MCParticle::GetVertex ( ) const

inline

Get the production vertex of the mc particle, units mm.

Returns: the production vertex of the mc particle

Definition at line 257 of file MCParticle.h.

Here is the caller graph for this function:

◆ IsPfoTarget()

bool pandora::MCParticle::IsPfoTarget ( ) const

inline

Whether the mc particle is a pfo target.

Returns: boolean

Definition at line 222 of file MCParticle.h.

◆ IsPfoTargetSet()

bool pandora::MCParticle::IsPfoTargetSet ( ) const

inline

Whether the pfo target been set.

Returns: boolean

Definition at line 229 of file MCParticle.h.

Here is the caller graph for this function:

◆ IsRootParticle()

bool pandora::MCParticle::IsRootParticle ( ) const

inline

Whether the mc particle is a root particle.

Returns: boolean

Definition at line 215 of file MCParticle.h.

Here is the caller graph for this function:

◆ operator<()

bool pandora::MCParticle::operator< ( const MCParticle & rhs ) const

operator< sorting by vertex position, then energy

Parameters

rhs	the object for comparison

Returns: boolean

Definition at line 26 of file MCParticle.cc.

Here is the call graph for this function:

◆ RemoveDaughter()

StatusCode pandora::MCParticle::RemoveDaughter ( const MCParticle *const pMCParticle )

protected

Remove daughter particle.

Parameters

mcParticle the daughter particle

Definition at line 88 of file MCParticle.cc.

◆ RemoveParent()

StatusCode pandora::MCParticle::RemoveParent ( const MCParticle *const pMCParticle )

protected

Remove parent particle.

Parameters

mcParticle the parent particle

Definition at line 101 of file MCParticle.cc.

◆ RemovePfoTarget()

StatusCode pandora::MCParticle::RemovePfoTarget ( )

protected

Remove pfo target particle.

Definition at line 125 of file MCParticle.cc.

◆ SetPfoTarget()

StatusCode pandora::MCParticle::SetPfoTarget ( const MCParticle *const pMCParticle )

protected

Set pfo target particle.

Parameters

mcParticle the pfo target particle

Definition at line 114 of file MCParticle.cc.

Friends And Related Symbol Documentation

◆ InputObjectManager< MCParticle >

friend class InputObjectManager< MCParticle >

friend

Definition at line 208 of file MCParticle.h.

◆ MCManager

friend class MCManager

friend

Definition at line 208 of file MCParticle.h.

◆ PandoraObjectFactory< object_creation::MCParticle::Parameters, object_creation::MCParticle::Object >

friend class PandoraObjectFactory< object_creation::MCParticle::Parameters, object_creation::MCParticle::Object >

friend

Definition at line 208 of file MCParticle.h.

Member Data Documentation

◆ m_daughterList

MCParticleList pandora::MCParticle::m_daughterList

protected

The list of mc daughter particles.

Definition at line 205 of file MCParticle.h.

◆ m_endpoint

const CartesianVector pandora::MCParticle::m_endpoint

protected

The endpoint of the mc particle, units mm.

Definition at line 199 of file MCParticle.h.

◆ m_energy

const float pandora::MCParticle::m_energy

protected

The energy of the mc particle, units GeV.

Definition at line 196 of file MCParticle.h.

◆ m_innerRadius

const float pandora::MCParticle::m_innerRadius

protected

Inner radius of the particle's path, units mm.

Definition at line 200 of file MCParticle.h.

◆ m_mcParticleType

const MCParticleType pandora::MCParticle::m_mcParticleType

protected

The type of the mc particle, e.g. vertex, 2D-projection, etc.

Definition at line 203 of file MCParticle.h.

◆ m_momentum

const CartesianVector pandora::MCParticle::m_momentum

protected

The momentum of the mc particle, units GeV.

Definition at line 197 of file MCParticle.h.

◆ m_outerRadius

const float pandora::MCParticle::m_outerRadius

protected

Outer radius of the particle's path, units mm.

Definition at line 201 of file MCParticle.h.

◆ m_parentList

MCParticleList pandora::MCParticle::m_parentList

protected

The list of mc parent particles.

Definition at line 206 of file MCParticle.h.

◆ m_particleId

const int pandora::MCParticle::m_particleId

protected

The PDG code of the mc particle.

Definition at line 202 of file MCParticle.h.

◆ m_pPfoTarget

const MCParticle* pandora::MCParticle::m_pPfoTarget

protected

The address of the pfo target.

Definition at line 204 of file MCParticle.h.

◆ m_uid

const Uid pandora::MCParticle::m_uid

protected

Unique identifier for the mc particle.

Definition at line 195 of file MCParticle.h.

◆ m_vertex

const CartesianVector pandora::MCParticle::m_vertex

protected

The production vertex of the mc particle, units mm.

Definition at line 198 of file MCParticle.h.

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

PandoraSDK/include/Objects/MCParticle.h
PandoraSDK/src/Objects/MCParticle.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MCParticle()

◆ ~MCParticle()

Member Function Documentation

◆ AddDaughter()

◆ AddParent()

◆ GetDaughterList()

◆ GetEndpoint()

◆ GetEnergy()

◆ GetInnerRadius()

◆ GetMCParticleType()

◆ GetMomentum()

◆ GetOuterRadius()

◆ GetParentList()

◆ GetParticleId()

◆ GetPfoTarget()

◆ GetUid()

◆ GetVertex()

◆ IsPfoTarget()

◆ IsPfoTargetSet()

◆ IsRootParticle()

◆ operator<()

◆ RemoveDaughter()

◆ RemoveParent()

◆ RemovePfoTarget()

◆ SetPfoTarget()

Friends And Related Symbol Documentation

◆ InputObjectManager< MCParticle >

◆ MCManager

◆ PandoraObjectFactory< object_creation::MCParticle::Parameters, object_creation::MCParticle::Object >

Member Data Documentation

◆ m_daughterList

◆ m_endpoint

◆ m_energy

◆ m_innerRadius

◆ m_mcParticleType

◆ m_momentum

◆ m_outerRadius

◆ m_parentList

◆ m_particleId

◆ m_pPfoTarget

◆ m_uid

◆ m_vertex