CTP: CB filling scheme check added (#2007)

* CTP: CB filling scheme check added

* implementation of comments from Piotr

* clang fix

* clang fix

---------

Co-authored-by: Lucia Anna Tarasovicova <lucia.anna.husova@cern.ch>

Author: lhusova

Modules/CTP/CMakeLists.txt

@@ -2,7 +2,7 @@
 
 add_library(O2QcCTP)
 
-target_sources(O2QcCTP PRIVATE src/CountersQcTask.cxx  src/RawDataQcTask.cxx )
+target_sources(O2QcCTP PRIVATE src/RawDataReaderCheck.cxx  src/CountersQcTask.cxx  src/RawDataQcTask.cxx )
 
 target_include_directories(
   O2QcCTP
@@ -21,7 +21,8 @@ add_root_dictionary(O2QcCTP
                     HEADERS
   include/CTP/CountersQcTask.h
 include/CTP/RawDataQcTask.h
-                    LINKDEF include/CTP/LinkDef.h)
+      include/CTP/RawDataReaderCheck.h
+                          LINKDEF include/CTP/LinkDef.h)
 
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/CTP
   DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/QualityControl")
@@ -42,4 +43,3 @@ foreach(test ${TEST_SRCS})
     PROPERTY RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/tests)
   set_tests_properties(${test_name} PROPERTIES TIMEOUT 20)
 endforeach()
-

Modules/CTP/include/CTP/LinkDef.h

@@ -5,5 +5,7 @@
 
 #pragma link C++ class o2::quality_control_modules::ctp::CTPRawDataReaderTask + ;
 
-#pragma link C++ class o2::quality_control_modules::ctp::CTPCountersTask+;
+#pragma link C++ class o2::quality_control_modules::ctp::CTPCountersTask + ;
+#pragma link C++ class o2::quality_control_modules::ctp::RawDataReaderCheck + ;
+
 #endif

Modules/CTP/include/CTP/RawDataReaderCheck.h

@@ -0,0 +1,52 @@
+// Copyright 2019-2020 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   RawDataReaderCheck.h
+/// \author Lucia Anna Tarasovicova
+///
+
+#ifndef QC_MODULE_CTP_CTPRAWDATAREADERCHECK_H
+#define QC_MODULE_CTP_CTPRAWDATAREADERCHECK_H
+
+#include "QualityControl/CheckInterface.h"
+
+namespace o2::quality_control_modules::ctp
+{
+
+/// \brief  This class is checking the expected BC filling scheme
+/// \author Lucia Anna Tarasovicova
+class RawDataReaderCheck : public o2::quality_control::checker::CheckInterface
+{
+ public:
+  /// Default constructor
+  RawDataReaderCheck() = default;
+  /// Destructor
+  ~RawDataReaderCheck() override = default;
+
+  // Override interface
+  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(RawDataReaderCheck, 2);
+
+ private:
+  int getRunNumberFromMO(std::shared_ptr<MonitorObject> mo);
+
+  int mRunNumber;
+  long int mTimestamp;
+};
+
+} // namespace o2::quality_control_modules::ctp
+
+#endif // QC_MODULE_CTP_CTPRAWDATAREADERCHECK_H

Modules/CTP/src/RawDataQcTask.cxx

@@ -12,6 +12,7 @@
 ///
 /// \file   RawDataQcTask.cxx
 /// \author Marek Bombara
+/// \author Lucia Anna Tarasovicova
 ///
 
 #include <TCanvas.h>
@@ -23,8 +24,11 @@
 #include "Headers/RAWDataHeader.h"
 #include "DPLUtils/DPLRawParser.h"
 #include "DataFormatsCTP/Digits.h"
+#include "DataFormatsCTP/Configuration.h"
+#include "DataFormatsCTP/RunManager.h"
 #include <Framework/InputRecord.h>
 #include <Framework/InputRecordWalker.h>
