Merge pull request #703 from kochebina/CoinSortOptions

Remove keep-options in policy for CoinSorter
OpenGATE · Sep 18, 2024 · c3bd0c8 · c3bd0c8
2 parents 8dffdc3 + 82ba48a
commit c3bd0c8
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 15 deletions.
diff --git a/source/digits_hits/include/GateCoincidenceSorter.hh b/source/digits_hits/include/GateCoincidenceSorter.hh
@@ -39,16 +39,29 @@ class GateDigitizerMgr;
 
 //    01/2016 Rewritten completely by [email protected]
 
+//    2023 Added to GND [email protected]
+
+/*
+  09/24 [email protected]
+  Simplification of number of options for multiple coincidences 
+  remove "keep" and replace (or remove if double) with "take", 
+  i.e. all coincidecnes are now written on disk
+  keepIfAllAreGoods = takeWinnerIfAllAreGoods
+  keepIfOnlyOneGood = takeWinnerIfOnlyOneGood
+  keepIfAnyIsGood = takeWinnerOfGoods
+  kKeepAll = removed
+*/
 typedef enum {kKillAll,
               kTakeAllGoods,
               kKillAllIfMultipleGoods,
               kTakeWinnerOfGoods,
               kTakeWinnerIfIsGood,
               kTakeWinnerIfAllAreGoods,
-              kKeepIfAllAreGoods,
-              kKeepIfOnlyOneGood,
-              kKeepIfAnyIsGood,
-              kKeepAll} multiple_policy_t;
+              kTakeWinnerIfOnlyOneGood
+              //kKeepIfOnlyOneGood,
+              //kKeepIfAnyIsGood,
+              //kKeepAll
+              } multiple_policy_t;
 
 
 

diff --git a/source/digits_hits/src/GateCoincidenceSorter.cc b/source/digits_hits/src/GateCoincidenceSorter.cc
@@ -43,7 +43,7 @@ GateCoincidenceSorter::GateCoincidenceSorter(GateDigitizerMgr* itsDigitizerMgr,
 	m_minS (-1),
 	m_maxDeltaZ ( -1),
     m_forceMinSecDifferenceToZero(false),	  
-    m_multiplesPolicy(kKeepIfAllAreGoods),
+    m_multiplesPolicy(kTakeWinnerIfAllAreGoods),
     m_allDigiOpenCoincGate(false),
     m_depth(1),
     m_presortBufferSize(256),
@@ -132,15 +132,31 @@ void GateCoincidenceSorter::SetMultiplesPolicy(const G4String& policy)
     else if (policy=="killAllIfMultipleGoods")
     	m_multiplesPolicy=kKillAllIfMultipleGoods;
     else if (policy=="keepIfAnyIsGood")
-    	m_multiplesPolicy=kKeepIfAnyIsGood;
+      {
+	m_multiplesPolicy= kTakeWinnerOfGoods;//kKeepIfAnyIsGood;
+	G4cout<<"WARNING (Coincidence Sorter): used policy keepIfAnyIsGood is outdated. Please, use takeWinnerOfGoods instead.\n";
+      }
     else if (policy=="keepIfOnlyOneGood")
-    	m_multiplesPolicy=kKeepIfOnlyOneGood;
-    else if (policy=="keepAll")
-    	m_multiplesPolicy=kKeepAll;
+      {
+      m_multiplesPolicy= kTakeWinnerIfOnlyOneGood;//kKeepIfOnlyOneGood;
+      G4cout<<"WARNING (Coincidence Sorter): used policy keepIfOnlyOneGood is outdated. Please, use takeWinnerIfOnlyOneGood instead.\n";
+      }
+    else if (policy=="takeWinnerIfOnlyOneGood")
+      {
+      m_multiplesPolicy= kTakeWinnerIfOnlyOneGood;
+      }
+
+    //else if (policy=="keepAll")
+    //	m_multiplesPolicy=kKeepAll;
     else {
-    	if (policy!="keepIfAllAreGoods")
-    	    G4cout<<"WARNING : policy not recognized, using default : keepMultiplesIfAllAreGoods\n";
-  	m_multiplesPolicy=kKeepIfAllAreGoods;
+      if(policy == "keepIfAllAreGoods")
+	G4cout<<"WARNING (Coincidence Sorter): used policy keepIfAllAreGoods is outdated. Please, use takeWinnerIfAllAreGoods instead.\n";
+      else
+    	if (policy!="takeWinnerIfAllAreGoods" )
+	  G4cout<<"WARNING : policy not recognized, using default : takeWinnerIfAllAreGoods\n";
+
+  	m_multiplesPolicy= kTakeWinnerIfAllAreGoods;//kKeepIfAllAreGoods;
+
     }
 }
 //------------------------------------------------------------------------------------------------------
@@ -454,9 +470,9 @@ void GateCoincidenceSorter::ProcessCompletedCoincidenceWindow(GateCoincidenceDig
       return;
     }
 
-    //G4cout<<"nGoods = "<<  nGoods<<G4endl;
+    /*//G4cout<<"nGoods = "<<  nGoods<<G4endl;
     // all the Keep* policies pass on a multi-coincidence rather than breaking into pairs
-    if( ( (m_multiplesPolicy==kKeepIfAnyIsGood) /*&& (nGoods>0)*/ ) || // if nGoods = 0, we don't get here
+    if( ( (m_multiplesPolicy==kKeepIfAnyIsGood) /*&& (nGoods>0)*/ /*) || // if nGoods = 0, we don't get here
     	( (m_multiplesPolicy==kKeepIfOnlyOneGood) && (nGoods==1)           ) ||
         ( (m_multiplesPolicy==kKeepIfAllAreGoods) && (nGoods==(nDigis*(nDigis-1)/2)) ) )
     {
@@ -470,6 +486,21 @@ void GateCoincidenceSorter::ProcessCompletedCoincidenceWindow(GateCoincidenceDig
       delete coincidence;
       return;
     }
+     */
+    if	( (m_multiplesPolicy==kTakeWinnerIfOnlyOneGood) && (nGoods==1)) 
+    {
+    	m_OutputCoincidenceDigiCollection->insert(coincidence);
+      return; // don't delete the coincidence
+    }
+    if( (m_multiplesPolicy==kTakeWinnerIfOnlyOneGood) )
+    {
+      delete coincidence;
+      return;
+    }
+
+
+
+
     // find winner and count the goods
     maxE = 0.0;
     nGoods = 0;

diff --git a/source/digits_hits/src/GateCoincidenceSorterMessenger.cc b/source/digits_hits/src/GateCoincidenceSorterMessenger.cc
@@ -89,7 +89,7 @@ GateCoincidenceSorterMessenger::GateCoincidenceSorterMessenger(GateCoincidenceSo
   cmdName = GetDirectoryName()+"MultiplesPolicy";
   MultiplePolicyCmd = new G4UIcmdWithAString(cmdName,this);
   MultiplePolicyCmd->SetGuidance("How to treat multiples coincidences");
-  MultiplePolicyCmd->SetCandidates("killAll takeAllGoods killAllIfMultipleGoods takeWinnerOfGoods takeWinnerIfIsGood takeWinnerIfAllAreGoods keepAll keepIfAnyIsGood keepIfOnlyOneGood keepIfAllAreGoods");
+  MultiplePolicyCmd->SetCandidates("killAll takeAllGoods killAllIfMultipleGoods takeWinnerOfGoods takeWinnerIfIsGood takeWinnerIfAllAreGoods takeWinnerIfOnlyOneGood keepIfAllAreGoods keepIfOnlyOneGood keepIfAnyIsGood");
 
   cmdName = GetDirectoryName()+"allDigiOpenCoincGate";
   AllDigiOpenCoincGateCmd = new G4UIcmdWithABool(cmdName,this);