edm4eic::CalorimeterHit Class Reference

#include <CalorimeterHit.h>

Public Types
using	mutable_type = MutableCalorimeterHit
using	collection_type = CalorimeterHitCollection

Public Member Functions
	CalorimeterHit ()
	default constructor
	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)
	Constructor initializing all members.
	CalorimeterHit (const CalorimeterHit &other)=default
	copy constructor
CalorimeterHit &	operator= (CalorimeterHit other)
	copy-assignment operator
MutableCalorimeterHit	clone () const
	create a mutable deep-copy of the object with identical relations
	~CalorimeterHit ()=default
	destructor
std::uint64_t	getCellID () const
	Access the The detector specific (geometrical) cell id.
float	getEnergy () const
	Access the The energy for this hit in [GeV].
float	getEnergyError () const
	Access the Error on energy [GeV].
float	getTime () const
	Access the The time of the hit in [ns].
float	getTimeError () const
	Access the Error on the time.
const edm4hep::Vector3f &	getPosition () const
	Access the The global position of the hit in world coordinates [mm].
const edm4hep::Vector3f &	getDimension () const
	Access the The dimension information of the cell [mm].
std::int32_t	getSector () const
	Access the Sector that this hit occurred in.
std::int32_t	getLayer () const
	Access the Layer that the hit occurred in.
const edm4hep::Vector3f &	getLocal () const
	Access the The local coordinates of the hit in the detector segment [mm].
const edm4hep::RawCalorimeterHit	getRawHit () const
	Access the Related raw calorimeter hit.
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from CalorimeterHitObj instance
bool	operator== (const CalorimeterHit &other) const
bool	operator== (const MutableCalorimeterHit &other) const
bool	operator< (const CalorimeterHit &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static CalorimeterHit	makeEmpty ()

Friends
class	MutableCalorimeterHit
class	CalorimeterHitCollection
class	edm4eic::CalorimeterHitCollectionData
class	CalorimeterHitCollectionIterator
void	swap (CalorimeterHit &a, CalorimeterHit &b)

Detailed Description

Calorimeter hit

Author

: W. Armstrong, S. Joosten

Member Typedef Documentation

collection_type

using edm4eic::CalorimeterHit::collection_type = CalorimeterHitCollection

mutable_type

using edm4eic::CalorimeterHit::mutable_type = MutableCalorimeterHit

Constructor & Destructor Documentation

CalorimeterHit() [1/3]

edm4eic::CalorimeterHit::CalorimeterHit

(

)

default constructor

CalorimeterHit() [2/3]

edm4eic::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 )

Constructor initializing all members.

CalorimeterHit() [3/3]

edm4eic::CalorimeterHit::CalorimeterHit ( const CalorimeterHit & other )

default

copy constructor

~CalorimeterHit()

edm4eic::CalorimeterHit::~CalorimeterHit ( )

default

destructor

Member Function Documentation

clone()

MutableCalorimeterHit edm4eic::CalorimeterHit::clone

(

)

const

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

getCellID()

std::uint64_t edm4eic::CalorimeterHit::getCellID

(

)

const

Access the The detector specific (geometrical) cell id.

getDimension()

const edm4hep::Vector3f & edm4eic::CalorimeterHit::getDimension

(

)

const

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

getEnergy()

float edm4eic::CalorimeterHit::getEnergy

(

)

const

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

getEnergyError()

float edm4eic::CalorimeterHit::getEnergyError

(

)

const

Access the Error on energy [GeV].

getLayer()

std::int32_t edm4eic::CalorimeterHit::getLayer

(

)

const

Access the Layer that the hit occurred in.

getLocal()

const edm4hep::Vector3f & edm4eic::CalorimeterHit::getLocal

(

)

const

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

getObjectID()

const podio::ObjectID edm4eic::CalorimeterHit::getObjectID

(

)

const

getPosition()

const edm4hep::Vector3f & edm4eic::CalorimeterHit::getPosition

(

)

const

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

getRawHit()

const edm4hep::RawCalorimeterHit edm4eic::CalorimeterHit::getRawHit

(

)

const

Access the Related raw calorimeter hit.

getSector()

std::int32_t edm4eic::CalorimeterHit::getSector

(

)

const

Access the Sector that this hit occurred in.

getTime()

float edm4eic::CalorimeterHit::getTime

(

)

const

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

getTimeError()

float edm4eic::CalorimeterHit::getTimeError

(

)

const

Access the Error on the time.

id()

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

inline

isAvailable()

bool edm4eic::CalorimeterHit::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

CalorimeterHit edm4eic::CalorimeterHit::makeEmpty ( )

static

operator<()

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

inline

operator=()

CalorimeterHit & edm4eic::CalorimeterHit::operator=

(

CalorimeterHit

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::CalorimeterHit::operator==

(

const MutableCalorimeterHit &

other

)

const

unlink()

void edm4eic::CalorimeterHit::unlink ( )

inline

disconnect from CalorimeterHitObj instance

Friends And Related Symbol Documentation

CalorimeterHitCollection

friend class CalorimeterHitCollection

friend

CalorimeterHitCollectionIterator

friend class CalorimeterHitCollectionIterator

friend

edm4eic::CalorimeterHitCollectionData

friend class edm4eic::CalorimeterHitCollectionData

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:

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