EDM4eic
EIC data model
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
edm4eic::ReconstructedParticle Class Reference

#include <ReconstructedParticle.h>

Public Types

using mutable_type = MutableReconstructedParticle
 
using collection_type = ReconstructedParticleCollection
 

Public Member Functions

 ReconstructedParticle ()
 default constructor
 
 ReconstructedParticle (const std::int32_t type, const float energy, const edm4hep::Vector3f &momentum, const edm4hep::Vector3f &referencePoint, const float charge, const float mass, const float goodnessOfPID, const edm4eic::Cov4f &covMatrix, const std::int32_t PDG)
 Constructor initializing all members.
 
 ReconstructedParticle (const ReconstructedParticle &other)=default
 copy constructor
 
ReconstructedParticle & operator= (ReconstructedParticle other) &
 copy-assignment operator
 
ReconstructedParticle & operator= (ReconstructedParticle other) &&=delete
 
MutableReconstructedParticle clone (bool cloneRelations=true) const
 
 ~ReconstructedParticle ()=default
 destructor
 
 ReconstructedParticle (const MutableReconstructedParticle &other)
 converting constructor from mutable object
 
std::int32_t getType () const
 Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
 
float getEnergy () const
 Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
 
const edm4hep::Vector3f & getMomentum () const
 Access the [GeV] particle momentum. Four momentum state is not kept consistent internally.
 
const edm4hep::Vector3f & getReferencePoint () const
 Access the [mm] reference, i.e. where the particle has been measured.
 
float getCharge () const
 Access the charge of the reconstructed particle.
 
float getMass () const
 Access the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
 
float getGoodnessOfPID () const
 Access the overall goodness of the PID on a scale of [0;1].
 
const edm4eic::Cov4f & getCovMatrix () const
 Access the covariance matrix of the reconstructed particle 4vector (10 parameters).
 
std::int32_t getPDG () const
 Access the PDG code for this particle.
 
const edm4eic::Vertex getStartVertex () const
 Access the Start vertex associated to this particle.
 
const edm4hep::ParticleID getParticleIDUsed () const
 Access the particle ID used for the kinematics of this particle.
 
std::size_t clusters_size () const
 
edm4eic::Cluster getClusters (std::size_t) const
 
std::vector< edm4eic::Cluster >::const_iterator clusters_begin () const
 
std::vector< edm4eic::Cluster >::const_iterator clusters_end () const
 
podio::RelationRange< edm4eic::Cluster > getClusters () const
 
std::size_t tracks_size () const
 
edm4eic::Track getTracks (std::size_t) const
 
std::vector< edm4eic::Track >::const_iterator tracks_begin () const
 
std::vector< edm4eic::Track >::const_iterator tracks_end () const
 
podio::RelationRange< edm4eic::Track > getTracks () const
 
std::size_t particles_size () const
 
edm4eic::ReconstructedParticle getParticles (std::size_t) const
 
std::vector< edm4eic::ReconstructedParticle >::const_iterator particles_begin () const
 
std::vector< edm4eic::ReconstructedParticle >::const_iterator particles_end () const
 
podio::RelationRange< edm4eic::ReconstructedParticle > getParticles () const
 
std::size_t particleIDs_size () const
 
edm4hep::ParticleID getParticleIDs (std::size_t) 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
 
void unlink ()
 disconnect from ReconstructedParticleObj instance
 
bool operator== (const ReconstructedParticle &other) const
 
bool operator== (const MutableReconstructedParticle &other) const
 
bool operator!= (const ReconstructedParticle &other) const
 
bool operator!= (const MutableReconstructedParticle &other) const
 
bool operator< (const ReconstructedParticle &other) const
 
podio::ObjectID id () const
 
const podio::ObjectID getObjectID () const
 

Static Public Member Functions

static ReconstructedParticle makeEmpty ()
 

Static Public Attributes

static constexpr std::string_view typeName = "edm4eic::ReconstructedParticle"
 

Friends

class MutableReconstructedParticle
 
class ReconstructedParticleCollection
 
class edm4eic::ReconstructedParticleCollectionData
 
class ReconstructedParticleCollectionIterator
 
podio::detail::OrderKey podio::detail::getOrderKey (const ReconstructedParticle &obj)
 
void swap (ReconstructedParticle &a, ReconstructedParticle &b)
 

Detailed Description

EIC Reconstructed Particle

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

Member Typedef Documentation

◆ collection_type

using edm4eic::ReconstructedParticle::collection_type = ReconstructedParticleCollection

◆ mutable_type

using edm4eic::ReconstructedParticle::mutable_type = MutableReconstructedParticle

Constructor & Destructor Documentation

◆ ReconstructedParticle() [1/4]

edm4eic::ReconstructedParticle::ReconstructedParticle ( )

default constructor

◆ ReconstructedParticle() [2/4]

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

Constructor initializing all members.

◆ ReconstructedParticle() [3/4]

