feat: PythonBindings for plugins (acts-project#4750)

This PR moves the Python bindings of Plugin-related code into `Python/Plugins` while keeping the exact same functionality (and tests running).

Author: asalzburger

Examples/Python/CMakeLists.txt

@@ -102,23 +102,11 @@ else()
     target_sources(ActsPythonBindings PRIVATE src/GeoModelStub.cpp)
 endif()
 
-if(ACTS_BUILD_PLUGIN_ROOT)
-    target_link_libraries(ActsPythonBindings PUBLIC Acts::PluginRoot)
-    target_sources(ActsPythonBindings PRIVATE src/TGeo.cpp)
-else()
-    target_sources(ActsPythonBindings PRIVATE src/TGeoStub.cpp)
-endif()
-
 if(ACTS_BUILD_PLUGIN_TRACCC)
-    target_link_libraries(ActsPythonBindings PUBLIC Acts::PluginDetray)
-    target_sources(ActsPythonBindings PRIVATE src/Detray.cpp)
     target_link_libraries(ActsPythonBindings PUBLIC Acts::PluginCovfie)
-    target_sources(ActsPythonBindings PRIVATE src/Covfie.cpp)
     target_link_libraries(ActsPythonBindings PUBLIC Acts::ExamplesTraccc)
     target_sources(ActsPythonBindings PRIVATE src/Traccc.cpp)
 else()
-    target_sources(ActsPythonBindings PRIVATE src/DetrayStub.cpp)
-    target_sources(ActsPythonBindings PRIVATE src/CovfieStub.cpp)
     target_sources(ActsPythonBindings PRIVATE src/TracccStub.cpp)
 endif()
 
@@ -130,20 +118,25 @@ else()
 endif()
 
 if(ACTS_BUILD_PLUGIN_DD4HEP AND ACTS_BUILD_EXAMPLES_DD4HEP)
-    pybind11_add_module(ActsPythonBindingsDD4hep src/DD4hepComponent.cpp)
+    pybind11_add_module(ActsExamplesPythonBindingsDD4hep src/DD4hepComponent.cpp)
     target_link_libraries(
-        ActsPythonBindingsDD4hep
+        ActsExamplesPythonBindingsDD4hep
         PUBLIC Acts::PythonUtilities Acts::ExamplesDetectorDD4hep
     )
-    add_dependencies(ActsPythonBindings ActsPythonBindingsDD4hep)
+    add_dependencies(ActsPythonBindings ActsExamplesPythonBindingsDD4hep)
 
-    install(TARGETS ActsPythonBindingsDD4hep DESTINATION ${_python_install_dir})
+    install(
+        TARGETS
+            ActsExamplesPythonBindingsDD4hep
+            DESTINATION
+            ${_python_install_dir}
+    )
     set_target_properties(
-        ActsPythonBindingsDD4hep
+        ActsExamplesPythonBindingsDD4hep
         PROPERTIES INSTALL_RPATH "\$ORIGIN/../../${CMAKE_INSTALL_LIBDIR}"
     )
     set_target_properties(
-        ActsPythonBindingsDD4hep
+        ActsExamplesPythonBindingsDD4hep
         PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${_python_dir}/acts
     )
     list(APPEND py_files examples/dd4hep.py)
@@ -160,24 +153,29 @@ else()
 endif()
 
 if(ACTS_BUILD_EXAMPLES_GEANT4)
-    pybind11_add_module(ActsPythonBindingsGeant4 src/Geant4Component.cpp)
+    pybind11_add_module(ActsExamplesPythonBindingsGeant4 src/Geant4Component.cpp)
     target_link_libraries(
-        ActsPythonBindingsGeant4
+        ActsExamplesPythonBindingsGeant4
         PUBLIC
             Acts::ExamplesGeant4
             Acts::ExamplesDetectorGeant4
             Acts::PythonUtilities
             Acts::ExamplesMuonSpectrometerMockupDetector
     )
-    add_dependencies(ActsPythonBindings ActsPythonBindingsGeant4)
+    add_dependencies(ActsPythonBindings ActsExamplesPythonBindingsGeant4)
 
-    install(TARGETS ActsPythonBindingsGeant4 DESTINATION ${_python_install_dir})
+    install(
+        TARGETS
+            ActsExamplesPythonBindingsGeant4
+            DESTINATION
+            ${_python_install_dir}
+    )
     set_target_properties(
-        ActsPythonBindingsGeant4
+        ActsExamplesPythonBindingsGeant4
         PROPERTIES INSTALL_RPATH "\$ORIGIN/../../${CMAKE_INSTALL_LIBDIR}"
     )
     set_target_properties(
-        ActsPythonBindingsGeant4
+        ActsExamplesPythonBindingsGeant4
         PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${_python_dir}/acts
     )
     list(APPEND py_files examples/geant4/__init__.py)

Examples/Python/python/acts/__init__.py

@@ -9,6 +9,7 @@
 from . import ActsPythonBindings
 from ._adapter import _patch_config
 
+
 if (
     "ACTS_LOG_FAILURE_THRESHOLD" in os.environ
     and os.environ["ACTS_LOG_FAILURE_THRESHOLD"] != logging.getFailureThreshold().name
@@ -52,19 +53,21 @@ def _decoratorFromFile(file: Union[str, Path], **kwargs):
 
     kwargs.setdefault("level", ActsPythonBindings.logging.INFO)
 
+    from .ActsPluginsPythonBindingsJson import (
+        MaterialMapJsonConverter,
+        JsonMaterialDecorator,
+    )
+    from .ActsPluginsPythonBindingsRoot import RootMaterialDecorator
+
     if file.suffix in (".json", ".cbor"):
-        c = ActsPythonBindings.MaterialMapJsonConverter.Config()
+        c = MaterialMapJsonConverter.Config()
         for k in kwargs.keys():
             if hasattr(c, k):
                 setattr(c, k, kwargs.pop(k))
 
-        return ActsPythonBindings.JsonMaterialDecorator(
-            jFileName=str(file), rConfig=c, **kwargs
-        )
+        return JsonMaterialDecorator(jFileName=str(file), rConfig=c, **kwargs)
     elif file.suffix == ".root":
-        return ActsPythonBindings._examples.RootMaterialDecorator(
-            fileName=str(file), **kwargs
-        )
+        return RootMaterialDecorator(fileName=str(file), **kwargs)
     else:
         raise ValueError(f"Unknown file type {file.suffix}")
 

Examples/Python/python/acts/examples/dd4hep.py

@@ -6,15 +6,22 @@
 # try importing and see if it works in order to provide a useful error message
 try:
     subprocess.check_call(
-        [sys.executable, "-c", "from acts import ActsPythonBindingsDD4hep"]
+        [
+            sys.executable,
+            "-c",
+            "from acts import ActsPluginsPythonBindingsDD4hep; from acts import ActsExamplesPythonBindingsDD4hep",
+        ]
     )
 except subprocess.CalledProcessError as e:
     print("Error encountered importing DD4hep. Likely you need to set LD_LIBRARY_PATH.")
     sys.exit(1)
 
 from acts._adapter import _patch_config
-from acts import ActsPythonBindingsDD4hep
+from acts import ActsPluginsPythonBindingsDD4hep
+from acts.ActsPluginsPythonBindingsDD4hep import *
 
-_patch_config(ActsPythonBindingsDD4hep)
+from acts import ActsExamplesPythonBindingsDD4hep
 
-from acts.ActsPythonBindingsDD4hep import *
+_patch_config(ActsExamplesPythonBindingsDD4hep)
+
+from acts.ActsExamplesPythonBindingsDD4hep import *

Examples/Python/python/acts/examples/geant4/__init__.py

@@ -5,16 +5,16 @@
 # try importing and see if it works in order to provide a useful error message
 try:
     subprocess.check_call(
-        [sys.executable, "-c", "from acts import ActsPythonBindingsGeant4"]
+        [sys.executable, "-c", "from acts import ActsExamplesPythonBindingsGeant4"]
     )
 except subprocess.CalledProcessError as e:
     print("Error encountered importing DD4hep. Likely you need to set LD_LIBRARY_PATH.")
     sys.exit(1)
 
 
 from acts._adapter import _patch_config
-from acts import ActsPythonBindingsGeant4
+from acts import ActsExamplesPythonBindingsGeant4
 
-_patch_config(ActsPythonBindingsGeant4)
+_patch_config(ActsExamplesPythonBindingsGeant4)
 
-from acts.ActsPythonBindingsGeant4 import *
+from acts.ActsExamplesPythonBindingsGeant4 import *

Examples/Python/python/acts/examples/odd.py

@@ -5,6 +5,7 @@
 from typing import Optional
 import acts
 import acts.examples
+from acts import root
 import warnings
 
 
@@ -69,7 +70,7 @@ def getOpenDataDetector(
             raise RuntimeError(msg)
 
     if materialDecorator is None:
-        materialDecorator = acts.examples.RootMaterialDecorator(
+        materialDecorator = acts.root.RootMaterialDecorator(
             fileName=str(odd_dir / "data/odd-material-maps.root"),
             level=customLogLevel(minLevel=acts.logging.WARNING),
         )

Examples/Python/src/CovfieStub.cpp

@@ -6,23 +6,17 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-#include "Acts/Detector/GeometryIdGenerator.hpp"
 #include "Acts/Utilities/Logger.hpp"
 #include "ActsExamples/DD4hepDetector/AlignedDD4hepDetectorElement.hpp"
 #include "ActsExamples/DD4hepDetector/DD4hepDetector.hpp"
 #include "ActsExamples/DD4hepDetector/OpenDataDetector.hpp"
 #include "ActsPlugins/DD4hep/DD4hepDetectorElement.hpp"
-#include "ActsPlugins/DD4hep/DD4hepDetectorStructure.hpp"
-#include "ActsPlugins/DD4hep/DD4hepFieldAdapter.hpp"
-#include "ActsPlugins/DD4hep/DD4hepIdentifierMapper.hpp"
 #include "ActsPython/Utilities/Helpers.hpp"
 #include "ActsPython/Utilities/Macros.hpp"
 
 #include <memory>
 #include <utility>
 
-#include <DD4hep/DetElement.h>
-#include <DD4hep/Fields.h>
 #include <pybind11/functional.h>
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
@@ -34,22 +28,13 @@ using namespace pybind11::literals;
 using namespace ActsExamples;
 using namespace ActsPython;
 
-PYBIND11_MODULE(ActsPythonBindingsDD4hep, m) {
+PYBIND11_MODULE(ActsExamplesPythonBindingsDD4hep, m) {
   {
-    py::class_<DD4hepDetectorElement, DetectorElementBase,
-               std::shared_ptr<DD4hepDetectorElement>>(m,
-                                                       "DD4hepDetectorElement");
-
     py::class_<AlignedDD4hepDetectorElement, DD4hepDetectorElement,
                std::shared_ptr<AlignedDD4hepDetectorElement>>(
         m, "AlignedDD4hepDetectorElement");
   }
 
-  {
-    py::class_<dd4hep::DetElement, std::shared_ptr<dd4hep::DetElement>>(
-        m, "DD4hepDetElement");
-  }
-
   {
     auto base =
         py::class_<DD4hepDetectorBase, Detector,
@@ -93,81 +78,4 @@ PYBIND11_MODULE(ActsPythonBindingsDD4hep, m) {
 
     patchKwargsConstructor(c);
   }
-
-  {
-    py::class_<DD4hepFieldAdapter, MagneticFieldProvider,
-               std::shared_ptr<DD4hepFieldAdapter>>(m, "DD4hepFieldAdapter");
-  }
-
-  {
-    m.def(
-        "createDD4hepIdGeoIdMap",
-        [](const TrackingGeometry& tGeometry)
-            -> std::map<DD4hepDetectorElement::DD4hepVolumeID,
-                        GeometryIdentifier> {
-          // The surface visitor
-          struct DD4hepIdGrabber {
-            std::map<DD4hepDetectorElement::DD4hepVolumeID, GeometryIdentifier>
-                dd4hepIdGeoIdMap;
-
-            void operator()(const Surface* surface) {
-              const auto* dde = surface->associatedDetectorElement();
-              const auto* dd4hepDetElement =
-                  dynamic_cast<const DD4hepDetectorElement*>(dde);
-              // Check if it is valid
-              if (dd4hepDetElement != nullptr) {
-                dd4hep::DDSegmentation::VolumeID dd4hepID =
-                    dd4hepDetElement->sourceElement().volumeID();
-                auto geoID = surface->geometryId();
-                dd4hepIdGeoIdMap[dd4hepID] = geoID;
-              }
-            }
-          };
-
-          // Create an instance
-          DD4hepIdGrabber dd4hepIdGrabber;
-          // Visit the surfaces & return what you have
-          tGeometry.visitSurfaces(dd4hepIdGrabber);
-          return dd4hepIdGrabber.dd4hepIdGeoIdMap;
-        });
-  }
-
-  {
-    using Options = DD4hepDetectorStructure::Options;
-    auto o = py::class_<Options>(m, "DD4hepDetectorOptions").def(py::init<>());
-    ACTS_PYTHON_STRUCT(o, logLevel, emulateToGraph, geoIdGenerator,
-                       materialDecorator);
-
-    patchKwargsConstructor(o);
-
-    m.def("attachDD4hepGeoIdMapper",
-          [](DD4hepDetectorStructure::Options& options,
-             const std::map<DD4hepDetectorElement::DD4hepVolumeID,
-                            GeometryIdentifier>& dd4hepIdGeoIdMap) {
-            // The Geo mapper
-            auto geoIdMapper = std::make_shared<const DD4hepIdentifierMapper>(
-                DD4hepIdentifierMapper::Config{dd4hepIdGeoIdMap},
-                getDefaultLogger("GeometryIdMapper", options.logLevel));
-
-            // A remaining recursive logger
-            auto geoIdGenerator =
-                std::make_shared<const Experimental::GeometryIdGenerator>(
-                    Experimental::GeometryIdGenerator::Config{},
-                    getDefaultLogger("GeometryIdGenerator", options.logLevel));
-
-            std::tuple<std::shared_ptr<const Experimental::GeometryIdGenerator>,
-                       std::shared_ptr<const DD4hepIdentifierMapper>>
-                chainedGenerators = {geoIdGenerator, geoIdMapper};
-
-            auto chainedGeoIdGenerator =
-                std::make_shared<const Experimental::ChainedGeometryIdGenerator<
-                    std::shared_ptr<const Experimental::GeometryIdGenerator>,
-                    std::shared_ptr<const DD4hepIdentifierMapper>>>(
-                    std::move(chainedGenerators),
-                    getDefaultLogger("ChainedGeometryIdGenerator",
-                                     options.logLevel));
-
-            options.geoIdGenerator = chainedGeoIdGenerator;
-          });
-  }
 }