[QC-810] Integration with GrpGeomHelper for GRP access in Tasks (#1586)

* [QC-810] Integration with GrpGeomHelper for GRP access in Tasks

* Create the GRP Geom Request if any field is enabled

Author: knopers8

Framework/CMakeLists.txt

@@ -113,6 +113,7 @@ target_link_libraries(O2QualityControl
                              O2::Mergers
                              O2::DataSampling
                              O2::DataFormatsQualityControl
+                             O2::DetectorsBase
                       PRIVATE Boost::system
                               ROOT::Gui
                               CURL::libcurl)

Framework/include/QualityControl/InfrastructureSpecReader.h

@@ -22,6 +22,7 @@
 #include "QualityControl/DataSourceSpec.h"
 #include "QualityControl/CheckSpec.h"
 #include "QualityControl/PostProcessingTaskSpec.h"
+#include "QualityControl/RecoRequestSpecs.h"
 #include <boost/property_tree/ptree_fwd.hpp>
 
 namespace o2::quality_control::core
@@ -53,6 +54,8 @@ postprocessing::PostProcessingTaskSpec readSpecEntry<postprocessing::PostProcess
 template <>
 ExternalTaskSpec readSpecEntry<ExternalTaskSpec>(std::string entryID, const boost::property_tree::ptree& entryTree, const boost::property_tree::ptree& wholeTree);
 template <>
+GRPGeomRequestSpec readSpecEntry<GRPGeomRequestSpec>(std::string entryID, const boost::property_tree::ptree& entryTree, const boost::property_tree::ptree& wholeTree);
+template <>
 CommonSpec readSpecEntry<CommonSpec>(std::string entryID, const boost::property_tree::ptree& entryTree, const boost::property_tree::ptree& wholeTree);
 
 // todo: section names should be enum.

Framework/include/QualityControl/RecoRequestSpecs.h

@@ -0,0 +1,48 @@
+// 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.
+
+#ifndef QUALITYCONTROL_RECOREQUESTSPECS_H
+#define QUALITYCONTROL_RECOREQUESTSPECS_H
+
+///
+/// \file   RecoRequestSpecs.h
+/// \author Piotr Konopka
+///
+
+//#include <DetectorsBase/GRPGeomHelper.h>
+#include <string>
+
+namespace o2::quality_control::core
+{
+
+// this reflects the GRPGeomRequest struct, but allows us to gather the values and fill the input specs at different stages
+struct GRPGeomRequestSpec {
+  std::string geomRequest = "None";
+
+  bool askGRPECS = false;
+  bool askGRPLHCIF = false;
+  bool askGRPMagField = false;
+  bool askMatLUT = false;
+  bool askTime = false;            // need orbit reset time for precise timestamp calculation
+  bool askOnceAllButField = false; // for all entries but field query only once
+  bool needPropagatorD = false;    // init also PropagatorD
+
+  bool anyRequestEnabled() const
+  {
+    return geomRequest != "None" || askGRPECS || askGRPLHCIF || askGRPMagField || askMatLUT || askTime || askOnceAllButField || needPropagatorD;
+  }
+};
+
+struct RecoDataRequestSpec {
+};
+} // namespace o2::quality_control::core
+
+#endif // QUALITYCONTROL_RECOREQUESTSPECS_H

Framework/include/QualityControl/TaskRunner.h

@@ -87,6 +87,8 @@ class TaskRunner : public framework::Task
   void init(framework::InitContext& iCtx) override;
   /// \brief TaskRunner's process callback
   void run(framework::ProcessingContext& pCtx) override;
+  /// \brief TaskRunner's finaliseCCDB callback
+  void finaliseCCDB(framework::ConcreteDataMatcher& matcher, void* obj) override;
 
   /// \brief TaskRunner's completion policy callback
   static framework::CompletionPolicy::CompletionOp completionPolicyCallback(o2::framework::InputSpan const& inputs);

Framework/include/QualityControl/TaskRunnerConfig.h

@@ -19,11 +19,17 @@
 
 #include <string>
 #include <unordered_map>
+#include <memory>
 
 #include <Framework/DataProcessorSpec.h>
 #include "QualityControl/Activity.h"
 #include "QualityControl/DiscardFileParameters.h"
 
+namespace o2::base
+{
+class GRPGeomRequest;
+}
+
 namespace o2::quality_control::core
 {
 
@@ -48,6 +54,7 @@ struct TaskRunnerConfig {
   int resetAfterCycles = 0;
   core::DiscardFileParameters infologgerDiscardParameters;
   Activity fallbackActivity;
+  std::shared_ptr<o2::base::GRPGeomRequest> grpGeomRequest;
 };
 
 } // namespace o2::quality_control::core

Framework/include/QualityControl/TaskSpec.h

@@ -22,6 +22,7 @@
 #include <unordered_map>
 
 #include "QualityControl/DataSourceSpec.h"
+#include "QualityControl/RecoRequestSpecs.h"
 
 namespace o2::quality_control::core
 {
@@ -70,6 +71,7 @@ struct TaskSpec {
   std::string mergingMode = "delta"; // todo as enum?
   int mergerCycleMultiplier = 1;
   std::vector<size_t> mergersPerLayer{ 1 };
+  GRPGeomRequestSpec grpGeomRequestSpec;
 };
 
 } // namespace o2::quality_control::core

Framework/src/InfrastructureSpecReader.cxx

@@ -138,6 +138,10 @@ TaskSpec InfrastructureSpecReader::readSpecEntry<TaskSpec>(std::string taskID, c
     }
   }
 
