[FDD] New histograms and checkers for FDD (#1749)

* [FDD] (1) Histogram to check the Charge saturation and checker implemaentation (2) Checkers for the SW and HW triggers (3) Add DeadChannelMap to GenericCheck (4) Add EventsInGateTime2ch histogram

* Protection against empty reasons in beautify function

* correct path for the deadChannel map

* Avoid having null pointer for dead channel map

---------

Co-authored-by: Arvind Khuntia <arvind.khuntia@cern.ch>

Author: arvindkhuntia

Modules/FIT/FDD/CMakeLists.txt

@@ -10,6 +10,7 @@ target_sources(O2QcFDD PRIVATE
                                src/PostProcTask.cxx
                                src/CFDEffCheck.cxx
                                src/OutOfBunchCollCheck.cxx
+                               src/TriggersSwVsTcmCheck.cxx
                                )
 
 target_include_directories(
@@ -35,6 +36,7 @@ add_root_dictionary(O2QcFDD
           include/FDD/PostProcTask.h
           include/FDD/CFDEffCheck.h
           include/FDD/OutOfBunchCollCheck.h
+          include/FDD/TriggersSwVsTcmCheck.h
   LINKDEF include/FDD/LinkDef.h)
 
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/FDD

Modules/FIT/FDD/include/FDD/CFDEffCheck.h

@@ -12,7 +12,7 @@
 ///
 /// \file   CFDEffCheck.h
 /// \author Sebastian Bysiak sbysiak@cern.ch
-///
+/// LATEST modification for FDD on 25.04.2023 (akhuntia@cern.ch)
 
 #ifndef QC_MODULE_FDD_FDDCFDEFFCHECK_H
 #define QC_MODULE_FDD_FDDCFDEFFCHECK_H

Modules/FIT/FDD/include/FDD/DigitQcTask.h

@@ -12,7 +12,7 @@
 ///
 /// \file   DigitQcTask.h
 /// \author Artur Furs afurs@cern.ch
-/// LATEST modification for FDD on 24.05.2022 (akhuntia@cern.ch)
+/// LATEST modification for FDD on 25.04.2023 (akhuntia@cern.ch)
 
 #ifndef QC_MODULE_FDD_FDDDIGITQCTASK_H
 #define QC_MODULE_FDD_FDDDIGITQCTASK_H
@@ -70,7 +70,6 @@ class DigitQcTask final : public TaskInterface
   constexpr static std::size_t sNCHANNELS_C = 8;
   constexpr static std::size_t sOrbitsPerTF = 256;
   constexpr static std::size_t sBCperOrbit = o2::constants::lhc::LHCMaxBunches;
-
   constexpr static float sCFDChannel2NS = o2::fdd::timePerTDC; // CFD channel width in ns
 
  private:
@@ -84,8 +83,9 @@ class DigitQcTask final : public TaskInterface
   double mTimeCurNS = 0.;
   int mTfCounter = 0;
   double mTimeSum = 0.;
-
   long mTFcreationTime = 0;
+  int mMinTimeGate = -192;
+  int mMaxTimeGate = 192;
 
   template <typename Param_t,
             typename = typename std::enable_if<std::is_floating_point<Param_t>::value ||
@@ -154,6 +154,8 @@ class DigitQcTask final : public TaskInterface
   int mTrgChargeLevelLow;
   int mTrgChargeLevelHigh;
   int mTrgOrGate;
+  int mBinMinADCSaturationCheck;
+  int mBinMaxADCSaturationCheck;
 
   // Object which will be published
   std::unique_ptr<TH2F> mHist2CorrTCMchAndPMch;
@@ -173,6 +175,8 @@ class DigitQcTask final : public TaskInterface
   std::unique_ptr<TH1F> mHistAverageTimeC;
   std::unique_ptr<TH1F> mHistChannelID;
   std::unique_ptr<TH1F> mHistCFDEff;
+  std::unique_ptr<TH1F> mHistGateTimeRatio2Ch;
+  std::unique_ptr<TH1F> mHistSaturationFraction;
   std::unique_ptr<TH2F> mHistTimeSum2Diff;
   std::unique_ptr<TH2F> mHistTriggersCorrelation;
   std::unique_ptr<TH1D> mHistCycleDuration;

Modules/FIT/FDD/include/FDD/GenericCheck.h

@@ -12,17 +12,18 @@
 ///
 /// \file   GenericCheck.h
 /// \author Sebastian Bysiak
-///
+/// LATEST modification for FDD on 25.04.2023 (akhuntia@cern.ch)
 
 #ifndef QC_MODULE_FDD_FDDGENERICCHECK_H
 #define QC_MODULE_FDD_FDDGENERICCHECK_H
 
 #include "QualityControl/CheckInterface.h"
 #include <DataFormatsQualityControl/FlagReasons.h>
+#include "DataFormatsFIT/DeadChannelMap.h"
+#include <DataFormatsQualityControl/FlagReasons.h>
 
 namespace o2::quality_control_modules::fdd
 {
-
 /// \brief  helper class to store acceptable limits for given quantity
 /// \author Sebastian Bysiak
 class SingleCheck
@@ -38,6 +39,7 @@ class SingleCheck
     mThresholdError = thresholdError;
     mShouldBeLower = shouldBeLower;
     mIsActive = isActive;
+    mBinNumberX = 0;
   };
   bool isActive() { return mIsActive; };
 
@@ -47,16 +49,17 @@ class SingleCheck
       return;
 
     std::string log = Form("%s : comparing  value = %f with thresholds = %f, %f", mCheckName.c_str(), checkedValue, mThresholdWarning, mThresholdError);
+    std::string reason;
     if (mShouldBeLower) {
       if (checkedValue > mThresholdError) {
         if (result.isBetterThan(Quality::Bad))
           result.set(Quality::Bad);
-        result.addReason(o2::quality_control::FlagReasonFactory::Unknown(), Form("%.3f > %.3f (%s error limit)", checkedValue, mThresholdError, mCheckName.c_str()));
+        reason = Form("%.3f > %.3f (%s error limit)", checkedValue, mThresholdError, mCheckName.c_str());
         log += "-> Bad";
       } else if (checkedValue > mThresholdWarning) {
         if (result.isBetterThan(Quality::Medium))
           result.set(Quality::Medium);
-        result.addReason(o2::quality_control::FlagReasonFactory::Unknown(), Form("%.3f > %.3f (%s warning limit)", checkedValue, mThresholdWarning, mCheckName.c_str()));
+        reason = Form("%.3f > %.3f (%s warning limit)", checkedValue, mThresholdWarning, mCheckName.c_str());
         log += "-> Medium";
       } else {
         log += "-> OK";
@@ -65,19 +68,37 @@ class SingleCheck
       if (checkedValue < mThresholdError) {
         if (result.isBetterThan(Quality::Bad))
           result.set(Quality::Bad);
-        result.addReason(o2::quality_control::FlagReasonFactory::Unknown(), Form("%.3f < %.3f (%s error limit)", checkedValue, mThresholdError, mCheckName.c_str()));
+        reason = Form("%.3f < %.3f (%s error limit)", checkedValue, mThresholdError, mCheckName.c_str());
         log += "-> Bad";
       } else if (checkedValue < mThresholdWarning) {
         if (result.isBetterThan(Quality::Medium))
           result.set(Quality::Medium);
-        result.addReason(o2::quality_control::FlagReasonFactory::Unknown(), Form("%.3f < %.3f (%s warning limit)", checkedValue, mThresholdWarning, mCheckName.c_str()));
+        reason = Form("%.3f < %.3f (%s warning limit)", checkedValue, mThresholdWarning, mCheckName.c_str());
         log += "-> Medium";
       } else {
         log += "-> OK";
       }
     }
+    if (reason.length()) {
+      if (mBinNumberX) {
+        reason += Form(" for channel %d", mBinNumberX);
+      }
+      result.addReason(o2::quality_control::FlagReasonFactory::Unknown(), reason);
+    }
+
     ILOG(Debug, Support) << log << ENDM;
   }
+  float getThresholdWarning()
+  {
+    return mThresholdWarning;
+  }
+  float getThresholdError()
+  {
+    return mThresholdError;
+  }
+
+ public:
+  int mBinNumberX;
 
  private:
   std::string mCheckName;
@@ -107,7 +128,8 @@ class GenericCheck : public o2::quality_control::checker::CheckInterface
 
  private:
   SingleCheck getCheckFromConfig(std::string);
-
+  SingleCheck mCheckMinThresholdY;
+  SingleCheck mCheckMaxThresholdY;
   SingleCheck mCheckMaxOverflowIntegralRatio;
 
   SingleCheck mCheckMinMeanX;
@@ -123,6 +145,11 @@ class GenericCheck : public o2::quality_control::checker::CheckInterface
 
   std::array<double, 4> mPositionMsgBox;
   std::string mNameObjOnCanvas;
+
+  constexpr static std::size_t sNCHANNELSPhy = 16;
+  o2::fit::DeadChannelMap* mDeadChannelMap;
+  std::string mDeadChannelMapStr;
+  std::string mPathDeadChannelMap;
 };
 
 } // namespace o2::quality_control_modules::fdd

