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

#include <ReconstructedParticleConst.h>

Public Member Functions

 ConstReconstructedParticle ()
 default constructor More...
 
 ConstReconstructedParticle (eic::Index ID, eic::VectorXYZ p, eic::VectorXYZ v, float time, std::int32_t pid, std::int16_t status, std::int16_t charge, eic::Weight weight, eic::Direction direction, float momentum, float energy, float mass)
 
 ConstReconstructedParticle (ReconstructedParticleObj *obj)
 constructor from existing ReconstructedParticleObj More...
 
 ConstReconstructedParticle (const ConstReconstructedParticle &other)
 copy constructor More...
 
ConstReconstructedParticle & operator= (const ConstReconstructedParticle &other)
 copy-assignment operator More...
 
ConstReconstructedParticle clone () const
 support cloning (deep-copy) More...
 
 ~ConstReconstructedParticle ()
 destructor More...
 
const eic::Index & ID () const
 Access the Unique particle index. More...
 
const eic::VectorXYZ & p () const
 Access the momentum vector [GeV]. More...
 
const eic::VectorXYZ & v () const
 Access the vertex [mm]. More...
 
const float & time () const
 Access the Time in [ns]. More...
 
const std::int32_t & pid () const
 Access the PID of reconstructed particle. More...
 
const std::int16_t & status () const
 Access the Status code. More...
 
const std::int16_t & charge () const
 Access the Particle charge (or sign) More...
 
const eic::Weight & weight () const
 Access the Particle weight, e.g. from PID algorithm [0-1]. More...
 
const eic::Direction & direction () const
 Access the Direction (theta/phi of this particle [mrad]) More...
 
const float & momentum () const
 Access the particle 3-momentum magnitude [GeV]. More...
 
const float & energy () const
 Access the Particle energy, consistent with PID assigment [GeV]. More...
 
const float & mass () const
 Access the The mass of the particle in [GeV]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from ReconstructedParticleObj instance More...
 
bool operator== (const ConstReconstructedParticle &other) const
 
bool operator== (const ReconstructedParticle &other) const
 
bool operator< (const ConstReconstructedParticle &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class ReconstructedParticle
 
class ReconstructedParticleCollection
 
class ReconstructedParticleConstCollectionIterator
 

Detailed Description

EIC Reconstructed Particle

Author
: W. Armstrong, S. Joosten

Constructor & Destructor Documentation

◆ ConstReconstructedParticle() [1/4]

eic::ConstReconstructedParticle::ConstReconstructedParticle ( )

default constructor

◆ ConstReconstructedParticle() [2/4]

eic::ConstReconstructedParticle::ConstReconstructedParticle ( eic::Index  ID,
eic::VectorXYZ  p,
eic::VectorXYZ  v,
float  time,
std::int32_t  pid,
std::int16_t  status,
std::int16_t  charge,
eic::Weight  weight,
eic::Direction  direction,
float  momentum,
float  energy,
float  mass 
)

◆ ConstReconstructedParticle() [3/4]

eic::ConstReconstructedParticle::ConstReconstructedParticle ( ReconstructedParticleObj *  obj)

constructor from existing ReconstructedParticleObj

◆ ConstReconstructedParticle() [4/4]

eic::ConstReconstructedParticle::ConstReconstructedParticle ( const ConstReconstructedParticle &  other)

copy constructor

◆ ~ConstReconstructedParticle()

eic::ConstReconstructedParticle::~ConstReconstructedParticle ( )

destructor

Member Function Documentation

◆ charge()

const std::int16_t & eic::ConstReconstructedParticle::charge ( ) const

Access the Particle charge (or sign)

◆ clone()

ConstReconstructedParticle eic::ConstReconstructedParticle::clone ( ) const

support cloning (deep-copy)

◆ direction()

const eic::Direction & eic::ConstReconstructedParticle::direction ( ) const

Access the Direction (theta/phi of this particle [mrad])

◆ energy()

const float & eic::ConstReconstructedParticle::energy ( ) const

Access the Particle energy, consistent with PID assigment [GeV].

◆ getObjectID()

const podio::ObjectID eic::ConstReconstructedParticle::getObjectID ( ) const

◆ ID()

const eic::Index & eic::ConstReconstructedParticle::ID ( ) const

Access the Unique particle index.

◆ id()

unsigned int eic::ConstReconstructedParticle::id ( ) const
inline

◆ isAvailable()

bool eic::ConstReconstructedParticle::isAvailable ( ) const

check whether the object is actually available

◆ mass()

const float & eic::ConstReconstructedParticle::mass ( ) const

Access the The mass of the particle in [GeV].

◆ momentum()

const float & eic::ConstReconstructedParticle::momentum ( ) const

Access the particle 3-momentum magnitude [GeV].

◆ operator<()

bool eic::ConstReconstructedParticle::operator< ( const ConstReconstructedParticle &  other) const
inline

◆ operator=()

ConstReconstructedParticle & eic::ConstReconstructedParticle::operator= ( const ConstReconstructedParticle &  other)

copy-assignment operator

◆ operator==() [1/2]

bool eic::ConstReconstructedParticle::operator== ( const ConstReconstructedParticle &  other) const
inline

◆ operator==() [2/2]

bool eic::ConstReconstructedParticle::operator== ( const ReconstructedParticle &  other) const

◆ p()

const eic::VectorXYZ & eic::ConstReconstructedParticle::p ( ) const

Access the momentum vector [GeV].

◆ pid()

const std::int32_t & eic::ConstReconstructedParticle::pid ( ) const

Access the PID of reconstructed particle.

◆ status()

const std::int16_t & eic::ConstReconstructedParticle::status ( ) const

Access the Status code.

◆ time()

const float & eic::ConstReconstructedParticle::time ( ) const

Access the Time in [ns].

◆ unlink()

void eic::ConstReconstructedParticle::unlink ( )
inline

disconnect from ReconstructedParticleObj instance

◆ v()

const eic::VectorXYZ & eic::ConstReconstructedParticle::v ( ) const

Access the vertex [mm].

◆ weight()

const eic::Weight & eic::ConstReconstructedParticle::weight ( ) const

Access the Particle weight, e.g. from PID algorithm [0-1].

Friends And Related Function Documentation

◆ ReconstructedParticle

friend class ReconstructedParticle
friend

◆ ReconstructedParticleCollection

friend class ReconstructedParticleCollection
friend

◆ ReconstructedParticleConstCollectionIterator

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