Belle II Software development
SensitiveDetector Class Reference

Sensitive Detector implementation of the CLAW detector. More...

#include <SensitiveDetector.h>

Inheritance diagram for SensitiveDetector:
SensitiveDetectorBase

Public Member Functions

 SensitiveDetector ()
 Constructor.
 
 ~SensitiveDetector ()
 Destructor.
 
int saveSimHit (const G4int cellId, const G4int trackID, const G4int pid, const G4double tof, const G4double edep, G4ThreeVector mom, ROOT::Math::XYZVector WightedPos)
 Save ClawSimHit into datastore.
 

Static Public Member Functions

static const std::map< std::string, RelationArray::EConsolidationAction > & getMCParticleRelations ()
 Return a list of all registered Relations with MCParticles.
 
static void setActive (bool activeStatus)
 Enable/Disable all Sensitive Detectors.
 
static void registerMCParticleRelation (const std::string &name, RelationArray::EConsolidationAction ignoreAction=RelationArray::c_negativeWeight)
 Register an relation involving MCParticles.
 
static void registerMCParticleRelation (const RelationArray &relation, RelationArray::EConsolidationAction ignoreAction=RelationArray::c_negativeWeight)
 Overload to make it easer to register MCParticle relations.
 

Protected Member Functions

bool step (G4Step *step, G4TouchableHistory *) override
 Step processing method.
 

Private Member Functions

virtual bool ProcessHits (G4Step *aStep, G4TouchableHistory *aROhist)
 Check if recording hits is enabled and if so call step() and set the correct MCParticle flag.
 

Private Attributes

int m_hitNum
 members of SensitiveDetector

 
int m_EvnetNumber
 The current number of created hits in an event.
 
int m_oldEvnetNumber
 The current number of created hits in an event.
 
int m_trackID
 The current number of created hits in an event.
 
G4ThreeVector m_startPos
 track id
 
G4ThreeVector m_endPos
 Position of prestep.
 
ROOT::Math::XYZVector m_WightedPos
 Position of poststep.
 
G4ThreeVector m_momentum
 Wighted step Position.
 
double m_startTime
 momentum of track
 
double m_endTime
 global time
 
double m_WightedTime
 global time
 
double m_startEnergy
 global time
 
double m_energyDeposit
 particle energy at the entrance in volume
 
double m_trackLength
 energy deposited in volume
 
int iECLCell
 length of the track in the volume
 
int TimeIndex
 Hit Energy of StoreArray.
 
ROOT::Math::XYZVector PosCell
 Hit Time of StoreArray.
 
ROOT::Math::XYZVector VecCell
 center of crystal position
 
double local_pos
 vector of crystal axis
 
double T_ave
 position alongthe vector of crystal axis

 
int firstcall
 flight time to diode sensor

 
int m_phiID
 flag of first call

 
int m_thetaID
 The current phi ID in an event.
 
int m_cellID
 The current theta ID in an event.
 
G4EmSaturation * saturationEngine
 The current cellID in an event.
 
Const::EDetector m_subdetector
 Subdetector the class belongs to.
 

Static Private Attributes

static std::map< std::string, RelationArray::EConsolidationActions_mcRelations
 Static set holding all relations which have to be updated at the end of the Event.
 
static bool s_active
 Static bool which indicates wether recording of hits is enabled.
 

Detailed Description

Sensitive Detector implementation of the CLAW detector.

Definition at line 25 of file SensitiveDetector.h.

Constructor & Destructor Documentation

◆ SensitiveDetector()

Constructor.

Definition at line 27 of file SensitiveDetector.cc.

