Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
pandora::ParticleFlowObject Class Reference

ParticleFlowObject class. More...

#include "ParticleFlowObject.h"

Inheritance diagram for pandora::ParticleFlowObject:
Inheritance graph
[legend]
Collaboration diagram for pandora::ParticleFlowObject:
Collaboration graph
[legend]

Public Member Functions

int GetParticleId () const
 Get the particle flow object id (PDG code)
 
int GetCharge () const
 Get particle flow object charge.
 
float GetMass () const
 Get particle flow object mass.
 
float GetEnergy () const
 Get the particle flow object energy.
 
const CartesianVector & GetMomentum () const
 Get particle flow object momentum vector.
 
const TrackList & GetTrackList () const
 Get the track list.
 
const ClusterList & GetClusterList () const
 Get the cluster list.
 
const VertexList & GetVertexList () const
 Get the vertex list.
 
TrackAddressList GetTrackAddressList () const
 Get track address list.
 
ClusterAddressList GetClusterAddressList () const
 Get the cluster address list.
 
unsigned int GetNTracks () const
 Get the number of tracks in the particle flow object.
 
unsigned int GetNClusters () const
 Get the number of clusters in the particle flow object.
 
const PfoList & GetParentPfoList () const
 Get the parent pfo list.
 
const PfoList & GetDaughterPfoList () const
 Get the daughter pfo list.
 
unsigned int GetNParentPfos () const
 Get the number of parent pfos.
 
unsigned int GetNDaughterPfos () const
 Get the number of daughter pfos.
 
const PropertiesMap & GetPropertiesMap () const
 Get the map from registered property name to floating point property value.
 
template<>
StatusCode AddToPfo (const Cluster *const pCluster)
 
template<>
StatusCode AddToPfo (const Track *const pTrack)
 
template<>
StatusCode AddToPfo (const Vertex *const pVertex)
 
template<>
StatusCode RemoveFromPfo (const Cluster *const pCluster)
 
template<>
StatusCode RemoveFromPfo (const Track *const pTrack)
 
template<>
StatusCode RemoveFromPfo (const Vertex *const pVertex)
 

Protected Member Functions

 ParticleFlowObject (const object_creation::ParticleFlowObject::Parameters &parameters)
 Constructor.
 
virtual ~ParticleFlowObject ()
 Destructor.
 
StatusCode AlterMetadata (const object_creation::ParticleFlowObject::Metadata &metadata)
 Alter particle flow object metadata parameters.
 
template<typename T >
StatusCode AddToPfo (const T *const pT)
 Add an object to the particle flow object.
 
template<typename T >
StatusCode RemoveFromPfo (const T *const pT)
 Remove an object from the particle flow object.
 
StatusCode AddParent (const ParticleFlowObject *const pPfo)
 Add a parent pfo to the parent pfo list.
 
StatusCode AddDaughter (const ParticleFlowObject *const pPfo)
 Add a daughter pfo to the daughter pfo list.
 
StatusCode RemoveParent (const ParticleFlowObject *const pPfo)
 Remove a parent pfo from the parent pfo list.
 
StatusCode RemoveDaughter (const ParticleFlowObject *const pPfo)
 Remove a daughter pfo from the daughter pfo list.
 
StatusCode UpdatePropertiesMap (const object_creation::ParticleFlowObject::Metadata &metadata)
 Update the properties map.
 

Protected Attributes

int m_particleId
 The particle flow object id (PDG code)
 
int m_charge
 The particle flow object charge.
 
float m_mass
 The particle flow object mass.
 
float m_energy
 The particle flow object energy.
 
CartesianVector m_momentum
 The particle flow object momentum.
 
TrackList m_trackList
 The track list.
 
ClusterList m_clusterList
 The cluster list.
 
VertexList m_vertexList
 The vertex list.
 
PfoList m_parentPfoList
 The list of parent pfos.
 
PfoList m_daughterPfoList
 The list of daughter pfos.
 
PropertiesMap m_propertiesMap
 The map from registered property name to floating point property value.
 

Friends

class ParticleFlowObjectManager
 
class AlgorithmObjectManager< ParticleFlowObject >
 
class PandoraObjectFactory< object_creation::ParticleFlowObject::Parameters, object_creation::ParticleFlowObject::Object >
 

Detailed Description

ParticleFlowObject class.

Definition at line 25 of file ParticleFlowObject.h.

Constructor & Destructor Documentation

◆ ParticleFlowObject()

pandora::ParticleFlowObject::ParticleFlowObject ( const object_creation::ParticleFlowObject::Parameters &  parameters)
protected

Constructor.

Parameters
parametersthe particle flow object parameters

Definition at line 19 of file ParticleFlowObject.cc.

◆ ~ParticleFlowObject()

pandora::ParticleFlowObject::~ParticleFlowObject ( )
protectedvirtual

Destructor.

Definition at line 36 of file ParticleFlowObject.cc.

