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

A generic simulated tracker hit. More...

#include <SimTrackerHit.h>

+ Inheritance diagram for EVENT::SimTrackerHit:

Public Types

typedef SimTrackerHit 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 ~SimTrackerHit ()
 Destructor. More...
 
virtual int getCellID0 () const =0
 Same name as in CalorimeterHit, even though there are no 'cells' in this case. More...
 
virtual int getCellID1 () const =0
 Same name as in CalorimeterHit, even though there are no 'cells' in this case Optional, check/set flag(LCIO::THBIT_ID1)==1. More...
 
virtual int getCellID () const =0
 DEPRECATED: use () More...
 
virtual const double * getPosition () const =0
 Returns the hit position in [mm]. More...
 
virtual float getdEdx () const =0
 Returns the dE/dx of the hit in [GeV]. More...
 
virtual float getEDep () const =0
 The energy deposited on the hit [GeV]. More...
 
virtual float getTime () const =0
 Returns the time of the hit in [ns]. More...
 
virtual MCParticlegetMCParticle () const =0
 Returns the MC particle that caused the hit. More...
 
virtual const float * getMomentum () const =0
 Returns the 3-momentum of the particle at the hits position in [GeV] - optional, only if bit LCIO::THBIT_MOMENTUM is set. More...
 
virtual float getPathLength () const =0
 The path length of the particle in the sensitive material that resulted in this hit. More...
 
virtual int getQuality () const =0
 The quality bit flag of the hit. More...
 
virtual bool isOverlay () const =0
 True if the hit has been overlayed by the simulation (or digitization) program. More...
 
virtual bool isProducedBySecondary () const =0
 True if the particle has been created by a secondary particle that is not stored in the MCParticle collection. 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...
 

Static Public Attributes

static const int BITOverlay = 31
 
static const int BITProducedBySecondary = 30
 

Detailed Description

A generic simulated tracker hit.

Author
gaede
Version
Id:
SimTrackerHit.aid,v 1.11 2010-06-17 12:28:59 engels Exp

Definition at line 23 of file SimTrackerHit.h.

Member Typedef Documentation

Useful typedef for template programming with LCIO.

Definition at line 31 of file SimTrackerHit.h.

Constructor & Destructor Documentation

virtual EVENT::SimTrackerHit::~SimTrackerHit ( )
inlinevirtual

Destructor.

Definition at line 27 of file SimTrackerHit.h.

Member Function Documentation

virtual int EVENT::SimTrackerHit::getCellID ( ) const
pure virtual

DEPRECATED: use ()

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

Same name as in CalorimeterHit, even though there are no 'cells' in this case.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

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

Same name as in CalorimeterHit, even though there are no 'cells' in this case Optional, check/set flag(LCIO::THBIT_ID1)==1.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

virtual float EVENT::SimTrackerHit::getdEdx ( ) const
pure virtual

Returns the dE/dx of the hit in [GeV].

Deprecated:
See Also
getEDep()
virtual float EVENT::SimTrackerHit::getEDep ( ) const
pure virtual

The energy deposited on the hit [GeV].

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

virtual MCParticle* EVENT::SimTrackerHit::getMCParticle ( ) const
pure virtual

Returns the MC particle that caused the hit.

See Also
MCParticle

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

virtual const float* EVENT::SimTrackerHit::getMomentum ( ) const
pure virtual

Returns the 3-momentum of the particle at the hits position in [GeV] - optional, only if bit LCIO::THBIT_MOMENTUM is set.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

virtual float EVENT::SimTrackerHit::getPathLength ( ) const
pure virtual

The path length of the particle in the sensitive material that resulted in this hit.

This is only stored together with momentum, i.e. if LCIO::THBIT_MOMENTUM is set.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

virtual const double* EVENT::SimTrackerHit::getPosition ( ) const
pure virtual

Returns the hit position in [mm].

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

virtual int EVENT::SimTrackerHit::getQuality ( ) const
pure virtual

The quality bit flag of the hit.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::LCTOOLS::getQualityBits().

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

Returns the time of the hit in [ns].

TO DO needs definition.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::operator<<().

virtual bool EVENT::SimTrackerHit::isOverlay ( ) const
pure virtual

True if the hit has been overlayed by the simulation (or digitization) program.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::LCTOOLS::getQualityBits().

virtual bool EVENT::SimTrackerHit::isProducedBySecondary ( ) const
pure virtual

True if the particle has been created by a secondary particle that is not stored in the MCParticle collection.

Implemented in IMPL::SimTrackerHitImpl.

Referenced by UTIL::LCTOOLS::getQualityBits().

Member Data Documentation

const int EVENT::SimTrackerHit::BITOverlay = 31
static
const int EVENT::SimTrackerHit::BITProducedBySecondary = 30
static

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