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

#include <MutableCherenkovParticleID.h>

Public Types

using object_type = CherenkovParticleID
 
using collection_type = CherenkovParticleIDCollection
 

Public Member Functions

 MutableCherenkovParticleID ()
 default constructor
 
 MutableCherenkovParticleID (const float npe, const float refractiveIndex, const float photonEnergy)
 Constructor initializing all members.
 
 MutableCherenkovParticleID (const MutableCherenkovParticleID &other)=default
 copy constructor
 
MutableCherenkovParticleID & operator= (MutableCherenkovParticleID other) &
 copy-assignment operator
 
MutableCherenkovParticleID & operator= (MutableCherenkovParticleID other) &&=delete
 
MutableCherenkovParticleID clone (bool cloneRelations=true) const
 
 ~MutableCherenkovParticleID ()=default
 destructor
 
float getNpe () const
 Access the Overall photoelectron count.
 
float getRefractiveIndex () const
 Access the Average refractive index at the Cherenkov photons' vertices.
 
float getPhotonEnergy () const
 Access the Average energy for these Cherenkov photons [GeV].
 
const edm4eic::TrackSegment getChargedParticle () const
 Access the reconstructed charged particle.
 
void setNpe (const float npe)
 Set the Overall photoelectron count.
 
float & getNpe ()
 Get mutable reference to Overall photoelectron count.
 
float & npe ()
 Get reference to Overall photoelectron count.
 
void setRefractiveIndex (const float refractiveIndex)
 Set the Average refractive index at the Cherenkov photons' vertices.
 
float & getRefractiveIndex ()
 Get mutable reference to Average refractive index at the Cherenkov photons' vertices.
 
float & refractiveIndex ()
 Get reference to Average refractive index at the Cherenkov photons' vertices.
 
void setPhotonEnergy (const float photonEnergy)
 Set the Average energy for these Cherenkov photons [GeV].
 
float & getPhotonEnergy ()
 Get mutable reference to Average energy for these Cherenkov photons [GeV].
 
float & photonEnergy ()
 Get reference to Average energy for these Cherenkov photons [GeV].
 
void setChargedParticle (const edm4eic::TrackSegment &value)
 Set the reconstructed charged particle.
 
void addToRawHitAssociations (const edm4eic::MCRecoTrackerHitAssociation &)
 
std::size_t rawHitAssociations_size () const
 
edm4eic::MCRecoTrackerHitAssociation getRawHitAssociations (std::size_t) const
 
std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator rawHitAssociations_begin () const
 
std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator rawHitAssociations_end () const
 
podio::RelationRange< edm4eic::MCRecoTrackerHitAssociation > getRawHitAssociations () const
 
void addToHypotheses (const edm4eic::CherenkovParticleIDHypothesis &)
 
std::size_t hypotheses_size () const
 
edm4eic::CherenkovParticleIDHypothesis getHypotheses (std::size_t) const
 
std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator hypotheses_begin () const
 
std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator hypotheses_end () const
 
podio::RelationRange< edm4eic::CherenkovParticleIDHypothesis > getHypotheses () const
 
void addToThetaPhiPhotons (const edm4hep::Vector2f &)
 
std::size_t thetaPhiPhotons_size () const
 
edm4hep::Vector2f getThetaPhiPhotons (std::size_t) const
 
std::vector< edm4hep::Vector2f >::const_iterator thetaPhiPhotons_begin () const
 
std::vector< edm4hep::Vector2f >::const_iterator thetaPhiPhotons_end () const
 
podio::RelationRange< edm4hep::Vector2f > getThetaPhiPhotons () const
 
bool isAvailable () const
 check whether the object is actually available
 
void unlink ()
 disconnect from CherenkovParticleIDObj instance
 
bool operator== (const MutableCherenkovParticleID &other) const
 
bool operator== (const CherenkovParticleID &other) const
 
bool operator!= (const MutableCherenkovParticleID &other) const
 
bool operator!= (const CherenkovParticleID &other) const
 
