LCIO  "2.7.4"
 All Classes Namespaces Functions Variables Typedefs Friends Pages
Public Types | Public Member Functions | List of all members
EVENT::SimCalorimeterHit Class Referenceabstract

The generic simulated calorimeter hit. More...

#include <pre-generated/EVENT/SimCalorimeterHit.h>

Inheritance diagram for EVENT::SimCalorimeterHit:
EVENT::LCObject lcrtrel::LCRTRelations IMPL::SimCalorimeterHitImpl IOIMPL::SimCalorimeterHitIOImpl

Public Types

typedef SimCalorimeterHit lcobject_type
 Useful typedef for template programming with LCIO.
 

Public Member Functions

virtual ~SimCalorimeterHit ()
 Destructor.
 
virtual int getCellID0 () const =0
 Returns the detector specific (geometrical) cell id.
 
virtual int getCellID1 () const =0
 Returns the second detector specific (geometrical) cell id. More...
 
virtual float getEnergy () const =0
 Returns the energy of the hit in [GeV].
 
virtual const float * getPosition () const =0
 Returns the position of the hit in world coordinates. More...
 
virtual const float * getStepPosition (int i) const =0
 Returns the position where the energy deposited (step) occurred optional, only if bit LCIO::CHBIT_STEP is set.
 
virtual int getNMCParticles () const =0
 Returns the number of MC contributions to the hit. More...
 
virtual int getNMCContributions () const =0
 Returns the number of MC contributions to the hit. More...
 
virtual float getEnergyCont (int i) const =0
 Returns the energy in [GeV] of the i-th contribution to the hit. More...
 
virtual float getTimeCont (int i) const =0
 Returns the time of the i-th in [ns] contribution to the hit. More...
 
virtual int getPDGCont (int i) const =0
 Returns the PDG code of the shower particle that caused this contribution. More...
 
virtual MCParticlegetParticleCont (int i) const =0
 Returns the MCParticle that caused the shower responsible for this contribution to the hit. More...
 
- Public Member Functions inherited from EVENT::LCObject
virtual ~LCObject ()
 Destructor.
 
virtual int id () const =0
 Returns an object id for internal (debugging) use in LCIO.
 
virtual LCObjectclone () const
 Returns an object id for internal (debugging) use in LCIO. More...
 
- Public Member Functions inherited from lcrtrel::LCRTRelations
template<class V >
V::ext_type ext ()
 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,...
 
template<class V >
const V::ext_type ext () const
 
template<class V >
V::rel_type rel ()
 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.
 

Additional Inherited Members

- Protected Member Functions inherited from lcrtrel::LCRTRelations
template<class V >
V::ptr & ptr () const
 Returns the reference to the pointer to the extension/relation object.
 

Detailed Description

The generic simulated calorimeter hit.

Author
gaede
Version
Id:
SimCalorimeterHit.aid,v 1.8 2006-03-24 13:25:52 gaede Exp

Member Function Documentation

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 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 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_STEP==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 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.

Deprecated:
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 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_STEP of the collection whether this information is available.

See Also
getNMCContributions()

Implemented in IMPL::SimCalorimeterHitImpl.

Referenced by 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 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 SIO::SIOSimCalHitHandler::write().


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