Add more details in log messages about dropped digis and the sorting window

Author: gertvanhoey

core/opengate_core/opengate_lib/digitizer/GateCoincidenceSorterActor.cpp

@@ -176,7 +176,7 @@ void GateCoincidenceSorterActor::BeginOfRunActionMasterThread(int run_id) {
   // digis from all threads, so that the coincidence actor can identify
   // coincidences between singles, irrespective of the thread in which they were
   // simulated (prompt as well as random coincidences).
-  fTimeSorter = std::make_unique<GateTimeSorter>();
+  fTimeSorter = std::make_unique<GateTimeSorter>(fOutputDigiCollectionName);
   fTimeSorter->Init(fInputDigiCollection);
   fTimeSorter->SetSortingWindow(fSortingTime);
   fTimeSorter->SetMaxSize(fClearEveryNEvents);

core/opengate_core/opengate_lib/digitizer/GateDigitizerPileupActor.cpp

@@ -71,7 +71,7 @@ void GateDigitizerPileupActor::InitializeUserInfo(py::dict &user_info) {
 
 void GateDigitizerPileupActor::BeginOfRunActionMasterThread(int run_id) {
 
-  fTimeSorter = std::make_unique<GateTimeSorter>();
+  fTimeSorter = std::make_unique<GateTimeSorter>(fOutputDigiCollectionName);
   fTimeSorter->Init(fInputDigiCollection);
   fTimeSorter->SetSortingWindow(fSortingTime);
   fTimeSorter->SetMaxSize(fClearEveryNEvents);

core/opengate_core/opengate_lib/digitizer/GateTimeSorter.cpp

@@ -6,7 +6,7 @@
 #include <memory>
 #include <utility>
 
-GateTimeSorter::GateTimeSorter() {
+GateTimeSorter::GateTimeSorter(const std::string &name) : fName(name) {
   fNumWorkingThreads =
       std::max(1, G4Threading::GetNumberOfRunningWorkerThreads());
   fNumActiveWorkingThreads.store(fNumWorkingThreads);
@@ -326,6 +326,7 @@ void GateTimeSorter::Process() {
   while (!iter.IsAtEnd()) {
     const size_t digiIndex = fSortedCollectionA->GetSize();
     const double digiTime = *t;
+    fNumDigi++;
     // If a digi is older (lower GlobalTime value) than the newest digi that has
     // already been transferred to the output collection, then this digi must be
     // dropped to be able to guarantee time-monotonicity in the output
@@ -337,13 +338,14 @@ void GateTimeSorter::Process() {
     if (fMostRecentTimeDeparted.has_value() &&
         (digiTime < *fMostRecentTimeDeparted)) {
       ++fNumDroppedDigi;
+      fMaxDropDelta =
+          std::max(fMaxDropDelta, *fMostRecentTimeDeparted - digiTime);
       if (!fSortingWindowWarningIssued) {
-        std::cout << "The digis in " << fInputCollection->GetName()
-                  << " have non-monotonicities in the GlobalTime attribute "
-                     "that exceed the sorting time ("
-                  << fMinimumSortingWindow
-                  << " ns). Please increase the sorting window to avoid "
-                     "dropped digis\n";
+        std::cout << "The digis output by actor '"
+                  << fInputCollection->GetName()
+                  << "' have non-monotonicities in the GlobalTime attribute "
+                     "that exceed the sorting time in actor '"
+                  << fName << "' (" << fMinimumSortingWindow << " ns).\n";
         fSortingWindowWarningIssued = true;
       }
     } else {
@@ -414,10 +416,14 @@ void GateTimeSorter::Flush() {
   Prune();
   fFlushed = true;
   if (fNumDroppedDigi > 0) {
-    std::cout << fNumDroppedDigi
-              << " digis have been dropped while time-sorting. Please increase "
-                 "the sorting time to a value higher than "
-              << fMinimumSortingWindow << " ns\n";
+    const auto percentage =
+        static_cast<double>(fNumDroppedDigi) / fNumDigi * 100;
+    std::cout << fNumDroppedDigi << " digis (" << percentage
+              << " %) have been dropped while time-sorting in actor '" << fName
+              << "'. Please increase the sorting time to a value higher than "
+                 "the current "
+              << fMinimumSortingWindow << " ns (suggestion: > " << fMaxDropDelta
+              << "ns)\n";
   }
 }
 

core/opengate_core/opengate_lib/digitizer/GateTimeSorter.h

@@ -15,7 +15,7 @@ class GateDigiAttributesFiller;
 
 class GateTimeSorter {
 public:
-  GateTimeSorter();
+  GateTimeSorter(const std::string &name);
 
   void Init(GateDigiCollection *input);
 
@@ -93,11 +93,14 @@ class GateTimeSorter {
 
   // GateTimeSorter internal state
 
+  std::string fName{};
   bool fInitialized{false};
   bool fProcessingStarted{false};
   bool fFlushed{false};
   bool fSortingWindowWarningIssued{false};
   size_t fNumDroppedDigi{};
+  size_t fNumDigi{};
+  double fMaxDropDelta{};
   std::optional<double> fMostRecentTimeArrived;
   std::optional<double> fMostRecentTimeDeparted;
 };