Modules/FIT/FDD/include/FDD/LinkDef.h

@@ -10,4 +10,5 @@
 #pragma link C++ class o2::quality_control_modules::fdd::PostProcTask + ;
 #pragma link C++ class o2::quality_control_modules::fdd::CFDEffCheck + ;
 #pragma link C++ class o2::quality_control_modules::fdd::OutOfBunchCollCheck + ;
+#pragma link C++ class o2::quality_control_modules::fdd::TriggersSwVsTcmCheck + ;
 #endif

Modules/FIT/FDD/include/FDD/TriggersSwVsTcmCheck.h

@@ -0,0 +1,44 @@
+// Copyright 2023 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file   TriggersSwVsTcmCheck.h
+/// \author Dawid Skora dawid.mateusz.skora@cern.ch
+/// \Modification for FDD by arvind.khuntia@cern.ch (25.04.2023)
+
+#ifndef QC_MODULE_FDD_TRIGGERSSWVSTCMCHECK_H
+#define QC_MODULE_FDD_TRIGGERSSWVSTCMCHECK_H
+
+#include "QualityControl/CheckInterface.h"
+#include "FV0Base/Constants.h"
+
+namespace o2::quality_control_modules::fdd
+{
+class TriggersSwVsTcmCheck : public o2::quality_control::checker::CheckInterface
+{
+ public:
+  TriggersSwVsTcmCheck() = default;
+  ~TriggersSwVsTcmCheck() override = default;
+
+  void configure() override;
+  Quality check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap) override;
+  void beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult = Quality::Null) override;
+  std::string getAcceptedType() override;
+
+  ClassDefOverride(TriggersSwVsTcmCheck, 2);
+
+ private:
+  std::array<double, 4> mPositionMsgBox;
+};
+
+} // namespace o2::quality_control_modules::fdd
+
+#endif // QC_MODULE_FDD_TRIGGERSSWVSTCMCHECK_H