bool operator< (const MutableCherenkovParticleID &other) const
 
podio::ObjectID id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class CherenkovParticleIDCollection
 
class CherenkovParticleIDMutableCollectionIterator
 
class CherenkovParticleID
 
void swap (MutableCherenkovParticleID &a, MutableCherenkovParticleID &b)
 

Detailed Description

Cherenkov detector PID

Author
: A. Kiselev, C. Chatterjee, C. Dilks

Member Typedef Documentation

◆ collection_type

using edm4eic::MutableCherenkovParticleID::collection_type = CherenkovParticleIDCollection

◆ object_type

using edm4eic::MutableCherenkovParticleID::object_type = CherenkovParticleID

Constructor & Destructor Documentation

◆ MutableCherenkovParticleID() [1/3]

edm4eic::MutableCherenkovParticleID::MutableCherenkovParticleID ( )

default constructor

◆ MutableCherenkovParticleID() [2/3]

edm4eic::MutableCherenkovParticleID::MutableCherenkovParticleID ( const float npe,
const float refractiveIndex,
const float photonEnergy )

Constructor initializing all members.

◆ MutableCherenkovParticleID() [3/3]

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

copy constructor

◆ ~MutableCherenkovParticleID()

edm4eic::MutableCherenkovParticleID::~MutableCherenkovParticleID ( )
default

destructor

Member Function Documentation

◆ addToHypotheses()

void edm4eic::MutableCherenkovParticleID::addToHypotheses ( const edm4eic::CherenkovParticleIDHypothesis & component)

◆ addToRawHitAssociations()

void edm4eic::MutableCherenkovParticleID::addToRawHitAssociations ( const edm4eic::MCRecoTrackerHitAssociation & component)

◆ addToThetaPhiPhotons()

void edm4eic::MutableCherenkovParticleID::addToThetaPhiPhotons ( const edm4hep::Vector2f & component)

◆ clone()

MutableCherenkovParticleID edm4eic::MutableCherenkovParticleID::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

◆ getChargedParticle()

const edm4eic::TrackSegment edm4eic::MutableCherenkovParticleID::getChargedParticle ( ) const

Access the reconstructed charged particle.

◆ getHypotheses() [1/2]

podio::RelationRange< edm4eic::CherenkovParticleIDHypothesis > edm4eic::MutableCherenkovParticleID::getHypotheses ( ) const

◆ getHypotheses() [2/2]

edm4eic::CherenkovParticleIDHypothesis edm4eic::MutableCherenkovParticleID::getHypotheses ( std::size_t index) const

◆ getNpe() [1/2]

float & edm4eic::MutableCherenkovParticleID::getNpe ( )

Get mutable reference to Overall photoelectron count.

◆ getNpe() [2/2]

float edm4eic::MutableCherenkovParticleID::getNpe ( ) const

Access the Overall photoelectron count.

◆ getObjectID()

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

◆ getPhotonEnergy() [1/2]

float & edm4eic::MutableCherenkovParticleID::getPhotonEnergy ( )

Get mutable reference to Average energy for these Cherenkov photons [GeV].

◆ getPhotonEnergy() [2/2]

float edm4eic::MutableCherenkovParticleID::getPhotonEnergy ( ) const

Access the Average energy for these Cherenkov photons [GeV].

◆ getRawHitAssociations() [1/2]

podio::RelationRange< edm4eic::MCRecoTrackerHitAssociation > edm4eic::MutableCherenkovParticleID::getRawHitAssociations ( ) const

◆ getRawHitAssociations() [2/2]

edm4eic::MCRecoTrackerHitAssociation edm4eic::MutableCherenkovParticleID::getRawHitAssociations ( std::size_t index) const

◆ getRefractiveIndex() [1/2]

float & edm4eic::MutableCherenkovParticleID::getRefractiveIndex ( )

Get mutable reference to Average refractive index at the Cherenkov photons' vertices.

◆ getRefractiveIndex() [2/2]

float edm4eic::MutableCherenkovParticleID::getRefractiveIndex ( ) const

