EICd
EIC data model
Public Member Functions | Friends | List of all members
eicd::ReconstructedParticle Class Reference

#include <ReconstructedParticle.h>

Public Member Functions

 ReconstructedParticle ()
 default constructor More...
 
 ReconstructedParticle (std::int32_t type, float energy, edm4hep::Vector3f momentum, edm4hep::Vector3f referencePoint, float charge, float mass, float goodnessOfPID, eicd::Cov4f covMatrix, std::int32_t PDG)
 
 ReconstructedParticle (ReconstructedParticleObj *obj)
 constructor from existing ReconstructedParticleObj More...
 
 ReconstructedParticle (const ReconstructedParticle &other)
 copy constructor More...
 
ReconstructedParticle & operator= (ReconstructedParticle other)
 copy-assignment operator More...
 
MutableReconstructedParticle clone () const
 create a mutable deep-copy of the object with identical relations More...
 
 ~ReconstructedParticle ()
 destructor More...
 
const std::int32_t & getType () const
 Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues. More...
 
const float & getEnergy () const
 Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally. More...
 
const edm4hep::Vector3f & getMomentum () const
 Access the [GeV] particle momentum. Four momentum state is not kept consistent internally. More...
 
const edm4hep::Vector3f & getReferencePoint () const
 Access the [mm] reference, i.e. where the particle has been measured. More...
 
const float & getCharge () const
 Access the charge of the reconstructed particle. More...
 
const float & getMass () const
 Access the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally. More...
 
const float & getGoodnessOfPID () const
 Access the overall goodness of the PID on a scale of [0;1]. More...
 
const eicd::Cov4f & getCovMatrix () const
 Access the cvariance matrix of the reconstructed particle 4vector (10 parameters). More...
 
const std::int32_t & getPDG () const
 Access the PDG code for this particle. More...
 
const eicd::Vertex getStartVertex () const
 Access the Start vertex associated to this particle. More...
 
const edm4hep::ParticleID getParticleIDUsed () const
 Access the particle ID used for the kinematics of this particle. More...
 
unsigned int clusters_size () const
 
eicd::Cluster getClusters (unsigned int) const
 
std::vector< eicd::Cluster >::const_iterator clusters_begin () const
 
std::vector< eicd::Cluster >::const_iterator clusters_end () const
 
podio::RelationRange< eicd::Cluster > getClusters () const
 
unsigned int tracks_size () const
 
eicd::Track getTracks (unsigned int) const
 
std::vector< eicd::Track >::const_iterator tracks_begin () const
 
std::vector< eicd::Track >::const_iterator tracks_end () const
 
podio::RelationRange< eicd::Track > getTracks () const
 
unsigned int particles_size () const
 
eicd::ReconstructedParticle getParticles (unsigned int) const
 
std::vector< eicd::ReconstructedParticle >::const_iterator particles_begin () const
 
std::vector< eicd::ReconstructedParticle >::const_iterator particles_end () const
 
podio::RelationRange< eicd::ReconstructedParticle > getParticles () const
 
unsigned int particleIDs_size () const
 
edm4hep::ParticleID getParticleIDs (unsigned int) const
 
std::vector< edm4hep::ParticleID >::const_iterator particleIDs_begin () const
 
std::vector< edm4hep::ParticleID >::const_iterator particleIDs_end () const
 
podio::RelationRange< edm4hep::ParticleID > getParticleIDs () const
 
bool isCompound () const
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from ReconstructedParticleObj instance More...
 
bool operator== (const ReconstructedParticle &other) const
 
bool operator== (const MutableReconstructedParticle &other) const
 