+  if (taskTree.count("grpGeomRequest") > 0) {
+    ts.grpGeomRequestSpec = readSpecEntry<GRPGeomRequestSpec>(ts.taskName, taskTree.get_child("grpGeomRequest"), wholeTree);
+  }
+
   return ts;
 }
 
@@ -322,6 +326,23 @@ ExternalTaskSpec
   return ets;
 }
 
+template <>
+GRPGeomRequestSpec
+  InfrastructureSpecReader::readSpecEntry<GRPGeomRequestSpec>(std::string, const boost::property_tree::ptree& grpGeomRequestTree, const boost::property_tree::ptree&)
+{
+  GRPGeomRequestSpec grpSpec;
+  grpSpec.geomRequest = grpGeomRequestTree.get<std::string>("geomRequest", grpSpec.geomRequest);
+  grpSpec.askGRPECS = grpGeomRequestTree.get<bool>("askGRPECS", grpSpec.askGRPECS);
+  grpSpec.askGRPLHCIF = grpGeomRequestTree.get<bool>("askGRPLHCIF", grpSpec.askGRPLHCIF);
+  grpSpec.askGRPMagField = grpGeomRequestTree.get<bool>("askGRPMagField", grpSpec.askGRPMagField);
+  grpSpec.askMatLUT = grpGeomRequestTree.get<bool>("askMatLUT", grpSpec.askMatLUT);
+  grpSpec.askTime = grpGeomRequestTree.get<bool>("askTime", grpSpec.askTime);
+  grpSpec.askOnceAllButField = grpGeomRequestTree.get<bool>("askOnceAllButField", grpSpec.askOnceAllButField);
+  grpSpec.needPropagatorD = grpGeomRequestTree.get<bool>("needPropagatorD", grpSpec.needPropagatorD);
+
+  return grpSpec;
+}
+
 std::string InfrastructureSpecReader::validateDetectorName(std::string name)
 {
   // name must be a detector code from DetID or one of the few allowed general names

Framework/src/TaskRunner.cxx

@@ -31,6 +31,7 @@
 #include <Framework/DataRefUtils.h>
 #include <Framework/EndOfStreamContext.h>
 #include <CommonUtils/ConfigurableParam.h>
+#include <DetectorsBase/GRPGeomHelper.h>
 
 #include "QualityControl/QcInfoLogger.h"
 #include "QualityControl/TaskFactory.h"
@@ -54,6 +55,7 @@ namespace o2::quality_control::core
 
 using namespace o2::framework;
 using namespace o2::header;
+using namespace o2::base;
 using namespace o2::configuration;
 using namespace o2::monitoring;
 using namespace std::chrono;
@@ -169,6 +171,10 @@ void TaskRunner::init(InitContext& iCtx)
   if (!ConfigParamGlo::keyValues.empty()) {
     conf::ConfigurableParam::updateFromString(ConfigParamGlo::keyValues);
   }
+  // load reco helpers
+  if (mTaskConfig.grpGeomRequest) {
+    GRPGeomHelper::instance().setRequest(mTaskConfig.grpGeomRequest);
+  }
 
   // init user's task
   mTask->setCcdbUrl(mTaskConfig.conditionUrl);
@@ -190,6 +196,10 @@ void TaskRunner::run(ProcessingContext& pCtx)
     startCycle();
   }
 