27 :
28 Simulation::SensitiveDetectorBase("ClawSensitiveDetector", Const::invalidDetector)
29 {
30 m_hitNum = 0;
31 m_EvnetNumber = 0;
33 m_trackID = 0;
34 m_startTime = 0;
35 m_endTime = 0;
36 m_WightedTime = 0;
37 m_startEnergy = 0;
39 m_trackLength = 0;
40 iECLCell = 0;
41 TimeIndex = 0;
42 local_pos = 0;
43 T_ave = 0;
44 firstcall = 0;
45 m_phiID = 0;
46 m_thetaID = 0;
47 m_cellID = 0;
48
49 //Make sure all collections are registered
50 StoreArray<MCParticle> mcParticles;
51 StoreArray<ClawSimHit> simHits;
52 RelationArray relMCSimHit(mcParticles, simHits);
53
54 //Register all collections we want to modify and require those we want to use
55 mcParticles.registerInDataStore();
56 simHits.registerInDataStore();
57 relMCSimHit.registerInDataStore();
58
59 //Register the Relation so that the TrackIDs get replaced by the actual
60 //MCParticle indices after simulating the events. This is needed as
61 //secondary particles might not be stored so everything relating to those
62 //particles will be attributed to the last saved mother particle
63 registerMCParticleRelation(relMCSimHit);
64#if G4VERSION_NUMBER < 1010
65 saturationEngine = new G4EmSaturation();
66#else
67 saturationEngine = new G4EmSaturation(1); // verbose level
68#endif
69
70 }
static void registerMCParticleRelation(const std::string &name, RelationArray::EConsolidationAction ignoreAction=RelationArray::c_negativeWeight)
Register an relation involving MCParticles.
int m_thetaID
The current phi ID in an event.
double m_energyDeposit
particle energy at the entrance in volume
int m_EvnetNumber
The current number of created hits in an event.
int TimeIndex
Hit Energy of StoreArray.
int m_trackID
The current number of created hits in an event.
int m_hitNum
members of SensitiveDetector
int firstcall
flight time to diode sensor
double T_ave
position alongthe vector of crystal axis
double local_pos
vector of crystal axis
int m_cellID
The current theta ID in an event.
double m_startTime
momentum of track
G4EmSaturation * saturationEngine
The current cellID in an event.
int iECLCell
length of the track in the volume
double m_trackLength
energy deposited in volume
int m_oldEvnetNumber
The current number of created hits in an event.

◆ ~SensitiveDetector()

Destructor.

Definition at line 72 of file SensitiveDetector.cc.

73 {
74
75 }

Member Function Documentation

◆ getMCParticleRelations()

static const std::map< std::string, RelationArray::EConsolidationAction > & getMCParticleRelations ( )
inlinestaticinherited

Return a list of all registered Relations with MCParticles.

Definition at line 42 of file SensitiveDetectorBase.h.

42{ return s_mcRelations; }
static std::map< std::string, RelationArray::EConsolidationAction > s_mcRelations
Static set holding all relations which have to be updated at the end of the Event.

◆ ProcessHits()

bool ProcessHits ( G4Step *  aStep,
G4TouchableHistory *  aROhist 
)
inlineprivatevirtualinherited

Check if recording hits is enabled and if so call step() and set the correct MCParticle flag.

Called by Geant4 for each step inside the sensitive volumes attached

Definition at line 94 of file SensitiveDetectorBase.h.

95 {
96 if (!s_active) return false;
97 bool result = step(aStep, aROhist);
98 // Do not include hits from invalid detector (beast,teastbeam, etc.)
99 if (result && (m_subdetector != Const::invalidDetector)) TrackInfo::getInfo(*aStep->GetTrack()).addSeenInDetector(m_subdetector);
100 return result;
101 }
virtual bool step(G4Step *step, G4TouchableHistory *ROhist)=0
Process a Geant4 step in any of the sensitive volumes attached to this sensitive detector.
Const::EDetector m_subdetector
Subdetector the class belongs to.
static bool s_active
Static bool which indicates wether recording of hits is enabled.
static Payload getInfo(Carrier &obj)
Static function to just return UserInformation attached to the obj of type Carrier.
Definition: UserInfo.h:100

◆ registerMCParticleRelation() [1/2]

static void registerMCParticleRelation ( const RelationArray relation,
RelationArray::EConsolidationAction  ignoreAction = RelationArray::c_negativeWeight 
)
inlinestaticinherited

Overload to make it easer to register MCParticle relations.

Parameters
relationRelationArray to register
ignoreAction

Definition at line 66 of file SensitiveDetectorBase.h.

67 { registerMCParticleRelation(relation.getName(), ignoreAction); }

◆ registerMCParticleRelation() [2/2]

void registerMCParticleRelation ( const std::string &  name,
RelationArray::EConsolidationAction  ignoreAction = RelationArray::c_negativeWeight 
)
staticinherited

Register an relation involving MCParticles.

All Relations which point from an MCParticle to something have to be registered with addMCParticleRelation() because the index of the MCParticles might change at the end of the event. During simulation, the TrackID should be used as index of the MCParticle

Parameters
nameName of the relation to register
ignoreAction

Definition at line 22 of file SensitiveDetectorBase.cc.

23 {
24 std::pair<std::map<std::string, RelationArray::EConsolidationAction>::iterator, bool> insert = s_mcRelations.insert(std::make_pair(
25 name, ignoreAction));
26 //If the relation already exists and the ignoreAction is different we do have a problem
27 if (!insert.second && insert.first->second != ignoreAction) {
28 B2FATAL("MCParticle Relation " << name << " already registered with different ignore action.");
29 }
30 }

◆ saveSimHit()

int saveSimHit ( const G4int  cellId,
const G4int  trackID,
const G4int  pid,
const G4double  tof,
const G4double  edep,
G4ThreeVector  mom,
ROOT::Math::XYZVector  WightedPos 
)

