ITS: diagnostic info inspection and adding QC check for ITSFeeTask (#572)

* ITS: diagnostic info inspection and adding QC check for ITSFeeTask

* minor amendment

* rename DDW variable, add warnings in case the ITS run number not found

Author: JianLIUhep

Modules/ITS/CMakeLists.txt

@@ -13,6 +13,7 @@ add_library(QcITS
             src/ITSFhrCheck.cxx
             src/ITSClusterCheck.cxx
             src/ITSTrackCheck.cxx
+            src/ITSFeeCheck.cxx
             )
 
 target_sources(QcITS PRIVATE src/TH2XlineReductor.cxx)
@@ -46,6 +47,7 @@ add_root_dictionary(QcITS
                             include/ITS/ITSFhrCheck.h
                             include/ITS/ITSClusterCheck.h
                             include/ITS/ITSTrackCheck.h
+                            include/ITS/ITSFeeCheck.h
                     LINKDEF include/ITS/LinkDef.h
                     BASENAME QcITS)
 

Modules/ITS/include/ITS/ITSFeeCheck.h

@@ -0,0 +1,48 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// 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   ITSFeeCheck.h
+/// \auhtor Liang Zhang
+/// \author Jian Liu
+///
+
+#ifndef QC_MODULE_ITS_ITSFEECHECK_H
+#define QC_MODULE_ITS_ITSFEECHECK_H
+
+#include "QualityControl/CheckInterface.h"
+
+namespace o2::quality_control_modules::its
+{
+
+/// \brief  Check the FAULT flag for the lanes
+
+class ITSFeeCheck : public o2::quality_control::checker::CheckInterface
+{
+
+ public:
+  /// Default constructor
+  ITSFeeCheck() = default;
+  /// Destructor
+  ~ITSFeeCheck() override = default;
+
+  // Override interface
+  void configure(std::string name) 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;
+
+ private:
+  ClassDefOverride(ITSFeeCheck, 1);
+};
+
+} // namespace o2::quality_control_modules::its
+
+#endif // QC_MODULE_ITS_ITSFeeCheck_H

Modules/ITS/include/ITS/ITSFeeTask.h

@@ -33,18 +33,23 @@ namespace o2::quality_control_modules::its
 /// \brief ITS FEE task aiming at 100% online data integrity checking
 class ITSFeeTask final : public TaskInterface
 {
-
-  struct GBTDdw { //GBT diagnostic word
-
-    union GBTBits {
-      struct payloadBits {
-        uint64_t flags2 : 36; /// 0:35  not defined yet
-        uint64_t flags1 : 36; /// 36:71  not defined yet
-        uint64_t id : 8;      /// 72:79  0xe0; Header Status Word (HSW) identifier
-      } payload;
-
-      uint8_t data8[16]; // 80 bits GBT word +  padding to 128 bits
-    } ddwBits;
+  struct GBTDiagnosticWord { //GBT diagnostic word
+    union {
+      uint64_t word0 = 0x0;
+      struct {
+        uint64_t laneStatus : 56;
+        uint16_t zero0 : 8;
+      } laneBits;
+    };
+    union {
+      uint64_t word1 = 0x0;
+      struct {
+        uint8_t flag1 : 4;
+        uint8_t index : 4;
+        uint8_t id : 8;
+        uint64_t padding : 48;
+      } indexBits;
+    };
   };
 
  public:
@@ -63,23 +68,30 @@ class ITSFeeTask final : public TaskInterface
 
  private:
   void setAxisTitle(TH1* object, const char* xTitle, const char* yTitle);
-  void createErrorTFPlots(int barrel);
+  void createFeePlots();
   void setPlotsFormat();
-  void getEnableLayers();
   void getRunNumber(); //for ITS commissioning only
   void resetGeneralPlots();
   static constexpr int NLayer = 7;
   static constexpr int NLayerIB = 3;
+  static constexpr int NLanes = 28;
+  static constexpr int NFees = 48 * 3 + 144 * 2;
+  static constexpr int NFlags = 4;
   const int StaveBoundary[NLayer + 1] = { 0, 12, 28, 48, 72, 102, 144, 192 };
-  std::array<bool, NLayer> mEnableLayers = { false };
   int mTimeFrameId = 0;
-  int mNTrigger = 13;
-  static constexpr int NError = 13;
-  TString mErrorType[NError] = { "ORBIT", "HB", "HBr", "HC", "PHYSICS", "PP", "CAL", "SOT", "EOT", "SOC", "EOC", "TF", "INT" }; //TODO: replace by defined error flags
+  static constexpr int mNTrigger = 13;
+  TString mTriggerType[mNTrigger] = { "ORBIT", "HB", "HBr", "HC", "PHYSICS", "PP", "CAL", "SOT", "EOT", "SOC", "EOC", "TF", "INT" };
+  std::string mLaneStatusFlag[NFlags] = { "OK", "WARNING", "ERROR", "FAULT" }; //b00 OK, b01 WARNING, b10 ERROR, b11 FAULT
 
   TH1I* mTFInfo; //count vs TF ID
-  TH2I* mErrorFlagVsFeeId;
-  TH1I* mErrorFlag;
+  TH2I* mTriggerVsFeeId;
+  TH1I* mTrigger;
+  TH2I* mLaneInfo;
+  TH2I* mFlag1Check;         //include transmission_timeout, packet_overflow, lane_starts_violation
+  TH2I* mIndexCheck;         //should be zero
+  TH2I* mIdCheck;            //should be 0x : e4
+  TH2I* mLaneStatus[NFlags]; //4 flags for each lane. 3/8/14 lane for each link. 3/2/2 link for each RU. TODO: remove the OK flag in these 4 flag plots, OK flag plot just used to debug.
+  TH1I* mProcessingTime;
   //TH1D* mInfoCanvas;//TODO: default, not implemented yet
   std::string mRunNumberPath;
   std::string mRunNumber = "000000";

Modules/ITS/include/ITS/LinkDef.h

@@ -14,5 +14,6 @@
 #pragma link C++ class o2::quality_control_modules::its::ITSFhrCheck + ;
 #pragma link C++ class o2::quality_control_modules::its::ITSClusterCheck + ;
 #pragma link C++ class o2::quality_control_modules::its::ITSTrackCheck + ;
+#pragma link C++ class o2::quality_control_modules::its::ITSFeeCheck + ;
 
 #endif

Modules/ITS/itsFee.json

@@ -23,7 +23,7 @@
             }
         },
         "tasks": {
-            "FEE": {
+            "ITSFEE": {
                 "active": "true",
                 "className": "o2::quality_control_modules::its::ITSFeeTask",
                 "moduleName": "QcITS",
@@ -36,7 +36,22 @@
                 },
                 "location": "remote"
             }
+        },
+        "checks": {
+            "ITSFeeCheck": {
+                "active": "true",
+                "className": "o2::quality_control_modules::its::ITSFeeCheck",
+                "moduleName": "QcITS",
+                "policy": "OnAny",
+                "detectorName": "ITS",
+                "dataSource": [{
+                    "type": "Task",
+                    "name": "ITSFEE",
+                    "MOs": ["LaneStatus/laneStatusFlagFAULT"]
+                }]
+            }
         }
+
     },
     "dataSamplingPolicies": [
         {

Modules/ITS/src/ITSClusterCheck.cxx

@@ -58,7 +58,7 @@ void ITSClusterCheck::beautify(std::shared_ptr<MonitorObject> mo, Quality checkR
     tInfo = new TText(0.1, 0.8, "Quality::GOOD");
     tInfo->SetTextColor(kGreen);
   } else if (checkResult == Quality::Bad) {
-    tInfo = new TText(0.1, 0.8, "Quality::GOOD");
+    tInfo = new TText(0.1, 0.8, "Quality::BAD");
     tInfo->SetTextColor(kRed);
   }
   tInfo->SetTextSize(17);

Modules/ITS/src/ITSFeeCheck.cxx

@@ -0,0 +1,68 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// 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   ITSFeeCheck.cxx
+/// \author LiAng Zhang
+/// \author Jian Liu
+///
+
+#include "ITS/ITSFeeCheck.h"
+#include "QualityControl/MonitorObject.h"
+#include "QualityControl/Quality.h"
+
+#include <fairlogger/Logger.h>
+#include <TList.h>
+#include <TH2.h>
+#include <TText.h>
+
+namespace o2::quality_control_modules::its
+{
+
+void ITSFeeCheck::configure(std::string) {}
+
+Quality ITSFeeCheck::check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap)
+{
+  auto mo = moMap->begin()->second;
+  Quality result = Quality::Null;
+  std::map<std::string, std::shared_ptr<MonitorObject>>::iterator iter;
+  for (iter = moMap->begin(); iter != moMap->end(); iter++) {
+    if (iter->second->getName() == "LaneStatus/laneStatusFlagFAULT") {
+      auto* h = dynamic_cast<TH2I*>(iter->second->getObject());
+      if (h->GetMaximum() > 0) {
+        result = Quality::Bad;
+      } else {
+        result = Quality::Good;
+      }
+    }
+  }
+  return result;
+}
+
+std::string ITSFeeCheck::getAcceptedType() { return "TH2I"; }
+
+void ITSFeeCheck::beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult)
+{
+  auto* h = dynamic_cast<TH2I*>(mo->getObject());
+  TText* tInfo;
+
+  if (checkResult == Quality::Good) {
+    tInfo = new TText(0.1, 0.8, "Quality::GOOD");
+    tInfo->SetTextColor(kGreen);
+  } else if (checkResult == Quality::Bad) {
+    tInfo = new TText(0.1, 0.8, "Quality::BAD");
+    tInfo->SetTextColor(kRed);
+  }
+  tInfo->SetTextSize(17);
+  tInfo->SetNDC();
+  h->GetListOfFunctions()->Add(tInfo);
+}
+
+} // namespace o2::quality_control_modules::its