Modules/FIT/FDD/src/CFDEffCheck.cxx

@@ -84,7 +84,7 @@ void CFDEffCheck::configure()
     //          supply deadChannelMap by hand when running offline
     std::map<std::string, std::string> metadata;
     mDeadChannelMap = retrieveConditionAny<o2::fit::DeadChannelMap>(mPathDeadChannelMap, metadata, (long)-1);
-    if (!mDeadChannelMap->map.size()) {
+    if (!mDeadChannelMap || !mDeadChannelMap->map.size()) {
       ILOG(Error, Support) << "object \"" << mPathDeadChannelMap << "\" NOT retrieved (or empty). All channels assumed to be alive!" << ENDM;
       mDeadChannelMap = new o2::fit::DeadChannelMap();
       for (uint8_t chId = 0; chId < sNCHANNELS; ++chId) {
@@ -98,9 +98,10 @@ void CFDEffCheck::configure()
       mDeadChannelMapStr += (mDeadChannelMapStr.empty() ? "" : ",") + std::to_string(chId);
     }
   }
-  if (mDeadChannelMapStr.empty())
+  if (mDeadChannelMapStr.empty()) {
     mDeadChannelMapStr = "EMPTY";
-  ILOG(Info, Support) << "Loaded dead channel map: " << mDeadChannelMapStr << ENDM;
+  }
+  ILOG(Debug, Support) << "Loaded dead channel map: " << mDeadChannelMapStr << ENDM;
 }
 
 Quality CFDEffCheck::check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap)
@@ -189,7 +190,7 @@ void CFDEffCheck::beautify(std::shared_ptr<MonitorObject> mo, Quality checkResul
     lineWarning->SetLineColor(kOrange);
     h->GetListOfFunctions()->Add(lineError);
     h->GetListOfFunctions()->Add(lineWarning);
-    h->SetStats(0);
+    h->SetStats(1);
   }
 }
 

