EICd
EIC data model
eicd::MutableReconstructedParticle Class Reference

#include <MutableReconstructedParticle.h>

Public Member Functions

 MutableReconstructedParticle ()
 default constructor More...
 
 MutableReconstructedParticle (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)
 
 MutableReconstructedParticle (ReconstructedParticleObj *obj)
 constructor from existing ReconstructedParticleObj More...
 
 MutableReconstructedParticle (const MutableReconstructedParticle &other)
 copy constructor More...
 
MutableReconstructedParticleoperator= (MutableReconstructedParticle other)
 copy-assignment operator More...
 
MutableReconstructedParticle clone () const
 create a mutable deep-copy of the object with identical relations More...
 
 ~MutableReconstructedParticle ()
 destructor More...
 
 operator ReconstructedParticle () const
 conversion to const object 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::Cov4fgetCovMatrix () 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...
 
void setType (std::int32_t value)
 Set the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues. More...
 
void setEnergy (float value)
 Set the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally. More...
 
void setMomentum (edm4hep::Vector3f value)
 Set the [GeV] particle momentum. Four momentum state is not kept consistent internally. More...
 
edm4hep::Vector3f & momentum ()
 Get reference to [GeV] particle momentum. Four momentum state is not kept consistent internally. More...
 
void setReferencePoint (edm4hep::Vector3f value)
 Set the [mm] reference, i.e. where the particle has been measured. More...
 
edm4hep::Vector3f & referencePoint ()
 Get reference to [mm] reference, i.e. where the particle has been measured. More...
 
void setCharge (float value)
 Set the charge of the reconstructed particle. More...
 
void setMass (float value)
 Set the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally. More...
 
void setGoodnessOfPID (float value)
 Set the overall goodness of the PID on a scale of [0;1]. More...
 
void setCovMatrix (eicd::Cov4f value)
 Set the cvariance matrix of the reconstructed particle 4vector (10 parameters). More...
 
eicd::Cov4fcovMatrix ()
 Get reference to cvariance matrix of the reconstructed particle 4vector (10 parameters). More...
 
void setPDG (std::int32_t value)
 Set the PDG code for this particle. More...
 
void setStartVertex (eicd::Vertex value)
 Set the Start vertex associated to this particle. More...
 
void setParticleIDUsed (edm4hep::ParticleID value)
 Set the particle ID used for the kinematics of this particle. More...
 
void addToClusters (eicd::Cluster)
 
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::ClustergetClusters () const
 
void addToTracks (eicd::Track)
 
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::TrackgetTracks () const
 
void addToParticles (eicd::ReconstructedParticle)
 
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::ReconstructedParticlegetParticles () const
 
void addToParticleIDs (edm4hep::ParticleID)
 
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 MutableReconstructedParticle &other) const
 
bool operator== (const ReconstructedParticle &other) const
 
