Added interface to user score weighting: (#81)

Added TG4ScoreWeightCalculator type for user scoreweight function that takes (pdg, ekin) as arguments and its setter to the TG4RunConfiguration class:
  void SetScoreWeightCalculator(TG4ScoreWeightCalculator swc);

The user function is then, in TG4SDManager::LateInitialize(), wrapped to G4ScoreWeightCalculator function that takes (const G4Step*) as argument and applied to all Geant4 scorers with activated score weighting.

Author: ihrivnac

source/digits+hits/include/TG4SDManager.h

@@ -15,8 +15,9 @@
 ///
 /// \author I. Hrivnacova; IPN, Orsay
 
-#include <globals.hh>
+#include "TG4ScoreWeightCalculator.h"
 
+#include <globals.hh>
 #include <Rtypes.h>
 
 class TG4SDServices;
@@ -41,6 +42,7 @@ class TG4SDManager
 
   // methods
   void Initialize();
+  void LateInitialize(TG4ScoreWeightCalculator swc);
 
   // TVirtualMC methods
   Int_t VolId(const Text_t* volName) const;
@@ -78,6 +80,9 @@ class TG4SDManager
   /// services related with sensitive detectors
   TG4SDServices* fSDServices;
 
+  /// score weight calculator
+  TG4ScoreWeightCalculator fScoreWeightCalculator;
+
   /// buffer for volume name
   mutable G4String fNameBuffer;
 };

source/digits+hits/include/TG4ScoreWeightCalculator.h

@@ -0,0 +1,24 @@
+#ifndef TG4_SCORE_WEIGHT_CALCULATOR_H
+#define TG4_SCORE_WEIGHT_CALCULATOR_H
+
+//------------------------------------------------
+// The Geant4 Virtual Monte Carlo package
+// Copyright (C) 2014 - 2018 Ivana Hrivnacova
+// All rights reserved.
+//
+// For the licensing terms see geant4_vmc/LICENSE.
+// Contact: root-vmc@cern.ch
+//-------------------------------------------------
+
+/// \file TG4ScoreWeightCalculator.h
+/// \brief Definition of the score weight calculator type
+///
+/// \author I. Hrivnacova; IPN, Orsay
+
+#include <Rtypes.h>
+
+#include <functional>
+
+using TG4ScoreWeightCalculator = std::function<Double_t(Int_t pdg, Double_t ekin)>;
+
+#endif // TG4_SCORE_WEIGHT_CALCULATOR_H

source/digits+hits/src/TG4SDManager.cxx

@@ -20,6 +20,11 @@
 #include "TG4SDConstruction.h"
 #include "TG4SDServices.h"
 
+#include "G4MultiFunctionalDetector.hh"
+#include "G4ScoringManager.hh"
+#include "G4VPrimitiveScorer.hh"
+#include "G4VScoringMesh.hh"
+
 #include <TVirtualMC.h>
 
 TG4SDManager* TG4SDManager::fgInstance = 0;
@@ -67,6 +72,48 @@ void TG4SDManager::Initialize()
   // G4cout << "TG4SDManager::Initialize done" << G4endl;
 }
 
