Merge pull request #142 from rest-for-physics/globalTimeReset

Global time reset

Author: lobis

inc/TRestGeant4Metadata.h

@@ -117,6 +117,14 @@ class TRestGeant4Metadata : public TRestMetadata {
     /// (fFullChain=true), or just a single decay (fFullChain=false).
     Bool_t fFullChain = true;
 
+    /// \brief Reset global time in case of a long radioactive decay, the global time of
+    /// the decay is stored in the variable offset defined on TRestGeant4Track
+    Bool_t fResetGlobalTime = true;
+
+    /// \brief Time precision, in us, to determine if the global time has to be reset
+    /// or not.
+    Double_t fResetTimePrecision = 1;
+
     /// \brief If defined, it will stop the full chain decay simulation when one of these isotope appears.
     std::set<std::string> fFullChainStopIsotopes;
 
@@ -216,6 +224,11 @@ class TRestGeant4Metadata : public TRestMetadata {
     /// \brief Returns true in case full decay chain simulation is enabled.
     inline Bool_t isFullChainActivated() const { return fFullChain; }
 
+    /// \brief Returns true in case global time is reset for long radioactive decays.
+    inline Bool_t isGlobalTimeReset() const { return fResetGlobalTime; }
+
+    inline Double_t GetResetTimePrecision() const { return fResetTimePrecision; }
+
     /// \brief Returns the isotopes that will stop the full chain decay simulation.
     inline std::set<std::string> GetFullChainStopIsotopes() const { return fFullChainStopIsotopes; }
 
@@ -417,7 +430,7 @@ class TRestGeant4Metadata : public TRestMetadata {
     TRestGeant4Metadata(const TRestGeant4Metadata& metadata);
     TRestGeant4Metadata& operator=(const TRestGeant4Metadata& metadata);
 
-    ClassDefOverride(TRestGeant4Metadata, 19);
+    ClassDefOverride(TRestGeant4Metadata, 20);
 
     // Allow modification of otherwise inaccessible / immutable members that shouldn't be modified by the user
     friend class SteppingAction;

inc/TRestGeant4Track.h

@@ -42,6 +42,7 @@ class TRestGeant4Track {
     std::vector<Int_t> fSecondaryTrackIDs;
 
     Double_t fGlobalTimestamp;
+    Double_t fTimeOffset = 0;
     Double_t fTimeLength;
 
     Double_t fInitialKineticEnergy;
@@ -65,6 +66,8 @@ class TRestGeant4Track {
         fHits.SetTrack(this);
     }
 
+    inline void SetTimeOffset(const double tOffset) { fTimeOffset = tOffset; }
+
     inline TString GetCreatorProcess() const { return fCreatorProcess; }
 
     inline void AddSecondaryTrackID(Int_t trackID) { fSecondaryTrackIDs.push_back(trackID); }
@@ -76,6 +79,7 @@ class TRestGeant4Track {
     inline Int_t GetParentID() const { return fParentID; }
     inline TString GetParticleName() const { return fParticleName; }
     inline Double_t GetGlobalTime() const { return fGlobalTimestamp; }
+    inline Double_t GetTimeOffset() const { return fTimeOffset; }
     inline Double_t GetTimeLength() const { return fTimeLength; }
     inline Double_t GetInitialKineticEnergy() const { return fInitialKineticEnergy; }
     inline TVector3 GetInitialPosition() const { return fInitialPosition; }
@@ -136,7 +140,7 @@ class TRestGeant4Track {
 
     friend class TRestGeant4Event;  // allows TRestGeant4Event to access private members
 
-    ClassDef(TRestGeant4Track, 5);  // REST event superclass
+    ClassDef(TRestGeant4Track, 6);  // REST event superclass
 
     // restG4
    public:

src/TRestGeant4Metadata.cxx

@@ -138,6 +138,12 @@
 /// * **printProgress**: if enabled, a message showing the progress of the simulation will be printed
 /// periodically. This option is enabled by default.
 ///
+/// * **resetGlobalTime**: when enabled it reset the global time stamp in case of long radioactive decay.
+/// This option is enabled by default.
+///
+/// * **resetTimePrecision**: this parameter defines the time precision required to reset the global time
+/// in case resetGlobalTime is enabled.
+///
 /// The following example illustrates the definition of the common simulation
 /// parameters.
 ///
@@ -146,6 +152,8 @@
 ///		<parameter name="gdmlFile" value="/path/to/mySetupTemplate.gdml"/>
 ///		<parameter name="maxTargetStepSize" value="200" units="um" />
 ///		<parameter name="subEventTimeDelay" value="100" units="us" />
+///             <parameter name="resetGlobalTime" value="true" />
+///             <parameter name="resetTimePrecision" value="1ns" />
 /// \endcode
 ///
 /// ## 2. The primary particle generator section
@@ -847,9 +855,11 @@ void TRestGeant4Metadata::InitFromConfigFile() {
         }
     }
 
-    Double_t defaultTime = 1. / REST_Units::s;
+    Double_t defaultTime = 1. / REST_Units::us;
     fSubEventTimeDelay = GetDblParameterWithUnits("subEventTimeDelay", defaultTime);
 
+    fResetTimePrecision = GetDblParameterWithUnits("resetTimePrecision", defaultTime);
+
     auto nEventsString = GetParameter("nEvents");
     if (nEventsString == PARAMETER_NOT_FOUND_STR) {
         nEventsString = GetParameter("Nevents");  // old name
@@ -872,6 +882,9 @@ void TRestGeant4Metadata::InitFromConfigFile() {
     fRegisterEmptyTracks = ToUpper(GetParameter("registerEmptyTracks", "false")) == "TRUE" ||
                            ToUpper(GetParameter("registerEmptyTracks", "off")) == "ON";
 
+    fResetGlobalTime = ToUpper(GetParameter("resetGlobalTime", "true")) == "TRUE" ||
+                       ToUpper(GetParameter("resetGlobalTime", "on")) == "ON";
+
     ReadGenerator();
     // Detector (old storage) section is processed after initializing geometry info in Detector Construction
     // This allows to use regular expression to match logical or physical volumes etc.
@@ -1508,6 +1521,14 @@ void TRestGeant4Metadata::PrintMetadata() {
     RESTMetadata << "GDML geometry: " << GetGdmlReference() << RESTendl;
     RESTMetadata << "GDML materials reference: " << GetMaterialsReference() << RESTendl;
     RESTMetadata << "Sub-event time delay: " << GetSubEventTimeDelay() << " us" << RESTendl;
+
+    if (isGlobalTimeReset()) {
+        RESTMetadata << "Reset global time: enabled" << RESTendl;
+        RESTMetadata << "Reset Time precision " << GetResetTimePrecision() << " us" << RESTendl;
+    } else {
+        RESTMetadata << "Reset global time: disabled" << RESTendl;
+    }
+
     Double_t mx = GetMagneticField().X();
     Double_t my = GetMagneticField().Y();
     Double_t mz = GetMagneticField().Z();
@@ -1703,6 +1724,8 @@ TRestGeant4Metadata& TRestGeant4Metadata::operator=(const TRestGeant4Metadata& m
     fBiasingVolumes = metadata.fBiasingVolumes;
     fMaxTargetStepSize = metadata.fMaxTargetStepSize;
     fSubEventTimeDelay = metadata.fSubEventTimeDelay;
+    fResetTimePrecision = metadata.fResetTimePrecision;
+    fResetGlobalTime = metadata.fResetGlobalTime;
     fFullChain = metadata.fFullChain;
     fSensitiveVolumes = metadata.fSensitiveVolumes;
     fNEvents = metadata.fNEvents;

src/TRestGeant4Track.cxx

@@ -125,8 +125,9 @@ void TRestGeant4Track::PrintTrack(size_t maxHits) const {
         << ToLengthString(fLength) << endl;
 
     cout << "   Initial position " << VectorToString(fInitialPosition) << " mm at time "
-         << ToTimeString(fGlobalTimestamp) << " - Time length of " << ToTimeString(fTimeLength)
-         << " and spatial length of " << ToLengthString(fLength) << endl;
+         << ToTimeString(fGlobalTimestamp) << " - Time offset " << ToTimeString(fTimeOffset)
+         << " - Time length of " << ToTimeString(fTimeLength) << " and spatial length of "
+         << ToLengthString(fLength) << endl;
 
     size_t nHits = GetNumberOfHits();
     if (maxHits > 0 && maxHits < nHits) {