Member Function Documentation

◆ AddDaughter()

StatusCode pandora::ParticleFlowObject::AddDaughter ( const ParticleFlowObject *const  pPfo)
protected

Add a daughter pfo to the daughter pfo list.

Parameters
pPfothe address of the daughter pfo

Definition at line 190 of file ParticleFlowObject.cc.

◆ AddParent()

StatusCode pandora::ParticleFlowObject::AddParent ( const ParticleFlowObject *const  pPfo)
protected

Add a parent pfo to the parent pfo list.

Parameters
pPfothe address of the parent pfo

Definition at line 176 of file ParticleFlowObject.cc.

◆ AddToPfo() [1/4]

template<>
StatusCode pandora::ParticleFlowObject::AddToPfo ( const Cluster *const  pCluster)

Definition at line 107 of file ParticleFlowObject.cc.

◆ AddToPfo() [2/4]

template<typename T >
StatusCode pandora::ParticleFlowObject::AddToPfo ( const T *const  pT)
protected

Add an object to the particle flow object.

Parameters
pTaddress of the object to add

◆ AddToPfo() [3/4]

template<>
StatusCode pandora::ParticleFlowObject::AddToPfo ( const Track *const  pTrack)

Definition at line 117 of file ParticleFlowObject.cc.

◆ AddToPfo() [4/4]

template<>
StatusCode pandora::ParticleFlowObject::AddToPfo ( const Vertex *const  pVertex)

Definition at line 127 of file ParticleFlowObject.cc.

◆ AlterMetadata()

StatusCode pandora::ParticleFlowObject::AlterMetadata ( const object_creation::ParticleFlowObject::Metadata &  metadata)
protected

Alter particle flow object metadata parameters.

Parameters
metaDatathe new particle flow object metadata (all fields now optional)

Definition at line 42 of file ParticleFlowObject.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetCharge()

int pandora::ParticleFlowObject::GetCharge ( ) const
inline

Get particle flow object charge.

Returns
The particle flow object charge

Definition at line 246 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetClusterAddressList()

ClusterAddressList pandora::ParticleFlowObject::GetClusterAddressList ( ) const

Get the cluster address list.

Returns
The cluster address list

Definition at line 81 of file ParticleFlowObject.cc.

Here is the call graph for this function:

◆ GetClusterList()

const ClusterList & pandora::ParticleFlowObject::GetClusterList ( ) const
inline

Get the cluster list.

Returns
The cluster list

Definition at line 281 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetDaughterPfoList()

const PfoList & pandora::ParticleFlowObject::GetDaughterPfoList ( ) const
inline

Get the daughter pfo list.

Returns
The daughter pfo list

Definition at line 316 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetEnergy()

float pandora::ParticleFlowObject::GetEnergy ( ) const
inline

Get the particle flow object energy.

Returns
The particle flow object energy

Definition at line 260 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetMass()

float pandora::ParticleFlowObject::GetMass ( ) const
inline

Get particle flow object mass.

Returns
The particle flow object mass

Definition at line 253 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetMomentum()

const CartesianVector & pandora::ParticleFlowObject::GetMomentum ( ) const
inline

Get particle flow object momentum vector.

Returns
The particle flow object momentum vector

Definition at line 267 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetNClusters()

unsigned int pandora::ParticleFlowObject::GetNClusters ( ) const
inline

Get the number of clusters in the particle flow object.

Returns
The number of clusters in the particle flow object

Definition at line 302 of file ParticleFlowObject.h.

◆ GetNDaughterPfos()

unsigned int pandora::ParticleFlowObject::GetNDaughterPfos ( ) const
inline

Get the number of daughter pfos.

Returns
The number of daughter pfos

Definition at line 330 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetNParentPfos()

unsigned int pandora::ParticleFlowObject::GetNParentPfos ( ) const
inline

Get the number of parent pfos.

Returns
The number of parent pfos

Definition at line 323 of file ParticleFlowObject.h.

◆ GetNTracks()

unsigned int pandora::ParticleFlowObject::GetNTracks ( ) const
inline

Get the number of tracks in the particle flow object.

Returns
The number of tracks in the particle flow object

Definition at line 295 of file ParticleFlowObject.h.

◆ GetParentPfoList()

const PfoList & pandora::ParticleFlowObject::GetParentPfoList ( ) const
inline

Get the parent pfo list.

Returns
The parent pfo list

Definition at line 309 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetParticleId()

int pandora::ParticleFlowObject::GetParticleId ( ) const
inline

Get the particle flow object id (PDG code)

Returns
The particle flow object id

Definition at line 239 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetPropertiesMap()

const PropertiesMap & pandora::ParticleFlowObject::GetPropertiesMap ( ) const
inline

Get the map from registered property name to floating point property value.

Returns
The properties map

Definition at line 337 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ GetTrackAddressList()

