feat: EDM4hep IO

.github/workflows/analysis.yml

@@ -21,7 +21,7 @@ env:
 jobs:
   build_debug:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004:v22
+    container: ghcr.io/acts-project/ubuntu2004:v24
     steps:
       - uses: actions/checkout@v3
 
@@ -61,7 +61,7 @@ jobs:
 
   build_performance:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004:v22
+    container: ghcr.io/acts-project/ubuntu2004:v24
     if: github.ref == 'refs/heads/main'
     steps:
       - uses: actions/checkout@v3

.github/workflows/builds.yml

@@ -17,7 +17,7 @@ env:
 jobs:
   lcg:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/${{ matrix.image }}:v22
+    container: ghcr.io/acts-project/${{ matrix.image }}:v24
     strategy:
       matrix:
         image:
@@ -91,7 +91,7 @@ jobs:
 
   linux_ubuntu:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004:v22
+    container: ghcr.io/acts-project/ubuntu2004:v24
     env:
       INSTALL_DIR: ${{ github.workspace }}/install
       ACTS_LOG_FAILURE_THRESHOLD: WARNING
@@ -166,7 +166,7 @@ jobs:
 
   linux_examples_test:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004:v22
+    container: ghcr.io/acts-project/ubuntu2004:v24
     needs: [linux_ubuntu]
     env:
       ACTS_LOG_FAILURE_THRESHOLD: FATAL
@@ -206,7 +206,7 @@ jobs:
 
   linux_physmon:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004:v22
+    container: ghcr.io/acts-project/ubuntu2004:v24
     needs: [linux_ubuntu]
     env:
       ACTS_LOG_FAILURE_THRESHOLD: FATAL
@@ -411,7 +411,7 @@ jobs:
         run: ./build-downstream/bin/ShowActsVersion
   cuda:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu1804_cuda:v22
+    container: ghcr.io/acts-project/ubuntu1804_cuda:v24
     steps:
       - uses: actions/checkout@v2
 
@@ -436,7 +436,7 @@ jobs:
         run: cmake --build build --
   exatrkx:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004_exatrkx:v22
+    container: ghcr.io/acts-project/ubuntu2004_exatrkx:v24
     steps:
       - uses: actions/checkout@v2
 
@@ -461,7 +461,7 @@ jobs:
         run: cmake --build build --
   sycl:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004_oneapi:v22
+    container: ghcr.io/acts-project/ubuntu2004_oneapi:v24
     defaults:
       run:
         shell: bash
@@ -493,7 +493,7 @@ jobs:
           && cmake --build build --
   docs:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/ubuntu2004:v22
+    container: ghcr.io/acts-project/ubuntu2004:v24
     env:
         DOXYGEN_WARN_AS_ERROR: YES
     steps:

.github/workflows/checks.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   format:
     runs-on: ubuntu-latest
-    container: ghcr.io/acts-project/format10:v22
+    container: ghcr.io/acts-project/format10:v24
     steps:
       - uses: actions/checkout@v3
       - name: Check

CMakeLists.txt

@@ -31,6 +31,7 @@ option(ACTS_BUILD_PLUGIN_AUTODIFF "Build the autodiff plugin" OFF)
 option(ACTS_USE_SYSTEM_AUTODIFF "Use autodiff provided by the system instead of the bundled version" OFF)
 option(ACTS_BUILD_PLUGIN_CUDA "Build CUDA plugin" OFF)
 option(ACTS_BUILD_PLUGIN_DD4HEP "Build DD4hep plugin" OFF)
+option(ACTS_BUILD_PLUGIN_EDM4HEP "Build EMD4hep plugin" OFF)
 option(ACTS_BUILD_PLUGIN_EXATRKX "Build the Exa.TrkX plugin" OFF)
 option(ACTS_USE_SYSTEM_ACTSDD4HEP "Use the ActsDD4hep glue library provided by the system instead of building it" OFF)
 option(ACTS_BUILD_PLUGIN_IDENTIFICATION "Build Identification plugin" OFF)
