LCIO  02.17
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | List of all members
EVENT::CalorimeterHit Class Referenceabstract

The generic calorimeter hit - created from SimCalorimeterHit or RawCalorimeterHit. More...

#include <CalorimeterHit.h>

+ Inheritance diagram for EVENT::CalorimeterHit:

Public Types

typedef CalorimeterHit lcobject_type
 Useful typedef for template programming with LCIO. More...
 
- Public Types inherited from lcrtrel::LCRTRelations
typedef std::type_index ext_index
 
typedef std::shared_ptr< void > ext_type
 
typedef std::map< ext_index,
ext_type
ext_map
 

Public Member Functions

virtual ~CalorimeterHit ()
 Destructor. More...
 
virtual int getCellID0 () const =0
 Returns the detector specific (geometrical) cell id. More...
 
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]. More...
 
virtual float getEnergyError () const =0
 Returns the error of the hit energy in [GeV]. More...
 
virtual float getTime () const =0
 Returns the time of the hit in [ns]. More...
 
virtual const float * getPosition () const =0
 Returns the position of the hit in world coordinates. More...
 
virtual int getType () const =0
 Type of hit. More...
 
virtual LCObjectgetRawHit () const =0
 The RawCalorimeterHit. More...
 
- Public Member Functions inherited from EVENT::LCObject
virtual ~LCObject ()
 Destructor. More...
 
virtual int id () const =0
 Returns an object id for internal (debugging) use in LCIO. More...
 
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,... More...
 
template<class V >
const V::ext_type ext () const
 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,... More...
 
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. More...
 

Detailed Description

The generic calorimeter hit - created from SimCalorimeterHit or RawCalorimeterHit.

The difference to RawCalorimeterHit is that amplitude ( energy) and time are now float and an optional position (x,y,z) can be stored with the hit. In order to suppress a (32-bit) pointer tag stored with every hit set flag(LCIO::RCHBIT_NO_PTR)==1.

Author
gaede
Version
Id:
CalorimeterHit.aid,v 1.16 2008-06-04 17:37:15 engels Exp

Definition at line 34 of file CalorimeterHit.h.

Member Typedef Documentation

Useful typedef for template programming with LCIO.

Definition at line 42 of file CalorimeterHit.h.

Constructor & Destructor Documentation

virtual EVENT::CalorimeterHit::~CalorimeterHit ( )
inlinevirtual

Destructor.

Definition at line 38 of file CalorimeterHit.h.

Member Function Documentation

virtual int EVENT::CalorimeterHit::getCellID0 ( ) const
pure virtual

Returns the detector specific (geometrical) cell id.

Implemented in IMPL::CalorimeterHitImpl.

Referenced by UTIL::operator<<(), and SIO::SIOCalHitHandler::write().

virtual int EVENT::CalorimeterHit::getCellID1 ( ) const
pure virtual

Returns the second detector specific (geometrical) cell id.

Optional, check/set flag(LCIO::RCHBIT_ID1)==1.

Implemented in IMPL::CalorimeterHitImpl.

Referenced by UTIL::operator<<(), and SIO::SIOCalHitHandler::write().

virtual float EVENT::CalorimeterHit::getEnergy ( ) const
pure virtual

Returns the energy of the hit in [GeV].

Implemented in IMPL::CalorimeterHitImpl.

Referenced by UTIL::operator<<(), and SIO::SIOCalHitHandler::write().

virtual float EVENT::CalorimeterHit::getEnergyError ( ) const
pure virtual

Returns the error of the hit energy in [GeV].

Optional, check/set flag(LCIO::RCHBIT_ENERGY_ERROR)==1.

Implemented in IMPL::CalorimeterHitImpl.

Referenced by UTIL::operator<<(), and SIO::SIOCalHitHandler::write().

virtual const float* EVENT::CalorimeterHit::getPosition ( ) const
pure virtual

Returns the position of the hit in world coordinates.

NULL if information is not stored - check flag(LCIO::RCHBIT_LONG)==1.

Implemented in IMPL::CalorimeterHitImpl.

Referenced by UTIL::operator<<(), and SIO::SIOCalHitHandler::write().

virtual LCObject* EVENT::CalorimeterHit::getRawHit ( ) const
pure virtual

The RawCalorimeterHit.

As in the future there might be other types of raw calorimeter hits the return type is LCObject.

Implemented in IMPL::CalorimeterHitImpl.

Referenced by SIO::SIOCalHitHandler::write().

virtual float EVENT::CalorimeterHit::getTime ( ) const
pure virtual

Returns the time of the hit in [ns].

Optional, check/set flag(LCIO::RCHBIT_TIME)==1.

Implemented in IMPL::CalorimeterHitImpl.

Referenced by SIO::SIOCalHitHandler::write().

virtual int EVENT::CalorimeterHit::getType ( ) const
pure virtual

Type of hit.

Mapping of integer types to type names through collection parameters "CalorimeterHitTypeNames" and "CalorimeterHitTypeValues".

Implemented in IMPL::CalorimeterHitImpl.

Referenced by UTIL::operator<<(), and SIO::SIOCalHitHandler::write().


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