Save ClawSimHit into datastore.

Definition at line 141 of file SensitiveDetector.cc.

149 {
150
151 //Get the datastore arraus
152 StoreArray<MCParticle> mcParticles;
153 StoreArray<ClawSimHit> simHits;
154 RelationArray relMClawmHit(mcParticles, simHits);
155
156 StoreArray<ClawSimHit> ClawHits;
157 RelationArray clawSimHitRel(mcParticles, ClawHits);
158 ROOT::Math::XYZVector momentum(mom.getX() / CLHEP::GeV, mom.getY() / CLHEP::GeV, mom.getZ() / CLHEP::GeV);
159 ClawHits.appendNew(cellId, trackID, pid, tof / CLHEP::ns, edep / CLHEP::GeV, momentum, posAve);
160 int simhitNumber = ClawHits.getEntries() - 1;
161 B2DEBUG(150, "HitNumber: " << simhitNumber);
162 clawSimHitRel.add(trackID, simhitNumber);
163 return (simhitNumber);
164 }//saveSimHit

◆ setActive()

static void setActive ( bool  activeStatus)
inlinestaticinherited

Enable/Disable all Sensitive Detectors.

By default, all sensitive detectors won't create hits to make it possible to use the Geant4 Navigator for non-simulation purposes. Only during simulation the sensitive detectors will be enabled to record hits

Parameters
activeStatusbool to indicate wether hits should be recorded

Definition at line 50 of file SensitiveDetectorBase.h.

50{ s_active = activeStatus; }

◆ step()

bool step ( G4Step *  step,
G4TouchableHistory *   
)
overrideprotectedvirtual

Step processing method.

Parameters
stepthe G4Step with the current step information
Returns
true if a Hit has been created, false if the hit was ignored

Implements SensitiveDetectorBase.

Definition at line 77 of file SensitiveDetector.cc.

78 {
79 const G4StepPoint& preStep = *step->GetPreStepPoint();
80 const G4StepPoint& postStep = *step->GetPostStepPoint();
81
82 G4Track& track = *step->GetTrack();
83 if (m_trackID != track.GetTrackID()) {
84 //TrackID changed, store track informations
85 m_trackID = track.GetTrackID();
86 //Get momentum
87 m_momentum = preStep.GetMomentum() ;
88 //Get energy
89 m_startEnergy = preStep.GetKineticEnergy() ;
90 //Reset energy deposit;
92 //Reset Wighted Time;
93 m_WightedTime = 0;
94 //Reset m_WightedPos;
95 m_WightedPos.SetXYZ(0, 0, 0);
96
97 }
98 //Update energy deposit
99 const double depEnergy = step->GetTotalEnergyDeposit() ;
100 m_energyDeposit += saturationEngine->VisibleEnergyDeposition(track.GetDefinition(), track.GetMaterialCutsCouple(),
101 step->GetStepLength(), depEnergy, 0.);
102 //step->GetTotalEnergyDeposit() ;
103
104 m_startTime = preStep.GetGlobalTime();
105 m_endTime = postStep.GetGlobalTime();
106 m_WightedTime += (m_startTime + m_endTime) / 2 * (step->GetTotalEnergyDeposit());
107
108 m_startPos = preStep.GetPosition();
109 m_endPos = postStep.GetPosition();
110 ROOT::Math::XYZVector position((m_startPos.getX() + m_endPos.getX()) / 2 / CLHEP::cm,
111 (m_startPos.getY() + m_endPos.getY()) / 2 / CLHEP::cm,
112 (m_startPos.getZ() + m_endPos.getZ()) / 2 / CLHEP::cm);
113 m_WightedPos += position * (step->GetTotalEnergyDeposit());
114
115 //Save Hit if track leaves volume or is killed
116 if (track.GetNextVolume() != track.GetVolume() || track.GetTrackStatus() >= fStopAndKill) {
117 int pdgCode = track.GetDefinition()->GetPDGEncoding();
118
119 //const G4VPhysicalVolume& v = * track.GetVolume();
120 //G4ThreeVector posCell = v.GetTranslation();
121 // Get layer ID
122
123 //if (v.GetName().find("Crystal") != std::string::npos) {
124 //CsiGeometryPar* eclp = CsiGeometryPar::Instance();
125 m_cellID = track.GetVolume()->GetCopyNo();
126
127 double dTotalEnergy = 1 / m_energyDeposit; //avoid the error no match for 'operator/'
128 if (m_energyDeposit > 0.) {
130 m_energyDeposit, m_momentum, m_WightedPos * dTotalEnergy);
131 //}
132 }
133
134 //Reset TrackID
135 m_trackID = 0;
136 }
137
138 return true;
139 }
int saveSimHit(const G4int cellId, const G4int trackID, const G4int pid, const G4double tof, const G4double edep, G4ThreeVector mom, ROOT::Math::XYZVector WightedPos)
Save ClawSimHit into datastore.
G4ThreeVector m_momentum
Wighted step Position.
G4ThreeVector m_startPos
track id
ROOT::Math::XYZVector m_WightedPos
Position of poststep.
G4ThreeVector m_endPos
Position of prestep.
bool step(G4Step *step, G4TouchableHistory *) override
Step processing method.