@@ -50,6 +51,7 @@ option(ACTS_BUILD_ALIGNMENT "Build Alignment package" OFF)
 # examples related options
 option(ACTS_BUILD_EXAMPLES "Build standalone examples" OFF)
 option(ACTS_BUILD_EXAMPLES_DD4HEP "Build DD4hep-based code in the examples" OFF)
+option(ACTS_BUILD_EXAMPLES_EDM4HEP "Build EDM4hep-based code in the examples" OFF)
 option(ACTS_BUILD_EXAMPLES_EXATRKX "Build the Exa.TrkX example code" OFF)
 option(ACTS_BUILD_EXAMPLES_GEANT4 "Build Geant4-based code in the examples" OFF)
 option(ACTS_BUILD_EXAMPLES_HEPMC3 "Build HepMC3-based code in the examples" OFF)
@@ -78,6 +80,7 @@ set_option_if(ACTS_BUILD_BENCHMARKS ACTS_BUILD_EVERYTHING)
 set_option_if(ACTS_BUILD_UNITTESTS ACTS_BUILD_EVERYTHING)
 set_option_if(ACTS_BUILD_INTEGRATIONTESTS ACTS_BUILD_EVERYTHING)
 set_option_if(ACTS_BUILD_EXAMPLES_DD4HEP ACTS_BUILD_EVERYTHING)
+set_option_if(ACTS_BUILD_EXAMPLES_EDM4HEP ACTS_BUILD_EVERYTHING)
 set_option_if(ACTS_BUILD_EXAMPLES_GEANT4 ACTS_BUILD_EVERYTHING)
 set_option_if(ACTS_BUILD_EXAMPLES_HEPMC3 ACTS_BUILD_EVERYTHING)
 set_option_if(ACTS_BUILD_EXAMPLES_PYTHIA8 ACTS_BUILD_EVERYTHING)
