Dev/python bindings for strixels (#364)

- added release notes - added documentation for python - added python bindings --------- Co-authored-by: vhinger <viktoria.hinger@psi.ch> Co-authored-by: Erik Fröjdh <erik.frojdh@psi.ch>
2026-09-25 20:32:10 +02:00 · 2026-09-16 13:53:02 +02:00
parent 2027c8371f
commit c880d6a252
35 changed files with 2321 additions and 826 deletions
@@ -0,0 +1,182 @@
+#include <pybind11/pybind11.h>
+
+#include "aare/StrixelPixelRemapping/StrixelPixelRemapDefs.hpp"
+#include "aare/StrixelPixelRemapping/StrixelPixelRemapFormat.hpp"
+
+namespace py = pybind11;
+
+void define_PixelStrixelMapDefs(py::module &m) {
+
+    py::enum_<aare::remap::defs::Rotation>(m, "Rotation")
+        .value("Identity", aare::remap::defs::Rotation::Identity)
+        .value("Rotate180", aare::remap::defs::Rotation::Rotate180)
+        .export_values();
+
+    py::enum_<aare::remap::defs::ModuloOrdering>(m, "ModuloOrdering")
+        .value("Forward", aare::remap::defs::ModuloOrdering::Forward)
+        .value("Reverse", aare::remap::defs::ModuloOrdering::Reverse)
+        .export_values();
+
+    py::class_<aare::remap::defs::Guardring>(m, "Guardring")
+        .def(py::init<int, int>(), py::arg("x"), py::arg("y"))
+        .def_readwrite("x", &aare::remap::defs::Guardring::x,
+                       "ring width in pixels")
+        .def_readwrite("y", &aare::remap::defs::Guardring::y,
+                       "ring height in pixels")
+        .def(
+            "__eq__",
+            [](const aare::remap::defs::Guardring &self,
+               const aare::remap::defs::Guardring &other) {
+                return self.x == other.x && self.y == other.y;
+            },
+            py::is_operator())
+
+        .def("__repr__", [](const aare::remap::defs::Guardring &self) {
+            return fmt::format("Guardring{{x={}, y={}}}", self.x, self.y);
+        });
+
+    py::class_<aare::remap::defs::BondShift>(m, "BondShift")
+        .def(py::init<int, int>(), py::arg("x"), py::arg("y"))
+        .def_readwrite("x", &aare::remap::defs::BondShift::x,
+                       "bond shift in x direction (pixels)")
+        .def_readwrite("y", &aare::remap::defs::BondShift::y,
+                       "bond shift in y direction (pixels)")
+        .def("__repr__", [](const aare::remap::defs::BondShift &self) {
+            return fmt::format("BondShift{{x={}, y={}}}", self.x, self.y);
+        });
+
+    py::class_<aare::remap::defs::SensorPixelGeometry>(m, "SensorPixelGeometry")
+        .def(py::init<int, int, aare::remap::defs::Guardring>(),
+             py::arg("num_pix_x"), py::arg("num_pix_y"),
+             py::arg("guardring") = aare::remap::defs::Guardring{0, 0})
+        .def_readwrite("num_pix_x",
+                       &aare::remap::defs::SensorPixelGeometry::num_pix_x,
+                       "number of pixels in x direction")
+        .def_readwrite("num_pix_y",
+                       &aare::remap::defs::SensorPixelGeometry::num_pix_y,
+                       "number of pixels in y direction")
+        .def_readwrite(
+            "guardring", &aare::remap::defs::SensorPixelGeometry::guardring,
+            "physical guardring around the sensor (default Guardring(0,0))")
+
+        .def("__repr__",
+             [](const aare::remap::defs::SensorPixelGeometry &self) {
+                 return fmt::format("SensorPixelGeometry{}",
+                                    aare::remap::format::to_string(self));
+             });
+
+    py::class_<aare::remap::defs::GroupStrixelGeometry>(m,
+                                                        "GroupStrixelGeometry")
+        .def(py::init<int, double>(), py::arg("multiplicity"),
+             py::arg("pitch_um"))
+        .def_readwrite("multiplicity",
+                       &aare::remap::defs::GroupStrixelGeometry::multiplicity,
+                       "maximum number of pixels a strixel covers")
+        .def_readwrite("pitch_um",
+                       &aare::remap::defs::GroupStrixelGeometry::pitch_um,
+                       "effective minimal strixel pitch [µm]")
+        .def("__repr__",
+             [](const aare::remap::defs::GroupStrixelGeometry &self) {
+                 return fmt::format("GroupStrixelGeometry{}",
+                                    aare::remap::format::to_string(self));
+             });
+
+    py::class_<aare::remap::defs::GroupRouting>(m, "GroupRouting")
+        .def(py::init<aare::remap::defs::ModuloOrdering>(),
+             py::arg("mod_order") = aare::remap::defs::ModuloOrdering::Forward)
+        .def_readwrite(
+            "mod_order", &aare::remap::defs::GroupRouting::mod_order,
+            "modulo ordering of pixels within each strixel multiplicity group "
+            "default(ModuloOrdering::Forward)")
+
+        .def("__repr__", [](const aare::remap::defs::GroupRouting &self) {
+            return fmt::format("GroupRouting{}",
+                               aare::remap::format::to_string(self));
+        });
+
+    py::class_<aare::remap::defs::GroupConfig>(m, "GroupConfig")
+        .def(py::init<aare::remap::defs::GroupStrixelGeometry,
+                      aare::remap::defs::GroupRouting, aare::InclusiveROI>(),
+             py::arg("strixel"), py::arg("routing"),
+             py::arg("placement_on_sensor"))
+
+        .def(py::init([](const aare::remap::defs::GroupStrixelGeometry &strixel,
+                         const aare::remap::defs::ModuloOrdering &mod_order,
+                         const aare::InclusiveROI &placement_on_sensor) {
+                 return aare::remap::defs::GroupConfig{
+                     strixel, {mod_order}, placement_on_sensor};
+             }),
+             py::arg("strixel"), py::arg("routing"),
+             py::arg("placement_on_sensor"))
+        .def_readwrite("strixel", &aare::remap::defs::GroupConfig::strixel,
+                       "strixel geometry of the group")
+        .def_readwrite("routing", &aare::remap::defs::GroupConfig::routing,
+                       "pixel-to-strixel routing pattern")
+        .def_readwrite(
+            "placement_on_sensor",
+            &aare::remap::defs::GroupConfig::placement_on_sensor,
+            "placement of the strixel group on the sensor (sensor-local "
+            "coordinates)")
+
+        .def("__repr__", [](const aare::remap::defs::GroupConfig &self) {
+            return fmt::format("GroupConfig{}",
+                               aare::remap::format::to_string(self));
+        });
+
+    py::class_<aare::remap::defs::SensorModulePlacement>(
+        m, "SensorModulePlacement")
+        .def(py::init<aare::InclusiveROI, aare::remap::defs::Rotation>(),
+             py::arg("placement_on_module"), py::arg("rotation"))
+        .def_readwrite(
+            "placement_on_module",
+            &aare::remap::defs::SensorModulePlacement::placement_on_module,
+            "sensor bounds in module coordinates")
+        .def_readwrite(
+            "rotation", &aare::remap::defs::SensorModulePlacement::rotation,
+            "physical orientation of the mounted sensor-ASIC assembly with "
+            "respect to the module reference frame")
+
+        .def("__repr__",
+             [](const aare::remap::defs::SensorModulePlacement &self) {
+                 return fmt::format("SensorModulePlacement{}",
+                                    aare::remap::format::to_string(self));
+             });
+
+    py::class_<aare::remap::defs::StrixelGroupToPixelMap>(
+        m, "StrixelGroupToPixelMap")
+        .def(py::init<>())
+        .def_readonly("effective_roi",
+                      &aare::remap::defs::StrixelGroupToPixelMap::effective_roi,
+                      "effective pixel ROI covered by this map (InclusiveROI)")
+
+        .def_property_readonly(
+            "map",
+            [](const aare::remap::defs::StrixelGroupToPixelMap &self)
+                -> py::array {
+                return py::array_t<ssize_t>(
+                    self.map.shape(), self.map.data(),
+                    py::cast(&self, py::return_value_policy::reference));
+            })
+
+        .def("empty", &aare::remap::defs::StrixelGroupToPixelMap::empty, R"(
+            Check if the map is empty.
+
+            Returns
+            -------
+            bool
+                True if the map is empty, False otherwise.
+        )");
+}
+
+template <std::size_t N> void define_SensorConfig(py::module &m) {
+    const auto class_name = fmt::format("SensorConfig_{}PixelGroups", N);
+    py::class_<aare::remap::defs::SensorConfig<N>>(m, class_name.c_str())
+        .def(py::init<aare::remap::defs::SensorPixelGeometry,
+                      std::array<aare::remap::defs::GroupConfig, N>>(),
+             py::arg("pixel"), py::arg("group_configs"))
+        .def_readwrite("pixel", &aare::remap::defs::SensorConfig<N>::pixel,
+                       "sensor pixel geometry (SensorPixelGeometry)")
+        .def_readwrite("group_configs",
+                       &aare::remap::defs::SensorConfig<N>::group_configs,
+                       "[list] of strixel group configurations");
+}