EICd
EIC data model
eic::CalorimeterHit Class Reference

#include <CalorimeterHit.h>

Public Member Functions

 CalorimeterHit ()
 default constructor More...
 
 CalorimeterHit (eic::Index ID, std::int64_t cellID, std::int32_t layer, std::int32_t sector, float energy, float energyError, float time, eic::VectorXYZ position, eic::VectorXYZ local, eic::VectorXYZ dimension)
 
 CalorimeterHit (CalorimeterHitObj *obj)
 constructor from existing CalorimeterHitObj More...
 
 CalorimeterHit (const CalorimeterHit &other)
 copy constructor More...
 
CalorimeterHitoperator= (const CalorimeterHit &other)
 copy-assignment operator More...
 
CalorimeterHit clone () const
 support cloning (deep-copy) More...
 
 ~CalorimeterHit ()
 destructor More...
 
 operator ConstCalorimeterHit () const
 conversion to const object More...
 
const eic::IndexID () const
 Access the unique ID for this hit. More...
 
const std::int64_t & cellID () const
 Access the The detector specific (geometrical) cell id. More...
 
const std::int32_t & layer () const
 Access the layer for this hit. More...
 
const std::int32_t & sector () const
 Access the sector for this hit. More...
 
const float & energy () const
 Access the The energy for this hit in [GeV]. More...
 
const float & energyError () const
 Access the Error on energy [GeV]. More...
 
const float & time () const
 Access the The time of the hit in [ns]. More...
 
const eic::VectorXYZposition () const
 Access the The global position of the hit in world coordinates [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 cell [mm]. More...
 
void ID (eic::Index value)
 Set the unique ID for this hit. More...
 
eic::IndexID ()
 Get reference to unique ID for this hit. More...
 
void cellID (std::int64_t value)
 Set the The detector specific (geometrical) cell id. More...
 
void layer (std::int32_t value)
 Set the layer for this hit. More...
 
void sector (std::int32_t value)
 Set the sector for this hit. More...
 
void energy (float value)
 Set the The energy for this hit in [GeV]. More...
 
void energyError (float value)
 Set the Error on energy [GeV]. More...
 
void time (float value)
 Set the The time of the hit in [ns]. More...
 
void position (eic::VectorXYZ value)
 Set the The global position of the hit in world coordinates [mm]. More...
 
eic::VectorXYZposition ()
 Get reference to The global position of the hit in world coordinates [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 cell [mm]. More...
 
eic::VectorXYZdimension ()
 Get reference to The dimension information of the cell [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 ConstCalorimeterHit &other) const
 
bool operator< (const CalorimeterHit &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class CalorimeterHitCollection
 
class CalorimeterHitCollectionIterator
 
class ConstCalorimeterHit
 

Detailed Description

Calorimeter hit

Author
: W. Armstrong, S. Joosten

Constructor & Destructor Documentation

◆ CalorimeterHit() [1/4]

eic::CalorimeterHit::CalorimeterHit ( )

default constructor

◆ CalorimeterHit() [2/4]

eic::CalorimeterHit::CalorimeterHit ( eic::Index  ID,
std::int64_t  cellID,
std::int32_t  layer,
std::int32_t  sector,
float  energy,
float  energyError,
float  time,
eic::VectorXYZ  position,
eic::VectorXYZ  local,
eic::VectorXYZ  dimension 
)

◆ CalorimeterHit() [3/4]

eic::CalorimeterHit::CalorimeterHit ( CalorimeterHitObj obj)

constructor from existing CalorimeterHitObj

◆ CalorimeterHit() [4/4]

eic::CalorimeterHit::CalorimeterHit ( const CalorimeterHit other)

copy constructor

◆ ~CalorimeterHit()

eic::CalorimeterHit::~CalorimeterHit ( )

destructor

Member Function Documentation

◆ cellID() [1/2]

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

Access the The detector specific (geometrical) cell id.

◆ cellID() [2/2]

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

Set the The detector specific (geometrical) cell id.

◆ clone()

CalorimeterHit eic::CalorimeterHit::clone ( ) const

support cloning (deep-copy)

◆ dimension() [1/3]

eic::VectorXYZ & eic::CalorimeterHit::dimension ( )

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

◆ dimension() [2/3]

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

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

◆ dimension() [3/3]

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

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

◆ energy() [1/2]

const float & eic::CalorimeterHit::energy ( ) const

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

◆ energy() [2/2]

void eic::CalorimeterHit::energy ( float  value)

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

◆ energyError() [1/2]

const float & eic::CalorimeterHit::energyError ( ) const

Access the Error on energy [GeV].

◆ energyError() [2/2]

void eic::CalorimeterHit::energyError ( float  value)

Set the Error on energy [GeV].

◆ getObjectID()

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

◆ ID() [1/3]

eic::Index & eic::CalorimeterHit::ID ( )

Get reference to unique ID for this hit.

◆ ID() [2/3]

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

Access the unique ID for this hit.

◆ id()

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

◆ ID() [3/3]

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

Set the unique ID for this hit.

◆ isAvailable()

bool eic::CalorimeterHit::isAvailable ( ) const

check whether the object is actually available

◆ layer() [1/2]

const std::int32_t & eic::CalorimeterHit::layer ( ) const

Access the layer for this hit.

◆ layer() [2/2]

void eic::CalorimeterHit::layer ( std::int32_t  value)

Set the layer for this hit.

◆ local() [1/3]

eic::VectorXYZ & eic::CalorimeterHit::local ( )

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

◆ local() [2/3]

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

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

◆ local() [3/3]

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

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

◆ operator ConstCalorimeterHit()

eic::CalorimeterHit::operator ConstCalorimeterHit ( ) const

conversion to const object

◆ operator<()

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

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

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

◆ operator==() [2/2]

bool eic::CalorimeterHit::operator== ( const ConstCalorimeterHit other) const

◆ position() [1/3]

eic::VectorXYZ & eic::CalorimeterHit::position ( )

Get reference to The global position of the hit in world coordinates [mm].

◆ position() [2/3]

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

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

◆ position() [3/3]

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

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

◆ sector() [1/2]

const std::int32_t & eic::CalorimeterHit::sector ( ) const

Access the sector for this hit.

◆ sector() [2/2]

void eic::CalorimeterHit::sector ( std::int32_t  value)

Set the sector for this hit.

◆ time() [1/2]

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

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

◆ time() [2/2]

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

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

◆ unlink()

void eic::CalorimeterHit::unlink ( )
inline

disconnect from CalorimeterHitObj instance

Friends And Related Function Documentation

◆ CalorimeterHitCollection

friend class CalorimeterHitCollection
friend

◆ CalorimeterHitCollectionIterator

friend class CalorimeterHitCollectionIterator
friend

◆ ConstCalorimeterHit

friend class ConstCalorimeterHit
friend

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