+//_____________________________________________________________________________
+void TG4SDManager::LateInitialize(TG4ScoreWeightCalculator swc)
+{
+  // Apply score weight if use of Geant4 scoring is activated
+
+   auto g4ScoringManager = G4ScoringManager::GetScoringManagerIfExist();
+   if (g4ScoringManager == nullptr ) return;
+
+   fScoreWeightCalculator = swc;
+
+   G4ScoreWeightCalculator g4Swc = [&calculator = fScoreWeightCalculator](const G4Step* step) -> G4double {
+     Double_t ekin = step->GetTrack()->GetKineticEnergy();
+     Int_t pdg = step->GetTrack()->GetParticleDefinition()->GetPDGEncoding();
+     return calculator(pdg, ekin);
+   };
+
+   // Loop over existing scoring meshes
+  auto nofMesh = g4ScoringManager->GetNumberOfMesh();
+  if (nofMesh < 1) return;
+  // G4cout << "Processing scorers for " << nofMesh << " meshes" << G4endl;
+  std::size_t counter = 0;
+  for (std::size_t i = 0; i < nofMesh; ++i) {
+    auto mesh = g4ScoringManager->GetMesh((G4int)i);
+    const auto mfd = mesh->GetMFD();
+    G4int nps = mfd->GetNumberOfPrimitives();
+    for (G4int i = 0; i < nps; ++i) {
+      auto scorer = mfd->GetPrimitive(i);
+      // G4cout << "Looping over " << scorer->GetName() << G4endl;
+      if (scorer->IsScoreWeighted()) {
+        // G4cout << " is weightScoring activated "  << scorer->IsScoreWeighted() << G4endl;
+        scorer->SetScoreWeightCalculator(g4Swc);
+        ++counter;
+      }
+    }
+  }
+
+  if (counter > 0) {
+    G4cout << "### User score weight calculator set to " << counter << " scorers."
+           << G4endl;
+  }
+}
+
 //_____________________________________________________________________________
 Int_t TG4SDManager::VolId(const Text_t* volName) const
 {

source/run/include/TG4RunConfiguration.h

@@ -15,6 +15,8 @@
 ///
 /// \author I. Hrivnacova; IPN Orsay
 
+#include "TG4ScoreWeightCalculator.h"
+
 #include <Rtypes.h>
 #include <TString.h>
 
@@ -103,6 +105,7 @@ class TG4RunConfiguration
   void SetParameter(const TString& name, Double_t value);
   void SetSpecialCutsOld();
   void SetUseOfG4Scoring();
+  void SetScoreWeightCalculator(TG4ScoreWeightCalculator swc);
 
   // get methods
   TString GetUserGeometry() const;
@@ -112,7 +115,9 @@ class TG4RunConfiguration
   Bool_t IsSpecialCuts() const;
   Bool_t IsSpecialCutsOld() const;
   Bool_t IsUseOfG4Scoring() const;
+  Bool_t IsUseOfScoreWeighting() const;
   Bool_t IsMTApplication() const;
+  TG4ScoreWeightCalculator GetScoreWeightCalculator() const;
 
  protected:
   // data members
@@ -125,9 +130,10 @@ class TG4RunConfiguration
   Bool_t fSpecialCuts;              ///< option for special cuts
   Bool_t fSpecialCutsOld;           ///< option for special cuts old
   Bool_t fUseOfG4Scoring;           ///< option to activate G4 commmand-line scoring
+  Bool_t fUseOfScoreWeighting;      ///< option to activate score weighting
   G4UImessenger* fAGDDMessenger;    //!< XML messenger
   G4UImessenger* fGDMLMessenger;    //!< XML messenger
-
+  TG4ScoreWeightCalculator fScoreWeightCalculator; //!< User Scoring Weight Calculator
   /// The map of special parameters which need to be set before creating TGeant4
   /// Actually used for monopole properties:
   /// monopoleMass, monopoleElCharge, monopoleMagCharge
@@ -150,6 +156,13 @@ inline void TG4RunConfiguration::SetUseOfG4Scoring()
   fUseOfG4Scoring = true;
 }
 
+/// Set User Scoring Weight Calculator
+inline void TG4RunConfiguration::SetScoreWeightCalculator(TG4ScoreWeightCalculator swc)
+{
+  fUseOfScoreWeighting = true;
+  fScoreWeightCalculator = swc;
+}
+
 /// Return physics list selection
 inline TString TG4RunConfiguration::GetPhysicsListSelection() const
 { 
@@ -161,4 +174,14 @@ inline Bool_t TG4RunConfiguration::IsUseOfG4Scoring() const
   return fUseOfG4Scoring;
 }
 
+inline Bool_t TG4RunConfiguration::IsUseOfScoreWeighting() const
+{
+  return fUseOfScoreWeighting;
+}
+
+inline TG4ScoreWeightCalculator TG4RunConfiguration::GetScoreWeightCalculator() const
+{
+  return fScoreWeightCalculator;
+}
+
 #endif // TG4V_RUN_CONFIGURATION_H

source/run/src/TG4RunConfiguration.cxx

@@ -50,6 +50,7 @@ TG4RunConfiguration::TG4RunConfiguration(const TString& userGeometry,
     fSpecialCuts(false),
     fSpecialCutsOld(false),
     fUseOfG4Scoring(false),
+    fUseOfScoreWeighting(false),
     fAGDDMessenger(0),
     fGDMLMessenger(0),
     fParameters()

source/run/src/TG4RunManager.cxx

@@ -54,7 +54,6 @@
 #include <G4Version.hh>
 #include <Randomize.hh>
 
-
 #ifdef USE_G4ROOT
 #include <TG4RootNavMgr.h>
 #endif
@@ -132,14 +131,12 @@ TG4RunManager::TG4RunManager(
 
   if (isMaster) {
     fgMasterInstance = this;
-
-    // create and configure G4 run manager
-    ConfigureRunManager();
-
     if (runConfiguration->IsUseOfG4Scoring()) {
       // activate G4 command-line scoring
       G4ScoringManager::GetScoringManager();
     }
+    // create and configure G4 run manager
+    ConfigureRunManager();
   }
   else {
     // Get G4 worker run manager
@@ -477,6 +474,12 @@ void TG4RunManager::LateInitialize()
   TG4PhysicsManager::Instance()->SetProcessActivation();
   TG4PhysicsManager::Instance()->RetrieveOpBoundaryProcess();
 
+  // late initialize SD manager
+  // (needed only if user sets score weight calculator)
+  if (fRunConfiguration->IsUseOfScoreWeighting()) {
+    TG4SDManager::Instance()->LateInitialize(fRunConfiguration->GetScoreWeightCalculator());
+  }
+
   // late initialize step manager
   TG4StepManager::Instance()->LateInitialize();