EICd
EIC data model
eicd::CalorimeterHit Class Reference

#include <CalorimeterHit.h>

Public Member Functions

 CalorimeterHit ()
 default constructor More...
 
 CalorimeterHit (std::uint64_t cellID, float energy, float energyError, float time, float timeError, edm4hep::Vector3f position, edm4hep::Vector3f dimension, std::int32_t sector, std::int32_t layer, edm4hep::Vector3f local)
 
 CalorimeterHit (CalorimeterHitObj *obj)
 constructor from existing CalorimeterHitObj More...
 
 CalorimeterHit (const CalorimeterHit &other)
 copy constructor More...
 
CalorimeterHitoperator= (CalorimeterHit other)
 copy-assignment operator More...
 
MutableCalorimeterHit clone () const
 create a mutable deep-copy of the object with identical relations More...
 
 ~CalorimeterHit ()
 destructor More...
 
const std::uint64_t & getCellID () const
 Access the The detector specific (geometrical) cell id. More...
 
const float & getEnergy () const
 Access the The energy for this hit in [GeV]. More...
 
const float & getEnergyError () const
 Access the Error on energy [GeV]. More...
 
const float & getTime () const
 Access the The time of the hit in [ns]. More...
 
const float & getTimeError () const
 Access the Error on the time. More...
 
const edm4hep::Vector3f & getPosition () const
 Access the The global position of the hit in world coordinates [mm]. More...
 
const edm4hep::Vector3f & getDimension () const
 Access the The dimension information of the cell [mm]. More...
 
const std::int32_t & getSector () const
 Access the Sector that this hit occured in. More...
 
const std::int32_t & getLayer () const
 Access the Layer that the hit occured in. More...
 
const edm4hep::Vector3f & getLocal () const
 Access the The local coordinates of the hit in the detector segment [mm]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from CalorimeterHitObj instance More...
 
bool operator== (const CalorimeterHit &other) const
 
bool operator== (const MutableCalorimeterHit &other) const
 
bool operator< (const CalorimeterHit &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class MutableCalorimeterHit
 
class CalorimeterHitCollection
 
class CalorimeterHitCollectionIterator
 
void swap (CalorimeterHit &a, CalorimeterHit &b)
 

Detailed Description

Calorimeter hit

Author
: W. Armstrong, S. Joosten

Constructor & Destructor Documentation

◆ CalorimeterHit() [1/4]

eicd::CalorimeterHit::CalorimeterHit ( )

default constructor

◆ CalorimeterHit() [2/4]

eicd::CalorimeterHit::CalorimeterHit ( std::uint64_t  cellID,
float  energy,
float  energyError,
float  time,
float  timeError,
edm4hep::Vector3f  position,
edm4hep::Vector3f  dimension,
std::int32_t  sector,
std::int32_t  layer,
edm4hep::Vector3f  local 
)

◆ CalorimeterHit() [3/4]

eicd::CalorimeterHit::CalorimeterHit ( CalorimeterHitObj obj)

constructor from existing CalorimeterHitObj

◆ CalorimeterHit() [4/4]

eicd::CalorimeterHit::CalorimeterHit ( const CalorimeterHit other)

copy constructor

◆ ~CalorimeterHit()

eicd::CalorimeterHit::~CalorimeterHit ( )

destructor

Member Function Documentation

◆ clone()

MutableCalorimeterHit eicd::CalorimeterHit::clone ( ) const

create a mutable deep-copy of the object with identical relations

◆ getCellID()

const std::uint64_t & eicd::CalorimeterHit::getCellID ( ) const

Access the The detector specific (geometrical) cell id.

◆ getDimension()

const edm4hep::Vector3f & eicd::CalorimeterHit::getDimension ( ) const

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

◆ getEnergy()

const float & eicd::CalorimeterHit::getEnergy ( ) const

Access the The energy for this hit in [GeV].

◆ getEnergyError()

const float & eicd::CalorimeterHit::getEnergyError ( ) const

Access the Error on energy [GeV].

◆ getLayer()

const std::int32_t & eicd::CalorimeterHit::getLayer ( ) const

Access the Layer that the hit occured in.

◆ getLocal()

const edm4hep::Vector3f & eicd::CalorimeterHit::getLocal ( ) const

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

◆ getObjectID()

const podio::ObjectID eicd::CalorimeterHit::getObjectID ( ) const

◆ getPosition()

const edm4hep::Vector3f & eicd::CalorimeterHit::getPosition ( ) const

Access the The global position of the hit in world coordinates [mm].

◆ getSector()

const std::int32_t & eicd::CalorimeterHit::getSector ( ) const

Access the Sector that this hit occured in.

◆ getTime()

const float & eicd::CalorimeterHit::getTime ( ) const

Access the The time of the hit in [ns].

◆ getTimeError()

const float & eicd::CalorimeterHit::getTimeError ( ) const

Access the Error on the time.

◆ id()

unsigned int eicd::CalorimeterHit::id ( ) const
inline

◆ isAvailable()

bool eicd::CalorimeterHit::isAvailable ( ) const

check whether the object is actually available

◆ operator<()

bool eicd::CalorimeterHit::operator< ( const CalorimeterHit other) const
inline

◆ operator=()

CalorimeterHit & eicd::CalorimeterHit::operator= ( CalorimeterHit  other)

copy-assignment operator

◆ operator==() [1/2]

bool eicd::CalorimeterHit::operator== ( const CalorimeterHit other) const
inline

◆ operator==() [2/2]

bool eicd::CalorimeterHit::operator== ( const MutableCalorimeterHit other) const

◆ unlink()

void eicd::CalorimeterHit::unlink ( )
inline

disconnect from CalorimeterHitObj instance

Friends And Related Function Documentation

◆ CalorimeterHitCollection

friend class CalorimeterHitCollection
friend

◆ CalorimeterHitCollectionIterator

friend class CalorimeterHitCollectionIterator
friend

◆ MutableCalorimeterHit

friend class MutableCalorimeterHit
friend

◆ swap

void swap ( CalorimeterHit a,
CalorimeterHit b 
)
friend

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