TrackAddressList pandora::ParticleFlowObject::GetTrackAddressList ( ) const

Get track address list.

Returns
The track address list

Definition at line 67 of file ParticleFlowObject.cc.

◆ GetTrackList()

const TrackList & pandora::ParticleFlowObject::GetTrackList ( ) const
inline

Get the track list.

Returns
The track list

Definition at line 274 of file ParticleFlowObject.h.

◆ GetVertexList()

const VertexList & pandora::ParticleFlowObject::GetVertexList ( ) const
inline

Get the vertex list.

Returns
The vertex list

Definition at line 288 of file ParticleFlowObject.h.

Here is the caller graph for this function:

◆ RemoveDaughter()

StatusCode pandora::ParticleFlowObject::RemoveDaughter ( const ParticleFlowObject *const  pPfo)
protected

Remove a daughter pfo from the daughter pfo list.

Parameters
pPfothe address of the daughter pfo

Definition at line 217 of file ParticleFlowObject.cc.

◆ RemoveFromPfo() [1/4]

template<>
StatusCode pandora::ParticleFlowObject::RemoveFromPfo ( const Cluster *const  pCluster)

Definition at line 139 of file ParticleFlowObject.cc.

◆ RemoveFromPfo() [2/4]

template<typename T >
StatusCode pandora::ParticleFlowObject::RemoveFromPfo ( const T *const  pT)
protected

Remove an object from the particle flow object.

Parameters
pTaddress of the object to remove

◆ RemoveFromPfo() [3/4]

template<>
StatusCode pandora::ParticleFlowObject::RemoveFromPfo ( const Track *const  pTrack)

Definition at line 151 of file ParticleFlowObject.cc.

◆ RemoveFromPfo() [4/4]

template<>
StatusCode pandora::ParticleFlowObject::RemoveFromPfo ( const Vertex *const  pVertex)

Definition at line 163 of file ParticleFlowObject.cc.

◆ RemoveParent()

StatusCode pandora::ParticleFlowObject::RemoveParent ( const ParticleFlowObject *const  pPfo)
protected

Remove a parent pfo from the parent pfo list.

Parameters
pPfothe address of the parent pfo

Definition at line 204 of file ParticleFlowObject.cc.

◆ UpdatePropertiesMap()

StatusCode pandora::ParticleFlowObject::UpdatePropertiesMap ( const object_creation::ParticleFlowObject::Metadata &  metadata)
protected

Update the properties map.

Parameters
metaDatathe new particle flow object metadata

Definition at line 230 of file ParticleFlowObject.cc.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ AlgorithmObjectManager< ParticleFlowObject >

friend class AlgorithmObjectManager< ParticleFlowObject >
friend

Definition at line 230 of file ParticleFlowObject.h.

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

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

Definition at line 230 of file ParticleFlowObject.h.

◆ ParticleFlowObjectManager

friend class ParticleFlowObjectManager
friend

Definition at line 230 of file ParticleFlowObject.h.

Member Data Documentation

◆ m_charge

int pandora::ParticleFlowObject::m_charge
protected

The particle flow object charge.

Definition at line 219 of file ParticleFlowObject.h.

◆ m_clusterList

ClusterList pandora::ParticleFlowObject::m_clusterList
protected

The cluster list.

Definition at line 224 of file ParticleFlowObject.h.

◆ m_daughterPfoList

PfoList pandora::ParticleFlowObject::m_daughterPfoList
protected

The list of daughter pfos.

Definition at line 227 of file ParticleFlowObject.h.

◆ m_energy

float pandora::ParticleFlowObject::m_energy
protected

The particle flow object energy.

Definition at line 221 of file ParticleFlowObject.h.

◆ m_mass

float pandora::ParticleFlowObject::m_mass
protected

The particle flow object mass.

Definition at line 220 of file ParticleFlowObject.h.

◆ m_momentum

CartesianVector pandora::ParticleFlowObject::m_momentum
protected

The particle flow object momentum.

Definition at line 222 of file ParticleFlowObject.h.

◆ m_parentPfoList

PfoList pandora::ParticleFlowObject::m_parentPfoList
protected

The list of parent pfos.

Definition at line 226 of file ParticleFlowObject.h.

◆ m_particleId

int pandora::ParticleFlowObject::m_particleId
protected

The particle flow object id (PDG code)

Definition at line 218 of file ParticleFlowObject.h.

◆ m_propertiesMap

PropertiesMap pandora::ParticleFlowObject::m_propertiesMap
protected

The map from registered property name to floating point property value.

Definition at line 228 of file ParticleFlowObject.h.

◆ m_trackList

TrackList pandora::ParticleFlowObject::m_trackList
protected

The track list.

Definition at line 223 of file ParticleFlowObject.h.

◆ m_vertexList

VertexList pandora::ParticleFlowObject::m_vertexList
protected

The vertex list.

Definition at line 225 of file ParticleFlowObject.h.

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