@@ -89,6 +92,7 @@ set_option_if(ACTS_BUILD_ALIGNMENT ACTS_BUILD_EVERYTHING)
 set_option_if(
   ACTS_BUILD_EXAMPLES
   ACTS_BUILD_EXAMPLES_DD4HEP
+  OR ACTS_BUILD_EXAMPLES_EDM4HEP
   OR ACTS_BUILD_EXAMPLES_GEANT4
   OR ACTS_BUILD_EXAMPLES_HEPMC3
   OR ACTS_BUILD_EXAMPLES_PYTHIA8
@@ -97,7 +101,11 @@ set_option_if(
 # core plugins might be required by examples or depend on each other
 set_option_if(
   ACTS_BUILD_PLUGIN_DD4HEP
-  ACTS_BUILD_EXAMPLES_DD4HEP OR ACTS_BUILD_EVERYTHING)
+  ACTS_BUILD_EXAMPLES_DD4HEP OR ACTS_BUILD_EVERYTHING OR
+  ACTS_BUILD_PLUGIN_EDM4HEP OR ACTS_BUILD_EXAMPLES_EDM4HEP)
+set_option_if(
+  ACTS_BUILD_PLUGIN_EDM4HEP
+  ACTS_BUILD_EXAMPLES_EDM4HEP OR ACTS_BUILD_EVERYTHING)
 set_option_if(
   ACTS_BUILD_PLUGIN_TGEO
   ACTS_BUILD_PLUGIN_DD4HEP OR ACTS_BUILD_EXAMPLES OR ACTS_BUILD_EVERYTHING)
@@ -151,6 +159,7 @@ set(_acts_autodiff_version 0.6)
 set(_acts_boost_version 1.71.0)
 set(_acts_dd4hep_version 1.11)
 set(_acts_actsdd4hep_version 1.0.0)
+set(_acts_edm4hep_version v00-04-01)
 set(_acts_doxygen_version 1.8.15)
 set(_acts_eigen3_version 3.3.7)
 set(_acts_hepmc3_version 3.2.1)
@@ -244,7 +253,9 @@ if(ACTS_BUILD_PLUGIN_DD4HEP)
   else()
     add_subdirectory(thirdparty/actsdd4hep)
   endif()
-
+endif()
+if(ACTS_BUILD_PLUGIN_EDM4HEP)
+  find_package(EDM4HEP REQUIRED)
 endif()
 if(ACTS_BUILD_PLUGIN_JSON)
   if(ACTS_USE_SYSTEM_NLOHMANN_JSON)
@@ -295,6 +306,9 @@ if(ACTS_BUILD_EXAMPLES_DD4HEP AND ACTS_BUILD_EXAMPLES_GEANT4)
 elseif(ACTS_BUILD_EXAMPLES_DD4HEP)
   find_package(DD4hep ${_acts_dd4hep_version} REQUIRED CONFIG COMPONENTS DDCore DDDetectors)
 endif()
+if(ACTS_BUILD_EXAMPLES_EDM4HEP)
+  find_package(EDM4HEP REQUIRED CONFIG)
+endif()
 if(ACTS_BUILD_EXAMPLES_GEANT4)
   find_package(Geant4 REQUIRED CONFIG COMPONENTS gdml)
 endif()

Examples/Detectors/DD4hepDetector/include/ActsExamples/DD4hepDetector/DD4hepDetector.hpp

@@ -15,15 +15,23 @@
 #include <memory>
 #include <vector>
 
-struct DD4hepDetector : public ActsExamples::IBaseDetector {
+namespace ActsExamples {
+namespace DD4hep {
+
+struct DD4hepDetector : public IBaseDetector {
+  std::shared_ptr<DD4hepGeometryService> geometryService;
+
   void addOptions(
       boost::program_options::options_description& opt) const override;
 
-  std::pair<ActsExamples::IBaseDetector::TrackingGeometryPtr, ContextDecorators>
-  finalize(const boost::program_options::variables_map& vm,
-           std::shared_ptr<const Acts::IMaterialDecorator> mdecorator) override;
+  std::pair<IBaseDetector::TrackingGeometryPtr, ContextDecorators> finalize(
+      const boost::program_options::variables_map& vm,
+      std::shared_ptr<const Acts::IMaterialDecorator> mdecorator) override;
 
-  std::pair<ActsExamples::IBaseDetector::TrackingGeometryPtr, ContextDecorators>
-  finalize(ActsExamples::DD4hep::DD4hepGeometryService::Config cfg,
-           std::shared_ptr<const Acts::IMaterialDecorator> mdecorator);
+  std::pair<IBaseDetector::TrackingGeometryPtr, ContextDecorators> finalize(
+      DD4hepGeometryService::Config cfg,
+      std::shared_ptr<const Acts::IMaterialDecorator> mdecorator);
 };
+
+}  // namespace DD4hep
+}  // namespace ActsExamples

Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp

@@ -16,6 +16,9 @@
 
 #include <boost/program_options.hpp>
 
+namespace ActsExamples {
+namespace DD4hep {
+
 void DD4hepDetector::addOptions(
     boost::program_options::options_description& opt) const {
   ActsExamples::Options::addDD4hepOptions(opt);
@@ -37,10 +40,10 @@ auto DD4hepDetector::finalize(
     -> std::pair<TrackingGeometryPtr, ContextDecorators> {
   Acts::GeometryContext dd4HepContext;
   config.matDecorator = mdecorator;
-  auto geometrySvc =
+  geometryService =
       std::make_shared<ActsExamples::DD4hep::DD4hepGeometryService>(config);
   TrackingGeometryPtr dd4tGeometry =
-      geometrySvc->trackingGeometry(dd4HepContext);
+      geometryService->trackingGeometry(dd4HepContext);
   if (!dd4tGeometry) {
     throw std::runtime_error{
         "Did not receive tracking geometry from DD4hep geometry service"};
@@ -50,3 +53,6 @@ auto DD4hepDetector::finalize(
   return std::make_pair<TrackingGeometryPtr, ContextDecorators>(
       std::move(dd4tGeometry), std::move(dd4ContextDeocrators));
 }
+
+}  // namespace DD4hep
+}  // namespace ActsExamples

Examples/Io/CMakeLists.txt

@@ -1,4 +1,5 @@
 add_subdirectory(Csv)
+add_subdirectory_if(EDM4hep ACTS_BUILD_EXAMPLES_EDM4HEP)
 add_subdirectory_if(HepMC3 ACTS_BUILD_EXAMPLES_HEPMC3)
 add_subdirectory(Json)
 add_subdirectory(NuclearInteractions)

Examples/Io/Csv/CMakeLists.txt

@@ -13,7 +13,7 @@ add_library(
   src/CsvSpacePointReader.cpp
   src/CsvTrackingGeometryWriter.cpp
   src/CsvMultiTrajectoryWriter.cpp 
-  src/CsvSpacepointWriter.cpp)
+  src/CsvSpacePointWriter.cpp)
 target_include_directories(
   ActsExamplesIoCsv
   PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>)

Examples/Io/EDM4hep/CMakeLists.txt

@@ -0,0 +1,13 @@
+add_library(
+  ActsExamplesIoEDM4hep SHARED
+  src/EDM4hepSimHitReader.cpp)
+target_include_directories(
+  ActsExamplesIoEDM4hep
+  PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>)
+target_link_libraries(
+  ActsExamplesIoEDM4hep
+  PUBLIC ActsCore ActsExamplesFramework ActsExamplesDetectorDD4hep ActsPluginEDM4hep)
+
+install(
+  TARGETS ActsExamplesIoEDM4hep
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})

Examples/Io/EDM4hep/include/ActsExamples/Io/EDM4hep/EDM4hepSimHitReader.hpp

@@ -0,0 +1,65 @@
+// This file is part of the Acts project.
+//
+// Copyright (C) 2022 CERN for the benefit of the Acts project
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+#pragma once
+
+#include "Acts/Geometry/GeometryIdentifier.hpp"
+#include "Acts/Utilities/Logger.hpp"
+#include "ActsExamples/DD4hepDetector/DD4hepGeometryService.hpp"
+#include "ActsExamples/Framework/IReader.hpp"
+
+#include <memory>
+#include <string>
+
+#include "podio/EventStore.h"
+#include "podio/ROOTReader.h"
+
+namespace ActsExamples {
+
+class EDM4hepSimHitReader final : public IReader {
+ public:
+  struct Config {
+    /// Where to the read input file from.
+    std::string inputPath;
+    /// Output simulated (truth) hits collection.
+    std::string outputSimHits;
+    /// DD4hep geometry service for cellID resolution.
+    std::shared_ptr<DD4hep::DD4hepGeometryService> dd4hepGeometryService;
+  };
+
+  /// Construct the simhit reader.
+  ///
+  /// @param config is the configuration object
+  /// @param level is the logging level
+  EDM4hepSimHitReader(const Config& config, Acts::Logging::Level level);
+
+  std::string name() const final override;
+
+  /// Return the available events range.
+  std::pair<size_t, size_t> availableEvents() const final override;
+
+  /// Read out data from the input stream.
+  ProcessCode read(const ActsExamples::AlgorithmContext& ctx) final override;
+
+  /// Readonly access to the config
+  const Config& config() const { return m_cfg; }
+
+ private:
+  Config m_cfg;
+  std::pair<size_t, size_t> m_eventsRange;
+  std::unique_ptr<const Acts::Logger> m_logger;
+
+  podio::ROOTReader m_reader;
+  podio::EventStore m_store;
+
+  std::vector<std::string> m_simHitCollections;
+
+  const Acts::Logger& logger() const { return *m_logger; }
+};
+
+}  // namespace ActsExamples