+#include "Framework/TimingInfo.h"
 
 namespace o2::quality_control_modules::ctp
 {
@@ -70,16 +74,23 @@ void CTPRawDataReaderTask::monitorData(o2::framework::ProcessingContext& ctx)
   std::vector<o2::framework::InputSpec> filter;
   std::vector<o2::ctp::LumiInfo> lumiPointsHBF1;
   std::vector<o2::ctp::CTPDigit> outputDigits;
-  mDecoder.decodeRaw(ctx.inputs(), filter, outputDigits, lumiPointsHBF1);
+
+  o2::framework::InputRecord& inputs = ctx.inputs();
+  mDecoder.decodeRaw(inputs, filter, outputDigits, lumiPointsHBF1);
+
+  std::string nameInput = "MTVX";
+  auto indexTvx = o2::ctp::CTPInputsConfiguration::getInputIndexFromName(nameInput);
 
   for (auto const digit : outputDigits) {
     uint16_t bcid = digit.intRecord.bc;
     // LOG(info) << "bcid = " << bcid;
-    mHistoBC->Fill(bcid);
+    if (digit.CTPInputMask[indexTvx - 1]) {
+      mHistoBC->Fill(bcid);
+    }
     if (digit.CTPInputMask.count()) {
       for (int i = 0; i < o2::ctp::CTP_NINPUTS; i++) {
         if (digit.CTPInputMask[i]) {
-          // LOG(info) << "i of input = " << i;
+          // LOG(info) << "i of input = " << i;#
           mHistoInputs->Fill(i);
         }
       }

Modules/CTP/src/RawDataReaderCheck.cxx

@@ -0,0 +1,137 @@
+// Copyright 2019-2020 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   RawDataReaderCheck.cxx
+/// \author Lucia Anna Tarasovicova
+///
+
+#include "CTP/RawDataReaderCheck.h"
+#include "QualityControl/MonitorObject.h"
+#include "QualityControl/Quality.h"
+#include "QualityControl/QcInfoLogger.h"
+#include "DataFormatsCTP/Configuration.h"
+#include "DataFormatsCTP/RunManager.h"
+// ROOT
+#include <TH1.h>
+#include <TLatex.h>
+#include "DataFormatsCTP/Configuration.h"
+#include "CCDB/BasicCCDBManager.h"
+#include "DataFormatsParameters/GRPLHCIFData.h"
+
+#include <DataFormatsQualityControl/FlagReasons.h>
+
+using namespace std;
+using namespace o2::quality_control;
+using namespace o2::ctp;
+
+namespace o2::quality_control_modules::ctp
+{
+
+void RawDataReaderCheck::configure() {}
+
+Quality RawDataReaderCheck::check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap)
+{
+  Quality result = Quality::Null;
+
+  // you can get details about the activity via the object mActivity:
+  ILOG(Debug, Devel) << "Run " << getActivity()->mId << ", type: " << getActivity()->mType << ", beam: " << getActivity()->mBeamType << ENDM;
+  // and you can get your custom parameters:
+  ILOG(Debug, Devel) << "custom param physics.pp.myOwnKey1 : " << mCustomParameters.atOrDefaultValue("myOwnKey1", "physics", "pp", "default_value") << ENDM;
+
+  mRunNumber = getActivity()->mId;
+
+  map<string, string> metadata; // can be empty
+  auto mo = moMap->begin()->second;
+  mTimestamp = mo->getValidity().getMin();
+  auto lhcifdata = UserCodeInterface::retrieveConditionAny<o2::parameters::GRPLHCIFData>("GLO/Config/GRPLHCIF", metadata, mTimestamp);
+  auto bfilling = lhcifdata->getBunchFilling();
+  std::vector<int> bcs = bfilling.getFilledBCs();
+  o2::ctp::BCMask* bcmask;
+  std::bitset<o2::constants::lhc::LHCMaxBunches> lhcBC_bitset = bcmask->BCmask;
+  lhcBC_bitset.reset();
+
+  for (auto const& bc : bcs) {
+    lhcBC_bitset.set(bc, 1);
+  }
+
+  int threshold = 10;
+
+  for (auto& [moName, mo] : *moMap) {
+
+    (void)moName;
+    if (mo->getName() == "histobc") {
+      auto* h = dynamic_cast<TH1F*>(mo->getObject());
+
+      result = Quality::Good;
+      result.addMetadata("BC_id", "good");
+      for (int i = 0; i < o2::constants::lhc::LHCMaxBunches; i++) {
+        if (lhcBC_bitset[i] && h->GetBinContent(i + 1) < threshold) {
+          result = Quality::Bad;
+          result.updateMetadata(Form("BC_id%d", i + 1), "bad");
+          result.addReason(quality_control::FlagReasonFactory::Unknown(), "Bunch crossing is expected, but not measured");
+          break;
+        }
+        if (lhcBC_bitset[i] && h->GetBinContent(i + 1) == threshold) {
+          result = Quality::Medium;
+          result.updateMetadata(Form("BC_id%d", i + 1), "medium");
+          result.addReason(quality_control::FlagReasonFactory::Unknown(), "Bunch crossing is expected, at the threshold of background");
+        }
+        if (!lhcBC_bitset[i] && h->GetBinContent(i + 1) == threshold) {
+          result = Quality::Medium;
+          result.updateMetadata(Form("BC_id%d", i + 1), "medium");
+          result.addReason(quality_control::FlagReasonFactory::Unknown(), "Bunch crossing not expected, at the threshold of background");
+        }
+        if (!lhcBC_bitset[i] && h->GetBinContent(i + 1) > threshold) {
+          result = Quality::Bad;
+          result.updateMetadata(Form("BC_id%d", i + 1), "bad");
+          result.addReason(quality_control::FlagReasonFactory::Unknown(), "Bunch crossing not expected, but measured");
+          break;
+        }
+      }
+    }
+  }
+  return result;
+}
+
+std::string RawDataReaderCheck::getAcceptedType() { return "TH1"; }
+
+void RawDataReaderCheck::beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult)
+{
+  std::shared_ptr<TLatex> msg;
+  if (mo->getName() == "histobc") {
+    auto* h = dynamic_cast<TH1F*>(mo->getObject());
+
+    if (checkResult == Quality::Good) {
+      h->SetLineColor(kGreen);
+    } else if (checkResult == Quality::Bad) {
+      ILOG(Debug, Devel) << "Quality::Bad, setting to red" << ENDM;
+      msg = std::make_shared<TLatex>(0.15, 0.8, Form("Reason: %s", (std::get<1>(checkResult.getReasons()[0])).c_str()));
+      msg->SetTextColor(kRed);
+      msg->SetTextSize(0.06);
+      msg->SetTextFont(43);
+      msg->SetNDC();
+      h->GetListOfFunctions()->Add(msg->Clone());
+      h->SetLineColor(kRed);
+    } else if (checkResult == Quality::Medium) {
+      ILOG(Debug, Devel) << "Quality::medium, setting to orange" << ENDM;
+      msg = std::make_shared<TLatex>(0.15, 0.8, Form("Reason: %s", (std::get<1>(checkResult.getReasons()[0])).c_str()));
+      msg->SetTextColor(kOrange);
+      msg->SetTextSize(0.06);
+      msg->SetTextFont(43);
+      msg->SetNDC();
+      h->GetListOfFunctions()->Add(msg->Clone());
+      h->SetLineColor(kOrange);
+    }
+  }
+}
+
+} // namespace o2::quality_control_modules::ctp