Feat: add GPUErrorQA class

Author: ariedel-cern

Detectors/TPC/qc/include/TPCQC/GPUErrorQA.h

@@ -18,22 +18,20 @@
 #define AliceO2_TPC_QC_GPUERRORQA_H
 
 #include <memory>
-#include <gsl/span>
+#include <string>
+#include <vector>
+#include <unordered_map>
 
 // root includes
-#include "TH1.h"
 
 // o2 includes
 // #include "DataFormatsTPC/Defs.h"
 
-namespace o2
-{
-namespace tpc
-{
-namespace qc
+class TH1;
+namespace o2::tpc::qc
 {
 
-/// @brief  TPC QC task for errors from GPU reconstruction
+/// @brief TPC QC task for errors from GPU reconstruction
 ///
 /// This class is used to retrieve and visualize GPU errors
 /// according to corresponding error code and location.
@@ -47,23 +45,25 @@ class GPUErrorQA
   GPUErrorQA() = default;
 
   /// process gpu error reported by the reconstruction workflow
-  void processErrors(gsl::span<const std::array<uint32_t, 4>> errors);
+  void processErrors(std::vector<std::array<uint32_t, 4>> errors);
 
   /// Initialize all histograms
   void initializeHistograms();
 
   /// Reset all histograms
   void resetHistograms();
 
+  /// return histograms
+  const std::unordered_map<std::string, std::unique_ptr<TH1>>& getMapHist() const { return mMapHist; };
+
   /// Dump results to a file
   void dumpToFile(std::string filename);
 
  private:
-  std::unique_ptr<TH1F> mHist;
-  ClassDefNV(GPUErrorQA, 1)
+  std::unordered_map<std::string, std::unique_ptr<TH1>> mMapHist;
+
+  ClassDefNV(GPUErrorQA, 1);
 };
-} // namespace qc
-} // namespace tpc
-} // namespace o2
+} // namespace o2::tpc::qc
 
 #endif // AliceO2_TPC_QC_GPUERRORQA_H

Detectors/TPC/qc/src/GPUErrorQA.cxx

@@ -11,16 +11,13 @@
 
 #define _USE_MATH_DEFINES
 
-#include <cmath>
-#include <memory>
-
 // root includes
 #include "TFile.h"
-#include <TH1.h>
+#include "TH1I.h"
 
 // o2 includes
 #include "TPCQC/GPUErrorQA.h"
-#include "GPUErrors.h"
+#include "GPUDefMacros.h"
 
 ClassImp(o2::tpc::qc::GPUErrorQA);
 
@@ -30,26 +27,49 @@ using namespace o2::tpc::qc;
 void GPUErrorQA::initializeHistograms()
 {
   TH1::AddDirectory(false);
-  mHist = std::make_unique<TH1F>("ErrorCounter", "ErrorCounter", o2::gpu::GPUErrors::getMaxErrors(), 0, o2::gpu::GPUErrors::getMaxErrors());
+
+  // get gpu error names
+  // copied from GPUErrors.h
+  static std::unordered_map<uint32_t, const char*> errorNames = {
+#define GPUCA_ERROR_CODE(num, name, ...) {num, GPUCA_M_STR(name)},
+#include "GPUErrorCodes.h"
+#undef GPUCA_ERROR_CODE
+  };
+
+  // 1D histogram counting all reported errors
+  mMapHist["ErrorCounter"] = std::make_unique<TH1I>("ErrorCounter", "ErrorCounter", errorNames.size(), -0.5, errorNames.size() - 0.5);
+  mMapHist["ErrorCounter"]->GetXaxis()->SetTitle("Error Codes");
+  mMapHist["ErrorCounter"]->GetYaxis()->SetTitle("Entries");
+  // for convienence, label each bin with the error name
+  for (size_t bin = 1; bin < mMapHist["ErrorCounter"]->GetNbinsX(); bin++) {
+    auto const& it = errorNames.find(bin);
+    mMapHist["ErrorCounter"]->GetXaxis()->SetBinLabel(bin, it->second);
+  }
 }
 //______________________________________________________________________________
 void GPUErrorQA::resetHistograms()
 {
-  mHist->Reset();
+  for (const auto& pair : mMapHist) {
+    pair.second->Reset();
+  }
 }
 //______________________________________________________________________________
-void GPUErrorQA::processErrors(gsl::span<const std::array<uint32_t, 4>> errors)
+void GPUErrorQA::processErrors(std::vector<std::array<uint32_t, 4>> errors)
 {
   for (const auto& error : errors) {
     uint32_t errorCode = error[0];
-    mHist->Fill(static_cast<float>(errorCode));
+    mMapHist["ErrorCounter"]->AddBinContent(errorCode);
   }
 }
 
 //______________________________________________________________________________
 void GPUErrorQA::dumpToFile(const std::string filename)
 {
-  auto f = std::unique_ptr<TFile>(TFile::Open(filename.c_str(), "recreate"));
-  mHist->Write();
-  f->Close();
+  auto f = std::unique_ptr<TFile>(TFile::Open(filename.data(), "recreate"));
+  TObjArray arr;
+  arr.SetName("GPUErrorQA_Hists");
+  for (const auto& [name, hist] : mMapHist) {
+    arr.Add(hist.get());
+  }
+  arr.Write(arr.GetName(), TObject::kSingleKey);
 }