chore!: rename validater -> validator

Core/include/Acts/Material/MaterialValidater.hpp → Core/include/Acts/Material/MaterialValidator.hpp

@@ -20,12 +20,12 @@ namespace Acts {
 
 class IAssignmentFinder;
 
-/// @brief The material validater is a tool that allows to record the material
+/// @brief The material validator is a tool that allows to record the material
 /// seen by a ray through a set of material surfaces.
 ///
 /// It does uses a material assigner that can be either done using the
 /// propagator or a more sinmple trial and error intersection;
-class MaterialValidater {
+class MaterialValidator {
  public:
   /// Nested configuration struct
   struct Config {
@@ -36,9 +36,9 @@ class MaterialValidater {
   /// Constructor
   /// @param cfg The configuration struct carrying the used tools
   /// @param mlogger The logging object
-  explicit MaterialValidater(const Config& cfg,
+  explicit MaterialValidator(const Config& cfg,
                              std::unique_ptr<const Logger> mlogger =
-                                 getDefaultLogger("MaterialValidater",
+                                 getDefaultLogger("MaterialValidator",
                                                   Logging::INFO));
 
   /// Method to record the material along a ray

Core/src/Material/CMakeLists.txt

@@ -19,7 +19,7 @@ target_sources(
         MaterialMapUtils.cpp
         MaterialMapper.cpp
         MaterialSlab.cpp
-        MaterialValidater.cpp
+        MaterialValidator.cpp
         ProtoVolumeMaterial.cpp
         SurfaceMaterialMapper.cpp
         VolumeMaterialMapper.cpp

Core/src/Material/MaterialValidater.cpp → Core/src/Material/MaterialValidator.cpp

@@ -6,25 +6,25 @@
 // 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/Material/MaterialValidater.hpp"
+#include "Acts/Material/MaterialValidator.hpp"
 
 #include "Acts/Material/ISurfaceMaterial.hpp"
 #include "Acts/Material/interface/IAssignmentFinder.hpp"
 #include "Acts/Utilities/StringHelpers.hpp"
 
-Acts::MaterialValidater::MaterialValidater(
-    const Acts::MaterialValidater::Config& cfg,
+Acts::MaterialValidator::MaterialValidator(
+    const Acts::MaterialValidator::Config& cfg,
     std::unique_ptr<const Acts::Logger> mlogger)
     : m_cfg(cfg), m_logger(std::move(mlogger)) {
   if (m_cfg.materialAssigner == nullptr) {
     throw std::invalid_argument("Missing material assigner");
   }
 }
 
-Acts::RecordedMaterialTrack Acts::MaterialValidater::recordMaterial(
+Acts::RecordedMaterialTrack Acts::MaterialValidator::recordMaterial(
     const GeometryContext& gctx, const MagneticFieldContext& mctx,
     const Vector3& position, const Vector3& direction) const {
-  ACTS_DEBUG("MaterialValidater::recordMaterial with position "
+  ACTS_DEBUG("MaterialValidator::recordMaterial with position "
              << toString(position) << " and direction " << toString(direction));
 
   // Prepare the material track
@@ -44,7 +44,7 @@
     mInteraction.position = sposition;
     mInteraction.direction = sdirection;
     mInteraction.materialSlab = MaterialSlab(
         materialSlab.material(), materialSlab.thickness() * pathCorrection);
     mInteraction.pathCorrection = pathCorrection;
     mInteraction.intersection = sposition;
     mInteraction.intersectionID = surface->geometryId();

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

@@ -11,7 +11,7 @@
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Material/MaterialInteraction.hpp"
-#include "Acts/Material/MaterialValidater.hpp"
+#include "Acts/Material/MaterialValidator.hpp"
 #include "Acts/Utilities/Logger.hpp"
 #include "ActsExamples/Framework/DataHandle.hpp"
 #include "ActsExamples/Framework/IAlgorithm.hpp"
@@ -45,8 +45,8 @@ class MaterialValidation : public IAlgorithm {
     /// Random number service
     std::shared_ptr<RandomNumbers> randomNumberSvc = nullptr;
 
-    // The validater
-    std::shared_ptr<Acts::MaterialValidater> materialValidater = nullptr;
+    // The validator
+    std::shared_ptr<Acts::MaterialValidator> materialValidator = nullptr;
 
     /// Output collection name
     std::string outputMaterialTracks = "material_tracks";

Examples/Algorithms/MaterialMapping/src/MaterialValidation.cpp

@@ -20,9 +20,9 @@ MaterialValidation::MaterialValidation(
     : IAlgorithm("MaterialValidation", std::move(logger)), m_cfg(cfg) {
   // Prepare the I/O collections
   m_outputMaterialTracks.initialize(m_cfg.outputMaterialTracks);
-  // Check the configuration - material validater
-  if (m_cfg.materialValidater == nullptr) {
-    throw std::invalid_argument("Missing material validater.");
+  // Check the configuration - material validator
+  if (m_cfg.materialValidator == nullptr) {
+    throw std::invalid_argument("Missing material validator.");
   }
   // Check the configuration - random number service
   if (m_cfg.randomNumberSvc == nullptr) {
@@ -54,7 +54,7 @@ ProcessCode MaterialValidation::execute(const AlgorithmContext& context) const {
                             std::sin(phi) * std::sin(theta), std::cos(theta));
 
     // Record the material
-    auto rMaterial = m_cfg.materialValidater->recordMaterial(
+    auto rMaterial = m_cfg.materialValidator->recordMaterial(
         context.geoContext, context.magFieldContext, m_cfg.startPosition,
         direction);
 

Examples/Scripts/Python/material_validation_core.py

@@ -6,7 +6,7 @@
 
 import acts
 from acts import (
-    MaterialValidater,
+    MaterialValidator,
     IntersectionMaterialAssigner,
     logging,
     GeometryContext,
@@ -37,14 +37,14 @@ def runMaterialValidation(s, ntracks, surfaces, outputFile, seed, loglevel):
     materialAssingerConfig.surfaces = surfaces
     materialAssinger = IntersectionMaterialAssigner(materialAssingerConfig, loglevel)
 
-    # Validater setup
-    materialValidaterConfig = MaterialValidater.Config()
-    materialValidaterConfig.materialAssigner = materialAssinger
-    materialValidater = MaterialValidater(materialValidaterConfig, loglevel)
+    # Validator setup
+    materialValidatorConfig = MaterialValidator.Config()
+    materialValidatorConfig.materialAssigner = materialAssinger
+    materialValidator = MaterialValidator(materialValidatorConfig, loglevel)
 
     # Validation Algorithm
     materialValidationConfig = MaterialValidation.Config()
-    materialValidationConfig.materialValidater = materialValidater
+    materialValidationConfig.materialValidator = materialValidator
     materialValidationConfig.outputMaterialTracks = "recorded-material-tracks"
     materialValidationConfig.ntracks = ntracks
     materialValidationConfig.randomNumberSvc = rnd

Python/Core/src/Material.cpp

@@ -14,7 +14,7 @@
 #include "Acts/Material/IVolumeMaterial.hpp"
 #include "Acts/Material/IntersectionMaterialAssigner.hpp"
 #include "Acts/Material/MaterialMapper.hpp"
-#include "Acts/Material/MaterialValidater.hpp"
+#include "Acts/Material/MaterialValidator.hpp"
 #include "Acts/Material/PropagatorMaterialAssigner.hpp"
 #include "Acts/Material/ProtoSurfaceMaterial.hpp"
 #include "Acts/Material/SurfaceMaterialMapper.hpp"
@@ -187,18 +187,18 @@ void addMaterial(py::module_& m) {
 
   {
     auto mvc =
-        py::class_<MaterialValidater, std::shared_ptr<MaterialValidater>>(
-            m, "MaterialValidater")
-            .def(py::init([](const MaterialValidater::Config& config,
+        py::class_<MaterialValidator, std::shared_ptr<MaterialValidator>>(
+            m, "MaterialValidator")
+            .def(py::init([](const MaterialValidator::Config& config,
                              Logging::Level level) {
-                   return std::make_shared<MaterialValidater>(
-                       config, getDefaultLogger("MaterialValidater", level));
+                   return std::make_shared<MaterialValidator>(
+                       config, getDefaultLogger("MaterialValidator", level));
                  }),
                  py::arg("config"), py::arg("level"))
-            .def("recordMaterial", &MaterialValidater::recordMaterial);
+            .def("recordMaterial", &MaterialValidator::recordMaterial);
 
     auto c =
-        py::class_<MaterialValidater::Config>(mvc, "Config").def(py::init<>());
+        py::class_<MaterialValidator::Config>(mvc, "Config").def(py::init<>());
     ACTS_PYTHON_STRUCT(c, materialAssigner);
   }
 }

Python/Examples/src/MaterialMapping.cpp

@@ -87,7 +87,7 @@ void addMaterialMapping(py::module& mex) {
         mex, "MaterialValidation");
     mv.def("execute", &MaterialValidation::execute);
     ACTS_PYTHON_STRUCT(c, ntracks, startPosition, phiRange, etaRange,
-                       randomNumberSvc, materialValidater,
+                       randomNumberSvc, materialValidator,
                        outputMaterialTracks);
   }
 }

Tests/UnitTests/Core/Material/CMakeLists.txt

@@ -16,7 +16,7 @@ add_unittest(MaterialGridHelper MaterialGridHelperTests.cpp)
 add_unittest(MaterialInteractionAssignment MaterialInteractionAssignmentTests.cpp)
 add_unittest(MaterialMapper MaterialMapperTests.cpp)
 add_unittest(MaterialSlab MaterialSlabTests.cpp)
-add_unittest(MaterialValidater MaterialValidaterTests.cpp)
+add_unittest(MaterialValidator MaterialValidatorTests.cpp)
 add_unittest(Material MaterialTests.cpp)
 add_unittest(ProtoSurfaceMaterial ProtoSurfaceMaterialTests.cpp)
 add_unittest(ProtoVolumeMaterial ProtoVolumeMaterialTests.cpp)

Tests/UnitTests/Core/Material/MaterialValidaterTests.cpp → Tests/UnitTests/Core/Material/MaterialValidatorTests.cpp

@@ -15,7 +15,7 @@
 #include "Acts/Material/HomogeneousSurfaceMaterial.hpp"
 #include "Acts/Material/MaterialInteraction.hpp"
 #include "Acts/Material/MaterialSlab.hpp"
-#include "Acts/Material/MaterialValidater.hpp"
+#include "Acts/Material/MaterialValidator.hpp"
 #include "Acts/Material/interface/IAssignmentFinder.hpp"
 #include "Acts/Surfaces/CylinderSurface.hpp"
 #include "Acts/Utilities/Intersection.hpp"
@@ -82,7 +82,7 @@ class IntersectSurfacesFinder : public IAssignmentFinder {
 
 BOOST_AUTO_TEST_SUITE(MaterialSuite)
 
-BOOST_AUTO_TEST_CASE(MaterialValidaterFlowTest) {
+BOOST_AUTO_TEST_CASE(MaterialValidatorFlowTest) {
   auto cylinder0 =
       Surface::makeShared<CylinderSurface>(Transform3::Identity(), 20, 100);
   auto cylinder1 =
@@ -105,14 +105,14 @@ BOOST_AUTO_TEST_CASE(MaterialValidaterFlowTest) {
   materialAssinger->surfaces = {cylinder0.get(), cylinder1.get(),
                                 cylinder2.get()};
 
-  MaterialValidater::Config mvConfig;
+  MaterialValidator::Config mvConfig;
   mvConfig.materialAssigner = materialAssinger;
 
-  auto materialValidater = MaterialValidater(
-      mvConfig, getDefaultLogger("MaterialValidater", Logging::VERBOSE));
+  auto materialValidator = MaterialValidator(
+      mvConfig, getDefaultLogger("MaterialValidator", Logging::VERBOSE));
 
   // Test one central ray
-  auto [posDir, rMaterial] = materialValidater.recordMaterial(
+  auto [posDir, rMaterial] = materialValidator.recordMaterial(
       tContext, MagneticFieldContext(), Vector3(0, 0, 0), Vector3(1, 0, 0));
 
   BOOST_CHECK(posDir.first == Vector3(0, 0, 0));
@@ -122,7 +122,7 @@ BOOST_AUTO_TEST_CASE(MaterialValidaterFlowTest) {
   BOOST_CHECK_EQUAL(rMaterial.materialInteractions.size(), 3u);
 
   // Test a ray at 45 degrees
-  auto [posDir2, rMaterial2] = materialValidater.recordMaterial(
+  auto [posDir2, rMaterial2] = materialValidator.recordMaterial(
       tContext, MagneticFieldContext(), Vector3(0, 0, 0),
       Vector3(1, 0, 1).normalized());