EICd
EIC data model
eic::ReconstructedParticle Class Reference

#include <ReconstructedParticle.h>

Public Member Functions

 ReconstructedParticle ()
 default constructor More...
 
 ReconstructedParticle (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)
 
 ReconstructedParticle (ReconstructedParticleObj *obj)
 constructor from existing ReconstructedParticleObj More...
 
 ReconstructedParticle (const ReconstructedParticle &other)
 copy constructor More...
 
ReconstructedParticleoperator= (const ReconstructedParticle &other)
 copy-assignment operator More...
 
ReconstructedParticle clone () const
 support cloning (deep-copy) More...
 
 ~ReconstructedParticle ()
 destructor More...
 
 operator ConstReconstructedParticle () const
 conversion to const object More...
 
const eic::IndexID () const
 Access the Unique particle index. More...
 
const eic::VectorXYZp () const
 Access the momentum vector [GeV]. More...
 
const eic::VectorXYZv () 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::Weightweight () const
 Access the Particle weight, e.g. from PID algorithm [0-1]. More...
 
const eic::Directiondirection () 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...
 
void ID (eic::Index value)
 Set the Unique particle index. More...
 
eic::IndexID ()
 Get reference to Unique particle index. More...
 
void p (eic::VectorXYZ value)
 Set the momentum vector [GeV]. More...
 
eic::VectorXYZp ()
 Get reference to momentum vector [GeV]. More...
 
void v (eic::VectorXYZ value)
 Set the vertex [mm]. More...
 
eic::VectorXYZv ()
 Get reference to vertex [mm]. More...
 
void time (float value)
 Set the Time in [ns]. More...
 
void pid (std::int32_t value)
 Set the PID of reconstructed particle. More...
 
void status (std::int16_t value)
 Set the Status code. More...
 
void charge (std::int16_t value)
 Set the Particle charge (or sign) More...
 
void weight (eic::Weight value)
 Set the Particle weight, e.g. from PID algorithm [0-1]. More...
 
eic::Weightweight ()
 Get reference to Particle weight, e.g. from PID algorithm [0-1]. More...
 
void direction (eic::Direction value)
 Set the Direction (theta/phi of this particle [mrad]) More...
 
eic::Directiondirection ()
 Get reference to Direction (theta/phi of this particle [mrad]) More...
 
void momentum (float value)
 Set the particle 3-momentum magnitude [GeV]. More...
 
void energy (float value)
 Set the Particle energy, consistent with PID assigment [GeV]. More...
 
void mass (float value)
 Set 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 ReconstructedParticle &other) const
 
bool operator== (const ConstReconstructedParticle &other) const
 
bool operator< (const ReconstructedParticle &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class ReconstructedParticleCollection
 
class ReconstructedParticleCollectionIterator
 
class ConstReconstructedParticle
 

Detailed Description

EIC Reconstructed Particle

Author
: W. Armstrong, S. Joosten

Constructor & Destructor Documentation

◆ ReconstructedParticle() [1/4]

eic::ReconstructedParticle::ReconstructedParticle ( )

default constructor

◆ ReconstructedParticle() [2/4]

eic::ReconstructedParticle::ReconstructedParticle ( 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 
)

◆ ReconstructedParticle() [3/4]

eic::ReconstructedParticle::ReconstructedParticle ( ReconstructedParticleObj obj)

constructor from existing ReconstructedParticleObj

◆ ReconstructedParticle() [4/4]

eic::ReconstructedParticle::ReconstructedParticle ( const ReconstructedParticle other)

copy constructor

◆ ~ReconstructedParticle()

eic::ReconstructedParticle::~ReconstructedParticle ( )

destructor

Member Function Documentation

◆ charge() [1/2]

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

Access the Particle charge (or sign)

◆ charge() [2/2]

void eic::ReconstructedParticle::charge ( std::int16_t  value)

Set the Particle charge (or sign)

◆ clone()

ReconstructedParticle eic::ReconstructedParticle::clone ( ) const

support cloning (deep-copy)

◆ direction() [1/3]

eic::Direction & eic::ReconstructedParticle::direction ( )

Get reference to Direction (theta/phi of this particle [mrad])

◆ direction() [2/3]

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

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

◆ direction() [3/3]

void eic::ReconstructedParticle::direction ( eic::Direction  value)

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

◆ energy() [1/2]

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

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

◆ energy() [2/2]

void eic::ReconstructedParticle::energy ( float  value)

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

◆ getObjectID()

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

◆ ID() [1/3]

eic::Index & eic::ReconstructedParticle::ID ( )

Get reference to Unique particle index.

◆ ID() [2/3]

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

Access the Unique particle index.

◆ id()

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

◆ ID() [3/3]

void eic::ReconstructedParticle::ID ( eic::Index  value)

Set the Unique particle index.

◆ isAvailable()

bool eic::ReconstructedParticle::isAvailable ( ) const

check whether the object is actually available

◆ mass() [1/2]

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

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

◆ mass() [2/2]

void eic::ReconstructedParticle::mass ( float  value)

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

◆ momentum() [1/2]

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

Access the particle 3-momentum magnitude [GeV].

◆ momentum() [2/2]

void eic::ReconstructedParticle::momentum ( float  value)

Set the particle 3-momentum magnitude [GeV].

◆ operator ConstReconstructedParticle()

eic::ReconstructedParticle::operator ConstReconstructedParticle ( ) const

conversion to const object

◆ operator<()

bool eic::ReconstructedParticle::operator< ( const ReconstructedParticle other) const
inline

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

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

◆ operator==() [2/2]

bool eic::ReconstructedParticle::operator== ( const ReconstructedParticle other) const
inline

◆ p() [1/3]

eic::VectorXYZ & eic::ReconstructedParticle::p ( )

Get reference to momentum vector [GeV].

◆ p() [2/3]

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

Access the momentum vector [GeV].

◆ p() [3/3]

void eic::ReconstructedParticle::p ( eic::VectorXYZ  value)

Set the momentum vector [GeV].

◆ pid() [1/2]

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

Access the PID of reconstructed particle.

◆ pid() [2/2]

void eic::ReconstructedParticle::pid ( std::int32_t  value)

Set the PID of reconstructed particle.

◆ status() [1/2]

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

Access the Status code.

◆ status() [2/2]

void eic::ReconstructedParticle::status ( std::int16_t  value)

Set the Status code.

◆ time() [1/2]

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

Access the Time in [ns].

◆ time() [2/2]

void eic::ReconstructedParticle::time ( float  value)

Set the Time in [ns].

◆ unlink()

void eic::ReconstructedParticle::unlink ( )
inline

disconnect from ReconstructedParticleObj instance

◆ v() [1/3]

eic::VectorXYZ & eic::ReconstructedParticle::v ( )

Get reference to vertex [mm].

◆ v() [2/3]

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

Access the vertex [mm].

◆ v() [3/3]

void eic::ReconstructedParticle::v ( eic::VectorXYZ  value)

Set the vertex [mm].

◆ weight() [1/3]

eic::Weight & eic::ReconstructedParticle::weight ( )

Get reference to Particle weight, e.g. from PID algorithm [0-1].

◆ weight() [2/3]

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

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

◆ weight() [3/3]

void eic::ReconstructedParticle::weight ( eic::Weight  value)

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

Friends And Related Function Documentation

◆ ConstReconstructedParticle

friend class ConstReconstructedParticle
friend

◆ ReconstructedParticleCollection

friend class ReconstructedParticleCollection
friend

◆ ReconstructedParticleCollectionIterator


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