+  if (mTaskConfig.grpGeomRequest) {
+    GRPGeomHelper::instance().checkUpdates(pCtx);
+  }
+
   auto [dataReady, timerReady] = validateInputs(pCtx.inputs());
 
   if (dataReady) {
@@ -210,6 +220,15 @@ void TaskRunner::run(ProcessingContext& pCtx)
   }
 }
 
+void TaskRunner::finaliseCCDB(ConcreteDataMatcher& matcher, void* obj)
+{
+  if (mTaskConfig.grpGeomRequest) {
+    if (!GRPGeomHelper::instance().finaliseCCDB(matcher, obj)) {
+      ILOG(Warning, Devel) << "Could not update CCDB objects requested by GRPGeomHelper" << ENDM;
+    }
+  }
+}
+
 CompletionPolicy::CompletionOp TaskRunner::completionPolicyCallback(o2::framework::InputSpan const& inputs)
 {
   // fixme: we assume that there is one timer input and the rest are data inputs. If some other implicit inputs are

Framework/src/TaskRunnerFactory.cxx

@@ -27,6 +27,7 @@
 #include <Headers/DataHeader.h>
 #include <Framework/O2ControlLabels.h>
 #include <Framework/DataProcessorLabel.h>
+#include <DetectorsBase/GRPGeomHelper.h>
 
 namespace o2::quality_control::core
 {
@@ -72,6 +73,19 @@ TaskRunnerConfig TaskRunnerFactory::extractConfig(const CommonSpec& globalConfig
                       0,
                       Lifetime::Timer);
 
+  static std::unordered_map<std::string, o2::base::GRPGeomRequest::GeomRequest> const geomRequestFromString = {
+    { "None", o2::base::GRPGeomRequest::GeomRequest::None },
+    { "Aligned", o2::base::GRPGeomRequest::GeomRequest::Aligned },
+    { "Ideal", o2::base::GRPGeomRequest::GeomRequest::Ideal },
+    { "Alignments", o2::base::GRPGeomRequest::GeomRequest::Alignments }
+  };
+  const auto& grp = taskSpec.grpGeomRequestSpec;
+  auto grpGeomRequest = grp.anyRequestEnabled()                                                               //
+                          ? nullptr                                                                           //
+                          : std::make_shared<o2::base::GRPGeomRequest>(                                       //
+                              grp.askTime, grp.askGRPECS, grp.askGRPLHCIF, grp.askGRPMagField, grp.askMatLUT, //
+                              geomRequestFromString.at(grp.geomRequest), inputs, grp.askOnceAllButField, grp.needPropagatorD);
+
   OutputSpec monitorObjectsSpec{ { "mo" },
                                  TaskRunner::createTaskDataOrigin(taskSpec.detectorName),
                                  TaskRunner::createTaskDataDescription(taskSpec.taskName),
@@ -112,7 +126,8 @@ TaskRunnerConfig TaskRunnerFactory::extractConfig(const CommonSpec& globalConfig
     taskSpec.saveObjectsToFile,
     resetAfterCycles.value_or(taskSpec.resetAfterCycles),
     globalConfig.infologgerDiscardParameters,
-    fallbackActivity
+    fallbackActivity,
+    grpGeomRequest
   };
 }
 

README.md

@@ -73,6 +73,7 @@ For a general overview of our (O2) software, organization and processes, please
     * [Solving performance issues](doc/Advanced.md#solving-performance-issues)
     * [CCDB / QCDB](doc/Advanced.md#ccdb--qcdb)
         * [Access run conditions and calibrations from the CCDB](doc/Advanced.md#access-run-conditions-and-calibrations-from-the-ccdb)
+        * [Access GRP objects with GRP Geom Helper](doc/Advanced.md#access-grp-objects-with-grp-geom-helper)
         * [Custom metadata](doc/Advanced.md#custom-metadata)
         * [Details on the data storage format in the CCDB](doc/Advanced.md#details-on-the-data-storage-format-in-the-ccdb)
         * [Local CCDB setup](doc/Advanced.md#local-ccdb-setup)