edm4eic::CherenkovParticleID Class Reference

#include <CherenkovParticleID.h>

Public Types
using	mutable_type = MutableCherenkovParticleID
using	collection_type = CherenkovParticleIDCollection

Public Member Functions
	CherenkovParticleID ()=default
	default constructor
	CherenkovParticleID (const float npe, const float refractiveIndex, const float photonEnergy)
	Constructor initializing all members.
	CherenkovParticleID (const CherenkovParticleID &other)=default
	copy constructor
CherenkovParticleID &	operator= (CherenkovParticleID other) &
	copy-assignment operator
CherenkovParticleID &	operator= (CherenkovParticleID other) &&=delete
MutableCherenkovParticleID	clone (bool cloneRelations=true) const
	~CherenkovParticleID ()=default
	destructor
	CherenkovParticleID (const MutableCherenkovParticleID &other)
	converting constructor from mutable object
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.
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
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
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 CherenkovParticleID &other) const
bool	operator== (const MutableCherenkovParticleID &other) const
bool	operator!= (const CherenkovParticleID &other) const
bool	operator!= (const MutableCherenkovParticleID &other) const
bool	operator< (const CherenkovParticleID &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static CherenkovParticleID	makeEmpty ()

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::CherenkovParticleID"

Friends
class	MutableCherenkovParticleID
class	CherenkovParticleIDCollection
class	edm4eic::CherenkovParticleIDCollectionData
class	CherenkovParticleIDCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const CherenkovParticleID &obj)
void	swap (CherenkovParticleID &a, CherenkovParticleID &b)

Detailed Description

Cherenkov detector PID

Author

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

Member Typedef Documentation

collection_type

using edm4eic::CherenkovParticleID::collection_type = CherenkovParticleIDCollection

mutable_type

using edm4eic::CherenkovParticleID::mutable_type = MutableCherenkovParticleID

Constructor & Destructor Documentation

CherenkovParticleID() [1/4]

edm4eic::CherenkovParticleID::CherenkovParticleID ( )

default

default constructor

CherenkovParticleID() [2/4]

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

Constructor initializing all members.

CherenkovParticleID() [3/4]

edm4eic::CherenkovParticleID::CherenkovParticleID ( const CherenkovParticleID & other )

default

copy constructor

~CherenkovParticleID()

edm4eic::CherenkovParticleID::~CherenkovParticleID ( )

default

destructor

CherenkovParticleID() [4/4]

edm4eic::CherenkovParticleID::CherenkovParticleID

(

const MutableCherenkovParticleID &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

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

(

)

const

Access the reconstructed charged particle.

getHypotheses() [1/2]

podio::RelationRange< edm4eic::CherenkovParticleIDHypothesis > edm4eic::CherenkovParticleID::getHypotheses

(

)

const

getHypotheses() [2/2]

edm4eic::CherenkovParticleIDHypothesis edm4eic::CherenkovParticleID::getHypotheses

(

std::size_t

index

)

const

getNpe()

float edm4eic::CherenkovParticleID::getNpe

(

)

const

Access the Overall photoelectron count.

getObjectID()

const podio::ObjectID edm4eic::CherenkovParticleID::getObjectID

(

)

const

getPhotonEnergy()

float edm4eic::CherenkovParticleID::getPhotonEnergy

(

)

const

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

getRawHitAssociations() [1/2]

podio::RelationRange< edm4eic::MCRecoTrackerHitAssociation > edm4eic::CherenkovParticleID::getRawHitAssociations

(

)

const

getRawHitAssociations() [2/2]

edm4eic::MCRecoTrackerHitAssociation edm4eic::CherenkovParticleID::getRawHitAssociations

(

std::size_t

index

)

const

getRefractiveIndex()

float edm4eic::CherenkovParticleID::getRefractiveIndex

(

)

const

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

getThetaPhiPhotons() [1/2]

podio::RelationRange< edm4hep::Vector2f > edm4eic::CherenkovParticleID::getThetaPhiPhotons

(

)

const

getThetaPhiPhotons() [2/2]

edm4hep::Vector2f edm4eic::CherenkovParticleID::getThetaPhiPhotons

(

std::size_t

index

)

const

hypotheses_begin()

std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator edm4eic::CherenkovParticleID::hypotheses_begin

(

)

const

hypotheses_end()

std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator edm4eic::CherenkovParticleID::hypotheses_end

(

)

const

hypotheses_size()

std::size_t edm4eic::CherenkovParticleID::hypotheses_size

(

)

const

id()

podio::ObjectID edm4eic::CherenkovParticleID::id ( ) const

inline

isAvailable()

bool edm4eic::CherenkovParticleID::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

CherenkovParticleID edm4eic::CherenkovParticleID::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

bool edm4eic::CherenkovParticleID::operator< ( const CherenkovParticleID & other ) const

inline

operator=() [1/2]

CherenkovParticleID & edm4eic::CherenkovParticleID::operator=

(

CherenkovParticleID

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::CherenkovParticleID::operator==

(

const MutableCherenkovParticleID &

other

)

const

rawHitAssociations_begin()

std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator edm4eic::CherenkovParticleID::rawHitAssociations_begin

(

)

const

rawHitAssociations_end()

std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator edm4eic::CherenkovParticleID::rawHitAssociations_end

(

)

const

rawHitAssociations_size()

std::size_t edm4eic::CherenkovParticleID::rawHitAssociations_size

(

)

const

thetaPhiPhotons_begin()

std::vector< edm4hep::Vector2f >::const_iterator edm4eic::CherenkovParticleID::thetaPhiPhotons_begin

(

)

const

thetaPhiPhotons_end()

std::vector< edm4hep::Vector2f >::const_iterator edm4eic::CherenkovParticleID::thetaPhiPhotons_end

(

)

const

thetaPhiPhotons_size()

std::size_t edm4eic::CherenkovParticleID::thetaPhiPhotons_size

(

)

const

unlink()

void edm4eic::CherenkovParticleID::unlink ( )

inline

disconnect from CherenkovParticleIDObj instance

Friends And Related Symbol Documentation

CherenkovParticleIDCollection

friend class CherenkovParticleIDCollection

friend

CherenkovParticleIDCollectionIterator

friend class CherenkovParticleIDCollectionIterator

friend

edm4eic::CherenkovParticleIDCollectionData

friend class edm4eic::CherenkovParticleIDCollectionData

friend

MutableCherenkovParticleID

friend class MutableCherenkovParticleID

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const CherenkovParticleID & obj )

friend

swap

void swap ( CherenkovParticleID & a, CherenkovParticleID & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::CherenkovParticleID::typeName = "edm4eic::CherenkovParticleID"

staticconstexpr

---

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

• build/edm4eic/CherenkovParticleID.h
• build/src/CherenkovParticleID.cc