Access the Average refractive index at the Cherenkov photons' vertices.

◆ getThetaPhiPhotons() [1/2]

podio::RelationRange< edm4hep::Vector2f > edm4eic::MutableCherenkovParticleID::getThetaPhiPhotons ( ) const

◆ getThetaPhiPhotons() [2/2]

edm4hep::Vector2f edm4eic::MutableCherenkovParticleID::getThetaPhiPhotons ( std::size_t index) const

◆ hypotheses_begin()

std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator edm4eic::MutableCherenkovParticleID::hypotheses_begin ( ) const

◆ hypotheses_end()

std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator edm4eic::MutableCherenkovParticleID::hypotheses_end ( ) const

◆ hypotheses_size()

std::size_t edm4eic::MutableCherenkovParticleID::hypotheses_size ( ) const

◆ id()

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

◆ isAvailable()

bool edm4eic::MutableCherenkovParticleID::isAvailable ( ) const

check whether the object is actually available

◆ npe()

float & edm4eic::MutableCherenkovParticleID::npe ( )

Get reference to Overall photoelectron count.

◆ operator!=() [1/2]

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

◆ operator!=() [2/2]

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

◆ operator<()

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

◆ operator=() [1/2]

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

copy-assignment operator

◆ operator=() [2/2]

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

◆ operator==() [1/2]

bool edm4eic::MutableCherenkovParticleID::operator== ( const CherenkovParticleID & other) const

◆ operator==() [2/2]

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

◆ photonEnergy()

float & edm4eic::MutableCherenkovParticleID::photonEnergy ( )

Get reference to Average energy for these Cherenkov photons [GeV].

◆ rawHitAssociations_begin()

std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator edm4eic::MutableCherenkovParticleID::rawHitAssociations_begin ( ) const

◆ rawHitAssociations_end()

std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator edm4eic::MutableCherenkovParticleID::rawHitAssociations_end ( ) const

◆ rawHitAssociations_size()

std::size_t edm4eic::MutableCherenkovParticleID::rawHitAssociations_size ( ) const

◆ refractiveIndex()

float & edm4eic::MutableCherenkovParticleID::refractiveIndex ( )

Get reference to Average refractive index at the Cherenkov photons' vertices.

◆ setChargedParticle()

void edm4eic::MutableCherenkovParticleID::setChargedParticle ( const edm4eic::TrackSegment & value)

Set the reconstructed charged particle.

◆ setNpe()

void edm4eic::MutableCherenkovParticleID::setNpe ( const float npe)

Set the Overall photoelectron count.

◆ setPhotonEnergy()

void edm4eic::MutableCherenkovParticleID::setPhotonEnergy ( const float photonEnergy)

Set the Average energy for these Cherenkov photons [GeV].

◆ setRefractiveIndex()

void edm4eic::MutableCherenkovParticleID::setRefractiveIndex ( const float refractiveIndex)

Set the Average refractive index at the Cherenkov photons' vertices.

◆ thetaPhiPhotons_begin()

std::vector< edm4hep::Vector2f >::const_iterator edm4eic::MutableCherenkovParticleID::thetaPhiPhotons_begin ( ) const

◆ thetaPhiPhotons_end()

std::vector< edm4hep::Vector2f >::const_iterator edm4eic::MutableCherenkovParticleID::thetaPhiPhotons_end ( ) const

◆ thetaPhiPhotons_size()

std::size_t edm4eic::MutableCherenkovParticleID::thetaPhiPhotons_size ( ) const

◆ unlink()

void edm4eic::MutableCherenkovParticleID::unlink ( )
inline

disconnect from CherenkovParticleIDObj instance

Friends And Related Symbol Documentation

◆ CherenkovParticleID

friend class CherenkovParticleID
friend

◆ CherenkovParticleIDCollection

friend class CherenkovParticleIDCollection
friend

◆ CherenkovParticleIDMutableCollectionIterator

friend class CherenkovParticleIDMutableCollectionIterator
friend

◆ swap

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