EICd
EIC data model
eic::PMTHit Class Reference

#include <PMTHit.h>

Public Member Functions

 PMTHit ()
 default constructor More...
 
 PMTHit (eic::Index ID, std::int64_t cellID, float npe, float time, float timeError, eic::VectorXYZ position, eic::VectorXYZ local, eic::VectorXYZ dimension)
 
 PMTHit (PMTHitObj *obj)
 constructor from existing PMTHitObj More...
 
 PMTHit (const PMTHit &other)
 copy constructor More...
 
PMTHitoperator= (const PMTHit &other)
 copy-assignment operator More...
 
PMTHit clone () const
 support cloning (deep-copy) More...
 
 ~PMTHit ()
 destructor More...
 
 operator ConstPMTHit () const
 conversion to const object More...
 
const eic::IndexID () const
 Access the Unique hit ID. More...
 
const std::int64_t & cellID () const
 Access the The detector specific (geometrical) cell id. More...
 
const float & npe () const
 Access the estimated number of photo-electrons [#]. More...
 
const float & time () const
 Access the Time [ns]. More...
 
const float & timeError () const
 Access the Error on the time [ns]. More...
 
const eic::VectorXYZposition () const
 Access the PMT hit position [mm]. More...
 
const eic::VectorXYZlocal () const
 Access the The local position of the hit in detector coordinates [mm]. More...
 
const eic::VectorXYZdimension () const
 Access the The dimension information of the pixel [mm]. More...
 
void ID (eic::Index value)
 Set the Unique hit ID. More...
 
eic::IndexID ()
 Get reference to Unique hit ID. More...
 
void cellID (std::int64_t value)
 Set the The detector specific (geometrical) cell id. More...
 
void npe (float value)
 Set the estimated number of photo-electrons [#]. More...
 
void time (float value)
 Set the Time [ns]. More...
 
void timeError (float value)
 Set the Error on the time [ns]. More...
 
void position (eic::VectorXYZ value)
 Set the PMT hit position [mm]. More...
 
eic::VectorXYZposition ()
 Get reference to PMT hit position [mm]. More...
 
void local (eic::VectorXYZ value)
 Set the The local position of the hit in detector coordinates [mm]. More...
 
eic::VectorXYZlocal ()
 Get reference to The local position of the hit in detector coordinates [mm]. More...
 
void dimension (eic::VectorXYZ value)
 Set the The dimension information of the pixel [mm]. More...
 
eic::VectorXYZdimension ()
 Get reference to The dimension information of the pixel [mm]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from PMTHitObj instance More...
 
bool operator== (const PMTHit &other) const
 
bool operator== (const ConstPMTHit &other) const
 
bool operator< (const PMTHit &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class PMTHitCollection
 
class PMTHitCollectionIterator
 
class ConstPMTHit
 

Detailed Description

EIC PMT hit

Author
: S. Joosten, C. Peng

Constructor & Destructor Documentation

◆ PMTHit() [1/4]

eic::PMTHit::PMTHit ( )

default constructor

◆ PMTHit() [2/4]

eic::PMTHit::PMTHit ( eic::Index  ID,
std::int64_t  cellID,
float  npe,
float  time,
float  timeError,
eic::VectorXYZ  position,
eic::VectorXYZ  local,
eic::VectorXYZ  dimension 
)

◆ PMTHit() [3/4]

eic::PMTHit::PMTHit ( PMTHitObj obj)

constructor from existing PMTHitObj

◆ PMTHit() [4/4]

eic::PMTHit::PMTHit ( const PMTHit other)

copy constructor

◆ ~PMTHit()

eic::PMTHit::~PMTHit ( )

destructor

Member Function Documentation

◆ cellID() [1/2]

const std::int64_t & eic::PMTHit::cellID ( ) const

Access the The detector specific (geometrical) cell id.

◆ cellID() [2/2]

void eic::PMTHit::cellID ( std::int64_t  value)

Set the The detector specific (geometrical) cell id.

◆ clone()

PMTHit eic::PMTHit::clone ( ) const

support cloning (deep-copy)

◆ dimension() [1/3]

eic::VectorXYZ & eic::PMTHit::dimension ( )

Get reference to The dimension information of the pixel [mm].

◆ dimension() [2/3]

const eic::VectorXYZ & eic::PMTHit::dimension ( ) const

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

◆ dimension() [3/3]

void eic::PMTHit::dimension ( eic::VectorXYZ  value)

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

◆ getObjectID()

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

◆ ID() [1/3]

eic::Index & eic::PMTHit::ID ( )

Get reference to Unique hit ID.

◆ ID() [2/3]

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

Access the Unique hit ID.

◆ id()

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

◆ ID() [3/3]

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

Set the Unique hit ID.

◆ isAvailable()

bool eic::PMTHit::isAvailable ( ) const

check whether the object is actually available

◆ local() [1/3]

eic::VectorXYZ & eic::PMTHit::local ( )

Get reference to The local position of the hit in detector coordinates [mm].

◆ local() [2/3]

const eic::VectorXYZ & eic::PMTHit::local ( ) const

Access the The local position of the hit in detector coordinates [mm].

◆ local() [3/3]

void eic::PMTHit::local ( eic::VectorXYZ  value)

Set the The local position of the hit in detector coordinates [mm].

◆ npe() [1/2]

const float & eic::PMTHit::npe ( ) const

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

◆ npe() [2/2]

void eic::PMTHit::npe ( float  value)

Set the estimated number of photo-electrons [#].

◆ operator ConstPMTHit()

eic::PMTHit::operator ConstPMTHit ( ) const

conversion to const object

◆ operator<()

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

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

bool eic::PMTHit::operator== ( const ConstPMTHit other) const

◆ operator==() [2/2]

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

◆ position() [1/3]

eic::VectorXYZ & eic::PMTHit::position ( )

Get reference to PMT hit position [mm].

◆ position() [2/3]

const eic::VectorXYZ & eic::PMTHit::position ( ) const

Access the PMT hit position [mm].

◆ position() [3/3]

void eic::PMTHit::position ( eic::VectorXYZ  value)

Set the PMT hit position [mm].

◆ time() [1/2]

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

Access the Time [ns].

◆ time() [2/2]

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

Set the Time [ns].

◆ timeError() [1/2]

const float & eic::PMTHit::timeError ( ) const

Access the Error on the time [ns].

◆ timeError() [2/2]

void eic::PMTHit::timeError ( float  value)

Set the Error on the time [ns].

◆ unlink()

void eic::PMTHit::unlink ( )
inline

disconnect from PMTHitObj instance

Friends And Related Function Documentation

◆ ConstPMTHit

friend class ConstPMTHit
friend

◆ PMTHitCollection

friend class PMTHitCollection
friend

◆ PMTHitCollectionIterator

friend class PMTHitCollectionIterator
friend

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