edm4eic::CalorimeterHit Class Reference

#include <CalorimeterHit.h>

Public Types
using	mutable_type = MutableCalorimeterHit
using	collection_type = CalorimeterHitCollection

Public Member Functions
	CalorimeterHit ()=default
	default constructor
	CalorimeterHit (const std::uint64_t cellID, const float energy, const float energyError, const float time, const float timeError, const edm4hep::Vector3f &position, const edm4hep::Vector3f &dimension, const std::int32_t sector, const std::int32_t layer, const edm4hep::Vector3f &local)
	Constructor initializing all members.
	CalorimeterHit (const CalorimeterHit &other)=default
	copy constructor
CalorimeterHit &	operator= (CalorimeterHit other) &
	copy-assignment operator
CalorimeterHit &	operator= (CalorimeterHit other) &&=delete
MutableCalorimeterHit	clone (bool cloneRelations=true) const
	~CalorimeterHit ()=default
	destructor
	CalorimeterHit (const MutableCalorimeterHit &other)
	converting constructor from mutable object
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
constexpr bool	operator== (const CalorimeterHit &other) const
bool	operator== (const MutableCalorimeterHit &other) const
constexpr 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 ()

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

Friends
class	MutableCalorimeterHit
class	CalorimeterHitCollection
class	edm4eic::CalorimeterHitCollectionData
class	CalorimeterHitCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const CalorimeterHit &obj)
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/4]

edm4eic::CalorimeterHit::CalorimeterHit ( )

default

default constructor

CalorimeterHit() [2/4]

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

Constructor initializing all members.

CalorimeterHit() [3/4]

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

default

copy constructor

~CalorimeterHit()

edm4eic::CalorimeterHit::~CalorimeterHit ( )

default

destructor

CalorimeterHit() [4/4]

edm4eic::CalorimeterHit::CalorimeterHit

(

const MutableCalorimeterHit &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableCalorimeterHit edm4eic::CalorimeterHit::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::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!=() [1/2]

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

inlineconstexpr

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

CalorimeterHit & edm4eic::CalorimeterHit::operator=

(

CalorimeterHit

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inlineconstexpr

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

podio::detail::getOrderKey

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

friend

swap

void swap ( CalorimeterHit & a, CalorimeterHit & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::CalorimeterHit::typeName = "edm4eic::CalorimeterHit"

staticconstexpr

---

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

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