Modules/FIT/FDD/src/DigitQcTask.cxx

@@ -12,7 +12,7 @@
 ///
 /// \file   DigitQcTask.cxx
 /// \author Artur Furs afurs@cern.ch
-/// LATEST modification for FDD on 24.08.2022 (sbysiak@cern.ch)
+/// LATEST modification for FDD on 25.04.2023 (akhuntia@cern.ch)
 
 #include "FDD/DigitQcTask.h"
 #include "TCanvas.h"
@@ -129,7 +129,8 @@ bool DigitQcTask::chIsVertexEvent(const o2::fdd::ChannelData chd)
   return (chd.getFlag(o2::fdd::ChannelData::kIsCFDinADCgate) &&
           !(chd.getFlag(o2::fdd::ChannelData::kIsTimeInfoNOTvalid) || chd.getFlag(o2::fdd::ChannelData::kIsTimeInfoLate) || chd.getFlag(o2::fdd::ChannelData::kIsTimeInfoLost)) &&
           std::abs(static_cast<Int_t>(chd.mTime)) < mTrgOrGate &&
-          !chd.getFlag(o2::fdd::ChannelData::kIsAmpHigh));
+          static_cast<Int_t>(chd.mChargeADC) > mTrgChargeLevelLow &&
+          static_cast<Int_t>(chd.mChargeADC) < mTrgChargeLevelHigh);
 }
 
 void DigitQcTask::initialize(o2::framework::InitContext& /*ctx*/)
@@ -175,6 +176,10 @@ void DigitQcTask::initialize(o2::framework::InitContext& /*ctx*/)
   mTrgChargeLevelHigh = getNumericalParameter("trgChargeLevelHigh", 4095);
   mTrgThresholdTimeLow = getNumericalParameter("trgThresholdTimeLow", -192);
   mTrgThresholdTimeHigh = getNumericalParameter("trgThresholdTimeHigh", 192);