Member Data Documentation

◆ firstcall

int firstcall
private

flight time to diode sensor

Definition at line 76 of file SensitiveDetector.h.

◆ iECLCell

int iECLCell
private

length of the track in the volume

Definition at line 70 of file SensitiveDetector.h.

◆ local_pos

double local_pos
private

vector of crystal axis

Definition at line 74 of file SensitiveDetector.h.

◆ m_cellID

int m_cellID
private

The current theta ID in an event.

Used to fill the DataStore ECL array

Definition at line 79 of file SensitiveDetector.h.

◆ m_endPos

G4ThreeVector m_endPos
private

Position of prestep.

Definition at line 59 of file SensitiveDetector.h.

◆ m_endTime

double m_endTime
private

global time

Definition at line 63 of file SensitiveDetector.h.

◆ m_energyDeposit

double m_energyDeposit
private

particle energy at the entrance in volume

Definition at line 66 of file SensitiveDetector.h.

◆ m_EvnetNumber

int m_EvnetNumber
private

The current number of created hits in an event.

Used to fill the DataStore ECLHit.

Definition at line 55 of file SensitiveDetector.h.

◆ m_hitNum

int m_hitNum
private

members of SensitiveDetector

Definition at line 54 of file SensitiveDetector.h.

◆ m_momentum

G4ThreeVector m_momentum
private

Wighted step Position.

Definition at line 61 of file SensitiveDetector.h.

◆ m_oldEvnetNumber

int m_oldEvnetNumber
private

The current number of created hits in an event.

Used to fill the DataStore ECL EB array.

Definition at line 56 of file SensitiveDetector.h.

◆ m_phiID

int m_phiID
private

flag of first call

Definition at line 77 of file SensitiveDetector.h.

◆ m_startEnergy

double m_startEnergy
private

global time

Definition at line 65 of file SensitiveDetector.h.

◆ m_startPos

G4ThreeVector m_startPos
private

track id

Definition at line 58 of file SensitiveDetector.h.

◆ m_startTime

double m_startTime
private

momentum of track

Definition at line 62 of file SensitiveDetector.h.

◆ m_subdetector

Const::EDetector m_subdetector
privateinherited

Subdetector the class belongs to.

Definition at line 91 of file SensitiveDetectorBase.h.

◆ m_thetaID

int m_thetaID
private

The current phi ID in an event.

Used to fill the DataStore ECL array

Definition at line 78 of file SensitiveDetector.h.

◆ m_trackID

int m_trackID
private

The current number of created hits in an event.

Used to fill the DataStore

Definition at line 57 of file SensitiveDetector.h.

◆ m_trackLength

double m_trackLength
private

energy deposited in volume

Definition at line 67 of file SensitiveDetector.h.

◆ m_WightedPos

ROOT::Math::XYZVector m_WightedPos
private

Position of poststep.

Definition at line 60 of file SensitiveDetector.h.

◆ m_WightedTime

double m_WightedTime
private

global time

Definition at line 64 of file SensitiveDetector.h.

◆ PosCell

ROOT::Math::XYZVector PosCell
private

Hit Time of StoreArray.

Definition at line 72 of file SensitiveDetector.h.

◆ s_active

bool s_active
staticprivateinherited

Static bool which indicates wether recording of hits is enabled.

Definition at line 89 of file SensitiveDetectorBase.h.

◆ s_mcRelations

map< string, RelationArray::EConsolidationAction > s_mcRelations
staticprivateinherited

Static set holding all relations which have to be updated at the end of the Event.

Definition at line 87 of file SensitiveDetectorBase.h.

◆ saturationEngine

G4EmSaturation* saturationEngine
private

The current cellID in an event.

Used to fill the DataStore ECL array
needed to call Birk's law

Definition at line 82 of file SensitiveDetector.h.

◆ T_ave

double T_ave
private

position alongthe vector of crystal axis

Definition at line 75 of file SensitiveDetector.h.

◆ TimeIndex

int TimeIndex
private

Hit Energy of StoreArray.

Definition at line 71 of file SensitiveDetector.h.

◆ VecCell

ROOT::Math::XYZVector VecCell
private

center of crystal position

Definition at line 73 of file SensitiveDetector.h.


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