feat: Add compatibility for PODIO 1.x (#3360)

This adds the ability to compile with PODIO 1.x. We retain compatibility with 0.17.x for now, using preprocessor gates.
acts-project · Jul 11, 2024 · 9b51fed · 9b51fed
1 parent 2413095
commit 9b51fed
Show file tree

Hide file tree

Showing 19 changed files with 112 additions and 61 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -205,7 +205,8 @@ set(_acts_dd4hep_version 1.21)
 set(_acts_edm4hep_version 0.7)
 set(_acts_geomodel_version 4.6.0)
 set(_acts_eigen3_version 3.3.7)
-set(_acts_podio_version 0.16)
+set(_acts_podio_version 1.0.1) # will try this first
+set(_acts_podio_fallback_version 0.16) # if not found, will try this one
 set(_acts_doxygen_version 1.9.4)
 set(_acts_hepmc3_version 3.2.1)
 set(_acts_nlohmanjson_version 3.2.0)
@@ -396,7 +397,11 @@ if(ACTS_BUILD_PLUGIN_ONNX OR ACTS_EXATRKX_ENABLE_ONNX)
   find_package(OnnxRuntime ${_acts_onnxruntime_version} REQUIRED)
 endif()
 if(ACTS_BUILD_PLUGIN_EDM4HEP OR ACTS_BUILD_PLUGIN_PODIO)
-  find_package(podio ${_acts_podio_version} REQUIRED CONFIG)
+  find_package(podio ${_acts_podio_version} CONFIG)
+  if(NOT podio_FOUND)
+    message(STATUS "Podio not found, trying ${_acts_podio_fallback_version} version")
+    find_package(podio ${_acts_podio_fallback_version} CONFIG REQUIRED)
+  endif()
   find_package(ROOT ${_acts_root_version} REQUIRED CONFIG COMPONENTS Core)
 endif()
 if(ACTS_BUILD_PLUGIN_EDM4HEP)

diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepMeasurementReader.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepMeasurementReader.hpp
@@ -7,6 +7,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 #pragma once
 
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "Acts/Utilities/Logger.hpp"
 #include "ActsExamples/EventData/Cluster.hpp"
 #include "ActsExamples/EventData/IndexSourceLink.hpp"
@@ -17,7 +18,6 @@
 #include <memory>
 #include <string>
 
-#include <podio/ROOTFrameReader.h>
 #include <tbb/enumerable_thread_specific.h>
 
 namespace ActsExamples {
@@ -69,9 +69,9 @@ class EDM4hepMeasurementReader final : public IReader {
   std::pair<std::size_t, std::size_t> m_eventsRange;
   std::unique_ptr<const Acts::Logger> m_logger;
 
-  tbb::enumerable_thread_specific<podio::ROOTFrameReader> m_reader;
+  tbb::enumerable_thread_specific<Acts::PodioUtil::ROOTReader> m_reader;
 
-  podio::ROOTFrameReader& reader();
+  Acts::PodioUtil::ROOTReader& reader();
 
   WriteDataHandle<MeasurementContainer> m_outputMeasurements{
       this, "OutputMeasurements"};

diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepMeasurementWriter.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepMeasurementWriter.hpp
@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "ActsExamples/EventData/Cluster.hpp"
 #include "ActsExamples/EventData/Measurement.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
@@ -17,7 +18,6 @@
 
 #include <edm4hep/TrackerHitCollection.h>
 #include <edm4hep/TrackerHitPlaneCollection.h>
-#include <podio/ROOTFrameWriter.h>
 
 namespace ActsExamples {
 
@@ -64,7 +64,7 @@ class EDM4hepMeasurementWriter final : public WriterT<MeasurementContainer> {
  private:
   Config m_cfg;
 
-  podio::ROOTFrameWriter m_writer;
+  Acts::PodioUtil::ROOTWriter m_writer;
 
   std::mutex m_writeMutex;
 

diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepMultiTrajectoryWriter.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepMultiTrajectoryWriter.hpp
@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "ActsExamples/EventData/Trajectories.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
 #include "ActsExamples/Framework/WriterT.hpp"
@@ -16,8 +17,6 @@
 
 #include <string>
 
-#include <podio/ROOTFrameWriter.h>
-
 namespace ActsExamples {
 
 /// Write out the tracks reconstructed using Combinatorial Kalman Filter to
@@ -69,7 +68,7 @@ class EDM4hepMultiTrajectoryWriter : public WriterT<TrajectoriesContainer> {
   Config m_cfg;
 
   std::mutex m_writeMutex;
-  podio::ROOTFrameWriter m_writer;
+  Acts::PodioUtil::ROOTWriter m_writer;
 
   ReadDataHandle<IndexMultimap<ActsFatras::Barcode>>
       m_inputMeasurementParticlesMap{this, "InputMeasurementParticlesMaps"};

diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepParticleWriter.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepParticleWriter.hpp
@@ -8,14 +8,13 @@
 
 #pragma once
 
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "ActsExamples/EventData/SimParticle.hpp"
 #include "ActsExamples/Framework/WriterT.hpp"
 
 #include <mutex>
 #include <string>
 
-#include <podio/ROOTFrameWriter.h>
-
 namespace ActsExamples {
 
 /// Write particles to EDM4hep
@@ -58,7 +57,7 @@ class EDM4hepParticleWriter final : public WriterT<SimParticleContainer> {
 
   std::mutex m_writeMutex;
 
-  podio::ROOTFrameWriter m_writer;
+  Acts::PodioUtil::ROOTWriter m_writer;
 };
 
 }  // namespace ActsExamples
diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepReader.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepReader.hpp
@@ -9,6 +9,7 @@
 #pragma once
 
 #include "Acts/Geometry/TrackingGeometry.hpp"
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "Acts/Utilities/Logger.hpp"
 #include "ActsExamples/EventData/SimHit.hpp"
 #include "ActsExamples/EventData/SimParticle.hpp"
@@ -21,7 +22,6 @@
 
 #include <DD4hep/DetElement.h>
 #include <edm4hep/MCParticleCollection.h>
-#include <podio/ROOTFrameReader.h>
 #include <tbb/enumerable_thread_specific.h>
 
 namespace ActsExamples {
@@ -107,9 +107,9 @@ class EDM4hepReader final : public IReader {
 
   std::unordered_map<unsigned int, const Acts::Surface*> m_surfaceMap;
 
-  tbb::enumerable_thread_specific<podio::ROOTFrameReader> m_reader;
+  tbb::enumerable_thread_specific<Acts::PodioUtil::ROOTReader> m_reader;
 
-  podio::ROOTFrameReader& reader();
+  Acts::PodioUtil::ROOTReader& reader();
 
   WriteDataHandle<SimParticleContainer> m_outputParticlesInitial{
       this, "OutputParticlesInitial"};

diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepSimHitWriter.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepSimHitWriter.hpp
@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "ActsExamples/EventData/SimHit.hpp"
 #include "ActsExamples/EventData/SimParticle.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
@@ -17,7 +18,6 @@
 
 #include <edm4hep/MCParticleCollection.h>
 #include <edm4hep/SimTrackerHitCollection.h>
-#include <podio/ROOTFrameWriter.h>
 
 namespace ActsExamples {
 
@@ -65,7 +65,7 @@ class EDM4hepSimHitWriter final : public WriterT<SimHitContainer> {
  private:
   Config m_cfg;
 
-  podio::ROOTFrameWriter m_writer;
+  Acts::PodioUtil::ROOTWriter m_writer;
 
   std::mutex m_writeMutex;
 

diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepTrackReader.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepTrackReader.hpp
@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "ActsExamples/EventData/Track.hpp"
 #include "ActsExamples/EventData/Trajectories.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
@@ -18,7 +19,6 @@
 
 #include <string>
 
-#include <podio/ROOTFrameReader.h>
 #include <tbb/enumerable_thread_specific.h>
 
 namespace ActsExamples {
@@ -61,9 +61,9 @@ class EDM4hepTrackReader : public IReader {
 
   WriteDataHandle<ConstTrackContainer> m_outputTracks{this, "OutputTracks"};
 
-  tbb::enumerable_thread_specific<podio::ROOTFrameReader> m_reader;
+  tbb::enumerable_thread_specific<Acts::PodioUtil::ROOTReader> m_reader;
 
-  podio::ROOTFrameReader& reader();
+  Acts::PodioUtil::ROOTReader& reader();
 
   std::unique_ptr<const Acts::Logger> m_logger;
 

diff --git a/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepTrackWriter.hpp b/Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepTrackWriter.hpp
@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "ActsExamples/EventData/Track.hpp"
 #include "ActsExamples/EventData/Trajectories.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
@@ -17,8 +18,6 @@
 
 #include <string>
 
-#include <podio/ROOTFrameWriter.h>
-
 namespace ActsExamples {
 
 class EDM4hepTrackWriter : public WriterT<ConstTrackContainer> {
@@ -58,7 +57,7 @@ class EDM4hepTrackWriter : public WriterT<ConstTrackContainer> {
 
   std::mutex m_writeMutex;
 
-  podio::ROOTFrameWriter m_writer;
+  Acts::PodioUtil::ROOTWriter m_writer;
 };
 
 }  // namespace ActsExamples
diff --git a/Examples/Io/EDM4hep/src/EDM4hepMeasurementReader.cpp b/Examples/Io/EDM4hep/src/EDM4hepMeasurementReader.cpp
@@ -9,6 +9,7 @@
 #include "ActsExamples/Io/EDM4hep/EDM4hepMeasurementReader.hpp"
 
 #include "Acts/Definitions/Units.hpp"
+#include "Acts/Plugins/Podio/PodioUtil.hpp"
 #include "ActsExamples/EventData/Cluster.hpp"
 #include "ActsExamples/EventData/Measurement.hpp"
 #include "ActsExamples/Framework/WhiteBoard.hpp"
@@ -21,7 +22,6 @@
 #include <edm4hep/TrackerHitCollection.h>
 #include <edm4hep/TrackerHitPlane.h>
 #include <edm4hep/TrackerHitPlaneCollection.h>
-#include <podio/Frame.h>
 
 namespace ActsExamples {
 
@@ -85,7 +85,7 @@ ProcessCode EDM4hepMeasurementReader::read(const AlgorithmContext& ctx) {
   return ProcessCode::SUCCESS;
 }
 
-podio::ROOTFrameReader& EDM4hepMeasurementReader::reader() {
+Acts::PodioUtil::ROOTReader& EDM4hepMeasurementReader::reader() {
   bool exists = false;
   auto& reader = m_reader.local(exists);
   if (!exists) {

diff --git a/Examples/Io/EDM4hep/src/EDM4hepReader.cpp b/Examples/Io/EDM4hep/src/EDM4hepReader.cpp
@@ -30,7 +30,6 @@
 #include <edm4hep/SimTrackerHitCollection.h>
 #include <podio/Frame.h>
 #include <podio/ObjectID.h>
-#include <podio/ROOTFrameReader.h>
 
 namespace ActsExamples {
 
@@ -82,7 +81,7 @@ EDM4hepReader::EDM4hepReader(const Config& config, Acts::Logging::Level level)
   });
 }
 
-podio::ROOTFrameReader& EDM4hepReader::reader() {
+Acts::PodioUtil::ROOTReader& EDM4hepReader::reader() {
   bool exists = false;
   auto& reader = m_reader.local(exists);
   if (!exists) {

diff --git a/Examples/Io/EDM4hep/src/EDM4hepTrackReader.cpp b/Examples/Io/EDM4hep/src/EDM4hepTrackReader.cpp
@@ -66,7 +66,7 @@ ProcessCode EDM4hepTrackReader::read(const AlgorithmContext& ctx) {
   return ProcessCode::SUCCESS;
 }
 
-podio::ROOTFrameReader& EDM4hepTrackReader::reader() {
+Acts::PodioUtil::ROOTReader& EDM4hepTrackReader::reader() {
   bool exists = false;
   auto& reader = m_reader.local(exists);
   if (!exists) {

diff --git a/Plugins/CMakeLists.txt b/Plugins/CMakeLists.txt
@@ -15,7 +15,7 @@ add_component_if(Detray PluginDetray ACTS_BUILD_PLUGIN_DETRAY)
 # dependent plugins. depend either on a independent plugins or on one another
 add_component_if(TGeo PluginTGeo ACTS_BUILD_PLUGIN_TGEO)
 add_component_if(DD4hep PluginDD4hep ACTS_BUILD_PLUGIN_DD4HEP)
+add_component_if(Podio PluginPodio ACTS_BUILD_PLUGIN_PODIO OR ACTS_PLUGIN_EDM4HEP)
 add_component_if(EDM4hep PluginEDM4hep ACTS_BUILD_PLUGIN_EDM4HEP)
-add_component_if(Podio PluginPodio ACTS_BUILD_PLUGIN_PODIO)
 
 propagate_components_to_parent()
diff --git a/Plugins/EDM4hep/CMakeLists.txt b/Plugins/EDM4hep/CMakeLists.txt
@@ -11,6 +11,7 @@ target_link_libraries(
 	ActsPluginEDM4hep
   PUBLIC
     ActsCore
+    ActsPluginPodio
     EDM4HEP::edm4hep)
 
 install(

diff --git a/Plugins/Podio/include/Acts/Plugins/Podio/PodioTrackContainer.hpp b/Plugins/Podio/include/Acts/Plugins/Podio/PodioTrackContainer.hpp
@@ -76,7 +76,7 @@ class PodioTrackContainerBase {
     if constexpr (EnsureConst) {
       dataPtr = &track.getData();
     } else {
-      dataPtr = &track.data();
+      dataPtr = &PodioUtil::getDataMutable(track);
     }
     auto& data = *dataPtr;
     switch (key) {
@@ -213,7 +213,8 @@ class MutablePodioTrackContainer : public PodioTrackContainerBase {
 
   IndexType addTrack_impl() {
     auto track = m_collection->create();
-    track.referenceSurface().surfaceType = PodioUtil::kNoSurface;
+    PodioUtil::getReferenceSurfaceMutable(track).surfaceType =
+        PodioUtil::kNoSurface;
     m_surfaces.emplace_back();
     for (const auto& [key, vec] : m_dynamic) {
       vec->add();
@@ -231,7 +232,8 @@ class MutablePodioTrackContainer : public PodioTrackContainerBase {
   }
 
   Parameters parameters(IndexType itrack) {
-    return Parameters{m_collection->at(itrack).data().parameters.data()};
+    return Parameters{
+        PodioUtil::getDataMutable(m_collection->at(itrack)).parameters.data()};
   }
 
   ConstParameters parameters(IndexType itrack) const {
@@ -240,7 +242,8 @@ class MutablePodioTrackContainer : public PodioTrackContainerBase {
   }
 
   Covariance covariance(IndexType itrack) {
-    return Covariance{m_collection->at(itrack).data().covariance.data()};
+    return Covariance{
+        PodioUtil::getDataMutable(m_collection->at(itrack)).covariance.data()};
   }
 
   ConstCovariance covariance(IndexType itrack) const {