DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
dd4hep::sim::Geant4HitData Class Reference

Base class for geant4 hit structures used by the default DDG4 sensitive detector implementations. More...

#include <Geant4Data.h>

Inheritance diagram for dd4hep::sim::Geant4HitData:
dd4hep::sim::Geant4Calorimeter::Hit dd4hep::sim::Geant4Tracker::Hit

Classes

class  MonteCarloContrib
 Utility class describing the monte carlo contribution of a given particle to a hit. More...
 

Public Types

enum  HitFlags {
  HIT_KILLED_TRACK = 1<<0, HIT_SECONDARY_TRACK = 1<<1, HIT_NEW_TRACK = 1<<2, HIT_STARTED_INSIDE = 1<<10,
  HIT_STARTED_SURFACE = 1<<11, HIT_STARTED_OUTSIDE = 1<<12, HIT_ENDED_INSIDE = 1<<13, HIT_ENDED_SURFACE = 1<<14,
  HIT_ENDED_OUTSIDE = 1<<15
}
 
typedef MonteCarloContrib Contribution
 
typedef std::vector< MonteCarloContribContributions
 

Public Member Functions

 Geant4HitData ()
 Default constructor. More...
 
virtual ~Geant4HitData ()
 Default destructor. More...
 

Static Public Member Functions

static Contribution extractContribution (const G4Step *step)
 Extract the MC contribution for a given hit from the step information. More...
 
static Contribution extractContribution (const G4Step *step, bool ApplyBirksLaw)
 Extract the MC contribution for a given hit from the step information with BirksLaw option. More...
 
static Contribution extractContribution (const Geant4FastSimSpot *spot)
 Extract the MC contribution for a given hit from the GFlash/FastSim spot information. More...
 

Public Attributes

long long int cellID = 0
 cellID More...
 
long flag = 0
 User flag to classify hits. More...
 
long g4ID = -1
 Original Geant 4 track identifier of the creating track (debugging) More...
 
std::unique_ptr< DataExtensionextension
 User data extension if required. More...
 

Detailed Description

Base class for geant4 hit structures used by the default DDG4 sensitive detector implementations.

Definition at line 110 of file Geant4Data.h.

Member Typedef Documentation

◆ Contribution

Definition at line 231 of file Geant4Data.h.

◆ Contributions

Definition at line 232 of file Geant4Data.h.

Member Enumeration Documentation

◆ HitFlags

Enumerator
HIT_KILLED_TRACK 
HIT_SECONDARY_TRACK 
HIT_NEW_TRACK 
HIT_STARTED_INSIDE 
HIT_STARTED_SURFACE 
HIT_STARTED_OUTSIDE 
HIT_ENDED_INSIDE 
HIT_ENDED_SURFACE 
HIT_ENDED_OUTSIDE 

Definition at line 112 of file Geant4Data.h.

Constructor & Destructor Documentation

◆ Geant4HitData()

Geant4HitData::Geant4HitData ( )

Default constructor.

Definition at line 54 of file Geant4Data.cpp.

◆ ~Geant4HitData()

Geant4HitData::~Geant4HitData ( )
virtual

Default destructor.

Definition at line 59 of file Geant4Data.cpp.

Member Function Documentation

◆ extractContribution() [1/3]

Geant4HitData::Contribution Geant4HitData::extractContribution ( const G4Step *  step)
static

Extract the MC contribution for a given hit from the step information.

Definition at line 64 of file Geant4Data.cpp.

◆ extractContribution() [2/3]

Geant4HitData::Contribution Geant4HitData::extractContribution ( const G4Step *  step,
bool  ApplyBirksLaw 
)
static

Extract the MC contribution for a given hit from the step information with BirksLaw option.

Extract the MC contribution for a given hit from the step information with BirksLaw effect option.

Definition at line 78 of file Geant4Data.cpp.

◆ extractContribution() [3/3]

Geant4HitData::Contribution Geant4HitData::extractContribution ( const Geant4FastSimSpot spot)
static

Extract the MC contribution for a given hit from the GFlash/FastSim spot information.

Extract the MC contribution for a given hit from the fast simulation spot information.

Definition at line 93 of file Geant4Data.cpp.

Member Data Documentation

◆ cellID

long long int dd4hep::sim::Geant4HitData::cellID = 0

cellID

Definition at line 124 of file Geant4Data.h.

◆ extension

std::unique_ptr<DataExtension> dd4hep::sim::Geant4HitData::extension

User data extension if required.

Definition at line 130 of file Geant4Data.h.

◆ flag

long dd4hep::sim::Geant4HitData::flag = 0

User flag to classify hits.

Definition at line 126 of file Geant4Data.h.

◆ g4ID

long dd4hep::sim::Geant4HitData::g4ID = -1

Original Geant 4 track identifier of the creating track (debugging)

Definition at line 128 of file Geant4Data.h.


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