chore: add detector directory (#1867)

This PR moves the new `Detector` infrastructure into its own directory, it should help organize this effort a bit better.
acts-project · Feb 16, 2023 · 656e69a · 656e69a
1 parent d857080
commit 656e69a
Show file tree

Hide file tree

Showing 36 changed files with 68 additions and 67 deletions.
diff --git a/Core/CMakeLists.txt b/Core/CMakeLists.txt
@@ -132,6 +132,7 @@ install(
 add_subdirectory(src/EventData)
 add_subdirectory(src/Digitization)
 add_subdirectory(src/Definitions)
+add_subdirectory(src/Detector)
 add_subdirectory(src/Geometry)
 add_subdirectory(src/MagneticField)
 add_subdirectory(src/Material)

diff --git a/Core/include/Acts/Geometry/Detector.hpp → Core/include/Acts/Detector/Detector.hpp b/Core/include/Acts/Geometry/Detector.hpp → Core/include/Acts/Detector/Detector.hpp
@@ -10,7 +10,7 @@
 
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/Definitions/Common.hpp"
-#include "Acts/Geometry/DetectorVolume.hpp"
+#include "Acts/Detector/DetectorVolume.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Navigation/NavigationDelegates.hpp"
 #include "Acts/Utilities/Delegate.hpp"

diff --git a/.../include/Acts/Geometry/DetectorVolume.hpp → .../include/Acts/Detector/DetectorVolume.hpp b/.../include/Acts/Geometry/DetectorVolume.hpp → .../include/Acts/Detector/DetectorVolume.hpp
diff --git a/Core/include/Acts/Geometry/Portal.hpp → Core/include/Acts/Detector/Portal.hpp b/Core/include/Acts/Geometry/Portal.hpp → Core/include/Acts/Detector/Portal.hpp
diff --git a/...Acts/Geometry/detail/PortalGenerators.hpp → ...nclude/Acts/Detector/PortalGenerators.hpp b/...Acts/Geometry/detail/PortalGenerators.hpp → ...nclude/Acts/Detector/PortalGenerators.hpp
@@ -9,8 +9,8 @@
 #pragma once
 
 #include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Detector/Portal.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
-#include "Acts/Geometry/Portal.hpp"
 #include "Acts/Geometry/VolumeBounds.hpp"
 #include "Acts/Navigation/DetectorVolumeUpdators.hpp"
 #include "Acts/Utilities/Helpers.hpp"
@@ -22,10 +22,8 @@
 
 namespace Acts {
 namespace Experimental {
-namespace detail {
 
 /// @brief Generator function for creation of portal surfaces
-/// for a cylindrical volume
 ///
 /// @param dTransform a contextually resolved transform
 /// @param dBounds the detecor volume bounds
@@ -79,6 +77,5 @@ defaultPortalGenerator() {
   return pGenerator;
 }
 
-}  // namespace detail
 }  // namespace Experimental
 }  // namespace Acts
diff --git a/...ude/Acts/Geometry/detail/PortalHelper.hpp → Core/include/Acts/Detector/PortalHelper.hpp b/...ude/Acts/Geometry/detail/PortalHelper.hpp → Core/include/Acts/Detector/PortalHelper.hpp
@@ -8,10 +8,10 @@
 
 #pragma once
 
-#include "Acts/Geometry/DetectorVolume.hpp"
+#include "Acts/Detector/DetectorVolume.hpp"
+#include "Acts/Detector/Portal.hpp"
+#include "Acts/Detector/PortalGenerators.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
-#include "Acts/Geometry/Portal.hpp"
-#include "Acts/Geometry/detail/PortalGenerators.hpp"
 #include "Acts/Utilities/Delegate.hpp"
 
 #include <exception>
@@ -21,7 +21,6 @@
 
 namespace Acts {
 namespace Experimental {
-namespace detail {
 
 /// @brief Calls the portal generation and adds registration to sub portals
 ///
@@ -61,6 +60,7 @@ generatePortalsUpdateInternals(
 /// Create a default portal generator that connects to the
 /// static method.
 ///
+/// @note parameters are ignored in this case
 inline static Delegate<std::vector<std::shared_ptr<Portal>>(
     const Transform3&, const VolumeBounds&,
     const std::shared_ptr<DetectorVolume>&)>
@@ -127,6 +127,5 @@ std::vector<std::shared_ptr<DetectorVolume>> attachedDetectorVolumes(
   return attachedVolumes[iu];
 }
 
-}  // namespace detail
 }  // namespace Experimental
 }  // namespace Acts
diff --git a/Core/include/Acts/Geometry/ProtoDetector.hpp → Core/include/Acts/Detector/ProtoDetector.hpp b/Core/include/Acts/Geometry/ProtoDetector.hpp → Core/include/Acts/Detector/ProtoDetector.hpp
diff --git a/Core/include/Acts/Geometry/KDTreeTrackingGeometryBuilder.hpp b/Core/include/Acts/Geometry/KDTreeTrackingGeometryBuilder.hpp
@@ -8,9 +8,9 @@
 
 #pragma once
 
+#include "Acts/Detector/ProtoDetector.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Geometry/GeometryIdentifier.hpp"
-#include "Acts/Geometry/ProtoDetector.hpp"
 #include "Acts/Geometry/TrackingGeometryBuilder.hpp"
 #include "Acts/Utilities/KDTree.hpp"
 #include "Acts/Utilities/Logger.hpp"

diff --git a/Core/include/Acts/Navigation/DetectorVolumeFinders.hpp b/Core/include/Acts/Navigation/DetectorVolumeFinders.hpp
@@ -8,8 +8,8 @@
 
 #pragma once
 
-#include "Acts/Geometry/Detector.hpp"
-#include "Acts/Geometry/DetectorVolume.hpp"
+#include "Acts/Detector/Detector.hpp"
+#include "Acts/Detector/DetectorVolume.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Navigation/NavigationDelegates.hpp"
 #include "Acts/Navigation/NavigationState.hpp"

diff --git a/Core/include/Acts/Navigation/SurfaceCandidatesUpdators.hpp b/Core/include/Acts/Navigation/SurfaceCandidatesUpdators.hpp
@@ -10,9 +10,9 @@
 
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/Definitions/Common.hpp"
-#include "Acts/Geometry/DetectorVolume.hpp"
+#include "Acts/Detector/DetectorVolume.hpp"
+#include "Acts/Detector/Portal.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
-#include "Acts/Geometry/Portal.hpp"
 #include "Acts/Navigation/NavigationState.hpp"
 #include "Acts/Navigation/NavigationStateUpdators.hpp"
 #include "Acts/Surfaces/Surface.hpp"

diff --git a/Core/include/Acts/Visualization/GeometryView3D.hpp b/Core/include/Acts/Visualization/GeometryView3D.hpp
@@ -9,8 +9,8 @@
 #pragma once
 
 #include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Detector/DetectorVolume.hpp"
 #include "Acts/Geometry/AbstractVolume.hpp"
-#include "Acts/Geometry/DetectorVolume.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Visualization/IVisualization3D.hpp"
 #include "Acts/Visualization/ViewConfig.hpp"

diff --git a/Core/src/Detector/CMakeLists.txt b/Core/src/Detector/CMakeLists.txt
@@ -0,0 +1,8 @@
+target_sources(
+  ActsCore
+  PRIVATE
+    Detector.cpp
+    DetectorVolume.cpp
+    Portal.cpp
+    ProtoDetector.cpp
+)
diff --git a/Core/src/Geometry/Detector.cpp → Core/src/Detector/Detector.cpp b/Core/src/Geometry/Detector.cpp → Core/src/Detector/Detector.cpp
@@ -6,10 +6,10 @@
 // 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/.
 
-#include "Acts/Geometry/Detector.hpp"
+#include "Acts/Detector/Detector.hpp"
 
 #include "Acts/Definitions/Common.hpp"
-#include "Acts/Geometry/Portal.hpp"
+#include "Acts/Detector/Portal.hpp"
 #include "Acts/Geometry/VolumeBounds.hpp"
 #include "Acts/Navigation/NavigationState.hpp"
 #include "Acts/Surfaces/Surface.hpp"

diff --git a/Core/src/Geometry/DetectorVolume.cpp → Core/src/Detector/DetectorVolume.cpp b/Core/src/Geometry/DetectorVolume.cpp → Core/src/Detector/DetectorVolume.cpp
@@ -6,9 +6,9 @@
 // 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/.
 
-#include "Acts/Geometry/DetectorVolume.hpp"
+#include "Acts/Detector/DetectorVolume.hpp"
 
-#include "Acts/Geometry/Portal.hpp"
+#include "Acts/Detector/Portal.hpp"
 #include "Acts/Geometry/VolumeBounds.hpp"
 #include "Acts/Navigation/DetectorVolumeUpdators.hpp"
 #include "Acts/Navigation/NavigationState.hpp"

diff --git a/Core/src/Geometry/Portal.cpp → Core/src/Detector/Portal.cpp b/Core/src/Geometry/Portal.cpp → Core/src/Detector/Portal.cpp
@@ -6,7 +6,7 @@
 // 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/.
 
-#include "Acts/Geometry/Portal.hpp"
+#include "Acts/Detector/Portal.hpp"
 
 #include "Acts/Surfaces/Surface.hpp"
 

diff --git a/Core/src/Geometry/ProtoDetector.cpp → Core/src/Detector/ProtoDetector.cpp b/Core/src/Geometry/ProtoDetector.cpp → Core/src/Detector/ProtoDetector.cpp
@@ -6,7 +6,7 @@
 // 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/.
 
-#include "Acts/Geometry/ProtoDetector.hpp"
+#include "Acts/Detector/ProtoDetector.hpp"
 
 #include "Acts/Utilities/Enumerate.hpp"
 

diff --git a/Core/src/Geometry/CMakeLists.txt b/Core/src/Geometry/CMakeLists.txt
@@ -13,8 +13,6 @@ target_sources(
     CylinderVolumeHelper.cpp
     Extent.cpp
     KDTreeTrackingGeometryBuilder.cpp
-    Detector.cpp
-    DetectorVolume.cpp
     DiscLayer.cpp
     GenericApproachDescriptor.cpp
     GenericCuboidVolumeBounds.cpp
@@ -27,9 +25,7 @@ target_sources(
     PassiveLayerBuilder.cpp
     PlaneLayer.cpp
     Polyhedron.cpp
-    Portal.cpp
     ProtoLayer.cpp
-    ProtoDetector.cpp
     ProtoLayerHelper.cpp
     SurfaceArrayCreator.cpp
     TrackingGeometry.cpp

diff --git a/Core/src/Visualization/GeometryView3D.cpp b/Core/src/Visualization/GeometryView3D.cpp
@@ -8,11 +8,11 @@
 
 #include "Acts/Visualization/GeometryView3D.hpp"
 
+#include "Acts/Detector/DetectorVolume.hpp"
+#include "Acts/Detector/Portal.hpp"
 #include "Acts/Geometry/CylinderVolumeBounds.hpp"
-#include "Acts/Geometry/DetectorVolume.hpp"
 #include "Acts/Geometry/Layer.hpp"
 #include "Acts/Geometry/Polyhedron.hpp"
-#include "Acts/Geometry/Portal.hpp"
 #include "Acts/Geometry/TrackingVolume.hpp"
 #include "Acts/Surfaces/ConeBounds.hpp"
 #include "Acts/Surfaces/ConeSurface.hpp"

diff --git a/Examples/Detectors/Geant4Detector/include/ActsExamples/Geant4Detector/Geant4Detector.hpp b/Examples/Detectors/Geant4Detector/include/ActsExamples/Geant4Detector/Geant4Detector.hpp
@@ -8,8 +8,8 @@
 
 #pragma once
 
+#include "Acts/Detector/ProtoDetector.hpp"
 #include "Acts/Geometry/GeometryIdentifier.hpp"
-#include "Acts/Geometry/ProtoDetector.hpp"
 #include "Acts/Plugins/Geant4/Geant4DetectorSurfaceFactory.hpp"
 
 #include <memory>

diff --git a/Examples/Detectors/Geant4Detector/src/Geant4Detector.cpp b/Examples/Detectors/Geant4Detector/src/Geant4Detector.cpp
@@ -8,8 +8,8 @@
 
 #include "ActsExamples/Geant4Detector/Geant4Detector.hpp"
 
+#include "Acts/Detector/Detector.hpp"
 #include "Acts/Geometry/CylinderVolumeHelper.hpp"
-#include "Acts/Geometry/Detector.hpp"
 #include "Acts/Geometry/KDTreeTrackingGeometryBuilder.hpp"
 #include "Acts/Geometry/LayerArrayCreator.hpp"
 #include "Acts/Geometry/LayerCreator.hpp"

diff --git a/Examples/Python/src/Geant4Component.cpp b/Examples/Python/src/Geant4Component.cpp
@@ -6,7 +6,7 @@
 // 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/.
 
-#include "Acts/Geometry/Detector.hpp"
+#include "Acts/Detector/Detector.hpp"
 #include "Acts/Geometry/TrackingGeometry.hpp"
 #include "Acts/MagneticField/MagneticFieldProvider.hpp"
 #include "Acts/Plugins/Geant4/Geant4DetectorElement.hpp"

diff --git a/Examples/Python/src/Geometry.cpp b/Examples/Python/src/Geometry.cpp
@@ -6,9 +6,9 @@
 // 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/.
 
-#include "Acts/Geometry/Detector.hpp"
+#include "Acts/Detector/Detector.hpp"
+#include "Acts/Detector/ProtoDetector.hpp"
 #include "Acts/Geometry/GeometryIdentifier.hpp"
-#include "Acts/Geometry/ProtoDetector.hpp"
 #include "Acts/Geometry/TrackingGeometry.hpp"
 #include "Acts/Plugins/Python/Utilities.hpp"
 #include "Acts/Surfaces/Surface.hpp"

diff --git a/Examples/Python/src/Json.cpp b/Examples/Python/src/Json.cpp
@@ -6,7 +6,7 @@
 // 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/.
 
-#include "Acts/Geometry/ProtoDetector.hpp"
+#include "Acts/Detector/ProtoDetector.hpp"
 #include "Acts/Material/IMaterialDecorator.hpp"
 #include "Acts/Plugins/Json/JsonMaterialDecorator.hpp"
 #include "Acts/Plugins/Json/MaterialMapJsonConverter.hpp"

diff --git a/Plugins/Json/include/Acts/Plugins/Json/ProtoDetectorJsonConverter.hpp b/Plugins/Json/include/Acts/Plugins/Json/ProtoDetectorJsonConverter.hpp
@@ -8,7 +8,7 @@
 
 #pragma once
 
-#include "Acts/Geometry/ProtoDetector.hpp"
+#include "Acts/Detector/ProtoDetector.hpp"
 #include "Acts/Plugins/Json/UtilitiesJsonConverter.hpp"
 
 // Custom Json encoder/decoders. Naming is mandated by nlohmann::json and thus

diff --git a/Tests/UnitTests/Core/CMakeLists.txt b/Tests/UnitTests/Core/CMakeLists.txt
@@ -2,6 +2,7 @@ add_unittest(Version VersionTests.cpp)
 
 add_subdirectory(Clusterization)
 add_subdirectory(Definitions)
+add_subdirectory(Detector)
 add_subdirectory(Digitization)
 add_subdirectory(EventData)
 add_subdirectory(Geometry)

diff --git a/Tests/UnitTests/Core/Detector/CMakeLists.txt b/Tests/UnitTests/Core/Detector/CMakeLists.txt
@@ -0,0 +1,6 @@
+add_unittest(Detector DetectorTests.cpp)
+add_unittest(DetectorVolume DetectorVolumeTests.cpp)
+add_unittest(ProtoDetector ProtoDetectorTests.cpp)
+add_unittest(Portal PortalTests.cpp)
+add_unittest(PortalGenerators PortalGeneratorsTests.cpp)
+
diff --git a/...UnitTests/Core/Geometry/DetectorTests.cpp → ...UnitTests/Core/Detector/DetectorTests.cpp b/...UnitTests/Core/Geometry/DetectorTests.cpp → ...UnitTests/Core/Detector/DetectorTests.cpp
@@ -8,11 +8,11 @@
 
 #include <boost/test/unit_test.hpp>
 
+#include "Acts/Detector/Detector.hpp"
+#include "Acts/Detector/DetectorVolume.hpp"
+#include "Acts/Detector/PortalGenerators.hpp"
 #include "Acts/Geometry/CylinderVolumeBounds.hpp"
-#include "Acts/Geometry/Detector.hpp"
-#include "Acts/Geometry/DetectorVolume.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
-#include "Acts/Geometry/detail/PortalGenerators.hpp"
 #include "Acts/Navigation/DetectorVolumeFinders.hpp"
 #include "Acts/Navigation/NavigationStateUpdators.hpp"
 #include "Acts/Navigation/SurfaceCandidatesUpdators.hpp"
@@ -60,7 +60,7 @@ BOOST_AUTO_TEST_CASE(DetectorConstruction) {
   auto cyl2Bounds =
       std::make_unique<Acts::CylinderVolumeBounds>(r2, r3, zHalfL);
 
-  auto portalGenerator = Acts::Experimental::detail::defaultPortalGenerator();
+  auto portalGenerator = Acts::Experimental::defaultPortalGenerator();
 
   auto cyl0 = Acts::Experimental::DetectorVolumeFactory::construct(
       portalGenerator, tContext, "Cyl0", nominal, std::move(cyl0Bounds),

diff --git a/...sts/Core/Geometry/DetectorVolumeTests.cpp → ...sts/Core/Detector/DetectorVolumeTests.cpp b/...sts/Core/Geometry/DetectorVolumeTests.cpp → ...sts/Core/Detector/DetectorVolumeTests.cpp
@@ -8,12 +8,12 @@
 
 #include <boost/test/unit_test.hpp>
 
+#include "Acts/Detector/DetectorVolume.hpp"
+#include "Acts/Detector/PortalGenerators.hpp"
+#include "Acts/Detector/PortalHelper.hpp"
 #include "Acts/Geometry/CuboidVolumeBounds.hpp"
 #include "Acts/Geometry/CylinderVolumeBounds.hpp"
-#include "Acts/Geometry/DetectorVolume.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
-#include "Acts/Geometry/detail/PortalGenerators.hpp"
-#include "Acts/Geometry/detail/PortalHelper.hpp"
 #include "Acts/Navigation/DetectorVolumeUpdators.hpp"
 #include "Acts/Navigation/NavigationState.hpp"
 #include "Acts/Navigation/SurfaceCandidatesUpdators.hpp"
@@ -53,7 +53,7 @@ BOOST_AUTO_TEST_CASE(CylindricalDetectorVolumePortals) {
   auto fullCylinderBounds =
       std::make_unique<Acts::CylinderVolumeBounds>(0., rOuter, zHalfL);
 
-  auto portalGenerator = detail::defaultPortalGenerator();
+  auto portalGenerator = defaultPortalGenerator();
 
   // Misconfigured - null pointer for bounds
   BOOST_CHECK_THROW(
@@ -116,7 +116,7 @@ BOOST_AUTO_TEST_CASE(UpdatePortal) {
   auto fullCylinderBounds =
       std::make_unique<Acts::CylinderVolumeBounds>(0., 10., 100.);
 
-  auto portalGenerator = detail::defaultPortalGenerator();
+  auto portalGenerator = defaultPortalGenerator();
 
   auto fullCylinderVolume = DetectorVolumeFactory::construct(
       portalGenerator, tContext, "FullCylinderVolume", nominal,
@@ -144,9 +144,8 @@ BOOST_AUTO_TEST_CASE(CuboidWithCuboid) {
   auto smallBoxBounds =
       std::make_unique<Acts::CuboidVolumeBounds>(smallBox, smallBox, smallBox);
 
-  auto portals = detail::defaultPortalGenerator();
-  auto generatePortalsUpdateInternals =
-      detail::defaultPortalAndSubPortalGenerator();
+  auto portals = defaultPortalGenerator();
+  auto generatePortalsUpdateInternals = defaultPortalAndSubPortalGenerator();
 
   // Create the inner box
   auto innerBox =