bool operator< (const MutableReconstructedParticle &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

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

Detailed Description

EIC Reconstructed Particle

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

Constructor & Destructor Documentation

◆ MutableReconstructedParticle() [1/4]

eicd::MutableReconstructedParticle::MutableReconstructedParticle ( )

default constructor

◆ MutableReconstructedParticle() [2/4]

eicd::MutableReconstructedParticle::MutableReconstructedParticle ( 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 
)

◆ MutableReconstructedParticle() [3/4]

eicd::MutableReconstructedParticle::MutableReconstructedParticle ( ReconstructedParticleObj obj)

constructor from existing ReconstructedParticleObj

◆ MutableReconstructedParticle() [4/4]

eicd::MutableReconstructedParticle::MutableReconstructedParticle ( const MutableReconstructedParticle other)

copy constructor

◆ ~MutableReconstructedParticle()

eicd::MutableReconstructedParticle::~MutableReconstructedParticle ( )

destructor

Member Function Documentation

◆ addToClusters()

void eicd::MutableReconstructedParticle::addToClusters ( eicd::Cluster  component)

◆ addToParticleIDs()

void eicd::MutableReconstructedParticle::addToParticleIDs ( edm4hep::ParticleID  component)

◆ addToParticles()

void eicd::MutableReconstructedParticle::addToParticles ( eicd::ReconstructedParticle  component)

◆ addToTracks()

void eicd::MutableReconstructedParticle::addToTracks ( eicd::Track  component)

◆ clone()

MutableReconstructedParticle eicd::MutableReconstructedParticle::clone ( ) const

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

◆ clusters_begin()

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

◆ clusters_end()

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

◆ clusters_size()

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

◆ covMatrix()

eicd::Cov4f & eicd::MutableReconstructedParticle::covMatrix ( )

Get reference to cvariance matrix of the reconstructed particle 4vector (10 parameters).

◆ getCharge()

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

Access the charge of the reconstructed particle.

◆ getClusters() [1/2]

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

◆ getClusters() [2/2]

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

◆ getCovMatrix()

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

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

◆ getEnergy()

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

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

◆ getGoodnessOfPID()

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

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

◆ getMass()

const float & eicd::MutableReconstructedParticle::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::MutableReconstructedParticle::getMomentum ( ) const

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

◆ getObjectID()

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

◆ getParticleIDs() [1/2]

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

◆ getParticleIDs() [2/2]

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

◆ getParticleIDUsed()

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

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

◆ getParticles() [1/2]

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

◆ getParticles() [2/2]

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

◆ getPDG()

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

Access the PDG code for this particle.

◆ getReferencePoint()

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

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

◆ getStartVertex()

const eicd::Vertex eicd::MutableReconstructedParticle::getStartVertex ( ) const

Access the Start vertex associated to this particle.

◆ getTracks() [1/2]

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

◆ getTracks() [2/2]

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

◆ getType()

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

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

◆ id()

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

◆ isAvailable()

bool eicd::MutableReconstructedParticle::isAvailable ( ) const

check whether the object is actually available

◆ isCompound()

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

◆ momentum()

edm4hep::Vector3f & eicd::MutableReconstructedParticle::momentum ( )

Get reference to [GeV] particle momentum. Four momentum state is not kept consistent internally.

◆ operator ReconstructedParticle()

eicd::MutableReconstructedParticle::operator ReconstructedParticle ( ) const

conversion to const object

◆ operator<()

bool eicd::MutableReconstructedParticle::operator< ( const MutableReconstructedParticle other) const
inline

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

bool eicd::MutableReconstructedParticle::operator== ( const MutableReconstructedParticle other) const
inline

◆ operator==() [2/2]

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

◆ particleIDs_begin()

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

◆ particleIDs_end()

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

◆ particleIDs_size()

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

◆ particles_begin()

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

◆ particles_end()

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

◆ particles_size()

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

◆ referencePoint()

edm4hep::Vector3f & eicd::MutableReconstructedParticle::referencePoint ( )

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

◆ setCharge()

void eicd::MutableReconstructedParticle::setCharge ( float  value)

Set the charge of the reconstructed particle.

◆ setCovMatrix()

void eicd::MutableReconstructedParticle::setCovMatrix ( eicd::Cov4f  value)

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

◆ setEnergy()

void eicd::MutableReconstructedParticle::setEnergy ( float  value)

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

◆ setGoodnessOfPID()

void eicd::MutableReconstructedParticle::setGoodnessOfPID ( float  value)

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

◆ setMass()

void eicd::MutableReconstructedParticle::setMass ( float  value)

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

◆ setMomentum()

void eicd::MutableReconstructedParticle::setMomentum ( edm4hep::Vector3f  value)

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

◆ setParticleIDUsed()

void eicd::MutableReconstructedParticle::setParticleIDUsed ( edm4hep::ParticleID  value)

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

◆ setPDG()

void eicd::MutableReconstructedParticle::setPDG ( std::int32_t  value)

Set the PDG code for this particle.

◆ setReferencePoint()

void eicd::MutableReconstructedParticle::setReferencePoint ( edm4hep::Vector3f  value)

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

◆ setStartVertex()

void eicd::MutableReconstructedParticle::setStartVertex ( eicd::Vertex  value)

Set the Start vertex associated to this particle.

◆ setType()

void eicd::MutableReconstructedParticle::setType ( std::int32_t  value)

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

◆ tracks_begin()

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

◆ tracks_end()

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

◆ tracks_size()

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

◆ unlink()

void eicd::MutableReconstructedParticle::unlink ( )
inline

disconnect from ReconstructedParticleObj instance

Friends And Related Function Documentation

◆ ReconstructedParticle

friend class ReconstructedParticle
friend

◆ ReconstructedParticleCollection

friend class ReconstructedParticleCollection
friend

◆ ReconstructedParticleMutableCollectionIterator

◆ swap

void swap ( MutableReconstructedParticle a,
MutableReconstructedParticle b 
)
friend

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