Migrate the propagation service to CCDB tables

Author: ktf

Common/TableProducer/propagationServiceV2.cxx

@@ -9,8 +9,8 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file propagationService.cxx
-/// \brief
+/// \file propagationServiceV2.cxx
+/// \brief V2: GRPMagField and MeanVertexObject migrated to declarative CCDB columns.
 /// \author ALICE
 
 //===============================================================
@@ -32,6 +32,11 @@
 #include "Common/Tools/TrackTuner.h"
 
 #include <CCDB/BasicCCDBManager.h>
+#include <DataFormatsCalibration/MeanVertexObject.h>
+#include <DataFormatsParameters/GRPMagField.h>
+#include <DetectorsBase/MatLayerCylSet.h>
+#include <DetectorsBase/Propagator.h>
+#include <Framework/ASoA.h>
 #include <Framework/AnalysisDataModel.h>
 #include <Framework/AnalysisHelpers.h>
 #include <Framework/AnalysisTask.h>
@@ -44,9 +49,27 @@
 
 #include <string>
 
+// Declarative CCDB columns for GRPMagField and MeanVertexObject.
+// MatLayerCylSet is intentionally excluded: it requires
+// MatLayerCylSet::rectifyPtrFromFile() after deserialisation, a type-specific
+// fixup the CCDB column mechanism does not perform.  It continues to be fetched
+// via Service<BasicCCDBManager> below.
+// strangenessBuilderModule uses ccdb->instance() for V-drift management
+// (excluded from migration per recipe).
+namespace o2::aod
+{
+namespace propsvcv2
+{
+DECLARE_SOA_CCDB_COLUMN(GRPMagField, grpMagField, o2::parameters::GRPMagField, "GLO/Config/GRPMagField");   //!
+DECLARE_SOA_CCDB_COLUMN(MeanVertex, meanVertex, o2::dataformats::MeanVertexObject, "GLO/Calib/MeanVertex"); //!
+} // namespace propsvcv2
+
+DECLARE_SOA_TIMESTAMPED_TABLE(PropSvcV2CCDBObjects, aod::Timestamps, o2::aod::timestamp::Timestamp, 1, "PROPSVCV2CC", //!
+                              propsvcv2::GRPMagField, propsvcv2::MeanVertex);
+} // namespace o2::aod
+
 using namespace o2;
 using namespace o2::framework;
-// using namespace o2::framework::expressions;
 
 // use parameters + cov mat non-propagated, aux info + (extension propagated)
 using FullTracksExt = soa::Join<aod::Tracks, aod::TracksExtra, aod::TracksCov>;
@@ -62,15 +85,22 @@ using TracksWithExtra = soa::Join<aod::Tracks, aod::TracksExtra>;
 // For dE/dx association in pre-selection
 using TracksExtraWithPID = soa::Join<aod::TracksExtra, aod::pidTPCFullEl, aod::pidTPCFullPi, aod::pidTPCFullPr, aod::pidTPCFullKa, aod::pidTPCFullHe>;
 