edm4eic::ReconstructedParticle::ReconstructedParticle ( const ReconstructedParticle & other)
default

copy constructor

◆ ~ReconstructedParticle()

edm4eic::ReconstructedParticle::~ReconstructedParticle ( )
default

destructor

◆ ReconstructedParticle() [4/4]

edm4eic::ReconstructedParticle::ReconstructedParticle ( const MutableReconstructedParticle & other)

converting constructor from mutable object

Member Function Documentation

◆ clone()

MutableReconstructedParticle edm4eic::ReconstructedParticle::clone ( bool cloneRelations = true) const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

◆ clusters_begin()

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

◆ clusters_end()

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

◆ clusters_size()

std::size_t edm4eic::ReconstructedParticle::clusters_size ( ) const

◆ getCharge()

float edm4eic::ReconstructedParticle::getCharge ( ) const

Access the charge of the reconstructed particle.

◆ getClusters() [1/2]

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

◆ getClusters() [2/2]

edm4eic::Cluster edm4eic::ReconstructedParticle::getClusters ( std::size_t index) const

◆ getCovMatrix()

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

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

◆ getEnergy()

float edm4eic::ReconstructedParticle::getEnergy ( ) const

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

◆ getGoodnessOfPID()

float edm4eic::ReconstructedParticle::getGoodnessOfPID ( ) const

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

◆ getMass()

float edm4eic::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 & edm4eic::ReconstructedParticle::getMomentum ( ) const

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

◆ getObjectID()

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

◆ getParticleIDs() [1/2]

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

◆ getParticleIDs() [2/2]

edm4hep::ParticleID edm4eic::ReconstructedParticle::getParticleIDs ( std::size_t index) const

◆ getParticleIDUsed()

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

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

◆ getParticles() [1/2]

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

◆ getParticles() [2/2]

edm4eic::ReconstructedParticle edm4eic::ReconstructedParticle::getParticles ( std::size_t index) const

◆ getPDG()

std::int32_t edm4eic::ReconstructedParticle::getPDG ( ) const

Access the PDG code for this particle.

◆ getReferencePoint()

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

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

◆ getStartVertex()

const edm4eic::Vertex edm4eic::ReconstructedParticle::getStartVertex ( ) const

Access the Start vertex associated to this particle.

◆ getTracks() [1/2]

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

◆ getTracks() [2/2]

edm4eic::Track edm4eic::ReconstructedParticle::getTracks ( std::size_t index) const

◆ getType()

std::int32_t edm4eic::ReconstructedParticle::getType ( ) const

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

◆ id()

podio::ObjectID edm4eic::ReconstructedParticle::id ( ) const
inline

◆ isAvailable()

bool edm4eic::ReconstructedParticle::isAvailable ( ) const

check whether the object is actually available

◆ isCompound()

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

◆ makeEmpty()

ReconstructedParticle edm4eic::ReconstructedParticle::makeEmpty ( )
static

◆ operator!=() [1/2]

bool edm4eic::ReconstructedParticle::operator!= ( const MutableReconstructedParticle & other) const
inline

◆ operator!=() [2/2]

bool edm4eic::ReconstructedParticle::operator!= ( const ReconstructedParticle & other) const
inline

◆ operator<()

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

◆ operator=() [1/2]

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

copy-assignment operator

◆ operator=() [2/2]

ReconstructedParticle & edm4eic::ReconstructedParticle::operator= ( ReconstructedParticle other) &&
delete

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ particleIDs_begin()

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

◆ particleIDs_end()

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

◆ particleIDs_size()

std::size_t edm4eic::ReconstructedParticle::particleIDs_size ( ) const

◆ particles_begin()

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

◆ particles_end()

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

◆ particles_size()

std::size_t edm4eic::ReconstructedParticle::particles_size ( ) const

◆ tracks_begin()

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

◆ tracks_end()

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

◆ tracks_size()

std::size_t edm4eic::ReconstructedParticle::tracks_size ( ) const

◆ unlink()

void edm4eic::ReconstructedParticle::unlink ( )
inline

disconnect from ReconstructedParticleObj instance

Friends And Related Symbol Documentation

◆ edm4eic::ReconstructedParticleCollectionData

friend class edm4eic::ReconstructedParticleCollectionData
friend

◆ MutableReconstructedParticle

friend class MutableReconstructedParticle
friend

◆ podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const ReconstructedParticle & obj)
friend

◆ ReconstructedParticleCollection

friend class ReconstructedParticleCollection
friend

◆ ReconstructedParticleCollectionIterator

friend class ReconstructedParticleCollectionIterator
friend

◆ swap

void swap ( ReconstructedParticle & a,
ReconstructedParticle & b )
friend

Member Data Documentation

◆ typeName

std::string_view edm4eic::ReconstructedParticle::typeName = "edm4eic::ReconstructedParticle"
staticconstexpr
The documentation for this class was generated from the following files: