Update to TOF QC (#556)

* Update TOF digit data source in json (F. Ercolessi)

* Update binning of orbitID in Compressed Data task

* Add json for full raw data running (on flp)

* Add label-less mode for counter

- Add also more utilities to count entries

* Update TOF Digit task

- Add orbitID, BCTime, EventCounter histograms
- Add counters for hits in view of filtering of noisy channels
- Add per channel hit counter

* Fix counter filling and histogram making

* add config file for raw data compressed + diagnostics (#2)

Co-authored-by: Francesca Ercolessi <francesca.ercolessi@cern.ch>

* Update Tasks and json for FULL TOF running (#3)

* Installing JSON, update CrateNames (#4)

* Update crate number name in post processing

* Installing new TOF JSONs

* Reduce messages in post processing

* add task compressed+diagnostics

* Reword TOF RawData task

- Add comments
- Format

* Remove split tasks for Raw data

* Rework TOF json to execute merged task on RawData

- Rename tof.json to tofdigit.json
- Format json files

* Remove compilation of split RawData tasks

* Move implementation of counter to dedicated file

* Fix compilation warning when using external array

* Using counters for IndexE and TimeBC histograms

* Fix compilation issue

- Reverted to the header only scheme

* Remove orphan namespace

* fixed DRM counter fill

* move fill of hSlotPartMask in endOfCycle()

* change ILOG(INFO) to DEBUG

* Use counters instead of histos when filling hSlotPartMask

* fix non necessary change from LOG(INFO) to DEBUG

Co-authored-by: ercolessi <48760541+ercolessi@users.noreply.github.com>
Co-authored-by: Francesca Ercolessi <francesca.ercolessi@cern.ch>

Author: njacazio

Modules/TOF/CMakeLists.txt

@@ -5,8 +5,7 @@ add_library(QcTOF)
 target_sources(QcTOF 
                       # Tasks
               PRIVATE src/TaskDigits.cxx
-                      src/TaskCompressedData.cxx
-                      src/TaskDiagnostics.cxx
+                      src/TaskRaw.cxx
                       # Checkers
                       src/CheckDiagnostics.cxx
                       src/CheckCompressedData.cxx
@@ -42,8 +41,7 @@ install(TARGETS QcTOF
 add_root_dictionary(QcTOF
                             # Tasks
                     HEADERS include/TOF/TaskDigits.h
-                            include/TOF/TaskCompressedData.h
-                            include/TOF/TaskDiagnostics.h
+                            include/TOF/TaskRaw.h
                             # Checkers
                             include/TOF/CheckCompressedData.h
                             include/TOF/CheckDiagnostics.h
@@ -83,9 +81,9 @@ set_tests_properties(testQcTOF PROPERTIES TIMEOUT 20)
 
 # ---- Extra scripts ----
 
-install(FILES tof.json
-              tofcompressed.json
-              tofdiagnostics.json
+install(FILES toffull.json
+              tofdigits.json
+              tofraw.json
               tofpostprocessdiagnosticpercrate.json
         DESTINATION etc)
 

Modules/TOF/include/Base/Counter.h

@@ -12,15 +12,13 @@
 /// \file   Counter.h
 /// \author Nicolo' Jacazio
 /// \since 24/03/2020
-/// \brief Utilities to count events and fill histograms at the end of the main processing loops
+/// \brief Utilities to count events and fill histograms at the end of the main processing loops.
+///        Can be used to count labelled and non labelled events and fill histograms only once.
 ///
 
 #ifndef QC_MODULE_TOF_COUNTER_H
 #define QC_MODULE_TOF_COUNTER_H
 
-// #define ENABLE_COUNTER_DEBUG_MODE // Flag used to enable more printing and more debug
-// #define ENABLE_PRINT_HISTOGRAMS_MODE // Flag used to enable more printing and more debug
-
 // ROOT includes
 #include "TH1.h"
 
@@ -35,7 +33,7 @@ namespace o2::quality_control_modules::tof
 
 /// \brief Class to count events
 /// \author Nicolo' Jacazio
-template <const unsigned size, const char* labels[size]>
+template <const unsigned int size, const char* labels[size]>
 class Counter
 {
  public:
@@ -47,119 +45,202 @@ class Counter
 
   /// Function to increment a counter
   /// @param v Index in the counter array to increment
-  void Count(const unsigned int& v)
-  {
-    if (v > size) {
-      LOG(FATAL) << "Incrementing counter too far! " << v << "/" << Size();
-    }
-#ifdef ENABLE_COUNTER_DEBUG_MODE
-    LOG(INFO) << "Incrementing " << v << "/" << Size() << " to " << counter[v];
-#endif
-    counter[v]++;
-  }
+  void Count(const unsigned int& v);
 
   /// Function to reset counters to zero
-  void Reset()
-  {
-    LOG(INFO) << "Resetting Counter";
-    for (unsigned int i = 0; i < size; i++) {
-      counter[i] = 0;
-    }
-  }
+  void Reset();
+
+  /// Function to print the counter content
+  void Print();
+
+  /// Function to get the total number of counts
+  uint32_t Total();
+
+  /// Function to get the total number of counts added since last call
+  uint32_t TotalNew();
+
+  /// Function to get the total number of counts and reset the counts
+  uint32_t TotalAndReset();
 
   /// Function to get how many counts where observed
   /// @return Returns the number of counts observed for a particular index
   uint32_t HowMany(const unsigned int& pos) const { return counter[pos]; }
 
   /// Function to make a histogram out of the counters
   /// @param h histogram to shape in order to have room for the counter size
-  void MakeHistogram(TH1* h) const
-  {
-    LOG(INFO) << "Making Histogram " << h->GetName() << " to accomodate counter of size " << size;
-    TAxis* axis = h->GetXaxis();
-    if (static_cast<unsigned int>(axis->GetNbins()) < size) {
-      LOG(FATAL) << "The histogram size (" << axis->GetNbins() << ") is not large enough to accomodate the counter size (" << size << ")";
+  void MakeHistogram(TH1* h) const;
+
+  /// Function to fill a histogram with the counters
+  /// @param h The histogram to fill
+  /// @param biny Y offset to fill to histogram, useful for TH2 and TH3
+  /// @param binz Z offset to fill to histogram, useful for TH3
+  void FillHistogram(TH1* h, const unsigned int& biny = 0, const unsigned int& binz = 0) const;
+
+  /// Getter for the size
+  /// @return Returns the size of the counter
+  unsigned int Size() const { return size; }
+
+ private:
+  // static_assert((sizeof(labels) / sizeof(const char*)) == size, "size of the counter and the one of the labels must coincide");
+  /// Containers to fill
+  std::array<uint32_t, size> counter = { 0 };
+  uint32_t mTotal = 0;
+};
+
+////////////////////
+// Implementation //
+////////////////////
+
+// #define ENABLE_COUNTER_DEBUG_MODE // Flag used to enable more printing and more debug
+// #define ENABLE_PRINT_HISTOGRAMS_MODE // Flag used to enable more printing and more debug
+
+template <const unsigned int size, const char* labels[size]>
+void Counter<size, labels>::Count(const unsigned int& v)
+{
+  if (v > size) {
+    LOG(FATAL) << "Incrementing counter too far! " << v << "/" << size;
+  }
+#ifdef ENABLE_COUNTER_DEBUG_MODE
+  LOG(INFO) << "Incrementing " << v << "/" << size << " to " << counter[v];
+#endif
+  counter[v]++;
+}
+
+template <const unsigned int size, const char* labels[size]>
+void Counter<size, labels>::Reset()
+{
+  LOG(DEBUG) << "Resetting Counter";
+  for (unsigned int i = 0; i < size; i++) {
+    counter[i] = 0;
+  }
+}
+
+template <const unsigned int size, const char* labels[size]>
+void Counter<size, labels>::Print()
+{
+  for (unsigned int i = 0; i < size; i++) {
+    if (labels) {
+      LOG(DEBUG) << "Bin " << i << "/" << size - 1 << " " << labels[i] << " = " << HowMany(i);
+    } else {
+      LOG(DEBUG) << "Bin " << i << "/" << size - 1 << " = " << HowMany(i);
     }
-    h->Reset();
-    unsigned int histo_size = size;
+  }
+}
+
+template <const unsigned int size, const char* labels[size]>
+uint32_t Counter<size, labels>::Total()
+{
+  uint32_t sum = 0;
+  for (unsigned int i = 0; i < size; i++) {
+    sum += counter[i];
+  }
+  mTotal = sum;
+  return sum;
+}
+
+template <const unsigned int size, const char* labels[size]>
+uint32_t Counter<size, labels>::TotalNew()
+{
+  uint32_t sum = mTotal;
+  return sum - Total();
+}
+
+template <const unsigned int size, const char* labels[size]>
+uint32_t Counter<size, labels>::TotalAndReset()
+{
+  uint32_t sum = Total();
+  Reset();
+  return sum;
+}
+
+template <const unsigned int size, const char* labels[size]>
+void Counter<size, labels>::MakeHistogram(TH1* h) const
+{
+  LOG(DEBUG) << "Making Histogram " << h->GetName() << " to accomodate counter of size " << size;
+  TAxis* axis = h->GetXaxis();
+  if (static_cast<unsigned int>(axis->GetNbins()) < size) {
+    LOG(FATAL) << "The histogram size (" << axis->GetNbins() << ") is not large enough to accomodate the counter size (" << size << ")";
+  }
+  h->Reset();
+  unsigned int histo_size = size;
+  if (labels) { // Only if labels are defined
     for (unsigned int i = 0; i < size; i++) {
-      if (labels[i] && labels[i][0]) {
+      if (labels[i] && !labels[i][0]) { // If label at position i is empty
+        LOG(DEBUG) << "Skipping label '" << labels[i] << "' at position " << i << "/" << size - 1;
         histo_size--;
       }
     }
-    if (histo_size == 0) {
-      LOG(FATAL) << "Asked to produce a histogram with size " << histo_size << ", check counter bin labels";
-    }
-    axis->Set(histo_size, 0, histo_size);
+  }
+  if (histo_size == 0) {
+    LOG(FATAL) << "Asked to produce a histogram with size " << histo_size << ", check counter bin labels";
+  } else {
+    LOG(DEBUG) << "Asked to produce a histogram with size " << histo_size << " out of the size " << size << " due to empty labels";
+  }
+
+  axis->Set(histo_size, 0, histo_size);
+  if (labels) { // Only if labels are defined
     unsigned int binx = 1;
     for (unsigned int i = 0; i < size; i++) {
-      if (labels[i] && labels[i][0]) {
+      if (labels[i] && !labels[i][0]) { // If label at position i is empty
         continue;
       }
-      LOG(INFO) << "Setting bin " << binx << "/" << histo_size << " to contain counter for " << labels[i] << " (index " << i << "/" << size - 1 << ")";
+      LOG(DEBUG) << "Setting bin " << binx << "/" << histo_size << " to contain counter for '" << labels[i] << "' (index " << i << "/" << size - 1 << ")";
       if (histo_size < binx) {
         LOG(FATAL) << "Making bin outside of histogram limits!";
       }
       axis->SetBinLabel(binx++, labels[i]);
     }
-    h->Reset();
+  }
+  h->Reset();
 #ifdef ENABLE_PRINT_HISTOGRAMS_MODE
-    h->Print("All");
+  h->Print("All");
 #endif
-  }
+}
 
-  /// Function to fill a histogram with the counters
-  /// @param h The histogram to fill
-  /// @param biny Y offset to fill to histogram, useful for TH2 and TH3
-  /// @param binz Z offset to fill to histogram, useful for TH3
-  void FillHistogram(TH1* h, const unsigned int& biny = 0, const unsigned int& binz = 0) const
-  {
-    LOG(INFO) << "Filling Histogram " << h->GetName() << " with counter contents";
-    unsigned int binx = 1;
-    const unsigned int nbinsx = h->GetNbinsX();
-    for (unsigned int i = 0; i < size; i++) {
-      if (labels[i] && labels[i][0]) {
-        if (counter[i] > 0) {
-          LOG(FATAL) << "Counter at position " << i << " was non empty (" << counter[i] << ") but was discarded because of empty labels";
-        }
-        continue;
+template <const unsigned int size, const char* labels[size]>
+void Counter<size, labels>::FillHistogram(TH1* h, const unsigned int& biny, const unsigned int& binz) const
+{
+  LOG(DEBUG) << "Filling Histogram " << h->GetName() << " with counter contents";
+  unsigned int binx = 1;
+  const unsigned int nbinsx = h->GetNbinsX();
+  for (unsigned int i = 0; i < size; i++) {
+    if (labels && labels[i] && !labels[i][0]) { // Labels are defined and label is empty
+      if (counter[i] > 0) {
+        LOG(FATAL) << "Counter at position " << i << " was non empty (" << counter[i] << ") but was discarded because of empty labels";
       }
+      continue;
+    }
 #ifdef ENABLE_COUNTER_DEBUG_MODE
-      LOG(INFO) << "Filling bin " << binx << " of position " << i << " of label " << labels[i] << " with " << counter[i];
+    LOG(INFO) << "Filling bin " << binx << " of position " << i << " of label " << labels[i] << " with " << counter[i];
 #endif
-      if (binx > nbinsx) {
-        LOG(FATAL) << "Filling histogram " << h->GetName() << " at position " << binx << " i.e. past its size (" << nbinsx << ")!";
-      }
-      const char* bin_label = h->GetXaxis()->GetBinLabel(binx);
-      if (strcmp(labels[i], bin_label) != 0) {
+    if (binx > nbinsx) {
+      LOG(FATAL) << "Filling histogram " << h->GetName() << " at position " << binx << " i.e. past its size (" << nbinsx << ")!";
+    }
+    const char* bin_label = h->GetXaxis()->GetBinLabel(binx);
+    if (labels) {
+      if (!labels[i]) {
+        LOG(DEBUG) << "Label at position " << i << " does not exist for axis label '" << bin_label << "'";
+      } else if (strcmp(labels[i], bin_label) != 0) {
         LOG(FATAL) << "Bin " << binx << " does not have the expected label '" << bin_label << "' vs '" << labels[i] << "'";
       }
-      if (counter[i] > 0) {
-        if (biny > 0) {
-          if (binz > 0) {
-            h->SetBinContent(binx, biny, binz, counter[i]);
-          } else {
-            h->SetBinContent(binx, biny, counter[i]);
-          }
+    }
+    if (counter[i] > 0) {
+      if (biny > 0) {
+        if (binz > 0) {
+          h->SetBinContent(binx, biny, binz, counter[i]);
         } else {
-          h->SetBinContent(binx, counter[i]);
+          h->SetBinContent(binx, biny, counter[i]);
         }
+      } else {
+        h->SetBinContent(binx, counter[i]);
       }
-      binx++;
     }
+    binx++;
+  }
 #ifdef ENABLE_PRINT_HISTOGRAMS_MODE
-    h->Print("All");
+  h->Print("All");
 #endif
-  }
-  /// Getter for the size
-  /// @return Returns the size of the counter
-  unsigned int Size() const { return size; }
-
- private:
-  // static_assert((sizeof(labels) / sizeof(const char*)) == size, "size of the counter and the one of the labels must coincide");
-  /// Containers to fill
-  std::array<uint32_t, size> counter = { 0 };
-};
+}
 
 } // namespace o2::quality_control_modules::tof
 

Modules/TOF/include/TOF/LinkDef.h

@@ -5,8 +5,7 @@
 
 // Tasks
 #pragma link C++ class o2::quality_control_modules::tof::TaskDigits+;
-#pragma link C++ class o2::quality_control_modules::tof::TaskCompressedData+;
-#pragma link C++ class o2::quality_control_modules::tof::TaskDiagnostics+;
+#pragma link C++ class o2::quality_control_modules::tof::TaskRaw+;
 // Checks
 #pragma link C++ class o2::quality_control_modules::tof::CheckDiagnostics+;
 #pragma link C++ class o2::quality_control_modules::tof::CheckCompressedData+;