bool operator< (const ReconstructedParticle &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class MutableReconstructedParticle
 
class ReconstructedParticleCollection
 
class ReconstructedParticleCollectionIterator
 
void swap (ReconstructedParticle &a, ReconstructedParticle &b)
 

Detailed Description

EIC Reconstructed Particle

Author
: W. Armstrong, S. Joosten, F. Gaede

Constructor & Destructor Documentation

◆ ReconstructedParticle() [1/4]

eicd::ReconstructedParticle::ReconstructedParticle ( )

default constructor

◆ ReconstructedParticle() [2/4]

eicd::ReconstructedParticle::ReconstructedParticle ( std::int32_t  type,
float  energy,
edm4hep::Vector3f  momentum,
edm4hep::Vector3f  referencePoint,
float  charge,
float  mass,
float  goodnessOfPID,
eicd::Cov4f  covMatrix,
std::int32_t  PDG 
)

◆ ReconstructedParticle() [3/4]

eicd::ReconstructedParticle::ReconstructedParticle ( ReconstructedParticleObj *  obj)

constructor from existing ReconstructedParticleObj

◆ ReconstructedParticle() [4/4]

eicd::ReconstructedParticle::ReconstructedParticle ( const ReconstructedParticle &  other)

copy constructor

◆ ~ReconstructedParticle()

eicd::ReconstructedParticle::~ReconstructedParticle ( )

destructor

Member Function Documentation

◆ clone()

MutableReconstructedParticle eicd::ReconstructedParticle::clone ( ) const

create a mutable deep-copy of the object with identical relations

◆ clusters_begin()

std::vector< eicd::Cluster >::const_iterator eicd::ReconstructedParticle::clusters_begin ( ) const

◆ clusters_end()

std::vector< eicd::Cluster >::const_iterator eicd::ReconstructedParticle::clusters_end ( ) const

◆ clusters_size()

unsigned int eicd::ReconstructedParticle::clusters_size ( ) const

◆ getCharge()

const float & eicd::ReconstructedParticle::getCharge ( ) const

Access the charge of the reconstructed particle.

◆ getClusters() [1/2]

podio::RelationRange< eicd::Cluster > eicd::ReconstructedParticle::getClusters ( ) const

◆ getClusters() [2/2]

eicd::Cluster eicd::ReconstructedParticle::getClusters ( unsigned int  index) const

◆ getCovMatrix()

const eicd::Cov4f & eicd::ReconstructedParticle::getCovMatrix ( ) const

Access the cvariance matrix of the reconstructed particle 4vector (10 parameters).

◆ getEnergy()

const float & eicd::ReconstructedParticle::getEnergy ( ) const

Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.

◆ getGoodnessOfPID()

const float & eicd::ReconstructedParticle::getGoodnessOfPID ( ) const

Access the overall goodness of the PID on a scale of [0;1].

◆ getMass()

const float & eicd::ReconstructedParticle::getMass ( ) const

Access the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.

◆ getMomentum()

const edm4hep::Vector3f & eicd::ReconstructedParticle::getMomentum ( ) const

Access the [GeV] particle momentum. Four momentum state is not kept consistent internally.

◆ getObjectID()

const podio::ObjectID eicd::ReconstructedParticle::getObjectID ( ) const

◆ getParticleIDs() [1/2]

podio::RelationRange< edm4hep::ParticleID > eicd::ReconstructedParticle::getParticleIDs ( ) const

◆ getParticleIDs() [2/2]

edm4hep::ParticleID eicd::ReconstructedParticle::getParticleIDs ( unsigned int  index) const

◆ getParticleIDUsed()

const edm4hep::ParticleID eicd::ReconstructedParticle::getParticleIDUsed ( ) const

Access the particle ID used for the kinematics of this particle.

◆ getParticles() [1/2]

podio::RelationRange< eicd::ReconstructedParticle > eicd::ReconstructedParticle::getParticles ( ) const

◆ getParticles() [2/2]

eicd::ReconstructedParticle eicd::ReconstructedParticle::getParticles ( unsigned int  index) const

◆ getPDG()

const std::int32_t & eicd::ReconstructedParticle::getPDG ( ) const

Access the PDG code for this particle.

◆ getReferencePoint()

const edm4hep::Vector3f & eicd::ReconstructedParticle::getReferencePoint ( ) const

Access the [mm] reference, i.e. where the particle has been measured.

◆ getStartVertex()

const eicd::Vertex eicd::ReconstructedParticle::getStartVertex ( ) const

Access the Start vertex associated to this particle.

◆ getTracks() [1/2]

podio::RelationRange< eicd::Track > eicd::ReconstructedParticle::getTracks ( ) const

◆ getTracks() [2/2]

eicd::Track eicd::ReconstructedParticle::getTracks ( unsigned int  index) const

◆ getType()

const std::int32_t & eicd::ReconstructedParticle::getType ( ) const

Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.

◆ id()

unsigned int eicd::ReconstructedParticle::id ( ) const
inline

◆ isAvailable()

bool eicd::ReconstructedParticle::isAvailable ( ) const

check whether the object is actually available

◆ isCompound()

bool eicd::ReconstructedParticle::isCompound ( ) const
inline

◆ operator<()

bool eicd::ReconstructedParticle::operator< ( const ReconstructedParticle &  other) const
inline

◆ operator=()

ReconstructedParticle & eicd::ReconstructedParticle::operator= ( ReconstructedParticle  other)

copy-assignment operator

◆ operator==() [1/2]

bool eicd::ReconstructedParticle::operator== ( const MutableReconstructedParticle &  other) const

◆ operator==() [2/2]

bool eicd::ReconstructedParticle::operator== ( const ReconstructedParticle &  other) const
inline

◆ particleIDs_begin()

std::vector< edm4hep::ParticleID >::const_iterator eicd::ReconstructedParticle::particleIDs_begin ( ) const

◆ particleIDs_end()

std::vector< edm4hep::ParticleID >::const_iterator eicd::ReconstructedParticle::particleIDs_end ( ) const

◆ particleIDs_size()

unsigned int eicd::ReconstructedParticle::particleIDs_size ( ) const

◆ particles_begin()

std::vector< eicd::ReconstructedParticle >::const_iterator eicd::ReconstructedParticle::particles_begin ( ) const

◆ particles_end()

std::vector< eicd::ReconstructedParticle >::const_iterator eicd::ReconstructedParticle::particles_end ( ) const

◆ particles_size()

unsigned int eicd::ReconstructedParticle::particles_size ( ) const

◆ tracks_begin()

std::vector< eicd::Track >::const_iterator eicd::ReconstructedParticle::tracks_begin ( ) const

◆ tracks_end()

std::vector< eicd::Track >::const_iterator eicd::ReconstructedParticle::tracks_end ( ) const

◆ tracks_size()

unsigned int eicd::ReconstructedParticle::tracks_size ( ) const

◆ unlink()

void eicd::ReconstructedParticle::unlink ( )
inline

disconnect from ReconstructedParticleObj instance

Friends And Related Function Documentation

◆ MutableReconstructedParticle

friend class MutableReconstructedParticle
friend

◆ ReconstructedParticleCollection

friend class ReconstructedParticleCollection
friend

◆ ReconstructedParticleCollectionIterator

friend class ReconstructedParticleCollectionIterator
friend

◆ swap

void swap ( ReconstructedParticle &  a,
ReconstructedParticle &  b 
)
friend
The documentation for this class was generated from the following files: