O2-5395: Trivial collision cut for some digitizers

Adding a protection which cuts away collisions happening
before the start of a timeframe.

This is just a crude security measure to not get wrong digits
coming from such collisions.

To fully achieve the goal of https://its.cern.ch/jira/browse/O2-5395,
a more careful handling of these collisions need to be implemented
on a case-by-case (detector level) basis.

Author: sawenzel

Detectors/TRD/workflow/src/TRDDigitizerSpec.cxx

@@ -93,6 +93,7 @@ class TRDDPLDigitizerTask : public o2::base::BaseDPLDigitizer
     size_t currTrig = 0;                    // from which collision is the current TRD trigger (only needed for debug information)
     bool firstEvent = true;                 // Flag for the first event processed
 
+    // the interaction record marking the timeframe start
     auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
 
     TStopwatch timer;

Steer/DigitizerWorkflow/src/CPVDigitizerSpec.cxx

@@ -29,6 +29,7 @@
 #include "DetectorsBase/BaseDPLDigitizer.h"
 #include "SimConfig/DigiParams.h"
 #include "Framework/CCDBParamSpec.h"
+#include "DetectorsRaw/HBFUtils.h"
 
 using namespace o2::framework;
 using SubSpecificationType = o2::framework::DataAllocator::SubSpecificationType;
@@ -121,9 +122,21 @@ void DigitizerSpec::run(framework::ProcessingContext& pc)
   bool isLastStream = true;
   double eventTime = timesview[0].getTimeNS() - o2::cpv::CPVSimParams::Instance().mDeadTime; // checked above that list not empty
   int eventId = 0;
+
+  // the interaction record marking the timeframe start
+  auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
+
   // loop over all composite collisions given from context
   // (aka loop over all the interaction records)
   for (int collID = 0; collID < n; ++collID) {
+    // Note: Very crude filter to neglect collisions coming before
+    // the first interaction record of the timeframe. Remove this, once these collisions can be handled
+    // within the digitization routine. Collisions before this timeframe might impact digits of this timeframe.
+    // See https://its.cern.ch/jira/browse/O2-5395.
+    if (timesview[collID] < firstTF) {
+      LOG(info) << "Too early: Not digitizing collision " << collID;
+      continue;
+    }
 
     double dt = timesview[collID].getTimeNS() - eventTime; // start new PHOS readout, continue current or dead time?
     if (dt > mReadoutTime && dt < mDeadTime) {             // dead time, skip event

Steer/DigitizerWorkflow/src/FDDDigitizerSpec.cxx

@@ -30,6 +30,7 @@
 #include "DataFormatsFDD/ChannelData.h"
 #include "DataFormatsFDD/MCLabel.h"
 #include "DataFormatsFIT/DeadChannelMap.h"
+#include "DetectorsRaw/HBFUtils.h"
 
 using namespace o2::framework;
 using SubSpecificationType = o2::framework::DataAllocator::SubSpecificationType;
@@ -96,7 +97,18 @@ class FDDDPLDigitizerTask : public o2::base::BaseDPLDigitizer
     std::vector<o2::fdd::Hit> hits;
     o2::dataformats::MCTruthContainer<o2::fdd::MCLabel> labels;
 
+    // the interaction record marking the timeframe start
+    auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
+
     for (int collID = 0; collID < irecords.size(); ++collID) {
+      // Note: Very crude filter to neglect collisions coming before
+      // the first interaction record of the timeframe. Remove this, once these collisions can be handled
+      // within the digitization routine. Collisions before this timeframe might impact digits of this timeframe.
+      // See https://its.cern.ch/jira/browse/O2-5395.
+      if (irecords[collID] < firstTF) {
+        LOG(info) << "Too early: Not digitizing collision " << collID;
+        continue;
+      }
 
       const auto& irec = irecords[collID];
       mDigitizer.setInteractionRecord(irec);

Steer/DigitizerWorkflow/src/FT0DigitizerSpec.cxx

@@ -113,11 +113,23 @@ class FT0DPLDigitizerTask : public o2::base::BaseDPLDigitizer
     // o2::dataformats::MCTruthContainer<o2::ft0::MCLabel> labelAccum;
     o2::dataformats::MCTruthContainer<o2::ft0::MCLabel> labels;
 
+    // the interaction record marking the timeframe start
+    auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
+
     // mDigitizer.setMCLabels(&labels);
     auto& eventParts = context->getEventParts(withQED);
     // loop over all composite collisions given from context
     // (aka loop over all the interaction records)
     for (int collID = 0; collID < timesview.size(); ++collID) {
+      // Note: Very crude filter to neglect collisions coming before
+      // the first interaction record of the timeframe. Remove this, once these collisions can be handled
+      // within the digitization routine. Collisions before this timeframe might impact digits of this timeframe.
+      // See https://its.cern.ch/jira/browse/O2-5395.
+      if (timesview[collID] < firstTF) {
+        LOG(info) << "Too early: Not digitizing collision " << collID;
+        continue;
+      }
+
       mDigitizer.setInteractionRecord(timesview[collID]);
       LOG(debug) << " setInteractionRecord " << timesview[collID] << " bc " << mDigitizer.getBC() << " orbit " << mDigitizer.getOrbit();
       // for each collision, loop over the constituents event and source IDs

Steer/DigitizerWorkflow/src/FV0DigitizerSpec.cxx

@@ -29,6 +29,7 @@
 #include "DataFormatsFV0/MCLabel.h"
 #include "SimulationDataFormat/MCCompLabel.h"
 #include "DetectorsBase/BaseDPLDigitizer.h"
+#include "DetectorsRaw/HBFUtils.h"
 #include <TFile.h>
 
 using namespace o2::framework;
@@ -71,10 +72,22 @@ class FV0DPLDigitizerTask : public o2::base::BaseDPLDigitizer
     auto& irecords = context->getEventRecords(withQED); //TODO: QED implementation to be tested
     auto& eventParts = context->getEventParts(withQED); //TODO: QED implementation to be tested
 
+    // the interaction record marking the timeframe start
+    auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
+
     // loop over all composite collisions given from context
     // (aka loop over all the interaction records)
     std::vector<o2::fv0::Hit> hits;
     for (int collID = 0; collID < irecords.size(); ++collID) {
+      // Note: Very crude filter to neglect collisions coming before
+      // the first interaction record of the timeframe. Remove this, once these collisions can be handled
+      // within the digitization routine. Collisions before this timeframe might impact digits of this timeframe.
+      // See https://its.cern.ch/jira/browse/O2-5395.
+      if (irecords[collID] < firstTF) {
+        LOG(info) << "Too early: Not digitizing collision " << collID;
+        continue;
+      }
+
       mDigitizer.clear();
       const auto& irec = irecords[collID];
       mDigitizer.setInteractionRecord(irec);

Steer/DigitizerWorkflow/src/HMPIDDigitizerSpec.cxx

@@ -30,6 +30,7 @@
 #include "DetectorsBase/BaseDPLDigitizer.h"
 #include "DetectorsCommonDataFormats/DetID.h"
 #include <SimConfig/DigiParams.h>
+#include "DetectorsRaw/HBFUtils.h"
 
 using namespace o2::framework;
 using SubSpecificationType = o2::framework::DataAllocator::SubSpecificationType;
@@ -95,9 +96,21 @@ class HMPIDDPLDigitizerTask : public o2::base::BaseDPLDigitizer
       mIntRecord.push_back(o2::hmpid::Trigger(o2::InteractionRecord(mDigitizer.getBc(), mDigitizer.getOrbit()), first, digitsAccum.size() - first));
     };
 
+    // the interaction record marking the timeframe start
+    auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
+
     // loop over all composite collisions given from context
     // (aka loop over all the interaction records)
     for (int collID = 0; collID < irecords.size(); ++collID) {
+      // Note: Very crude filter to neglect collisions coming before
+      // the first interaction record of the timeframe. Remove this, once these collisions can be handled
+      // within the digitization routine. Collisions before this timeframe might impact digits of this timeframe.
+      // See https://its.cern.ch/jira/browse/O2-5395.
+      if (irecords[collID] < firstTF) {
+        LOG(info) << "Too early: Not digitizing collision " << collID;
+        continue;
+      }
+
       // try to start new readout cycle by setting the trigger time
       auto triggeraccepted = mDigitizer.setTriggerTime(irecords[collID].getTimeNS());
       if (triggeraccepted) {

Steer/DigitizerWorkflow/src/PHOSDigitizerSpec.cxx

@@ -25,6 +25,7 @@
 #include "PHOSBase/PHOSSimParams.h"
 #include "DataFormatsParameters/GRPObject.h"
 #include "DataFormatsPHOS/MCLabel.h"
+#include "DetectorsRaw/HBFUtils.h"
 #include <SimulationDataFormat/MCTruthContainer.h>
 
 using namespace o2::framework;
@@ -112,9 +113,22 @@ void DigitizerSpec::run(framework::ProcessingContext& pc)
   bool isLastStream = true;
   double eventTime = timesview[0].getTimeNS() - o2::phos::PHOSSimParams::Instance().mDeadTime; // checked above that list not empty
   int eventId = 0;
+
+  // the interaction record marking the timeframe start
+  auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
+
   // loop over all composite collisions given from context
   // (aka loop over all the interaction records)
   for (int collID = 0; collID < n; ++collID) {
+    // Note: Very crude filter to neglect collisions coming before
+    // the first interaction record of the timeframe. Remove this, once these collisions can be handled
+    // within the digitization routine. Collisions before this timeframe might impact digits of this timeframe.
+    // See https://its.cern.ch/jira/browse/O2-5395.
+    if (timesview[collID] < firstTF) {
+      LOG(info) << "Too early: Not digitizing collision " << collID;
+      continue;
+    }
+
     double dt = timesview[collID].getTimeNS() - eventTime; // start new PHOS readout, continue current or dead time?
     if (dt > mReadoutTime && dt < mDeadTime) {             // dead time, skip event
       continue;

Steer/DigitizerWorkflow/src/ZDCDigitizerSpec.cxx

@@ -35,6 +35,7 @@
 #include "SimConfig/DigiParams.h"
 #include "ZDCBase/ModuleConfig.h"
 #include "ZDCSimulation/SimCondition.h"
+#include "DetectorsRaw/HBFUtils.h"
 
 using namespace o2::framework;
 using SubSpecificationType = o2::framework::DataAllocator::SubSpecificationType;
@@ -108,7 +109,18 @@ class ZDCDPLDigitizerTask : public o2::base::BaseDPLDigitizer
     // (aka loop over all the interaction records)
     std::vector<o2::zdc::Hit> hits;
 
+    // the interaction record marking the timeframe start
+    auto firstTF = InteractionTimeRecord(o2::raw::HBFUtils::Instance().getFirstSampledTFIR(), 0);
+
     for (int collID = 0; collID < irecords.size(); ++collID) {
+      // Note: Very crude filter to neglect collisions coming before
+      // the first interaction record of the timeframe. Remove this, once these collisions can be handled
+      // within the digitization routine. Collisions before this timeframe might impact digits of this timeframe.
+      // See https://its.cern.ch/jira/browse/O2-5395.
+      if (irecords[collID] < firstTF) {
+        LOG(info) << "Too early: Not digitizing collision " << collID;
+        continue;
+      }
 
       const auto& irec = irecords[collID];
       mDigitizer.setInteractionRecord(irec);