| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26
27 #ifndef SIPMHIT_HHinline
28 #define SIPMHIT_HHinline
29
30 #include "G4THitsCollection.hh"
31 #include "G4VHit.hh"
32 #include "G4Types.hh"
33 #include "G4String.hh"
34
35 #include <vector>
36
37 /**
38 * @brief SiPM hit
39 *
40 * Stores information of energy deposited in the SiPM.
41 *
42 * Hits can be digitised, to take into account the time window for the deposits
43 * as well as to set the time information based on the energy threshold.
44 * By default no time window is used (all energy deposits are counted), as well
45 * as no energy threshold is used (time of the first energy deposit, however
46 * small, is counted as hit time).
47 *
48 */
49
50 class SiPMHit : public G4VHit {
51 public:
52 /// Constructor
53 /// @param[in] aName Name of the pixel volume
54 /// @param[in] aCopyNoSensor ID of the sensor
55 /// @param[in] aCopyNoCell ID of the cell
56 SiPMHit(G4String aName, G4int aCopyNoSensor, G4int aCopyNoCell);
57 ~SiPMHit(){};
58 /// Get hit ID calculated as 1000 * sensorID + cellID
59 G4int ID() { return 1000 * fCopyNumSensor + fCopyNumCell; }
60 /// Add non-zero energy deposit to vector of deposits
61 /// @param[in] aEnergy Deposited energy
62 /// @param[in] aTime Time of deposit
63 inline void AddEdep(const G4double aEnergy, const G4double aTime) {
64 if (aEnergy > 0)
65 fEdep.push_back(std::make_pair(aEnergy, aTime));
66 }
67 /// Add non-zero non-ionizing energy deposit to vector of deposits
68 /// @param[in] aEnergy Deposited energy
69 /// @param[in] aTime Time of deposit
70 inline void AddEdepNonIonizing(const G4double aEnergy, const G4double aTime) {
71 if (aEnergy > 0)
72 fEdepNonIonizing.push_back(std::make_pair(aEnergy, aTime));
73 }
74 /// Digitise hit
75 /// Calculate time of hit as global time of energy deposit which added
76 /// to hit energy exceeds the energy threshold. Take into account only
77 /// deposits with global time within the timeWindow.
78 /// @param[in] timeWindow Maximal global time for deposit, caounted from
79 /// the time of the first deposit
80 /// @param[in] toaThreshold Energy threshold, first deposit that adds to
81 /// the hit energy and exceeds the threshold is counted as time of
82 /// arrival.
83 void Digitise(const G4double timeWindow, const G4double toaThreshold);
84 /// Set hit position
85 /// @param[in] x X position
86 /// @param[in] y Y position
87 /// @param[in] z Z position
88 inline void SetPosition(G4double x, G4double y, G4double z) {
89 fPosX = x;
90 fPosY = y;
91 fPosZ = z;
92 }
93 /// Get hit X position
94 inline G4double GetX() const { return fPosX; }
95 /// Get hit Y position
96 inline G4double GetY() const { return fPosY; }
97 /// Get hit Z position
98 inline G4double GetZ() const { return fPosZ; }
99 /// Check if hit is valid
100 inline G4bool isValidHit() const { return fIsValidHit; }
101 /// Get hit energy
102 inline G4double GetEdep() const { return fEdepDigi; }
103 /// Get hit non-ionizing energy
104 inline G4double GetEdepNonIonizing() const { return fEdepNonIonizingDigi; }
105 /// Get time of arrival
106 inline G4double GetTOA() const { return fTimeOfArrival; }
107
108 private:
109 /// Name of the logical volume
110 G4String fVolumeName = "";
111 /// ID of the sensor
112 G4int fCopyNumCell = -1;
113 /// ID of the cell
114 G4int fCopyNumSensor = -1;
115 /// Position along x axis
116 G4double fPosX = -1;
117 /// Position along y axis
118 G4double fPosY = -1;
119 /// Position along z axis
120 G4double fPosZ = -1;
121 /// Vector of energy deposits (and their global time)
122 std::vector<std::pair<G4double, G4double>> fEdep;
123 /// Vector of non-ionizing energy deposits (and their global time)
124 std::vector<std::pair<G4double, G4double>> fEdepNonIonizing;
125 /// Flag indicating if hit is valid (digitised and with non-zero energy)
126 G4bool fIsValidHit = false;
127 /// Energy of the digitised hit
128 G4double fEdepDigi = -1;
129 /// Non-ionizing energy of the digitised hit
130 G4double fEdepNonIonizingDigi = -1;
131 /// Time of arrival of the digitised hit
132 G4double fTimeOfArrival = -1;
133 };
134
135 typedef G4THitsCollection<SiPMHit> SiPMHitCollection;
136
137 #endif /* SIPMHIT_HH */