EVENT::SimCalorimeterHit Class Reference

#include <SimCalorimeterHit.h>

Inheritance diagram for EVENT::SimCalorimeterHit:

List of all members.

Public Types
typedef SimCalorimeterHit	lcobject_type
Public Member Functions
virtual	~SimCalorimeterHit ()
	Destructor.
virtual int	getCellID0 () const =0
virtual int	getCellID1 () const =0
virtual float	getEnergy () const =0
virtual const float *	getPosition () const =0
virtual int	getNMCParticles () const =0
virtual int	getNMCContributions () const =0
virtual float	getEnergyCont (int i) const =0
virtual float	getTimeCont (int i) const =0
virtual int	getPDGCont (int i) const =0
virtual MCParticle *	getParticleCont (int i) const =0
virtual int	id () const =0
virtual LCObject *	clone () const
template<class V>
V::ext_type	ext ()
template<class V>
V::rel_type	rel ()
Protected Member Functions
template<class V>
V::ptr &	ptr ()

---

Detailed Description

The generic simulated calorimeter hit.

Author:

gaede

Version:

Id

SimCalorimeterHit.aid,v 1.8 2006/03/24 13:25:52 gaede Exp

Definition at line 23 of file SimCalorimeterHit.h.

---

Member Typedef Documentation

typedef SimCalorimeterHit EVENT::SimCalorimeterHit::lcobject_type

Useful typedef for template programming with LCIO Definition at line 31 of file SimCalorimeterHit.h.

---

Constructor & Destructor Documentation

virtual EVENT::SimCalorimeterHit::~SimCalorimeterHit (   )  [inline, virtual]

Destructor. Definition at line 27 of file SimCalorimeterHit.h.

---

Member Function Documentation

virtual LCObject* EVENT::LCObject::clone (   )  const [inline, virtual, inherited]

Deep copy of the object. C++ implementations should return the concrete type (virtual constructor). No reasonable implementation yet. Do not use this method. Reimplemented in IMPL::SimCalorimeterHitImpl. Definition at line 52 of file LCObject.h.

template<class V> V::ext_type lcrtrel::LCRTRelations::ext (   )  [inline, inherited]

Provides access to an extension object - the type and ownership is defined by the class V which should be a subtype of LCExtension, LCOwnedExtension, LCExtensionVector, LCExtensionList,... Definition at line 430 of file LCRTRelations.h.

virtual int EVENT::SimCalorimeterHit::getCellID0 (   )  const [pure virtual]

Returns the detector specific (geometrical) cell id. Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual int EVENT::SimCalorimeterHit::getCellID1 (   )  const [pure virtual]

Returns the second detector specific (geometrical) cell id. 0 if information is not stored - check the flag word (bit CHBIT_ID1) of the collection. Default is to store only cellid0. Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual float EVENT::SimCalorimeterHit::getEnergy (   )  const [pure virtual]

Returns the energy of the hit in [GeV]. Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual float EVENT::SimCalorimeterHit::getEnergyCont (  int  i  )  const [pure virtual]

Returns the energy in [GeV] of the i-th contribution to the hit. See also: getNMCContributions() Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual int EVENT::SimCalorimeterHit::getNMCContributions (   )  const [pure virtual]

Returns the number of MC contributions to the hit. 0 if information is not stored. There are two levels of detail: if collection flag bit LCIO.CHBIT_PDG==1 then all simulator steps' contributions to the hit are stored, otherwise there is only one contribution for every particle entering the calorimeter. Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual int EVENT::SimCalorimeterHit::getNMCParticles (   )  const [pure virtual]

Returns the number of MC contributions to the hit. 0 if information is not stored. Renamed to getNMCContributions. See also: getNMCContributions() Implemented in IMPL::SimCalorimeterHitImpl.

virtual MCParticle* EVENT::SimCalorimeterHit::getParticleCont (  int  i  )  const [pure virtual]

Returns the MCParticle that caused the shower responsible for this contribution to the hit. This is the particle that flew into the calorimeter and not the shower particle that made the energy deposition. See also: getNMCContributions() Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual int EVENT::SimCalorimeterHit::getPDGCont (  int  i  )  const [pure virtual]

Returns the PDG code of the shower particle that caused this contribution. Check the flag word bit LCIO.CHBIT_PDG of the collection whether this information is available. See also: getNMCContributions() Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual const float* EVENT::SimCalorimeterHit::getPosition (   )  const [pure virtual]

Returns the position of the hit in world coordinates. NULL if information is not stored - check the flag word (bit CHBIT_LONG) of the collection. Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual float EVENT::SimCalorimeterHit::getTimeCont (  int  i  )  const [pure virtual]

Returns the time of the i-th in [ns] contribution to the hit. See also: getNMCContributions() Implemented in IMPL::SimCalorimeterHitImpl. Referenced by UTIL::LCTOOLS::printSimCalorimeterHits(), and SIO::SIOSimCalHitHandler::write().

virtual int EVENT::LCObject::id (   )  const [pure virtual, inherited]

Returns an object id for internal (debugging) use in LCIO. Implemented in tpc_tracking::CustomLCIOObject, EVENT::LCFloatVec, EVENT::LCGenericObject, EVENT::LCIntVec, EVENT::LCStrVec, IMPL::CalorimeterHitImpl, IMPL::ClusterImpl, IMPL::LCGenericObjectImpl, IMPL::LCRelationImpl, IMPL::LCRunHeaderImpl, IMPL::MCParticleImpl, IMPL::ParticleIDImpl, IMPL::RawCalorimeterHitImpl, IMPL::ReconstructedParticleImpl, IMPL::SimCalorimeterHitImpl, IMPL::SimTrackerHitImpl, IMPL::TPCHitImpl, IMPL::TrackerDataImpl, IMPL::TrackerHitImpl, IMPL::TrackerPulseImpl, IMPL::TrackerRawDataImpl, IMPL::TrackImpl, IMPL::VertexImpl, and tpc_tracking::CustomLCIOObject. Referenced by UTIL::operator<<(), UTIL::LCTOOLS::printCalorimeterHits(), UTIL::LCTOOLS::printClusters(), UTIL::LCTOOLS::printMCParticles(), UTIL::LCTOOLS::printRawCalorimeterHits(), UTIL::LCTOOLS::printReconstructedParticles(), UTIL::LCTOOLS::printRelation(), UTIL::LCTOOLS::printSimCalorimeterHits(), UTIL::LCTOOLS::printTPCHits(), UTIL::LCTOOLS::printTrackerData(), UTIL::LCTOOLS::printTrackerHits(), UTIL::LCTOOLS::printTrackerPulse(), UTIL::LCTOOLS::printTrackerRawData(), and UTIL::LCTOOLS::printTracks().

template<class V> V::ptr& lcrtrel::LCRTRelations::ptr (   )  [inline, protected, inherited]

Returns the reference to the pointer to the extension/relation object Definition at line 508 of file LCRTRelations.h.

template<class V> V::rel_type lcrtrel::LCRTRelations::rel (   )  [inline, inherited]

Provides read access to relations - the object types and their connectivity are defined by the class V which has to be a subtype of either LC1To1Relation, LC1ToNRelation or LCNToNRelation. Definition at line 444 of file LCRTRelations.h.

---

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

• include/EVENT/SimCalorimeterHit.h

---