Merge pull request #101 from rest-for-physics/lobis-quenching

Add process to quench energy deposits

Author: lobis

inc/TRestGeant4Hits.h

@@ -70,6 +70,9 @@ class TRestGeant4Hits : public TRestHits {
 
     size_t GetNumberOfHitsInVolume(Int_t volumeID) const;
 
+    // non-const methods (should only be used on the analysis, carefully)
+    std::vector<Float_t>& GetEnergyRef() { return fEnergy; }
+
     // Constructor
     TRestGeant4Hits();
     // Destructor

inc/TRestGeant4QuenchingProcess.h

@@ -0,0 +1,82 @@
+/*************************************************************************
+ * This file is part of the REST software framework.                     *
+ *                                                                       *
+ * Copyright (C) 2016 GIFNA/TREX (University of Zaragoza)                *
+ * For more information see http://gifna.unizar.es/trex                  *
+ *                                                                       *
+ * REST is free software: you can redistribute it and/or modify          *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * REST is distributed in the hope that it will be useful,               *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
+ * GNU General Public License for more details.                          *
+ *                                                                       *
+ * You should have a copy of the GNU General Public License along with   *
+ * REST in $REST_PATH/LICENSE.                                           *
+ * If not, see http://www.gnu.org/licenses/.                             *
+ * For the list of contributors see $REST_PATH/CREDITS.                  *
+ *************************************************************************/
+
+#ifndef RestCore_TRestGeant4QuenchingProcess
+#define RestCore_TRestGeant4QuenchingProcess
+
+#include <TRestEventProcess.h>
+
+#include "TRestGeant4Event.h"
+#include "TRestGeant4Metadata.h"
+
+//! Recomputes the energy of every hit based on quenching factor for each particle and volume
+class TRestGeant4QuenchingProcess : public TRestEventProcess {
+   private:
+    /// A pointer to the specific TRestGeant4Event input
+    TRestGeant4Event* fInputG4Event{};  //!
+
+    /// A pointer to the specific TRestGeant4Event output
+    TRestGeant4Event* fOutputG4Event{};  //!
+
+    /// A pointer to the simulation metadata information accessible to TRestRun
+    TRestGeant4Metadata* fGeant4Metadata{};  //!
+
+    /// It stores the quenching factor for each particle for each user volume expression
+    std::map<std::string, std::map<std::string, float_t>> fUserVolumeParticleQuenchingFactor = {};
+
+    /// It stores the quenching factor for each particle for each volume of the simulation
+    std::map<std::string, std::map<std::string, float_t>> fVolumeParticleQuenchingFactor = {};
+
+    void Initialize() override;
+    void InitFromConfigFile() override;
+    void LoadDefaultConfig();
+
+   public:
+    std::vector<std::string> GetUserVolumeExpressions() const;
+    float_t GetQuenchingFactorForVolumeAndParticle(const std::string& volumeName,
+                                                   const std::string& particleName) const;
+
+    //
+    any GetInputEvent() const override { return fInputG4Event; }
+    any GetOutputEvent() const override { return fOutputG4Event; }
+
+    void InitProcess() override;
+    TRestEvent* ProcessEvent(TRestEvent* inputEvent) override;
+    void EndProcess() override;
+
+    void LoadConfig(const std::string& configFilename, const std::string& name = "");
+
+    void PrintMetadata() override;
+
+    /// Returns a new instance of this class
+    TRestEventProcess* Maker() { return new TRestGeant4QuenchingProcess; }
+
+    /// Returns the name of this process
+    const char* GetProcessName() const override { return "Geant4Quenching"; }
+
+    TRestGeant4QuenchingProcess();
+    explicit TRestGeant4QuenchingProcess(const char* configFilename);
+    ~TRestGeant4QuenchingProcess() override;
+
+    ClassDefOverride(TRestGeant4QuenchingProcess, 1);
+};
+#endif

inc/TRestGeant4Track.h

@@ -55,6 +55,7 @@ class TRestGeant4Track {
 
    public:
     inline const TRestGeant4Hits& GetHits() const { return fHits; }
+    inline TRestGeant4Hits* GetHitsPointer() { return &fHits; }
     inline const TRestGeant4Event* GetEvent() const { return fEvent; }
     const TRestGeant4Metadata* GetGeant4Metadata() const;
 

macros/REST_Geant4_ViewEvent.C

@@ -11,7 +11,6 @@
 //***
 //*******************************************************************************************************
 Int_t REST_Geant4_ViewEvent(TString fName, Double_t geomScale = 0.1) {
-
     TFile* f = TFile::Open(fName);
 
     TIter nextkey(f->GetListOfKeys());

src/TRestGeant4QuenchingProcess.cxx

@@ -0,0 +1,268 @@
+/*************************************************************************
+ * This file is part of the REST software framework.                     *
+ *                                                                       *
+ * Copyright (C) 2016 GIFNA/TREX (University of Zaragoza)                *
+ * For more information see http://gifna.unizar.es/trex                  *
+ *                                                                       *
+ * REST is free software: you can redistribute it and/or modify          *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * REST is distributed in the hope that it will be useful,               *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
+ * GNU General Public License for more details.                          *
+ *                                                                       *
+ * You should have a copy of the GNU General Public License along with   *
+ * REST in $REST_PATH/LICENSE.                                           *
+ * If not, see http://www.gnu.org/licenses/.                             *
+ * For the list of contributors see $REST_PATH/CREDITS.                  *
+ *************************************************************************/
+
+//////////////////////////////////////////////////////////////////////////
+/// The TRestGeant4QuenchingProcess modifies the energy deposits of the simulation by multiplying by a
+/// user-defined quenching factor. This quenching factor is specified by volume and by particle and has the
+/// value 1.0 by default (no change). Physical volumes, logical volumes, or expressions (to be matched to
+/// either physical or logical) can be used for volumes. Example usage: \code
+///< TRestGeant4QuenchingProcess>
+///
+///    <volume name="^scintillatorVolume">
+///    <particle name="gamma" quenchingFactor="1.0"/>
+///    <particle name="e-" quenchingFactor="0.5"/>
+///    <particle name="e+" quenchingFactor="0.9"/>
+///    <particle name="mu-" quenchingFactor="0.2"/>
+///    <particle name="neutron" quenchingFactor="0.1"/>
+///    </volume>
+///
+///    <volume name="gasVolume">
+///    <particle name="gamma" quenchingFactor="0.2"/>
+///    <particle name="e-" quenchingFactor="0.2"/>
+///    </volume>
+///
+///    </TRestGeant4QuenchingProcess>
+/// \endcode
+///
+
+#include "TRestGeant4QuenchingProcess.h"
+
+using namespace std;
+
+ClassImp(TRestGeant4QuenchingProcess);
+
+///////////////////////////////////////////////
+/// \brief Default constructor
+///
+TRestGeant4QuenchingProcess::TRestGeant4QuenchingProcess() { Initialize(); }
+
+///////////////////////////////////////////////
+/// \brief Constructor loading data from a config file
+///
+/// If no configuration path is defined using TRestMetadata::SetConfigFilePath
+/// the path to the config file must be specified using full path, absolute or
+/// relative.
+///
+/// The default behaviour is that the config file must be specified with
+/// full path, absolute or relative.
+///
+/// \param configFilename A const char* giving the path to an RML file.
+///
+TRestGeant4QuenchingProcess::TRestGeant4QuenchingProcess(const char* configFilename) {
+    Initialize();
+
+    if (LoadConfigFromFile(configFilename)) {
+        LoadDefaultConfig();
+    }
+}
+
+///////////////////////////////////////////////
+/// \brief Default destructor
+///
+TRestGeant4QuenchingProcess::~TRestGeant4QuenchingProcess() { delete fOutputG4Event; }
+
+///////////////////////////////////////////////
+/// \brief Function to load the default config in absence of RML input
+///
+void TRestGeant4QuenchingProcess::LoadDefaultConfig() { SetTitle("Default config"); }
+
+///////////////////////////////////////////////
+/// \brief Function to initialize input/output event members and define the
+/// section name
+///
+void TRestGeant4QuenchingProcess::Initialize() {
+    fGeant4Metadata = nullptr;
+    SetSectionName(this->ClassName());
+    SetLibraryVersion(LIBRARY_VERSION);
+
+    fInputG4Event = nullptr;
+    fOutputG4Event = new TRestGeant4Event();
+}
+
+///////////////////////////////////////////////
+/// \brief Function to load the configuration from an external configuration
+/// file.
+///
+/// If no configuration path is defined in TRestMetadata::SetConfigFilePath
+/// the path to the config file must be specified using full path, absolute or
+/// relative.
+///
+/// \param configFilename A const char* giving the path to an RML file.
+/// \param name The name of the specific metadata. It will be used to find the
+/// corresponding TRestGeant4QuenchingProcess section inside the RML.
+///
+void TRestGeant4QuenchingProcess::LoadConfig(const string& configFilename, const string& name) {
+    if (LoadConfigFromFile(configFilename, name)) {
+        LoadDefaultConfig();
+    }
+}
+
+void TRestGeant4QuenchingProcess::InitFromConfigFile() {
+    TiXmlElement* volumeElement = GetElement("volume");
+    while (volumeElement) {
+        TiXmlElement* particleElement = GetElement("particle", volumeElement);
+        const string volumeName = GetParameter("name", volumeElement, "");
+        if (volumeName.empty()) {
+            cerr << "TRestGeant4QuenchingProcess: No volume expression specified" << endl;
+            exit(1);
+        }
+        while (particleElement) {
+            const string particleName = GetParameter("name", particleElement, "");
+            if (particleName.empty()) {
+                cerr << "TRestGeant4QuenchingProcess: No particle name specified" << endl;
+                exit(1);
+            }
+            const auto quenchingFactor = stof(GetParameter("quenchingFactor", particleElement, -1.0));
+            // if no value is specified, give error
+            if (quenchingFactor < 0.0 || quenchingFactor > 1.0) {
+                cerr << "TRestGeant4QuenchingProcess: Quenching factor must be between 0 and 1" << endl;
+                exit(1);
+            }
+            fUserVolumeParticleQuenchingFactor[volumeName][particleName] = quenchingFactor;
+            particleElement = GetNextElement(particleElement);
+        }
+        volumeElement = GetNextElement(volumeElement);
+    }
+}
+
+///////////////////////////////////////////////
+/// \brief Process initialization. User volume expressions are matched to physical volumes
+void TRestGeant4QuenchingProcess::InitProcess() {
+    fGeant4Metadata = GetMetadata<TRestGeant4Metadata>();
+    if (fGeant4Metadata == nullptr) {
+        cerr << "TRestGeant4QuenchingProcess: No TRestGeant4Metadata found" << endl;
+        exit(1);
+    }
+
+    const auto geometryInfo = fGeant4Metadata->GetGeant4GeometryInfo();
+    // check all the user volume expressions are valid and correspond to at least a volume
+    for (const auto& [userVolume, particleToQuenchingMap] : fUserVolumeParticleQuenchingFactor) {
+        set<string> physicalVolumes = {};
+        for (const auto& volume : geometryInfo.GetAllPhysicalVolumesMatchingExpression(userVolume)) {
+            physicalVolumes.insert(volume.Data());
+        }
+        if (!physicalVolumes.empty()) {
+            continue;
+        }
+        // maybe it refers to a logical volume
+        for (const auto& logicalVolume : geometryInfo.GetAllLogicalVolumesMatchingExpression(userVolume)) {
+            for (const auto& volume : geometryInfo.GetAllPhysicalVolumesFromLogical(logicalVolume.Data())) {
+                physicalVolumes.insert(volume.Data());
+            }
+        }
+
+        if (physicalVolumes.empty()) {
+            cerr << "TRestGeant4QuenchingProcess: No volume found matching expression " << userVolume << endl;
+            exit(1);
+        }
+
+        for (const auto& physicalVolume : physicalVolumes) {
+            fVolumeParticleQuenchingFactor[physicalVolume] = particleToQuenchingMap;
+        }
+    }
+
+    RESTDebug << "TRestGeant4QuenchingProcess initialized with volumes" << RESTendl;
+    for (const auto& [volume, particleToQuenchingMap] : fVolumeParticleQuenchingFactor) {
+        RESTDebug << volume << RESTendl;
+        for (const auto& [particle, quenchingFactor] : particleToQuenchingMap) {
+            RESTDebug << "\t" << particle << " " << quenchingFactor << RESTendl;
+        }
+    }
+}
+
+///////////////////////////////////////////////
+/// \brief The main processing event function
+///
+TRestEvent* TRestGeant4QuenchingProcess::ProcessEvent(TRestEvent* inputEvent) {
+    fInputG4Event = (TRestGeant4Event*)inputEvent;
+    *fOutputG4Event = *((TRestGeant4Event*)inputEvent);
+
+    fOutputG4Event->InitializeReferences(GetRunInfo());
+
+    // loop over all tracks
+    for (int trackIndex = 0; trackIndex < int(fOutputG4Event->GetNumberOfTracks()); trackIndex++) {
+        // get the track
+        TRestGeant4Track* track = fOutputG4Event->GetTrackPointer(trackIndex);
+        const auto& particleName = track->GetParticleName();
+
+        auto hits = track->GetHitsPointer();
+        auto& energy = hits->GetEnergyRef();
+        for (int hitIndex = 0; hitIndex < int(hits->GetNumberOfHits()); hitIndex++) {
+            const auto& volumeName = hits->GetVolumeName(hitIndex);
+            const float_t quenchingFactor =
+                GetQuenchingFactorForVolumeAndParticle(volumeName.Data(), particleName.Data());
+            // default is 1.0, so no quenching
+            energy[hitIndex] *= quenchingFactor;
+        }
+    }
+
+    return fOutputG4Event;
+}
+
+///////////////////////////////////////////////
+/// \brief Function to include required actions after all events have been processed.
+void TRestGeant4QuenchingProcess::EndProcess() {}
+
+vector<string> TRestGeant4QuenchingProcess::GetUserVolumeExpressions() const {
+    vector<string> userVolumeExpressions;
+    userVolumeExpressions.reserve(fUserVolumeParticleQuenchingFactor.size());
+    for (auto const& x : fUserVolumeParticleQuenchingFactor) {
+        userVolumeExpressions.push_back(x.first);
+    }
+    return userVolumeExpressions;
+}
+
+float_t TRestGeant4QuenchingProcess::GetQuenchingFactorForVolumeAndParticle(
+    const string& volumeName, const string& particleName) const {
+    float_t quenchingFactor = 1.0;
+    // check if the volume is in the map
+    if (fVolumeParticleQuenchingFactor.find(volumeName) != fVolumeParticleQuenchingFactor.end()) {
+        // check if the particle is in the map
+        if (fVolumeParticleQuenchingFactor.at(volumeName).find(particleName) !=
+            fVolumeParticleQuenchingFactor.at(volumeName).end()) {
+            quenchingFactor = fVolumeParticleQuenchingFactor.at(volumeName).at(particleName);
+        }
+    }
+    return quenchingFactor;
+}
+
+void TRestGeant4QuenchingProcess::PrintMetadata() {
+    BeginPrintProcess();
+    cout << "Printing TRestGeant4QuenchingProcess user configuration" << endl;
+    for (auto const& [volume, particleQuenchingFactorMap] : fUserVolumeParticleQuenchingFactor) {
+        cout << "Volume: " << volume << endl;
+        for (auto const& [particle, quenchingFactor] : particleQuenchingFactorMap) {
+            cout << "  - Particle: " << particle << " Quenching factor: " << quenchingFactor << endl;
+        }
+    }
+
+    if (!fVolumeParticleQuenchingFactor.empty()) {
+        cout << "Printing TRestGeant4QuenchingProcess configuration with actual volumes" << endl;
+        for (auto const& [volume, particleQuenchingFactorMap] : fVolumeParticleQuenchingFactor) {
+            cout << "Volume: " << volume << endl;
+            for (auto const& [particle, quenchingFactor] : particleQuenchingFactorMap) {
+                cout << "  - Particle: " << particle << " Quenching factor: " << quenchingFactor << endl;
+            }
+        }
+    }
+    EndPrintProcess();
+}