feat: move ROOT surface material map I/O to plugins (acts-project#4400)

This PR moves the I/O for material map reading/writing into
`Plugins/Root` and removes the duplicated code from `RootMaterialWriter`
and `RootMaterialDecorator`.

It also harmonizes the usage/definition of `SurfaceMaterialMaps`.
`VolumeMaterialMaps`, and `DetectorMaterialMaps` consistently by
declaring them once.

It is backward compatible, and introduces a new, common ROOT I/O
material backend that can be shared between all material classes
(homongeneous, binned, grid, indexed).

This PR also allows UnitTests to be added for Material writing, the
first ones are done with it, and it removes roughly 100 SonarCloud
issues, mainly related to how we call and use ROOT.

This will be followed by a PRs doing the same for Volume material and
updated Grid based surface material.

The reading gis kept backward-compatible.


--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

- Use a *conventional commits* prefix: [quick
summary](https://www.conventionalcommits.org/en/v1.0.0/#summary)
- We mostly use `feat`, `fix`, `refactor`, `docs`, `chore` and `build`
types.
- A milestone will be assigned by one of the maintainers

---------

Co-authored-by: Paul Gessinger <hello@paulgessinger.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: 3 people

Core/include/Acts/Material/MaterialMapper.hpp

@@ -12,6 +12,7 @@
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
 #include "Acts/Material/MaterialInteraction.hpp"
 #include "Acts/Material/MaterialInteractionAssignment.hpp"
+#include "Acts/Material/TrackingGeometryMaterial.hpp"
 #include "Acts/Material/interface/IAssignmentFinder.hpp"
 #include "Acts/Material/interface/ISurfaceMaterialAccumulater.hpp"
 #include "Acts/Utilities/Logger.hpp"
@@ -24,14 +25,6 @@ namespace Acts {
 /// @brief material mapping procedure
 class MaterialMapper {
  public:
-  /// @brief The material maps
-  using SurfaceMaterialMaps =
-      std::map<GeometryIdentifier, std::shared_ptr<const ISurfaceMaterial>>;
-  using VolumeMaterialMaps =
-      std::map<GeometryIdentifier, std::shared_ptr<const IVolumeMaterial>>;
-  using DetectorMaterialMaps =
-      std::pair<SurfaceMaterialMaps, VolumeMaterialMaps>;
-
   /// @brief nested configuration struct
   struct Config {
     // The assignment finder
@@ -83,7 +76,7 @@ class MaterialMapper {
       const Options& options = Options{}) const;
 
   /// Finalize the maps
-  DetectorMaterialMaps finalizeMaps(const State& state) const;
+  TrackingGeometryMaterial finalizeMaps(const State& state) const;
 
  private:
   /// Access method to the logger

Core/include/Acts/Material/TrackingGeometryMaterial.hpp

@@ -0,0 +1,28 @@
+// This file is part of the ACTS project.
+//
+// Copyright (C) 2016 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 https://mozilla.org/MPL/2.0/.
+
+#pragma once
+
+#include "Acts/Geometry/GeometryIdentifier.hpp"
+#include "Acts/Material/ISurfaceMaterial.hpp"
+#include "Acts/Material/IVolumeMaterial.hpp"
+
+#include <map>
+#include <memory>
+#include <utility>
+
+namespace Acts {
+
+using SurfaceMaterialMaps =
+    std::map<GeometryIdentifier, std::shared_ptr<const ISurfaceMaterial>>;
+using VolumeMaterialMaps =
+    std::map<GeometryIdentifier, std::shared_ptr<const IVolumeMaterial>>;
+using TrackingGeometryMaterial =
+    std::pair<SurfaceMaterialMaps, VolumeMaterialMaps>;
+
+}  // namespace Acts

Core/src/Material/MaterialMapper.cpp

@@ -79,10 +79,10 @@ Acts::MaterialMapper::mapMaterial(State& state, const GeometryContext& gctx,
   return {mappedMaterial, unmappedMaterial};
 }
 
-Acts::MaterialMapper::DetectorMaterialMaps Acts::MaterialMapper::finalizeMaps(
+Acts::TrackingGeometryMaterial Acts::MaterialMapper::finalizeMaps(
     const State& state) const {
   // The final maps
-  DetectorMaterialMaps detectorMaterialMaps;
+  TrackingGeometryMaterial detectorMaterialMaps;
   // The surface maps
   detectorMaterialMaps.first =
       m_cfg.surfaceMaterialAccumulater->finalizeMaterial(

Examples/Algorithms/MaterialMapping/include/ActsExamples/MaterialMapping/IMaterialWriter.hpp

@@ -9,23 +9,7 @@
 #pragma once
 
 #include "Acts/Geometry/GeometryIdentifier.hpp"
-
-#include <map>
-#include <memory>
-
-namespace Acts {
-
-class ISurfaceMaterial;
-class IVolumeMaterial;
-
-using SurfaceMaterialMap =
-    std::map<GeometryIdentifier, std::shared_ptr<const ISurfaceMaterial>>;
-
-using VolumeMaterialMap =
-    std::map<GeometryIdentifier, std::shared_ptr<const IVolumeMaterial>>;
-
-using DetectorMaterialMaps = std::pair<SurfaceMaterialMap, VolumeMaterialMap>;
-}  // namespace Acts
+#include "Acts/Material/TrackingGeometryMaterial.hpp"
 
 namespace ActsExamples {
 
@@ -40,7 +24,8 @@ class IMaterialWriter {
   /// The single writer class
   ///
   /// @param detMaterial the detector material maps
-  virtual void writeMaterial(const Acts::DetectorMaterialMaps& detMaterial) = 0;
+  virtual void writeMaterial(
+      const Acts::TrackingGeometryMaterial& detMaterial) = 0;
 };
 
 }  // namespace ActsExamples

Examples/Algorithms/MaterialMapping/include/ActsExamples/MaterialMapping/MappingMaterialDecorator.hpp

@@ -41,9 +41,6 @@ class MappingMaterialDecorator : public IMaterialDecorator {
  public:
   using BinningMap = std::map<std::uint64_t, std::pair<int, int>>;
 
-  using VolumeMaterialMap =
-      std::map<GeometryIdentifier, std::shared_ptr<const IVolumeMaterial>>;
-
   MappingMaterialDecorator(const Acts::TrackingGeometry& tGeometry,
                            Acts::Logging::Level level,
                            bool clearSurfaceMaterial = true,
@@ -276,7 +273,7 @@ class MappingMaterialDecorator : public IMaterialDecorator {
  private:
   BinningMap m_binningMap;
 
-  VolumeMaterialMap m_volumeMaterialMap;
+  VolumeMaterialMaps m_volumeMaterialMap;
 
   bool m_clearSurfaceMaterial{true};
   bool m_clearVolumeMaterial{true};

Examples/Algorithms/MaterialMapping/include/ActsExamples/MaterialMapping/MaterialMapping.hpp

@@ -13,6 +13,7 @@
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
 #include "Acts/Material/MaterialInteraction.hpp"
 #include "Acts/Material/SurfaceMaterialMapper.hpp"
+#include "Acts/Material/TrackingGeometryMaterial.hpp"
 #include "Acts/Material/VolumeMaterialMapper.hpp"
 #include "Acts/Utilities/Logger.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
@@ -32,18 +33,7 @@
 #include <vector>
 
 namespace Acts {
-
 class TrackingGeometry;
-class ISurfaceMaterial;
-class IVolumeMaterial;
-
-using SurfaceMaterialMap =
-    std::map<GeometryIdentifier, std::shared_ptr<const ISurfaceMaterial>>;
-
-using VolumeMaterialMap =
-    std::map<GeometryIdentifier, std::shared_ptr<const IVolumeMaterial>>;
-
-using DetectorMaterialMaps = std::pair<SurfaceMaterialMap, VolumeMaterialMap>;
 }  // namespace Acts
 
 namespace ActsExamples {

Examples/Algorithms/MaterialMapping/src/CoreMaterialMapping.cpp

@@ -36,7 +36,7 @@ CoreMaterialMapping::CoreMaterialMapping(const CoreMaterialMapping::Config& cfg,
 }
 
 CoreMaterialMapping::~CoreMaterialMapping() {
-  Acts::DetectorMaterialMaps detectorMaterial =
+  Acts::TrackingGeometryMaterial detectorMaterial =
       m_cfg.materialMapper->finalizeMaps(*m_mappingState);
   // Loop over the available writers and write the maps
   for (auto& imw : m_cfg.materiaMaplWriters) {

Examples/Algorithms/MaterialMapping/src/MaterialMapping.cpp

@@ -49,7 +49,7 @@ MaterialMapping::MaterialMapping(const MaterialMapping::Config& cfg,
 
 ProcessCode MaterialMapping::finalize() {
   ACTS_INFO("Finalizing material mappig output");
-  Acts::DetectorMaterialMaps detectorMaterial;
+  Acts::TrackingGeometryMaterial detectorMaterial;
 
   if (m_cfg.materialSurfaceMapper && m_cfg.materialVolumeMapper) {
     // Finalize all the maps using the cached state

Examples/Io/Json/include/ActsExamples/Io/Json/JsonMaterialWriter.hpp

@@ -12,6 +12,7 @@
 #include "Acts/Geometry/GeometryIdentifier.hpp"
 #include "Acts/Material/ISurfaceMaterial.hpp"
 #include "Acts/Material/IVolumeMaterial.hpp"
+#include "Acts/Material/TrackingGeometryMaterial.hpp"
 #include "Acts/Plugins/Json/MaterialMapJsonConverter.hpp"
 #include "Acts/Utilities/EnumBitwiseOperators.hpp"
 #include "Acts/Utilities/Logger.hpp"
@@ -27,18 +28,7 @@
 #include <utility>
 
 namespace Acts {
-
 class TrackingGeometry;
-class ISurfaceMaterial;
-class IVolumeMaterial;
-
-using SurfaceMaterialMap =
-    std::map<GeometryIdentifier, std::shared_ptr<const ISurfaceMaterial>>;
-
-using VolumeMaterialMap =
-    std::map<GeometryIdentifier, std::shared_ptr<const IVolumeMaterial>>;
-
-using DetectorMaterialMaps = std::pair<SurfaceMaterialMap, VolumeMaterialMap>;
 }  // namespace Acts
 
 namespace ActsExamples {
@@ -79,7 +69,8 @@ class JsonMaterialWriter : public IMaterialWriter {
   /// Write out the material map
   ///
   /// @param detMaterial is the SurfaceMaterial and VolumeMaterial maps
-  void writeMaterial(const Acts::DetectorMaterialMaps& detMaterial) override;
+  void writeMaterial(
+      const Acts::TrackingGeometryMaterial& detMaterial) override;
 
   /// Write out the material map from Geometry
   ///

Examples/Io/Json/src/JsonMaterialWriter.cpp

@@ -28,7 +28,7 @@ ActsExamples::JsonMaterialWriter::JsonMaterialWriter(
 ActsExamples::JsonMaterialWriter::~JsonMaterialWriter() = default;
 
 void ActsExamples::JsonMaterialWriter::writeMaterial(
-    const Acts::DetectorMaterialMaps& detMaterial) {
+    const Acts::TrackingGeometryMaterial& detMaterial) {
   // Evoke the converter
   auto jOut = m_converter->materialMapsToJson(detMaterial);
   // And write the file(s)