-struct propagationService {
-  // CCDB boilerplate declarations
+struct propagationServiceV2 {
+  // Service<BasicCCDBManager> kept for MatLUT (rectifyPtrFromFile) and
+  // strangenessBuilderModule (V-drift via ccdb->instance()).
+  // GRPMagField and MeanVertex are sourced from CCDB columns instead.
   o2::framework::Configurable<std::string> ccdburl{"ccdburl", "http://alice-ccdb.cern.ch", "url of the ccdb repository"};
   Service<o2::ccdb::BasicCCDBManager> ccdb;
 
-  // propagation stuff
+  // propagation stuff — ccdbLoader used only for lut + mMeanVtx (set from column) + runNumber
   o2::common::StandardCCDBLoaderConfigurables standardCCDBLoaderConfigurables;
   o2::common::StandardCCDBLoader ccdbLoader;
 
+  // Declarative CCDB path overrides (replace grpmagPath / mVtxPath in StandardCCDBLoaderConfigurables)
+  // Option names: "ccdb:fGRPMagField" and "ccdb:fMeanVertex" respectively.
+  ConfigurableCCDBPath<o2::aod::propsvcv2::GRPMagField> grpmagPath;
+  ConfigurableCCDBPath<o2::aod::propsvcv2::MeanVertex> mVtxPath;
+
   // boilerplate: strangeness builder stuff
   o2::pwglf::strangenessbuilder::products products;
   o2::pwglf::strangenessbuilder::coreConfigurables baseOpts;
@@ -87,12 +117,14 @@ struct propagationService {
   o2::common::TrackPropagationConfigurables trackPropagationConfigurables;
   o2::common::TrackPropagationModule trackPropagation;
 
+  using MyBCs = soa::Join<aod::BCsWithTimestamps, aod::PropSvcV2CCDBObjects>;
+
   // registry
   HistogramRegistry histos{"histos"};
 
   void init(o2::framework::InitContext& initContext)
   {
-    // CCDB boilerplate init
+    // Only needed for MatLUT fetch and strangenessBuilderModule V-drift
     ccdb->setCaching(true);
     ccdb->setLocalObjectValidityChecking();
     ccdb->setURL(ccdburl.value);
@@ -102,38 +134,72 @@ struct propagationService {
     strangenessBuilderModule.init(baseOpts, v0BuilderOpts, cascadeBuilderOpts, preSelectOpts, histos, initContext);
   }
 
-  void processRealData(soa::Join<aod::Collisions, aod::EvSels> const& collisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtIU const& tracks, aod::BCsWithTimestamps const& bcs)
+  // Load MatLUT once (needs rectifyPtrFromFile, kept manual), set B-field per run from
+  // GRPMagField CCDB column, and refresh mMeanVtx pointer every call (pointer into current
+  // BC table, valid only for the duration of this process() invocation).
+  template <typename TBC>
+  void initCCDB(TBC const& bc0)
+  {
+    if (!ccdbLoader.lut) {
+      LOG(info) << "Loading material look-up table for run: " << bc0.runNumber();
+      ccdbLoader.lut = o2::base::MatLayerCylSet::rectifyPtrFromFile(
+        ccdb->template getForRun<o2::base::MatLayerCylSet>(standardCCDBLoaderConfigurables.lutPath.value, bc0.runNumber()));
+      o2::base::Propagator::Instance()->setMatLUT(ccdbLoader.lut);
+    }
+    // Always refresh: pointer into current BC table, invalidated after process() returns
+    ccdbLoader.mMeanVtx = &bc0.meanVertex();
+    if (ccdbLoader.runNumber != bc0.runNumber()) {
+      const auto& grpmag = bc0.grpMagField(); // from declarative CCDB column
+      LOG(info) << "Setting B-field to current " << grpmag.getL3Current() << " A for run " << bc0.runNumber() << " from GRPMagField CCDB column";
+      o2::base::Propagator::initFieldFromGRP(&grpmag);
+      ccdbLoader.runNumber = bc0.runNumber();
+    }
+  }
+
+  void processRealData(soa::Join<aod::Collisions, aod::EvSels> const& collisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtIU const& tracks, MyBCs const& bcs)
   {
-    ccdbLoader.initCCDBfromBCs(standardCCDBLoaderConfigurables, ccdb, bcs);
+    if (bcs.size() == 0) {
+      return;
+    }
+    initCCDB(bcs.begin());
     trackPropagation.fillTrackTables<false>(trackPropagationConfigurables, trackTunerObj, ccdbLoader, collisions, tracks, trackPropagationProducts, histos);
     strangenessBuilderModule.dataProcess(ccdb, histos, collisions, static_cast<TObject*>(nullptr), v0s, cascades, trackedCascades, tracks, bcs, static_cast<TObject*>(nullptr), products);
   }
 
-  void processMonteCarlo(soa::Join<aod::Collisions, aod::EvSels, aod::McCollisionLabels> const& collisions, aod::McCollisions const& mccollisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtLabeledIU const& tracks, aod::BCsWithTimestamps const& bcs, aod::McParticles const& mcParticles)
+  void processMonteCarlo(soa::Join<aod::Collisions, aod::EvSels, aod::McCollisionLabels> const& collisions, aod::McCollisions const& mccollisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtLabeledIU const& tracks, MyBCs const& bcs, aod::McParticles const& mcParticles)
   {
-    ccdbLoader.initCCDBfromBCs(standardCCDBLoaderConfigurables, ccdb, bcs);
+    if (bcs.size() == 0) {
+      return;
+    }
+    initCCDB(bcs.begin());
     trackPropagation.fillTrackTables<true>(trackPropagationConfigurables, trackTunerObj, ccdbLoader, collisions, tracks, trackPropagationProducts, histos);
     strangenessBuilderModule.dataProcess(ccdb, histos, collisions, mccollisions, v0s, cascades, trackedCascades, tracks, bcs, mcParticles, products);
   }
 
-  void processRealDataWithPID(soa::Join<aod::Collisions, aod::EvSels> const& collisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtIUWithPID const& tracks, aod::BCsWithTimestamps const& bcs)
+  void processRealDataWithPID(soa::Join<aod::Collisions, aod::EvSels> const& collisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtIUWithPID const& tracks, MyBCs const& bcs)
   {
-    ccdbLoader.initCCDBfromBCs(standardCCDBLoaderConfigurables, ccdb, bcs);
+    if (bcs.size() == 0) {
+      return;
+    }
+    initCCDB(bcs.begin());
     trackPropagation.fillTrackTables<false>(trackPropagationConfigurables, trackTunerObj, ccdbLoader, collisions, tracks, trackPropagationProducts, histos);
     strangenessBuilderModule.dataProcess(ccdb, histos, collisions, static_cast<TObject*>(nullptr), v0s, cascades, trackedCascades, tracks, bcs, static_cast<TObject*>(nullptr), products);
   }
 
-  void processMonteCarloWithPID(soa::Join<aod::Collisions, aod::EvSels, aod::McCollisionLabels> const& collisions, aod::McCollisions const& mccollisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtLabeledIUWithPID const& tracks, aod::BCsWithTimestamps const& bcs, aod::McParticles const& mcParticles)
+  void processMonteCarloWithPID(soa::Join<aod::Collisions, aod::EvSels, aod::McCollisionLabels> const& collisions, aod::McCollisions const& mccollisions, aod::V0s const& v0s, aod::Cascades const& cascades, aod::TrackedCascades const& trackedCascades, FullTracksExtLabeledIUWithPID const& tracks, MyBCs const& bcs, aod::McParticles const& mcParticles)
   {
-    ccdbLoader.initCCDBfromBCs(standardCCDBLoaderConfigurables, ccdb, bcs);
+    if (bcs.size() == 0) {
+      return;
+    }
+    initCCDB(bcs.begin());
     trackPropagation.fillTrackTables<true>(trackPropagationConfigurables, trackTunerObj, ccdbLoader, collisions, tracks, trackPropagationProducts, histos);
     strangenessBuilderModule.dataProcess(ccdb, histos, collisions, mccollisions, v0s, cascades, trackedCascades, tracks, bcs, mcParticles, products);
   }
 
-  PROCESS_SWITCH(propagationService, processRealData, "process real data", true);
-  PROCESS_SWITCH(propagationService, processMonteCarlo, "process monte carlo", false);
-  PROCESS_SWITCH(propagationService, processRealDataWithPID, "process real data", false);
-  PROCESS_SWITCH(propagationService, processMonteCarloWithPID, "process monte carlo", false);
+  PROCESS_SWITCH(propagationServiceV2, processRealData, "process real data", true);
+  PROCESS_SWITCH(propagationServiceV2, processMonteCarlo, "process monte carlo", false);
+  PROCESS_SWITCH(propagationServiceV2, processRealDataWithPID, "process real data", false);
+  PROCESS_SWITCH(propagationServiceV2, processMonteCarloWithPID, "process monte carlo", false);
 };
 
 //****************************************************************************************
@@ -143,6 +209,6 @@ struct propagationService {
 //****************************************************************************************
 WorkflowSpec defineDataProcessing(ConfigContext const& cfgc)
 {
-  WorkflowSpec workflow{adaptAnalysisTask<propagationService>(cfgc)};
+  WorkflowSpec workflow{adaptAnalysisTask<propagationServiceV2>(cfgc)};
   return workflow;
 }