Merge pull request AliceO2Group#18 from noferini/tof-dev

add event counter and tracing of empty crates in TOF decoding

Author: noferini

Detectors/TOF/base/include/TOFBase/Digit.h

@@ -116,9 +116,12 @@ struct ReadoutWindowData {
   o2::dataformats::RangeReference<int, int> refDiagnostic;
 
   // crate info for diagnostic patterns
-  int mNdiaCrate[72] = {0};
+  int mNdiaCrate[Geo::kNCrate] = {0};
+  int mDeltaBCCrate[Geo::kNCrate] = {0};
+  int mDeltaEventCounterCrate[Geo::kNCrate] = {0};
 
   InteractionRecord mFirstIR{0, 0};
+  int mEventCounter = 0;
 
   const InteractionRecord& getBCData() const { return mFirstIR; }
 
@@ -164,7 +167,14 @@ struct ReadoutWindowData {
   void setFirstEntryDia(int first) { refDiagnostic.setFirstEntry(first); }
   void setNEntriesDia(int ne) { refDiagnostic.setEntries(ne); }
 
-  ClassDefNV(ReadoutWindowData, 3);
+  void setEventCounter(int ev) { mEventCounter = ev; }
+  void setDeltaEventCounterCrate(int crate, int ev) { mDeltaEventCounterCrate[crate] = ev; }
+  int getEventCounter() const { return mEventCounter; }
+  int getDeltaEventCounterCrate(int crate) const { return mDeltaEventCounterCrate[crate]; }
+  void setDeltaBCCrate(int crate, int bc) { mDeltaBCCrate[crate] = bc; }
+  int getDeltaBCCrate(int crate) const { return mDeltaBCCrate[crate]; }
+
+  ClassDefNV(ReadoutWindowData, 4);
 };
 
 } // namespace tof

Detectors/TOF/base/include/TOFBase/WindowFiller.h

@@ -78,6 +78,8 @@ class WindowFiller
   void addPattern(const uint32_t val, int icrate, int orbit, int bc) { mCratePatterns.emplace_back(val, icrate, orbit * 3 + (bc + 100) / Geo::BC_IN_WINDOW); }
   void addCrateHeaderData(unsigned long orbit, int crate, int32_t bc, uint32_t eventCounter);
 
+  void setTraceEmptyCrates(bool val) { mTraceEmptyCrates = val; }
+
  protected:
   // info TOF timewindow
   uint64_t mReadoutWindowCurrent = 0;
@@ -91,6 +93,8 @@ class WindowFiller
   int mMaskNoiseRate = -1;
   int mChannelCounts[o2::tof::Geo::NCHANNELS]; // count of channel hits in the current TF (if MaskNoiseRate enabled)
 
+  bool mTraceEmptyCrates = 1; // set to 0 not to trace empty crates
+
   // digit info
   //std::vector<Digit>* mDigits;
 
@@ -145,7 +149,7 @@ class WindowFiller
     return true;
   }
 
-  ClassDefNV(WindowFiller, 1);
+  ClassDefNV(WindowFiller, 2);
 };
 } // namespace tof
 } // namespace o2

Detectors/TOF/base/src/WindowFiller.cxx

@@ -140,34 +140,59 @@ void WindowFiller::fillOutputContainer(std::vector<Digit>& digits)
     ReadoutWindowData info(first, ne);
     int orbit_shift = mReadoutWindowData.size() / Geo::NWINDOW_IN_ORBIT;
 
+    bool isCrateMissing[Geo::kNCrate];
+
     int bc_shift = -1;
-    if (mReadoutWindowData.size() >= mCrateHeaderData.size())
+    int eventcounter = -1;
+    if (mReadoutWindowData.size() >= mCrateHeaderData.size()) {
       bc_shift = (mReadoutWindowData.size() % Geo::NWINDOW_IN_ORBIT) * Geo::BC_IN_WINDOW; // insert default value
-    else {
+      eventcounter = mReadoutWindowData.size() % 4096;
+      for (int icrate = 0; icrate < Geo::kNCrate; icrate++)
+        isCrateMissing[icrate] = mTraceEmptyCrates;
+    } else {
       unsigned long irow = mReadoutWindowData.size();
       for (int icrate = 0; icrate < Geo::kNCrate; icrate++) {
         if (mCrateHeaderData[irow].bc[icrate] == -1) { // crate not read
+          isCrateMissing[icrate] = mTraceEmptyCrates;
           continue;
         }
+        isCrateMissing[icrate] = false;
         if (bc_shift == -1 || mCrateHeaderData[irow].bc[icrate] < bc_shift)
           bc_shift = mCrateHeaderData[irow].bc[icrate];
+        if (eventcounter == -1 || mCrateHeaderData[irow].eventCounter[icrate] < eventcounter)
+          eventcounter = mCrateHeaderData[irow].eventCounter[icrate];
       }
+
       if (bc_shift == -1)
         bc_shift = (mReadoutWindowData.size() % Geo::NWINDOW_IN_ORBIT) * Geo::BC_IN_WINDOW; // insert default value
+      if (eventcounter == -1)
+        eventcounter = mReadoutWindowData.size() % 4096; // insert default value
     }
 
     info.setBCData(mFirstIR.orbit + orbit_shift, mFirstIR.bc + bc_shift);
+    info.setEventCounter(eventcounter);
     int firstPattern = mPatterns.size();
     int npatterns = 0;
 
+    int icrateToBeChecked = 0;
+
     // check if patterns are in the current row
     for (std::vector<PatternData>::reverse_iterator it = mCratePatterns.rbegin(); it != mCratePatterns.rend(); ++it) {
-      if (it->row > mReadoutWindowCurrent)
+      if (it->row > mReadoutWindowCurrent) {
         break;
+      }
 
       if (it->row < mReadoutWindowCurrent) { // this should not happen
         LOG(ERROR) << "One pattern skipped because appears to occur early of the current row " << it->row << " < " << mReadoutWindowCurrent << " ?!";
       } else {
+        for (; icrateToBeChecked < it->icrate; icrateToBeChecked++) { // checks all crates before the one provided by patterns to see if they were read (fill pattern 0 for all not read)
+          if (isCrateMissing[icrateToBeChecked]) {
+            mPatterns.push_back(0);
+            info.addedDiagnostic(icrateToBeChecked);
+            npatterns++;
+          }
+        }
+
         mPatterns.push_back(it->pattern);
         info.addedDiagnostic(it->icrate);
 
@@ -176,6 +201,14 @@ void WindowFiller::fillOutputContainer(std::vector<Digit>& digits)
       mCratePatterns.pop_back();
     }
 
+    for (; icrateToBeChecked < Geo::kNCrate; icrateToBeChecked++) { // check if remaining crates were read otherwise add pattern=0 to crates not read
+      if (isCrateMissing[icrateToBeChecked]) {
+        mPatterns.push_back(0);
+        info.addedDiagnostic(icrateToBeChecked);
+        npatterns++;
+      }
+    }
+
     info.setFirstEntryDia(firstPattern);
     info.setNEntriesDia(npatterns);
     if (digits.size() || npatterns) {

Detectors/TOF/workflow/include/TOFWorkflowUtils/CompressedDecodingTask.h

@@ -68,6 +68,7 @@ class CompressedDecodingTask : public DecoderBase, public Task
   uint32_t mInitOrbit = 0;
   bool mRowFilter = false;
   bool mMaskNoise = false;
+  bool mSkipEmptyCrates = false;
   int mNoiseRate = 1000;
   TStopwatch mTimer;
 };

Detectors/TOF/workflow/src/CompressedDecodingTask.cxx

@@ -42,10 +42,14 @@ void CompressedDecodingTask::init(InitContext& ic)
   mMaskNoise = ic.options().get<bool>("mask-noise");
   mNoiseRate = ic.options().get<int>("noise-counts");
   mRowFilter = ic.options().get<bool>("row-filter");
+  mSkipEmptyCrates = ic.options().get<bool>("skip-empty-crates");
 
   if (mMaskNoise)
     mDecoder.maskNoiseRate(mNoiseRate);
 
+  if (mSkipEmptyCrates)
+    mDecoder.setTraceEmptyCrates(0);
+
   auto finishFunction = [this]() {
     LOG(INFO) << "CompressedDecoding finish";
   };
@@ -327,6 +331,7 @@ DataProcessorSpec getCompressedDecodingSpec(const std::string& inputDesc, bool c
     Options{
       {"row-filter", VariantType::Bool, false, {"Filter empty row"}},
       {"mask-noise", VariantType::Bool, false, {"Flag to mask noisy digits"}},
+      {"skip-empty-crates", VariantType::Bool, false, {"Flag not to trace empty crates"}},
       {"noise-counts", VariantType::Int, 1000, {"Counts in a single (TF) payload"}}}};
 }