+  mBinMinADCSaturationCheck = getNumericalParameter("BinMinADCSaturationCheck", 1);
+  mBinMaxADCSaturationCheck = getNumericalParameter("BinMaxADCSaturationCheck", 3600);
+  mMinTimeGate = getNumericalParameter("minGateTimeForRatioHistogram", -192);
+  mMaxTimeGate = getNumericalParameter("maxGateTimeForRatioHistogram", 192);
   if (mTrgModeSide == TrgModeSide::kAplusC) {
     mTrgThresholdCenA = getNumericalParameter("trgThresholdCenA", 20);
     mTrgThresholdSCenA = getNumericalParameter("trgThresholdSCenA", 10);
@@ -286,7 +291,10 @@ void DigitQcTask::initialize(o2::framework::InitContext& /*ctx*/)
   mHistTimeSum2Diff->GetYaxis()->SetRangeUser(-5, 5);
   mHistNumADC = std::make_unique<TH1F>("HistNumADC", "HistNumADC", sNCHANNELS_PM, 0, sNCHANNELS_PM);
   mHistNumCFD = std::make_unique<TH1F>("HistNumCFD", "HistNumCFD", sNCHANNELS_PM, 0, sNCHANNELS_PM);
-  mHistCFDEff = std::make_unique<TH1F>("CFD_efficiency", "CFD efficiency;ChannelID;efficiency", sNCHANNELS_PM, 0, sNCHANNELS_PM);
+  mHistCFDEff = std::make_unique<TH1F>("CFD_efficiency", "Fraction of events with CFD in ADC gate vs ChannelID;ChannelID;Event fraction with CFD in ADC gate", sNCHANNELS_PM, 0, sNCHANNELS_PM);
+  mHistSaturationFraction = std::make_unique<TH1F>("ADCChargeFractionInRange", Form("Fraction of charge in [%d, %d] ADC;Channel ID;Event fraction in [%d, %d] ADC", mBinMinADCSaturationCheck, mBinMaxADCSaturationCheck, mBinMinADCSaturationCheck, mBinMaxADCSaturationCheck), sNCHANNELS_PM, 0, sNCHANNELS_PM);
+  std::string gateTimeRatioTitle = "Ratio of events between time " + std::to_string(mMinTimeGate) + " and " + std::to_string(mMaxTimeGate);
+  mHistGateTimeRatio2Ch = std::make_unique<TH1F>("EventsInGateTime", gateTimeRatioTitle.c_str(), sNCHANNELS_PM, 0, sNCHANNELS_PM);
   mHistNchA = std::make_unique<TH1F>("NumChannelsA", "Number of channels(TCM), side A;Nch", sNCHANNELS_A, 0, sNCHANNELS_A);
   mHistNchC = std::make_unique<TH1F>("NumChannelsC", "Number of channels(TCM), side C;Nch", sNCHANNELS_C, 0, sNCHANNELS_C);
   mHistSumAmpA = std::make_unique<TH1F>("SumAmpA", "Sum of amplitudes(TCM), side A;", 5e3, 0, 5e3);
@@ -353,6 +361,8 @@ void DigitQcTask::initialize(o2::framework::InitContext& /*ctx*/)
   rebinFromConfig(); // after all histos are created
   // 1-dim hists
   getObjectsManager()->startPublishing(mHistCFDEff.get());
+  getObjectsManager()->startPublishing(mHistSaturationFraction.get());
+  getObjectsManager()->startPublishing(mHistGateTimeRatio2Ch.get());
   getObjectsManager()->startPublishing(mHistBC.get());
   getObjectsManager()->startPublishing(mHistNchA.get());
   getObjectsManager()->startPublishing(mHistNchC.get());
@@ -420,6 +430,8 @@ void DigitQcTask::startOfActivity(Activity& activity)
   mHistBC->Reset();
   mHistChDataBits->Reset();
   mHistCFDEff->Reset();
+  mHistSaturationFraction->Reset();
+  mHistGateTimeRatio2Ch->Reset();
   mHistNumADC->Reset();
   mHistNumCFD->Reset();
   mHistTimeSum2Diff->Reset();
@@ -823,6 +835,29 @@ void DigitQcTask::endOfCycle()
   // one has to set num. of entries manually because
   // default TH1Reductor gets only mean,stddev and entries (no integral)
   mHistCFDEff->Divide(mHistNumADC.get(), mHistNumCFD.get());
+  for (int iPM = 0; iPM < sNCHANNELS_PM; iPM++) {
+    double intNumerator = mHistAmp2Ch->ProjectionY("yNum", iPM + 1, iPM + 1)->Integral(mBinMinADCSaturationCheck, mBinMaxADCSaturationCheck);
+    double intDenominator = mHistAmp2Ch->ProjectionY("yDen", iPM + 1, iPM + 1)->Integral(mBinMinADCSaturationCheck, mHistAmp2Ch->GetNbinsY());
+    if (intDenominator)
+      mHistSaturationFraction->SetBinContent(iPM, intNumerator / intDenominator);
+  }
+
+  for (int channel = 0; channel <= sNCHANNELS_PM; channel++) {
+    float events_in_range = 0;
+    float events_per_channel = 0;
+    for (int bin_on_y_axis = 1; bin_on_y_axis <= mHistTime2Ch->GetNbinsY(); bin_on_y_axis++) {
+      if (mHistTime2Ch->GetYaxis()->GetBinLowEdge(bin_on_y_axis) > mMinTimeGate && mHistTime2Ch->GetYaxis()->GetBinLowEdge(bin_on_y_axis) < mMaxTimeGate) {
+        events_in_range += mHistTime2Ch->GetBinContent(channel + 1, bin_on_y_axis);
+      }
+      events_per_channel += mHistTime2Ch->GetBinContent(channel + 1, bin_on_y_axis);
+    }
+    if (events_per_channel) {
+      mHistGateTimeRatio2Ch->SetBinContent(channel + 1, events_in_range / events_per_channel);
+    } else {
+      mHistGateTimeRatio2Ch->SetBinContent(channel + 1, 0);
+    }
+  }
+  mHistSaturationFraction->GetYaxis()->SetRangeUser(0, 1.1);
   mHistCycleDurationRange->SetBinContent(1., mTimeMaxNS - mTimeMinNS);
   mHistCycleDurationRange->SetEntries(mTimeMaxNS - mTimeMinNS);
   mHistCycleDurationNTF->SetBinContent(1., mTfCounter);
@@ -847,6 +882,8 @@ void DigitQcTask::reset()
   mHistBC->Reset();
   mHistChDataBits->Reset();
   mHistCFDEff->Reset();
+  mHistSaturationFraction->Reset();
+  mHistGateTimeRatio2Ch->Reset();
   mHistNumADC->Reset();
   mHistNumCFD->Reset();
   mHistTimeSum2Diff->Reset();