Merge pull request #64 from rest-for-physics/lobis-hits-getters

Update TRestGeant4Hits getters to return directly process or volume names

Author: lobis

inc/TRestGeant4Event.h

@@ -210,7 +210,7 @@ class TRestGeant4Event : public TRestEvent {
         return lowestID;
     }
 
-    const std::set<std::string> GetUniqueParticles() const;
+    std::set<std::string> GetUniqueParticles() const;
 
     Bool_t ContainsProcessInVolume(Int_t processID, Int_t volumeID = -1) const;
     inline Bool_t ContainsProcess(Int_t processID) const { return ContainsProcessInVolume(processID, -1); }

inc/TRestGeant4Hits.h

@@ -49,13 +49,17 @@ class TRestGeant4Hits : public TRestHits {
 
     inline TVector3 GetMomentumDirection(size_t n) const { return fMomentumDirection[n]; }
 
-    inline Int_t GetProcess(size_t n) const { return fProcessID[n]; }
+    inline Int_t GetProcessId(size_t n) const { return fProcessID[n]; }
+    inline Int_t GetProcess(size_t n) const { return GetProcessId(n); }
+    inline Int_t GetHitProcess(size_t n) const { return GetProcessId(n); }
+    TString GetProcessName(size_t n) const;
+
+    inline Int_t GetVolumeId(size_t n) const { return fVolumeID[n]; }
+    inline Int_t GetHitVolume(size_t n) const { return GetVolumeId(n); }
+    TString GetVolumeName(size_t n) const;
 
     void RemoveG4Hits();
 
-    inline Int_t GetHitProcess(size_t n) const { return fProcessID[n]; }
-    inline Int_t GetHitVolume(size_t n) const { return fVolumeID[n]; }
-    inline Int_t GetVolumeId(size_t n) const { return fVolumeID[n]; }
     inline Double_t GetKineticEnergy(size_t n) const { return fKineticEnergy[n]; }
 
     Double_t GetEnergyInVolume(Int_t volumeID) const;

inc/TRestGeant4Metadata.h

@@ -337,6 +337,14 @@ class TRestGeant4Metadata : public TRestMetadata {
         return fRemoveUnwantedTracksVolumesToKeep.count(volumeName) > 0;
     }
 
+    inline std::vector<std::string> GetRemoveUnwantedTracksVolumesToKeep() const {
+        std::vector<std::string> result;
+        for (const auto& volume : fRemoveUnwantedTracksVolumesToKeep) {
+            result.emplace_back(volume);
+        }
+        return result;
+    }
+
     /// Returns a std::string with the name of the active volume with index n
     inline TString GetActiveVolumeName(Int_t n) const { return fActiveVolumes[n]; }
 
@@ -364,7 +372,7 @@ class TRestGeant4Metadata : public TRestMetadata {
 
     ~TRestGeant4Metadata();
 
-    ClassDefOverride(TRestGeant4Metadata, 11);
+    ClassDefOverride(TRestGeant4Metadata, 12);
 
     // Allow modification of otherwise inaccessible / immutable members that shouldn't be modified by the user
     friend class SteppingAction;

inc/TRestGeant4Track.h

@@ -133,6 +133,8 @@ class TRestGeant4Track {
     // Destructor
     virtual ~TRestGeant4Track();
 
+    friend class TRestGeant4Event;  // allows TRestGeant4Event to access private members
+
     ClassDef(TRestGeant4Track, 5);  // REST event superclass
 
     // restG4

src/TRestGeant4Event.cxx

@@ -1120,7 +1120,7 @@ void TRestGeant4Event::PrintEvent(int maxTracks, int maxHits) const {
     cout << "- Total deposited energy: " << ToEnergyString(fTotalDepositedEnergy) << endl;
     cout << "- Sensitive detectors total energy: " << ToEnergyString(fSensitiveVolumeEnergy) << endl;
 
-    cout << "- Primary source position: " << VectorToString(fPrimaryPosition) << "{} mm" << endl;
+    cout << "- Primary source position: " << VectorToString(fPrimaryPosition) << " mm" << endl;
 
     for (int i = 0; i < GetNumberOfPrimaries(); i++) {
         const char* sourceNumberString =
@@ -1202,10 +1202,12 @@ void TRestGeant4Event::InitializeReferences(TRestRun* run) {
      */
     for (auto& track : fTracks) {
         track.SetEvent(this);
+        track.fHits.SetTrack(&track);
+        track.fHits.SetEvent(this);
     }
 }
 
-const set<string> TRestGeant4Event::GetUniqueParticles() const {
+set<string> TRestGeant4Event::GetUniqueParticles() const {
     set<string> result;
     for (const auto& track : fTracks) {
         result.insert(track.GetParticleName().Data());

src/TRestGeant4Hits.cxx

@@ -26,7 +26,7 @@ ClassImp(TRestGeant4Hits);
 
 TRestGeant4Hits::TRestGeant4Hits() : TRestHits() {}
 
-TRestGeant4Hits::~TRestGeant4Hits() {}
+TRestGeant4Hits::~TRestGeant4Hits() = default;
 
 void TRestGeant4Hits::RemoveG4Hits() {
     RemoveHits();
@@ -37,30 +37,32 @@ void TRestGeant4Hits::RemoveG4Hits() {
 }
 
 Double_t TRestGeant4Hits::GetEnergyInVolume(Int_t volumeID) const {
-    Double_t en = 0;
+    Double_t energy = 0;
 
     for (int n = 0; n < fNHits; n++) {
-        if (fVolumeID[n] == volumeID) en += GetEnergy(n);
+        if (fVolumeID[n] == volumeID) {
+            energy += GetEnergy(n);
+        }
     }
 
-    return en;
+    return energy;
 }
 
 TVector3 TRestGeant4Hits::GetMeanPositionInVolume(Int_t volumeID) const {
     TVector3 pos;
-    Double_t en = 0;
+    Double_t energy = 0;
     for (int n = 0; n < fNHits; n++)
         if (fVolumeID[n] == volumeID) {
             pos += GetPosition(n) * GetEnergy(n);
-            en += GetEnergy(n);
+            energy += GetEnergy(n);
         }
 
-    if (en == 0) {
+    if (energy == 0) {
         Double_t nan = TMath::QuietNaN();
         return {nan, nan, nan};
     }
 
-    pos = (1. / en) * pos;
+    pos = (1. / energy) * pos;
     return pos;
 }
 
@@ -73,9 +75,11 @@ TVector3 TRestGeant4Hits::GetFirstPositionInVolume(Int_t volumeID) const {
 }
 
 TVector3 TRestGeant4Hits::GetLastPositionInVolume(Int_t volumeID) const {
-    for (int n = fNHits - 1; n >= 0; n--)
-        if (fVolumeID[n] == volumeID) return GetPosition(n);
-
+    for (int n = fNHits - 1; n >= 0; n--) {
+        if (fVolumeID[n] == volumeID) {
+            return GetPosition(n);
+        }
+    }
     Double_t nan = TMath::QuietNaN();
     return {nan, nan, nan};
 }
@@ -91,15 +95,24 @@ size_t TRestGeant4Hits::GetNumberOfHitsInVolume(Int_t volumeID) const {
 }
 
 TRestGeant4Metadata* TRestGeant4Hits::GetGeant4Metadata() const {
-    const TRestGeant4Event* event = nullptr;
+    const TRestGeant4Event* event;
     if (fTrack != nullptr) {
         event = fTrack->GetEvent();
     } else {
         event = fEvent;
     }
     if (event == nullptr) {
-        cout << "null event" << endl;
         return nullptr;
     }
     return const_cast<TRestGeant4Metadata*>(event->GetGeant4Metadata());
 }
+
+TString TRestGeant4Hits::GetProcessName(size_t n) const {
+    const auto metadata = GetGeant4Metadata();
+    return metadata == nullptr ? "" : metadata->GetGeant4PhysicsInfo().GetProcessName(GetProcessId(n));
+}
+
+TString TRestGeant4Hits::GetVolumeName(size_t n) const {
+    const auto metadata = GetGeant4Metadata();
+    return metadata == nullptr ? "" : metadata->GetGeant4GeometryInfo().GetVolumeFromID(GetVolumeId(n));
+}