chore: rename NextNavigator to DetectorNavigator (#2311)

To distinguish between the `Navigator` that takes the `TrackingGeometry` and the one for the updated `Detector` description, this PR renames the `NextNavigator` to `DetectorNavigator` to make sure what is meant by that.
acts-project · Jul 21, 2023 · 22fa536 · 22fa536
1 parent b30f678
commit 22fa536
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 31 deletions.
diff --git a/...include/Acts/Navigation/NextNavigator.hpp → ...ude/Acts/Navigation/DetectorNavigator.hpp b/...include/Acts/Navigation/NextNavigator.hpp → ...ude/Acts/Navigation/DetectorNavigator.hpp
@@ -31,7 +31,7 @@
 namespace Acts {
 namespace Experimental {
 
-class NextNavigator {
+class DetectorNavigator {
  public:
   struct Config {
     /// Detector for this Navigation
@@ -68,9 +68,10 @@ class NextNavigator {
   ///
   /// @param cfg The navigator configuration
   /// @param _logger a logger instance
-  explicit NextNavigator(Config cfg, std::shared_ptr<const Logger> _logger =
-                                         getDefaultLogger("NextNavigator",
-                                                          Logging::Level::INFO))
+  explicit DetectorNavigator(Config cfg,
+                             std::shared_ptr<const Logger> _logger =
+                                 getDefaultLogger("DetectorNavigator",
+                                                  Logging::Level::INFO))
       : m_cfg{cfg}, m_logger{std::move(_logger)} {}
 
   State makeState(const Surface* startSurface,

diff --git a/Examples/Python/python/acts/__init__.py b/Examples/Python/python/acts/__init__.py
@@ -31,10 +31,10 @@ def Propagator(stepper, navigator):
     for prefix in ("Eigen", "Atlas", "StraightLine"):
         _stepper = getattr(ActsPythonBindings, f"{prefix}Stepper")
         if isinstance(stepper, _stepper):
-            _nextNavigator = getattr(ActsPythonBindings, "NextNavigator")
-            if isinstance(navigator, _nextNavigator):
+            _detectorNavigator = getattr(ActsPythonBindings, "DetectorNavigator")
+            if isinstance(navigator, _detectorNavigator):
                 return getattr(
-                    ActsPythonBindings._propagator, f"{prefix}NextPropagator"
+                    ActsPythonBindings._propagator, f"{prefix}DetectorPropagator"
                 )(stepper, navigator)
             return getattr(ActsPythonBindings._propagator, f"{prefix}Propagator")(
                 stepper, navigator

diff --git a/Examples/Python/src/Propagation.cpp b/Examples/Python/src/Propagation.cpp
@@ -8,7 +8,7 @@
 
 #include "Acts/Definitions/Direction.hpp"
 #include "Acts/EventData/TrackParameters.hpp"
-#include "Acts/Navigation/NextNavigator.hpp"
+#include "Acts/Navigation/DetectorNavigator.hpp"
 #include "Acts/Plugins/Python/Utilities.hpp"
 #include "Acts/Propagator/AtlasStepper.hpp"
 #include "Acts/Propagator/EigenStepper.hpp"
@@ -89,16 +89,17 @@ void addPropagation(Context& ctx) {
   }
 
   {
-    using Config = Acts::Experimental::NextNavigator::Config;
-    auto nav = py::class_<Acts::Experimental::NextNavigator,
-                          std::shared_ptr<Acts::Experimental::NextNavigator>>(
-                   m, "NextNavigator")
-                   .def(py::init<>([](Config cfg,
-                                      Logging::Level level = Logging::INFO) {
-                          return Acts::Experimental::NextNavigator{
-                              cfg, getDefaultLogger("NextNavigator", level)};
-                        }),
-                        py::arg("cfg"), py::arg("level") = Logging::INFO);
+    using Config = Acts::Experimental::DetectorNavigator::Config;
+    auto nav =
+        py::class_<Acts::Experimental::DetectorNavigator,
+                   std::shared_ptr<Acts::Experimental::DetectorNavigator>>(
+            m, "DetectorNavigator")
+            .def(py::init<>(
+                     [](Config cfg, Logging::Level level = Logging::INFO) {
+                       return Acts::Experimental::DetectorNavigator{
+                           cfg, getDefaultLogger("DetectorNavigator", level)};
+                     }),
+                 py::arg("cfg"), py::arg("level") = Logging::INFO);
 
     auto c = py::class_<Config>(nav, "Config").def(py::init<>());
 
@@ -143,7 +144,7 @@ void addPropagation(Context& ctx) {
   }
 
   {
-    addPropagator<Acts::EigenStepper<>, Acts::Experimental::NextNavigator>(
+    addPropagator<Acts::EigenStepper<>, Acts::Experimental::DetectorNavigator>(
         prop, "EigenNext");
   }
 

diff --git a/Examples/Run/Geant4/TestMockupBuilder.cpp b/Examples/Run/Geant4/TestMockupBuilder.cpp
@@ -11,9 +11,9 @@
 #include "Acts/Detector/Portal.hpp"
 #include "Acts/MagneticField/ConstantBField.hpp"
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
+#include "Acts/Navigation/DetectorNavigator.hpp"
 #include "Acts/Navigation/DetectorVolumeFinders.hpp"
 #include "Acts/Navigation/NavigationState.hpp"
-#include "Acts/Navigation/NextNavigator.hpp"
 #include "Acts/Navigation/SurfaceCandidatesUpdators.hpp"
 #include "Acts/Propagator/AbortList.hpp"
 #include "Acts/Propagator/EigenStepper.hpp"

diff --git a/Tests/UnitTests/Core/Navigation/CMakeLists.txt b/Tests/UnitTests/Core/Navigation/CMakeLists.txt
@@ -2,4 +2,4 @@ add_unittest(DetectorVolumeUpdators DetectorVolumeUpdatorsTests.cpp)
 add_unittest(DetectorVolumeFinders DetectorVolumeFindersTests.cpp)
 add_unittest(NavigationState NavigationStateTests.cpp)
 add_unittest(NavigationStateUpdators NavigationStateUpdatorsTests.cpp)
-add_unittest(NextNavigator NextNavigatorTests.cpp)
+add_unittest(DetectorNavigator DetectorNavigatorTests.cpp)
diff --git a/...ts/Core/Navigation/NextNavigatorTests.cpp → ...ore/Navigation/DetectorNavigatorTests.cpp b/...ts/Core/Navigation/NextNavigatorTests.cpp → ...ore/Navigation/DetectorNavigatorTests.cpp
@@ -19,8 +19,8 @@
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/MagneticField/ConstantBField.hpp"
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
+#include "Acts/Navigation/DetectorNavigator.hpp"
 #include "Acts/Navigation/DetectorVolumeFinders.hpp"
-#include "Acts/Navigation/NextNavigator.hpp"
 #include "Acts/Navigation/SurfaceCandidatesUpdators.hpp"
 #include "Acts/Propagator/AbortList.hpp"
 #include "Acts/Propagator/ActionList.hpp"
@@ -44,7 +44,7 @@ Acts::MagneticFieldContext mfContext;
 
 BOOST_AUTO_TEST_SUITE(Experimental)
 
-BOOST_AUTO_TEST_CASE(NextNavigator) {
+BOOST_AUTO_TEST_CASE(DetectorNavigator) {
   auto innerVolume = Acts::Experimental::DetectorVolumeFactory::construct(
       Acts::Experimental::defaultPortalAndSubPortalGenerator(), tgContext,
       "Inner Volume", Acts::Transform3::Identity(),
@@ -73,19 +73,19 @@ BOOST_AUTO_TEST_CASE(NextNavigator) {
   auto bField = std::make_shared<Acts::ConstantBField>(
       Acts::Vector3(0, 0, 2 * Acts::UnitConstants::T));
 
-  Acts::Experimental::NextNavigator::Config navCfg;
+  Acts::Experimental::DetectorNavigator::Config navCfg;
   navCfg.detector = detector.get();
 
   auto stepper = Acts::EigenStepper<>(bField);
-  auto navigator = Acts::Experimental::NextNavigator(
-      navCfg,
-      Acts::getDefaultLogger("NextNavigator", Acts::Logging::Level::VERBOSE));
+  auto navigator = Acts::Experimental::DetectorNavigator(
+      navCfg, Acts::getDefaultLogger("DetectorNavigator",
+                                     Acts::Logging::Level::VERBOSE));
   auto options = Acts::PropagatorOptions<ActionListType, AbortListType>(
       tgContext, mfContext);
-  auto propagator =
-      Acts::Propagator<Acts::EigenStepper<>, Acts::Experimental::NextNavigator>(
-          stepper, navigator,
-          Acts::getDefaultLogger("Propagator", Acts::Logging::Level::VERBOSE));
+  auto propagator = Acts::Propagator<Acts::EigenStepper<>,
+                                     Acts::Experimental::DetectorNavigator>(
+      stepper, navigator,
+      Acts::getDefaultLogger("Propagator", Acts::Logging::Level::VERBOSE));
 
   // define start parameters
   Acts::Vector4 pos(0, 0, -5, 0);