edm4eic::PMTHit Class Reference

#include <PMTHit.h>

Public Types
using	mutable_type = MutablePMTHit
using	collection_type = PMTHitCollection

Public Member Functions
	PMTHit ()
	default constructor
	PMTHit (const std::uint64_t cellID, const float npe, const float time, const float timeError, const edm4hep::Vector3f &position, const edm4hep::Vector3f &dimension, const std::int32_t sector, const edm4hep::Vector3f &local)
	Constructor initializing all members.
	PMTHit (const PMTHit &other)=default
	copy constructor
PMTHit &	operator= (PMTHit other) &
	copy-assignment operator
PMTHit &	operator= (PMTHit other) &&=delete
MutablePMTHit	clone (bool cloneRelations=true) const
	~PMTHit ()=default
	destructor
	PMTHit (const MutablePMTHit &other)
	converting constructor from mutable object
std::uint64_t	getCellID () const
	Access the The detector specific (geometrical) cell id.
float	getNpe () const
	Access the Estimated number of photo-electrons [#].
float	getTime () const
	Access the Time [ns].
float	getTimeError () const
	Access the Error on the time [ns].
const edm4hep::Vector3f &	getPosition () const
	Access the PMT hit position [mm].
const edm4hep::Vector3f &	getDimension () const
	Access the The dimension information of the pixel [mm].
std::int32_t	getSector () const
	Access the The sector this hit occurred in.
const edm4hep::Vector3f &	getLocal () const
	Access the The local position of the hit in detector coordinates (relative to the sector) [mm].
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from PMTHitObj instance
bool	operator== (const PMTHit &other) const
bool	operator== (const MutablePMTHit &other) const
bool	operator!= (const PMTHit &other) const
bool	operator!= (const MutablePMTHit &other) const
bool	operator< (const PMTHit &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static PMTHit	makeEmpty ()

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

Friends
class	MutablePMTHit
class	PMTHitCollection
class	edm4eic::PMTHitCollectionData
class	PMTHitCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const PMTHit &obj)
void	swap (PMTHit &a, PMTHit &b)

Detailed Description

EIC PMT hit

Author

: S. Joosten, C. Peng

Member Typedef Documentation

collection_type

using edm4eic::PMTHit::collection_type = PMTHitCollection

mutable_type

using edm4eic::PMTHit::mutable_type = MutablePMTHit

Constructor & Destructor Documentation

PMTHit() [1/4]

edm4eic::PMTHit::PMTHit

(

)

default constructor

PMTHit() [2/4]

edm4eic::PMTHit::PMTHit	(	const std::uint64_t	cellID,
		const float	npe,
		const float	time,
		const float	timeError,
		const edm4hep::Vector3f &	position,
		const edm4hep::Vector3f &	dimension,
		const std::int32_t	sector,
		const edm4hep::Vector3f &	local )

Constructor initializing all members.

PMTHit() [3/4]

edm4eic::PMTHit::PMTHit ( const PMTHit & other )

default

copy constructor

~PMTHit()

edm4eic::PMTHit::~PMTHit ( )

default

destructor

PMTHit() [4/4]

edm4eic::PMTHit::PMTHit

(

const MutablePMTHit &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutablePMTHit edm4eic::PMTHit::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

getCellID()

std::uint64_t edm4eic::PMTHit::getCellID

(

)

const

Access the The detector specific (geometrical) cell id.

getDimension()

const edm4hep::Vector3f & edm4eic::PMTHit::getDimension

(

)

const

Access the The dimension information of the pixel [mm].

getLocal()

const edm4hep::Vector3f & edm4eic::PMTHit::getLocal

(

)

const

Access the The local position of the hit in detector coordinates (relative to the sector) [mm].

getNpe()

float edm4eic::PMTHit::getNpe

(

)

const

Access the Estimated number of photo-electrons [#].

getObjectID()

const podio::ObjectID edm4eic::PMTHit::getObjectID

(

)

const

getPosition()

const edm4hep::Vector3f & edm4eic::PMTHit::getPosition

(

)

const

Access the PMT hit position [mm].

getSector()

std::int32_t edm4eic::PMTHit::getSector

(

)

const

Access the The sector this hit occurred in.

getTime()

float edm4eic::PMTHit::getTime

(

)

const

Access the Time [ns].

getTimeError()

float edm4eic::PMTHit::getTimeError

(

)

const

Access the Error on the time [ns].

id()

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

inline

isAvailable()

bool edm4eic::PMTHit::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

PMTHit edm4eic::PMTHit::makeEmpty ( )

static

operator!=() [1/2]

bool edm4eic::PMTHit::operator!= ( const MutablePMTHit & other ) const

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

PMTHit & edm4eic::PMTHit::operator=

(

PMTHit

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

bool edm4eic::PMTHit::operator==

(

const MutablePMTHit &

other

)

const

operator==() [2/2]

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

inline

unlink()

void edm4eic::PMTHit::unlink ( )

inline

disconnect from PMTHitObj instance

Friends And Related Symbol Documentation

edm4eic::PMTHitCollectionData

friend class edm4eic::PMTHitCollectionData

friend

MutablePMTHit

friend class MutablePMTHit

friend

PMTHitCollection

friend class PMTHitCollection

friend

PMTHitCollectionIterator

friend class PMTHitCollectionIterator

friend

podio::detail::getOrderKey

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

friend

swap

void swap ( PMTHit & a, PMTHit & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::PMTHit::typeName = "edm4eic::PMTHit"

staticconstexpr

---

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

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