From fb3ecc290a72b643ebea732e64f41150093e881d Mon Sep 17 00:00:00 2001 From: Benjamin Huth Date: Fri, 16 Jun 2023 18:50:30 +0200 Subject: [PATCH 01/11] first version --- CI/codespell_ignore_core.txt | 8 +++++++ CI/codespell_ignore_examples.txt | 7 ++++++ .../GreedyAmbiguityResolution.hpp | 4 ++-- .../GreedyAmbiguityResolution.ipp | 2 +- .../Acts/Clusterization/Clusterization.hpp | 2 +- Core/include/Acts/Definitions/Direction.hpp | 4 ++-- Core/include/Acts/Definitions/Tolerance.hpp | 2 +- .../Acts/Definitions/TrackParametrization.hpp | 12 +++++----- Core/include/Acts/Definitions/Units.hpp | 2 +- .../Detector/CylindricalContainerBuilder.hpp | 2 +- Core/include/Acts/Detector/Detector.hpp | 2 +- .../Acts/Detector/DetectorComponents.hpp | 2 +- Core/include/Acts/Detector/DetectorVolume.hpp | 14 +++++------ .../Acts/Detector/DetectorVolumeBuilder.hpp | 2 +- .../Acts/Detector/LayerStructureBuilder.hpp | 6 ++--- .../Acts/Detector/PortalGenerators.hpp | 4 ++-- .../Detector/detail/GridAxisGenerators.hpp | 4 ++-- .../Detector/detail/IndexedGridFiller.hpp | 4 ++-- .../detail/IndexedSurfacesGenerator.hpp | 2 +- .../Detector/detail/KdtSurfacesProvider.hpp | 2 +- .../Detector/detail/ReferenceGenerators.hpp | 10 ++++---- .../Acts/Detector/detail/SupportHelper.hpp | 2 +- .../Digitization/CartesianSegmentation.hpp | 8 +++---- .../Acts/Digitization/DigitizationModule.hpp | 2 +- .../Acts/Digitization/PlanarModuleStepper.hpp | 6 ++--- .../Acts/Digitization/Segmentation.hpp | 4 ++-- Core/include/Acts/EventData/Charge.hpp | 2 +- Core/include/Acts/EventData/Measurement.hpp | 4 ++-- .../MultiComponentBoundTrackParameters.hpp | 4 ++-- .../Acts/EventData/MultiTrajectory.hpp | 6 ++--- .../EventData/SingleBoundTrackParameters.hpp | 6 ++--- .../EventData/SingleFreeTrackParameters.hpp | 4 ++-- .../include/Acts/EventData/TrackContainer.hpp | 4 ++-- .../CorrectedTransformationFreeToBound.hpp | 4 ++-- .../Acts/EventData/detail/ParameterTraits.hpp | 4 ++-- Core/include/Acts/Geometry/AbstractVolume.hpp | 4 ++-- .../Acts/Geometry/BoundarySurfaceFace.hpp | 4 ++-- .../Acts/Geometry/BoundarySurfaceT.hpp | 14 +++++------ Core/include/Acts/Geometry/ConeLayer.hpp | 8 +++---- .../Acts/Geometry/ConeVolumeBounds.hpp | 2 +- .../Acts/Geometry/CuboidVolumeBounds.hpp | 2 +- .../Acts/Geometry/CuboidVolumeBuilder.hpp | 4 ++-- .../Geometry/CutoutCylinderVolumeBounds.hpp | 2 +- Core/include/Acts/Geometry/CylinderLayer.hpp | 2 +- .../Acts/Geometry/CylinderVolumeBounds.hpp | 2 +- .../Acts/Geometry/CylinderVolumeBuilder.hpp | 12 +++++----- .../Acts/Geometry/CylinderVolumeHelper.hpp | 12 +++++----- Core/include/Acts/Geometry/Extent.hpp | 4 ++-- .../Geometry/GenericApproachDescriptor.hpp | 4 ++-- .../Geometry/GenericCuboidVolumeBounds.hpp | 2 +- .../Acts/Geometry/GeometryHierarchyMap.hpp | 2 +- .../Acts/Geometry/GeometryObjectSorter.hpp | 6 ++--- .../Acts/Geometry/GlueVolumesDescriptor.hpp | 2 +- .../IConfinedTrackingVolumeBuilder.hpp | 2 +- .../Acts/Geometry/ILayerArrayCreator.hpp | 2 +- Core/include/Acts/Geometry/ILayerBuilder.hpp | 6 ++--- .../Geometry/ITrackingGeometryBuilder.hpp | 6 ++--- .../Acts/Geometry/ITrackingVolumeHelper.hpp | 2 +- .../KDTreeTrackingGeometryBuilder.hpp | 2 +- Core/include/Acts/Geometry/Layer.hpp | 6 ++--- .../Acts/Geometry/LayerArrayCreator.hpp | 2 +- Core/include/Acts/Geometry/LayerCreator.hpp | 12 +++++----- .../include/Acts/Geometry/NavigationLayer.hpp | 2 +- .../Acts/Geometry/PassiveLayerBuilder.hpp | 8 +++---- .../Acts/Geometry/SurfaceArrayCreator.hpp | 20 ++++++++-------- .../Acts/Geometry/TrackingGeometry.hpp | 2 +- Core/include/Acts/Geometry/TrackingVolume.hpp | 8 +++---- .../Acts/Geometry/TrapezoidVolumeBounds.hpp | 8 +++---- .../Acts/MagneticField/SolenoidBField.hpp | 2 +- .../Acts/Material/AccumulatedMaterialSlab.hpp | 2 +- .../Material/AccumulatedSurfaceMaterial.hpp | 4 ++-- .../Material/HomogeneousSurfaceMaterial.hpp | 4 ++-- .../Acts/Material/IMaterialDecorator.hpp | 2 +- .../Acts/Material/ISurfaceMaterial.hpp | 2 +- .../include/Acts/Material/IVolumeMaterial.hpp | 2 +- Core/include/Acts/Material/Interactions.hpp | 2 +- .../Acts/Material/MaterialGridHelper.hpp | 4 ++-- .../Acts/Material/MaterialInteraction.hpp | 12 +++++----- .../Acts/Material/ProtoSurfaceMaterial.hpp | 10 ++++---- .../Acts/Material/ProtoVolumeMaterial.hpp | 6 ++--- .../Acts/Material/VolumeMaterialMapper.hpp | 2 +- .../Acts/Material/detail/AverageMaterials.hpp | 2 +- .../Navigation/DetectorVolumeUpdators.hpp | 4 ++-- .../Acts/Navigation/NavigationState.hpp | 4 ++-- .../include/Acts/Navigation/NextNavigator.hpp | 2 +- .../Navigation/SurfaceCandidatesUpdators.hpp | 4 ++-- Core/include/Acts/Propagator/AbortList.hpp | 2 +- Core/include/Acts/Propagator/ActionList.hpp | 2 +- Core/include/Acts/Propagator/AtlasStepper.hpp | 14 +++++------ .../Acts/Propagator/ConstrainedStep.hpp | 2 +- .../Acts/Propagator/CovarianceTransport.hpp | 2 +- Core/include/Acts/Propagator/EigenStepper.hpp | 4 ++-- .../Acts/Propagator/MultiEigenStepperLoop.hpp | 6 ++--- .../Acts/Propagator/MultiStepperAborters.hpp | 6 ++--- Core/include/Acts/Propagator/Navigator.hpp | 10 ++++---- Core/include/Acts/Propagator/Propagator.hpp | 2 +- Core/include/Acts/Propagator/Propagator.ipp | 2 +- .../Acts/Propagator/RiddersPropagator.hpp | 4 ++-- .../Acts/Propagator/StandardAborters.hpp | 4 ++-- .../Acts/Propagator/StepperConcept.hpp | 8 +++---- .../Acts/Propagator/StraightLineStepper.hpp | 6 ++--- .../Propagator/detail/CovarianceEngine.hpp | 2 +- .../detail/GenericDefaultExtension.hpp | 2 +- .../Acts/Propagator/detail/JacobianEngine.hpp | 2 +- .../detail/PointwiseMaterialInteraction.hpp | 10 ++++---- .../detail/abort_list_implementation.hpp | 2 +- Core/include/Acts/Seeding/BinFinder.hpp | 2 +- .../Acts/Seeding/CandidatesForMiddleSp.hpp | 8 +++---- .../Seeding/EstimateTrackParamsFromSeed.hpp | 2 +- Core/include/Acts/Seeding/SeedFilter.ipp | 2 +- Core/include/Acts/Seeding/SeedFinder.hpp | 6 ++--- Core/include/Acts/Seeding/SeedFinder.ipp | 6 ++--- Core/include/Acts/Seeding/SeedFinderUtils.ipp | 4 ++-- .../SpacePointFormation/SpacePointBuilder.hpp | 2 +- .../SpacePointBuilderOptions.hpp | 4 ++-- Core/include/Acts/Surfaces/AnnulusBounds.hpp | 6 ++--- Core/include/Acts/Surfaces/BoundaryCheck.hpp | 4 ++-- Core/include/Acts/Surfaces/ConeBounds.hpp | 4 ++-- Core/include/Acts/Surfaces/ConeSurface.hpp | 6 ++--- .../Acts/Surfaces/ConvexPolygonBounds.hpp | 4 ++-- Core/include/Acts/Surfaces/CylinderBounds.hpp | 2 +- .../include/Acts/Surfaces/CylinderSurface.hpp | 8 +++---- Core/include/Acts/Surfaces/DiamondBounds.hpp | 2 +- Core/include/Acts/Surfaces/DiscBounds.hpp | 4 ++-- Core/include/Acts/Surfaces/DiscSurface.hpp | 12 +++++----- .../Acts/Surfaces/DiscTrapezoidBounds.hpp | 4 ++-- Core/include/Acts/Surfaces/EllipseBounds.hpp | 2 +- Core/include/Acts/Surfaces/LineBounds.hpp | 2 +- Core/include/Acts/Surfaces/LineSurface.hpp | 6 ++--- Core/include/Acts/Surfaces/PerigeeSurface.hpp | 4 ++-- Core/include/Acts/Surfaces/PlanarBounds.hpp | 2 +- Core/include/Acts/Surfaces/PlaneSurface.hpp | 12 +++++----- .../include/Acts/Surfaces/RectangleBounds.hpp | 4 ++-- Core/include/Acts/Surfaces/StrawSurface.hpp | 2 +- Core/include/Acts/Surfaces/Surface.hpp | 10 ++++---- Core/include/Acts/Surfaces/SurfaceArray.hpp | 2 +- .../include/Acts/Surfaces/TrapezoidBounds.hpp | 2 +- .../Surfaces/detail/IntersectionHelper2D.hpp | 4 ++-- .../CombinatorialKalmanFilter.hpp | 8 +++---- .../Acts/TrackFinding/MeasurementSelector.hpp | 2 +- .../Acts/TrackFitting/BetheHeitlerApprox.hpp | 4 ++-- Core/include/Acts/TrackFitting/Chi2Fitter.hpp | 2 +- .../Acts/TrackFitting/KalmanFitter.hpp | 16 ++++++------- .../Acts/TrackFitting/detail/GsfActor.hpp | 6 ++--- .../detail/KLMixtureReduction.hpp | 2 +- .../detail/KalmanUpdateHelpers.hpp | 4 ++-- Core/include/Acts/Utilities/BinAdjustment.hpp | 2 +- .../Acts/Utilities/BinAdjustmentVolume.hpp | 6 ++--- Core/include/Acts/Utilities/BinUtility.hpp | 4 ++-- Core/include/Acts/Utilities/BinnedArray.hpp | 6 ++--- Core/include/Acts/Utilities/BinnedArrayXD.hpp | 4 ++-- Core/include/Acts/Utilities/BinningData.hpp | 22 +++++++++--------- Core/include/Acts/Utilities/BoundingBox.hpp | 8 +++---- .../Acts/Utilities/CalibrationContext.hpp | 2 +- .../Acts/Utilities/FiniteStateMachine.hpp | 2 +- Core/include/Acts/Utilities/Helpers.hpp | 4 ++-- Core/include/Acts/Utilities/Intersection.hpp | 2 +- Core/include/Acts/Utilities/KDTree.hpp | 4 ++-- Core/include/Acts/Utilities/Logger.hpp | 2 +- Core/include/Acts/Utilities/MultiIndex.hpp | 8 +++---- Core/include/Acts/Utilities/Result.hpp | 4 ++-- .../Acts/Utilities/SpacePointUtility.hpp | 8 +++---- Core/include/Acts/Utilities/UnitVectors.hpp | 4 ++-- Core/include/Acts/Utilities/VectorHelpers.hpp | 2 +- .../include/Acts/Utilities/detail/AxisFwd.hpp | 2 +- .../Utilities/detail/MPL/type_collector.hpp | 2 +- .../detail/ReferenceWrapperAnyCompat.hpp | 2 +- .../Acts/Utilities/detail/Subspace.hpp | 2 +- .../Vertexing/AdaptiveGridTrackDensity.hpp | 2 +- .../Vertexing/AdaptiveGridTrackDensity.ipp | 8 +++---- .../Vertexing/AdaptiveMultiVertexFinder.hpp | 2 +- .../Vertexing/FullBilloirVertexFitter.hpp | 2 +- .../Vertexing/FullBilloirVertexFitter.ipp | 2 +- .../Vertexing/GaussianGridTrackDensity.hpp | 4 ++-- .../Acts/Vertexing/GaussianTrackDensity.hpp | 2 +- .../Acts/Vertexing/VertexingOptions.hpp | 4 ++-- .../Acts/Vertexing/ZScanVertexFinder.hpp | 4 ++-- .../Acts/Visualization/EventDataView3D.hpp | 2 +- .../Acts/Visualization/GeometryView3D.hpp | 8 +++---- .../Acts/Visualization/IVisualization3D.hpp | 2 +- .../Acts/Visualization/ObjVisualization3D.hpp | 2 +- .../Detector/CylindricalContainerBuilder.cpp | 4 ++-- Core/src/Detector/DetectorVolumeBuilder.cpp | 4 ++-- Core/src/Detector/LayerStructureBuilder.cpp | 6 ++--- Core/src/Detector/VolumeStructureBuilder.cpp | 4 ++-- .../detail/CylindricalDetectorHelper.cpp | 16 ++++++------- Core/src/Detector/detail/PortalHelper.cpp | 2 +- .../Digitization/CartesianSegmentation.cpp | 6 ++--- Core/src/Geometry/ConeVolumeBounds.cpp | 2 +- Core/src/Geometry/CylinderVolumeBuilder.cpp | 2 +- Core/src/Geometry/CylinderVolumeHelper.cpp | 4 ++-- Core/src/Geometry/Extent.cpp | 2 +- .../KDTreeTrackingGeometryBuilder.cpp | 2 +- Core/src/Geometry/Layer.cpp | 10 ++++---- Core/src/Geometry/ProtoLayerHelper.cpp | 4 ++-- Core/src/Geometry/TrackingVolume.cpp | 10 ++++---- .../Material/AccumulatedSurfaceMaterial.cpp | 4 ++-- Core/src/Material/AverageMaterials.cpp | 6 ++--- Core/src/Material/Interactions.cpp | 2 +- Core/src/Material/SurfaceMaterialMapper.cpp | 6 ++--- Core/src/Material/VolumeMaterialMapper.cpp | 2 +- Core/src/Propagator/MultiStepperError.cpp | 2 +- Core/src/Surfaces/ConeSurface.cpp | 2 +- Core/src/Surfaces/CylinderBounds.cpp | 2 +- Core/src/Surfaces/CylinderSurface.cpp | 8 +++---- Core/src/Surfaces/DiscSurface.cpp | 10 ++++---- Core/src/Surfaces/LineSurface.cpp | 4 ++-- Core/src/Surfaces/PlaneSurface.cpp | 4 ++-- Core/src/Surfaces/Surface.cpp | 6 ++--- Core/src/Surfaces/detail/AlignmentHelper.cpp | 2 +- .../Alignment/AlignmentAlgorithm.hpp | 4 ++-- .../GreedyAmbiguityResolutionAlgorithm.hpp | 2 +- .../Digitization/DigitizationAlgorithm.hpp | 2 +- .../Digitization/DigitizationConfig.hpp | 2 +- .../Digitization/DigitizationConfigurator.hpp | 2 +- .../Digitization/MeasurementCreation.hpp | 2 +- .../Digitization/src/ModuleClusters.cpp | 2 +- .../Geant4/EventStoreRegistry.hpp | 4 ++-- .../ActsExamples/Geant4/Geant4Simulation.hpp | 2 +- .../Geant4/src/Geant4Simulation.cpp | 2 +- .../Geant4/src/SensitiveSteppingAction.cpp | 2 +- .../Geant4/src/SimParticleTranslation.cpp | 2 +- .../Geant4HepMC/src/EventAction.cpp | 2 +- .../src/PrimaryGeneratorAction.cpp | 2 +- .../Geant4HepMC/src/SteppingAction.cpp | 2 +- .../Generators/Pythia8ProcessGenerator.cpp | 2 +- .../MaterialMapping/IMaterialWriter.hpp | 2 +- .../MappingMaterialDecorator.hpp | 4 ++-- .../MaterialMapping/MaterialMapping.hpp | 2 +- .../MaterialMappingOptions.hpp | 4 ++-- .../Propagation/PropagationAlgorithm.hpp | 4 ++-- .../Propagation/PropagatorInterface.hpp | 2 +- .../TrackParamsEstimationAlgorithm.hpp | 2 +- .../TrackFinding/src/SeedingAlgorithm.cpp | 2 +- .../src/TrackParamsEstimationAlgorithm.cpp | 2 +- .../TrackFindingML/AmbiguityResolutionML.hpp | 4 ++-- .../AmbiguityResolutionMLAlgorithm.hpp | 2 +- .../AmbiguityResolutionMLDBScanAlgorithm.hpp | 2 +- .../TrackFitting/RefittingAlgorithm.hpp | 4 ++-- .../TrackFitting/TrackFitterFunction.hpp | 2 +- .../TrackFitting/TrackFittingAlgorithm.hpp | 2 +- .../TrackFittingChi2Algorithm.hpp | 2 +- .../TruthTracking/ParticleSelector.hpp | 2 +- .../TruthTracking/ParticleSmearing.cpp | 2 +- .../TruthTracking/TruthSeedSelector.hpp | 4 ++-- .../TruthTracking/TruthSeedingAlgorithm.cpp | 4 ++-- .../AdaptiveMultiVertexFinderAlgorithm.hpp | 2 +- .../InternallyAlignedDetectorElement.hpp | 4 ++-- .../Detectors/DD4hepDetector/src/DetUtils.h | 2 +- .../DetectorInspectors/SurfaceIndexing.hpp | 6 ++--- .../GenericDetector/BuildGenericDetector.hpp | 6 ++--- .../GenericDetector/LayerBuilderT.hpp | 2 +- .../GenericDetector/ProtoLayerCreatorT.hpp | 14 +++++------ .../src/MockupSectorBuilder.cpp | 2 +- .../TGeoDetector/JsonTGeoDetectorConfig.hpp | 2 +- .../src/TGeoITkModuleSplitter.cpp | 4 ++-- .../TelescopeDetectorElement.hpp | 4 ++-- Examples/Framework/CMakeLists.txt | 4 ++-- .../EventData/GeometryContainers.hpp | 2 +- .../EventData/IndexSourceLink.hpp | 2 +- .../ActsExamples/EventData/SimVertex.hpp | 2 +- .../Framework/AlgorithmContext.hpp | 4 ++-- .../ActsExamples/Framework/IReader.hpp | 4 ++-- .../ActsExamples/Framework/RandomNumbers.hpp | 2 +- .../ActsExamples/Framework/WhiteBoard.hpp | 2 +- .../ActsExamples/Utilities/GroupBy.hpp | 2 +- .../ActsExamples/Validation/ResPlotTool.hpp | 2 +- .../Io/Csv/CsvMeasurementReader.hpp | 2 +- Examples/Io/Csv/src/CsvMeasurementReader.cpp | 4 ++-- Examples/Io/Csv/src/CsvMeasurementWriter.cpp | 2 +- .../Io/Csv/src/CsvPlanarClusterReader.cpp | 4 ++-- .../Io/Csv/src/CsvPlanarClusterWriter.cpp | 2 +- Examples/Io/HepMC3/src/HepMC3Event.cpp | 2 +- .../NuclearInteractionParametrisation.hpp | 4 ++-- ...RootNuclearInteractionParametersWriter.cpp | 4 ++-- .../Plugins/Obj/ObjWriterOptions.hpp | 4 ++-- .../Performance/SeedingPerformanceWriter.cpp | 2 +- .../Performance/VertexPerformanceWriter.cpp | 2 +- .../Performance/VertexPerformanceWriter.hpp | 2 +- .../Io/Root/RootMaterialTrackWriter.hpp | 2 +- .../Io/Root/src/RootMaterialDecorator.cpp | 2 +- .../python/acts/examples/reconstruction.py | 4 ++-- .../MaterialMapping/CommonMaterialMapping.hpp | 2 +- .../MaterialValidationBase.hpp | 2 +- .../Propagation/PropagationExampleBase.hpp | 2 +- .../Run/Common/src/CommonMaterialMapping.cpp | 2 +- Examples/Run/Common/src/CommonOptions.cpp | 8 +++---- .../Run/Common/src/MagneticFieldOptions.cpp | 2 +- .../Common/src/NuclearInteractionOptions.cpp | 2 +- .../Common/src/TelescopeDetectorOptions.cpp | 2 +- .../src/TelescopeDetectorWithOptions.cpp | 2 +- .../Common/DigitizationConfigExample.hpp | 2 +- .../Common/DigitizationExample.hpp | 2 +- Examples/Run/HelloWorld/HelloWorld.cpp | 2 +- Examples/Run/HepMC3/HepMC3Example.cpp | 4 ++-- Examples/Run/MagneticField/BFieldExample.cpp | 4 ++-- Examples/Run/Misc/TabulateEnergyLoss.cpp | 2 +- .../Reconstruction/Common/HoughExample.hpp | 2 +- .../Reconstruction/Common/RecCKFTracks.cpp | 4 ++-- .../Reconstruction/Common/SeedingExample.hpp | 2 +- Examples/Scripts/MaterialMapping/Mat_map.C | 2 +- .../Orion/launchMaterialAutoTuning.sh | 2 +- .../Orion/material_mapping_optimisation.py | 8 +++---- .../ambiguity_solver_full_chain.py | 6 ++--- .../ambiguity_solver_network.py | 2 +- .../train_ambiguity_solver.py | 2 +- Examples/Scripts/Python/geant4_parallel.py | 2 +- .../Scripts/Python/torchscript_models_v01.tar | Bin 0 -> 18094080 bytes .../Scripts/TrackingPerformance/CommonUtils.h | 20 ++++++++-------- .../TrackingPerformance/TrackSummary.cpp | 2 +- .../boundParamResolution.C | 2 +- .../defineReconstructionPerformance.C | 2 +- .../reconstructionPerformance.C | 2 +- Examples/Scripts/compareRootFiles.C | 2 +- Examples/Scripts/layerMaterial.C | 2 +- Examples/Scripts/printBField.C | 6 ++--- .../Detector/LayerStructureBuilderTests.cpp | 12 +++++----- 317 files changed, 655 insertions(+), 640 deletions(-) create mode 100644 CI/codespell_ignore_core.txt create mode 100644 CI/codespell_ignore_examples.txt create mode 100644 Examples/Scripts/Python/torchscript_models_v01.tar diff --git a/CI/codespell_ignore_core.txt b/CI/codespell_ignore_core.txt new file mode 100644 index 00000000000..802feaf534f --- /dev/null +++ b/CI/codespell_ignore_core.txt @@ -0,0 +1,8 @@ +bu +strack +sTrack +compres +compRes +coner +coneR + diff --git a/CI/codespell_ignore_examples.txt b/CI/codespell_ignore_examples.txt new file mode 100644 index 00000000000..a344b7482ef --- /dev/null +++ b/CI/codespell_ignore_examples.txt @@ -0,0 +1,7 @@ +fime +gaus +te +parm +bu +writeT +writet diff --git a/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.hpp b/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.hpp index 0c15f333696..76490d76eae 100644 --- a/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.hpp +++ b/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.hpp @@ -42,7 +42,7 @@ class GreedyAmbiguityResolution { /// Maximum number of iterations std::uint32_t maximumIterations = 1000; - /// Minumum number of measurement to form a track. + /// Minimum number of measurement to form a track. size_t nMeasurementsMin = 7; }; @@ -75,7 +75,7 @@ class GreedyAmbiguityResolution { /// /// @param tracks The input track container. /// @param state An empty state object which is expected to be default constructed. - /// @param sourceLinkHash A functor to aquire a hash from a given source link. + /// @param sourceLinkHash A functor to acquire a hash from a given source link. /// @param sourceLinkEquality A functor to check equality of two source links. template class holder_t, typename source_link_hash_t, diff --git a/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.ipp b/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.ipp index 5aeed2de533..0be168f0b47 100644 --- a/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.ipp +++ b/Core/include/Acts/AmbiguityResolution/GreedyAmbiguityResolution.ipp @@ -30,7 +30,7 @@ void GreedyAmbiguityResolution::computeInitialState( // count and chi2 and fill the measurement map in order to relate tracks to // each other if they have shared hits. for (const auto& track : tracks) { - // Kick out tracks that do not fullfil our initial requirements + // Kick out tracks that do not fulfill our initial requirements if (track.nMeasurements() < m_cfg.nMeasurementsMin) { continue; } diff --git a/Core/include/Acts/Clusterization/Clusterization.hpp b/Core/include/Acts/Clusterization/Clusterization.hpp index 1716d464a6d..e5971e696ca 100644 --- a/Core/include/Acts/Clusterization/Clusterization.hpp +++ b/Core/include/Acts/Clusterization/Clusterization.hpp @@ -84,7 +84,7 @@ template ClusterCollection mergeClusters(CellCollection& /*cells*/); /// @brief createClusters -/// Conveniance function which runs both labelClusters and createClusters. +/// Convenience function which runs both labelClusters and createClusters. template = 0 ? Value::Positive : Value::Negative; @@ -47,7 +47,7 @@ class Direction final { /// /// @param scalar is the signed value /// - /// @return a direciton enum + /// @return a direction enum static inline constexpr Direction fromScalarZeroAsPositive( ActsScalar scalar) { return scalar >= 0 ? Value::Positive : Value::Negative; diff --git a/Core/include/Acts/Definitions/Tolerance.hpp b/Core/include/Acts/Definitions/Tolerance.hpp index b3ed98ccb01..0380c732408 100644 --- a/Core/include/Acts/Definitions/Tolerance.hpp +++ b/Core/include/Acts/Definitions/Tolerance.hpp @@ -21,7 +21,7 @@ static constexpr ActsScalar s_epsilon = /// Tolerance for being on Surface /// /// @note This is intentionally given w/o an explicit unit to avoid having -/// to include the units header unneccessarily. With the native length +/// to include the units header unnecessarily. With the native length /// unit of mm this corresponds to 0.1um. static constexpr ActsScalar s_onSurfaceTolerance = 1e-4; diff --git a/Core/include/Acts/Definitions/TrackParametrization.hpp b/Core/include/Acts/Definitions/TrackParametrization.hpp index 8d22793f256..56c341fa11b 100644 --- a/Core/include/Acts/Definitions/TrackParametrization.hpp +++ b/Core/include/Acts/Definitions/TrackParametrization.hpp @@ -63,14 +63,14 @@ enum BoundIndices : unsigned int { /// in `namespace Acts` and are prefixed to avoid naming collisions. enum FreeIndices : unsigned int { // Spatial position - // The spatial position components must be stored as one continous block. + // The spatial position components must be stored as one continuous block. eFreePos0 = 0u, eFreePos1 = eFreePos0 + 1u, eFreePos2 = eFreePos0 + 2u, // Time eFreeTime = 3u, // (Unit) direction - // The direction components must be stored as one continous block. + // The direction components must be stored as one continuous block. eFreeDir0 = 4u, eFreeDir1 = eFreeDir0 + 1u, eFreeDir2 = eFreeDir0 + 2u, @@ -108,10 +108,10 @@ static_assert(FreeIndices::eFreeSize == 8u, static_assert(eBoundLoc0 != eBoundLoc1, "Local parameters must be different"); // Ensure free track parameter indices are consistently defined. -static_assert(eFreePos1 == eFreePos0 + 1u, "Position must be continous"); -static_assert(eFreePos2 == eFreePos0 + 2u, "Position must be continous"); -static_assert(eFreeDir1 == eFreeDir0 + 1u, "Direction must be continous"); -static_assert(eFreeDir2 == eFreeDir0 + 2u, "Direction must be continous"); +static_assert(eFreePos1 == eFreePos0 + 1u, "Position must be continuous"); +static_assert(eFreePos2 == eFreePos0 + 2u, "Position must be continuous"); +static_assert(eFreeDir1 == eFreeDir0 + 1u, "Direction must be continuous"); +static_assert(eFreeDir2 == eFreeDir0 + 2u, "Direction must be continuous"); // Shorthand vector/matrix types related to bound track parameters. using BoundVector = ActsVector; diff --git a/Core/include/Acts/Definitions/Units.hpp b/Core/include/Acts/Definitions/Units.hpp index 43215c3fea2..ff9c6a89543 100644 --- a/Core/include/Acts/Definitions/Units.hpp +++ b/Core/include/Acts/Definitions/Units.hpp @@ -124,7 +124,7 @@ namespace Acts { /// double bfield = 3.9_T; /// /// // convert output values (via unit constants) -/// doube t_in_ns = trackPars.time() / Acts::UnitConstants::ns; +/// double t_in_ns = trackPars.time() / Acts::UnitConstants::ns; /// // convert output values (via unit user literals) /// double x_in_mm = trackPars.position()[ePos0] / 1_mm; /// double p_in_TeV = trackPars.absoluteMomentum() / 1_TeV; diff --git a/Core/include/Acts/Detector/CylindricalContainerBuilder.hpp b/Core/include/Acts/Detector/CylindricalContainerBuilder.hpp index 4dd1e512f56..f024564b75b 100644 --- a/Core/include/Acts/Detector/CylindricalContainerBuilder.hpp +++ b/Core/include/Acts/Detector/CylindricalContainerBuilder.hpp @@ -65,7 +65,7 @@ class CylindricalContainerBuilder : public IDetectorComponentBuilder { /// configuration object Config m_cfg; - /// Private acces method to the logger + /// Private access method to the logger const Logger& logger() const { return *m_logger; } /// logging instance diff --git a/Core/include/Acts/Detector/Detector.hpp b/Core/include/Acts/Detector/Detector.hpp index 6ea5e1fc6a2..826b69d2fb1 100644 --- a/Core/include/Acts/Detector/Detector.hpp +++ b/Core/include/Acts/Detector/Detector.hpp @@ -30,7 +30,7 @@ class Detector : public std::enable_shared_from_this { /// /// @param name the detecor name /// @param rootVolumes the volumes contained by this detector - /// @param detectorVolumeUpdator is a Delegate to find the assocaited volume + /// @param detectorVolumeUpdator is a Delegate to find the associated volume /// /// @note will throw an exception if volumes vector is empty /// @note will throw an exception if duplicate volume names exist diff --git a/Core/include/Acts/Detector/DetectorComponents.hpp b/Core/include/Acts/Detector/DetectorComponents.hpp index d227a2b176c..d1d7a8a19f1 100644 --- a/Core/include/Acts/Detector/DetectorComponents.hpp +++ b/Core/include/Acts/Detector/DetectorComponents.hpp @@ -37,7 +37,7 @@ class Portal; /// component. struct DetectorComponent { using PortalContainer = std::map>; - /// The vector of construced volume(s) + /// The vector of constructed volume(s) std::vector> volumes = {}; /// The current map of outside portals PortalContainer portals; diff --git a/Core/include/Acts/Detector/DetectorVolume.hpp b/Core/include/Acts/Detector/DetectorVolume.hpp index d4d08d4c08a..36c09554c66 100644 --- a/Core/include/Acts/Detector/DetectorVolume.hpp +++ b/Core/include/Acts/Detector/DetectorVolume.hpp @@ -46,7 +46,7 @@ class Detector; /// /// @note The construction of DetectorVolumes is done via a dedicated /// factory, this is necessary as then the shared_ptr is non-weak and it -/// can be registred in the portal generator for further geometry processing. +/// can be registered in the portal generator for further geometry processing. /// /// @note Navigation is always done by plain pointers, while /// object ownership is done by shared/unique pointers. @@ -92,8 +92,8 @@ class DetectorVolume : public std::enable_shared_from_this { /// @param transform the transform defining the volume position /// @param bounds the volume bounds /// @param surfaces are the contained surfaces of this volume - /// @param volumes are the containes volumes of this volume - /// @param detectorVolumeUpdator is a Delegate to find the assocaited volume + /// @param volumes are the contains volumes of this volume + /// @param detectorVolumeUpdator is a Delegate to find the associated volume /// @param surfaceCandidateUpdator the navigation state updator for surfaces/portals /// /// @note throws exception if misconfigured: no bounds @@ -167,7 +167,7 @@ class DetectorVolume : public std::enable_shared_from_this { /// Const access to the transform /// - /// @param gctx the geometry contect + /// @param gctx the geometry context /// /// @note the geometry context is currently ignored, but /// is a placeholder for eventually misaligned volumes @@ -178,7 +178,7 @@ class DetectorVolume : public std::enable_shared_from_this { /// Const access to the center /// - /// @param gctx the geometry contect + /// @param gctx the geometry context /// /// @note the geometry context is currently ignored, but /// is a placeholder for eventually misaligned volumes @@ -212,7 +212,7 @@ class DetectorVolume : public std::enable_shared_from_this { /// The Extent for this volume /// /// @param gctx is the geometry context - /// @param nseg is the number of segements to approximate + /// @param nseg is the number of segments to approximate /// /// @return an Extent object Extent extent(const GeometryContext& gctx, size_t nseg = 1) const; @@ -346,7 +346,7 @@ class DetectorVolume : public std::enable_shared_from_this { // Check containment - only in debug mode /// /// @param gctx the current geometry context object, e.g. alignment - /// @param nseg is the number of segements to approximate + /// @param nseg is the number of segments to approximate /// /// @return a boolean indicating if the objects are properly contained bool checkContainment(const GeometryContext& gctx, size_t nseg = 1) const; diff --git a/Core/include/Acts/Detector/DetectorVolumeBuilder.hpp b/Core/include/Acts/Detector/DetectorVolumeBuilder.hpp index 9c3e37c8ea2..766cc97bf00 100644 --- a/Core/include/Acts/Detector/DetectorVolumeBuilder.hpp +++ b/Core/include/Acts/Detector/DetectorVolumeBuilder.hpp @@ -67,7 +67,7 @@ class DetectorVolumeBuilder : public IDetectorComponentBuilder { /// configuration object Config m_cfg; - /// Private acces method to the logger + /// Private access method to the logger const Logger& logger() const { return *m_logger; } /// logging instance diff --git a/Core/include/Acts/Detector/LayerStructureBuilder.hpp b/Core/include/Acts/Detector/LayerStructureBuilder.hpp index 71c41424609..b33f6a797cc 100644 --- a/Core/include/Acts/Detector/LayerStructureBuilder.hpp +++ b/Core/include/Acts/Detector/LayerStructureBuilder.hpp @@ -42,7 +42,7 @@ namespace Experimental { /// class LayerStructureBuilder : public IInternalStructureBuilder { public: - /// @brief Support parameter defintions + /// @brief Support parameter definitions struct Support { /// Define whether you want to build support structures std::array values = {}; @@ -80,7 +80,7 @@ class LayerStructureBuilder : public IInternalStructureBuilder { /// Polyhedron approximations unsigned int nSegments = 1u; /// Extra information, mainly for screen output - std::string auxilliary = ""; + std::string auxiliary = ""; }; /// Constructor @@ -102,7 +102,7 @@ class LayerStructureBuilder : public IInternalStructureBuilder { /// configuration object Config m_cfg; - /// Private acces method to the logger + /// Private access method to the logger const Logger& logger() const { return *m_logger; } /// logging instance diff --git a/Core/include/Acts/Detector/PortalGenerators.hpp b/Core/include/Acts/Detector/PortalGenerators.hpp index 272f2d099d5..e4841f7745e 100644 --- a/Core/include/Acts/Detector/PortalGenerators.hpp +++ b/Core/include/Acts/Detector/PortalGenerators.hpp @@ -21,7 +21,7 @@ namespace Experimental { class DetectorVolume; class Portal; -/// The Portal genertor definition +/// The Portal generator definition using PortalGenerator = Delegate>( const Transform3&, const VolumeBounds&, const std::shared_ptr&)>; @@ -45,7 +45,7 @@ PortalGenerator defaultPortalGenerator(); /// @brief Calls the portal generation and adds registration to sub portals /// /// This code is split off the PortalGenerator code in order to allow -/// unit testing of the portal generation wihtout detector volume construction +/// unit testing of the portal generation without detector volume construction /// /// @param dTransform a contextually resolved transform /// @param dBounds the detecor volume bounds diff --git a/Core/include/Acts/Detector/detail/GridAxisGenerators.hpp b/Core/include/Acts/Detector/detail/GridAxisGenerators.hpp index f14c28fb909..dc7d79d4d7a 100644 --- a/Core/include/Acts/Detector/detail/GridAxisGenerators.hpp +++ b/Core/include/Acts/Detector/detail/GridAxisGenerators.hpp @@ -24,7 +24,7 @@ namespace detail { /// /// The call operator() API allows to plug axis generators into /// dedicated code snippets and create fitting axis types on the fly -/// which then turn into conrete Grid types. +/// which then turn into concrete Grid types. /// namespace GridAxisGenerators { @@ -58,7 +58,7 @@ using EqBound = Eq; using EqOpen = Eq; using EqClosed = Eq; -/// @brief Templated base generator for vairable axis as a tuple - 1D +/// @brief Templated base generator for variable axis as a tuple - 1D /// /// @tparam aType the type of the axis (Bound, Closed, Open) template diff --git a/Core/include/Acts/Detector/detail/IndexedGridFiller.hpp b/Core/include/Acts/Detector/detail/IndexedGridFiller.hpp index 27b4c1fd575..c448105613b 100644 --- a/Core/include/Acts/Detector/detail/IndexedGridFiller.hpp +++ b/Core/include/Acts/Detector/detail/IndexedGridFiller.hpp @@ -193,7 +193,7 @@ std::set localIndices( /// /// @param lbins the local bins /// -/// @return a string containing the local bins orderd in a set +/// @return a string containing the local bins ordered in a set template std::string outputIndices(const std::set& lbins) { std::string rString; @@ -259,7 +259,7 @@ struct IndexedGridFiller { std::vector gridQueries; gridQueries.reserve(refs.size()); for (const auto& ref : refs) { - // Cast the transfrom according to the grid binning + // Cast the transform according to the grid binning gridQueries.push_back(iGrid.castPosition(ref)); } ACTS_DEBUG(gridQueries.size() << " reference points generated."); diff --git a/Core/include/Acts/Detector/detail/IndexedSurfacesGenerator.hpp b/Core/include/Acts/Detector/detail/IndexedSurfacesGenerator.hpp index 9a501a17025..7ae7efe0431 100644 --- a/Core/include/Acts/Detector/detail/IndexedSurfacesGenerator.hpp +++ b/Core/include/Acts/Detector/detail/IndexedSurfacesGenerator.hpp @@ -79,7 +79,7 @@ struct IndexedSurfacesGenerator { IndexedSurfacesImpl indexedSurfaces(std::move(grid), bvArray, transform); - // Fill the bin indicies + // Fill the bin indices IndexedGridFiller filler{binExpansion}; filler.oLogger = oLogger->cloneWithSuffix("_filler"); filler.fill(gctx, indexedSurfaces, surfaces, rGenerator, assignToAll); diff --git a/Core/include/Acts/Detector/detail/KdtSurfacesProvider.hpp b/Core/include/Acts/Detector/detail/KdtSurfacesProvider.hpp index ff28adb0e10..f303c023c45 100644 --- a/Core/include/Acts/Detector/detail/KdtSurfacesProvider.hpp +++ b/Core/include/Acts/Detector/detail/KdtSurfacesProvider.hpp @@ -114,7 +114,7 @@ class KdtSurfaces { /// Cast values that turn a global position to lookup position std::array m_casts = {}; - /// Helper to generate refernce points for filling + /// Helper to generate reference points for filling reference_generator m_rGenerator; /// Unroll the cast loop diff --git a/Core/include/Acts/Detector/detail/ReferenceGenerators.hpp b/Core/include/Acts/Detector/detail/ReferenceGenerators.hpp index cd0c78add4f..e0e087db1af 100644 --- a/Core/include/Acts/Detector/detail/ReferenceGenerators.hpp +++ b/Core/include/Acts/Detector/detail/ReferenceGenerators.hpp @@ -30,14 +30,14 @@ struct CenterReferenceGenerator { /// @param gctx the geometry context of this operation /// @param surface the surface for which the reference point is to be accessed /// - /// @return a vector of referene points for filling + /// @return a vector of reference points for filling const std::vector references(const GeometryContext& gctx, const Surface& surface) const { return {surface.center(gctx)}; } }; -/// A struct to access reference postions based on bin values +/// A struct to access reference positions based on bin values /// /// This generator will provide only one filling point and hence /// only a single bin in the indexed grid. @@ -45,12 +45,12 @@ struct BinningValueReferenceGenerator { /// The binning value BinningValue bValue = BinningValue::binValues; - /// Helper to access a reference postion based on binning value + /// Helper to access a reference position based on binning value /// /// @param gctx the geometry context of this operation /// @param surface the surface for which the reference point is to be accessed /// - /// @return a vector of referene points for filling + /// @return a vector of reference points for filling const std::vector references(const GeometryContext& gctx, const Surface& surface) const { return {surface.binningPosition(gctx, bValue)}; @@ -75,7 +75,7 @@ struct PolyhedronReferenceGenerator { /// @param gctx the geometry context of this operation /// @param surface the surface for which the reference point is to be accessed /// - /// @return a vector of referene points for filling + /// @return a vector of reference points for filling const std::vector references(const GeometryContext& gctx, const Surface& surface) const { // Create the return vector diff --git a/Core/include/Acts/Detector/detail/SupportHelper.hpp b/Core/include/Acts/Detector/detail/SupportHelper.hpp index 0281954b5da..5e2dee8bffb 100644 --- a/Core/include/Acts/Detector/detail/SupportHelper.hpp +++ b/Core/include/Acts/Detector/detail/SupportHelper.hpp @@ -52,7 +52,7 @@ std::vector> discSupport( /// @param assignToAll [in, out] indices that are assigned to all bins in the indexing /// @param layerExtent the externally provided layer Extent /// @param layerRepresentation the shape of the layer -/// @param layerSupportValues the support structue in numbers +/// @param layerSupportValues the support structure in numbers /// @param layerTransform is an optional value of the layer transform /// @param supportSplits the number of splits if splitting is configured /// diff --git a/Core/include/Acts/Digitization/CartesianSegmentation.hpp b/Core/include/Acts/Digitization/CartesianSegmentation.hpp index cba00367911..edc71b2e792 100644 --- a/Core/include/Acts/Digitization/CartesianSegmentation.hpp +++ b/Core/include/Acts/Digitization/CartesianSegmentation.hpp @@ -21,7 +21,7 @@ namespace Acts { /// @brief Segmentation Base class /// -/// Segementation class for generic pixel, strixels and strip segmentations +/// Segmentation class for generic pixel, strixels and strip segmentations /// in a cartesian frame, this uses a cartesian X/Y local surface definition /// /// The calculation can be done in full 3D, i.e. the segments of the path @@ -29,7 +29,7 @@ namespace Acts { /// the planar module are calculated in a 3D model - or in 2D, when the entire /// calculation is done on the projective surface. When the 2D option is used, /// segmentation surfaces are not created. The 2D calculation is faster and uses -/// less memory, however, effects witin the sensor volume can not be easily +/// less memory, however, effects within the sensor volume can not be easily /// integrated /// /// Conventions: @@ -49,7 +49,7 @@ class CartesianSegmentation : public Segmentation { CartesianSegmentation(const std::shared_ptr& mBounds, size_t numCellsX, size_t numCellsY = 1); - /// @todo contructor from BinUtilities for more complex readouts + /// @todo constructor from BinUtilities for more complex readouts /// /// @param bUtility is the bin Utility, // it will define the RectangleBounds if none are provided @@ -57,7 +57,7 @@ class CartesianSegmentation : public Segmentation { /// optimisation /// /// @note if both RectangleBounds and BinUtility are provided, no check is - /// done for consitency + /// done for consistency CartesianSegmentation(std::shared_ptr bUtility, std::shared_ptr mBounds = nullptr); diff --git a/Core/include/Acts/Digitization/DigitizationModule.hpp b/Core/include/Acts/Digitization/DigitizationModule.hpp index ee7cb0457fb..3027ca65156 100644 --- a/Core/include/Acts/Digitization/DigitizationModule.hpp +++ b/Core/include/Acts/Digitization/DigitizationModule.hpp @@ -113,7 +113,7 @@ class DigitizationModule { DigitizationStep digitizationStep(const Vector3& start, const Vector3& end) const; - /// Return the bounding surfaces inlcuding top and bottom + /// Return the bounding surfaces including top and bottom const SurfacePtrVector& boundarySurfaces() const; /// Return all surfaces in X - excluding the boundaries diff --git a/Core/include/Acts/Digitization/PlanarModuleStepper.hpp b/Core/include/Acts/Digitization/PlanarModuleStepper.hpp index c7aa7aae22c..f9f6497982d 100644 --- a/Core/include/Acts/Digitization/PlanarModuleStepper.hpp +++ b/Core/include/Acts/Digitization/PlanarModuleStepper.hpp @@ -30,7 +30,7 @@ class PlanarModuleStepper { public: /// Constructor /// - /// @param mlogger is the logging istance + /// @param mlogger is the logging instance PlanarModuleStepper(std::unique_ptr mlogger = getDefaultLogger( "PlanarModuleStepper", Logging::INFO)); @@ -42,7 +42,7 @@ class PlanarModuleStepper { /// @param gctx The current geometry context object, e.g. alignment /// @param dmodule is the digitization module /// @param startPoint is the starting position of the stepping - /// @param endPoint is the end postion of the stepping + /// @param endPoint is the end position of the stepping /// /// @return is the vector of digitization steps std::vector cellSteps(const GeometryContext& gctx, @@ -55,7 +55,7 @@ class PlanarModuleStepper { /// @param gctx The current geometry context object, e.g. alignment /// @param dmodule is the digitization module /// @param moduleIntersection is the 2d intersection at the module surface - /// @param trackDirection is the track direction at the instersection + /// @param trackDirection is the track direction at the intersection /// /// @return is the vector of digitization steps std::vector cellSteps(const GeometryContext& gctx, diff --git a/Core/include/Acts/Digitization/Segmentation.hpp b/Core/include/Acts/Digitization/Segmentation.hpp index b0070e970aa..702d94c33c0 100644 --- a/Core/include/Acts/Digitization/Segmentation.hpp +++ b/Core/include/Acts/Digitization/Segmentation.hpp @@ -57,7 +57,7 @@ class Segmentation { SurfacePtrVector& segmentationSurfacesY, double halfThickness, int readoutDirection, double lorentzAngle) const = 0; - /// Get the digitization cell fropm a 3D position + /// Get the digitization cell from a 3D position /// - ignores the shift, i.e. assumenes in to be in cell frame /// /// @param position is the position for which the cell is requested @@ -65,7 +65,7 @@ class Segmentation { /// @return is a cell with cell ids virtual DigitizationCell cell(const Vector3& position) const = 0; - /// Get the digitization cell fropm a 2D position + /// Get the digitization cell from a 2D position /// - ignores the shift, i.e. assumenes in to be in cell frame /// /// @param position is the position for which the cell is requested diff --git a/Core/include/Acts/EventData/Charge.hpp b/Core/include/Acts/EventData/Charge.hpp index 6ea7a652fbc..e6df928ffe1 100644 --- a/Core/include/Acts/EventData/Charge.hpp +++ b/Core/include/Acts/EventData/Charge.hpp @@ -122,7 +122,7 @@ struct SinglyCharged { /// approximate comparison with an arbitrary epsilon. class AnyCharge { public: - /// Delete default constructor to ensure charge is always explicitely given. + /// Delete default constructor to ensure charge is always explicitly given. AnyCharge() = delete; /// Construct with the magnitude of the input charge. template diff --git a/Core/include/Acts/EventData/Measurement.hpp b/Core/include/Acts/EventData/Measurement.hpp index 28bde195c03..8c13b204614 100644 --- a/Core/include/Acts/EventData/Measurement.hpp +++ b/Core/include/Acts/EventData/Measurement.hpp @@ -126,10 +126,10 @@ class Measurement { /// Expansion matrix from the measured subspace into the full space. /// - /// This is equivalent to the tranpose of the projection matrix only in the + /// This is equivalent to the transpose of the projection matrix only in the /// case of a trivial projection matrix. While this is the case here, it is /// still recommended to use the expansion matrix directly in cases where it - /// is explicitely used. + /// is explicitly used. ExpansionMatrix expander() const { return m_subspace.template expander(); } diff --git a/Core/include/Acts/EventData/MultiComponentBoundTrackParameters.hpp b/Core/include/Acts/EventData/MultiComponentBoundTrackParameters.hpp index cbacafd17d7..f1b292911c2 100644 --- a/Core/include/Acts/EventData/MultiComponentBoundTrackParameters.hpp +++ b/Core/include/Acts/EventData/MultiComponentBoundTrackParameters.hpp @@ -18,7 +18,7 @@ namespace Acts { -/// This class is only a light wrapper arround a surface and a vector of +/// This class is only a light wrapper around a surface and a vector of /// parameters. Its main purpose is to provide many constructors for the /// underlying vector. Most accessors are generated from the /// SingleBoundTrackParameters equivalent and thus may be expensive @@ -110,7 +110,7 @@ class MultiComponentBoundTrackParameters { /// @param cov Bound parameters covariance matrix /// /// In principle, only the charge magnitude is needed her to allow - /// unambigous extraction of the absolute momentum. The particle charge is + /// unambiguous extraction of the absolute momentum. The particle charge is /// required as an input here to be consistent with the other constructors /// below that that also take the charge as an input. The charge sign is /// only used in debug builds to check for consistency with the q/p diff --git a/Core/include/Acts/EventData/MultiTrajectory.hpp b/Core/include/Acts/EventData/MultiTrajectory.hpp index 0819813a5e0..a53ef7d629b 100644 --- a/Core/include/Acts/EventData/MultiTrajectory.hpp +++ b/Core/include/Acts/EventData/MultiTrajectory.hpp @@ -307,7 +307,7 @@ class TrackStateProxy { return component(); } - /// Return whather this track state has a previous (parent) track state. + /// Return whether this track state has a previous (parent) track state. /// @return Boolean indicating whether a previous track state exists bool hasPrevious() const { return component() != kInvalid; @@ -344,7 +344,7 @@ class TrackStateProxy { shareFrom(other, component, component); } - /// Share a shareable component from anothe track state + /// Share a shareable component from another track state /// @param shareSource Which component to share from /// @param shareTarget Which component to share as. This can be be different from /// as @p shareSource, e.g. predicted can be shared as filtered. @@ -1471,7 +1471,7 @@ class MultiTrajectory { } /// Share a shareable component from between track state. - /// @param iself The track state index to share "into" + /// @param itself The track state index to share "into" /// @param iother The track state index to share from /// @param shareSource Which component to share from /// @param shareTarget Which component to share as. This doesn't have to be the same diff --git a/Core/include/Acts/EventData/SingleBoundTrackParameters.hpp b/Core/include/Acts/EventData/SingleBoundTrackParameters.hpp index 65ad1c9363c..da9586579ea 100644 --- a/Core/include/Acts/EventData/SingleBoundTrackParameters.hpp +++ b/Core/include/Acts/EventData/SingleBoundTrackParameters.hpp @@ -46,7 +46,7 @@ class SingleBoundTrackParameters { /// @param q Particle charge /// @param cov Bound parameters covariance matrix /// - /// In principle, only the charge magnitude is needed her to allow unambigous + /// In principle, only the charge magnitude is needed her to allow unambiguous /// extraction of the absolute momentum. The particle charge is required as /// an input here to be consistent with the other constructors below that /// that also take the charge as an input. The charge sign is only used in @@ -160,7 +160,7 @@ class SingleBoundTrackParameters { /// Optional covariance matrix. const std::optional& covariance() const { return m_cov; } - /// Access a single parameter value indentified by its index. + /// Access a single parameter value identified by its index. /// /// @tparam kIndex Track parameter index template @@ -258,7 +258,7 @@ class SingleBoundTrackParameters { /// @note Comparing track parameters for bitwise equality is not a good /// idea. /// Depending on the context you might want to compare only the - /// parameter values, or compare them for compability instead of + /// parameter values, or compare them for compatibility instead of /// equality; you might also have different (floating point) thresholds /// of equality in different contexts. None of that can be handled by /// this operator. Users should think really hard if this is what they diff --git a/Core/include/Acts/EventData/SingleFreeTrackParameters.hpp b/Core/include/Acts/EventData/SingleFreeTrackParameters.hpp index 76aa99232a2..f466a07143b 100644 --- a/Core/include/Acts/EventData/SingleFreeTrackParameters.hpp +++ b/Core/include/Acts/EventData/SingleFreeTrackParameters.hpp @@ -38,7 +38,7 @@ class SingleFreeTrackParameters { /// @param q Particle charge /// @param cov Free parameters covariance matrix /// - /// In principle, only the charge magnitude is needed her to allow unambigous + /// In principle, only the charge magnitude is needed her to allow unambiguous /// extraction of the absolute momentum. The particle charge is required as /// an input here to be consistent with the other constructors below that /// that also take the charge as an input. The charge sign is only used in @@ -133,7 +133,7 @@ class SingleFreeTrackParameters { /// Optional covariance matrix. const std::optional& covariance() const { return m_cov; } - /// Access a single parameter value indentified by its index. + /// Access a single parameter value identified by its index. /// /// @tparam kIndex Track parameter index template diff --git a/Core/include/Acts/EventData/TrackContainer.hpp b/Core/include/Acts/EventData/TrackContainer.hpp index d0134be438f..18f5a724f0e 100644 --- a/Core/include/Acts/EventData/TrackContainer.hpp +++ b/Core/include/Acts/EventData/TrackContainer.hpp @@ -31,7 +31,7 @@ template struct IsReadOnlyTrackContainer; /// Track container interface class. This type represents a collections of -/// tracks. It uses a backend to store bothe the actual tracks and the +/// tracks. It uses a backend to store both the actual tracks and the /// associated track states. /// @tparam track_container_t the track container backend /// @tparam traj_t the track state container backend @@ -130,7 +130,7 @@ class TrackContainer { /// Remove a track at index @p itrack from the container /// @note This invalidates all track proxies! - /// @param itrack The index of the track to remmove + /// @param itrack The index of the track to remove template > void removeTrack(IndexType itrack) { m_container->removeTrack_impl(itrack); diff --git a/Core/include/Acts/EventData/detail/CorrectedTransformationFreeToBound.hpp b/Core/include/Acts/EventData/detail/CorrectedTransformationFreeToBound.hpp index d2a779b7635..6c389c4c269 100644 --- a/Core/include/Acts/EventData/detail/CorrectedTransformationFreeToBound.hpp +++ b/Core/include/Acts/EventData/detail/CorrectedTransformationFreeToBound.hpp @@ -33,14 +33,14 @@ struct FreeToBoundCorrection { /// Construct from boolean and UKF parameters (alpha, beta) /// - /// @param apply_ Wheter to apply correction + /// @param apply_ Whether to apply correction /// @param alpha_ The UKF tuning parameter alpha /// @param beta_ The UKF tuning parameter beta FreeToBoundCorrection(bool apply_, ActsScalar alpha_, ActsScalar beta_); /// Construct from boolean only /// - /// @param apply_ Wheter to apply correction + /// @param apply_ Whether to apply correction explicit FreeToBoundCorrection(bool apply_); /// Return boolean for applying correction or not diff --git a/Core/include/Acts/EventData/detail/ParameterTraits.hpp b/Core/include/Acts/EventData/detail/ParameterTraits.hpp index f68f21e57f0..5e3b0df0163 100644 --- a/Core/include/Acts/EventData/detail/ParameterTraits.hpp +++ b/Core/include/Acts/EventData/detail/ParameterTraits.hpp @@ -105,7 +105,7 @@ struct CyclicParameterTraits { // Limit types for parameter traits. // -// The functions names are chosen to be consisten w/ std::numeric_limits +// The functions names are chosen to be consistent w/ std::numeric_limits struct PhiBoundParameterLimits { static constexpr double lowest() { return -M_PI; } static constexpr double max() { return M_PI; } @@ -131,7 +131,7 @@ struct ParameterTraitsImpl { }; template struct ParameterTraitsImpl { - // other bound parameters not explicitely specified above are unrestricted + // other bound parameters not explicitly specified above are unrestricted using Type = UnrestrictedParameterTraits; }; template diff --git a/Core/include/Acts/Geometry/AbstractVolume.hpp b/Core/include/Acts/Geometry/AbstractVolume.hpp index 0b170aa9f4d..9fa2a215928 100644 --- a/Core/include/Acts/Geometry/AbstractVolume.hpp +++ b/Core/include/Acts/Geometry/AbstractVolume.hpp @@ -39,14 +39,14 @@ using VolumeBoundsPtr = std::shared_ptr; /// the Acts::VolumeBounds that carry a decompose method. /// /// Boundary surfaces can be shared between AbstractVolumes to enhance automatic -/// navigation between AbstractVolumes, therefor they are reference counted by a +/// navigation between AbstractVolumes, therefore they are reference counted by a /// std::shared_ptr holder class. class AbstractVolume : public Volume { public: /// Constructor with shared Transform3*, VolumeBounds* /// - /// @param transform is the gobal 3d transformation into the volume frame + /// @param transform is the global 3d transformation into the volume frame /// @param volbounds is the boundary definition AbstractVolume(const Transform3& transform, VolumeBoundsPtr volbounds); diff --git a/Core/include/Acts/Geometry/BoundarySurfaceFace.hpp b/Core/include/Acts/Geometry/BoundarySurfaceFace.hpp index 92dfc95efb9..2575619aa2a 100644 --- a/Core/include/Acts/Geometry/BoundarySurfaceFace.hpp +++ b/Core/include/Acts/Geometry/BoundarySurfaceFace.hpp @@ -16,13 +16,13 @@ namespace Acts { /// /// Enum to describe the position of the BoundarySurface /// respectively to the frame orientatin of the volume, -/// this is mainly ment for code readability. +/// this is mainly meant for code readability. /// /// The different numeration sequences can be found in the /// documentation of the actual VolumeBounds implementations. /// /// The order of faces is chosen to follow - as much as -/// possible - a cycular structure. +/// possible - a circular structure. enum BoundarySurfaceFace { negativeFaceXY = 0, positiveFaceXY = 1, diff --git a/Core/include/Acts/Geometry/BoundarySurfaceT.hpp b/Core/include/Acts/Geometry/BoundarySurfaceT.hpp index 25854431d0b..ffcdc5f0b47 100644 --- a/Core/include/Acts/Geometry/BoundarySurfaceT.hpp +++ b/Core/include/Acts/Geometry/BoundarySurfaceT.hpp @@ -55,8 +55,8 @@ class BoundarySurfaceT { /// Constructor for a Boundary with exact two Volumes attached to it /// - usually used in a volume constructor /// - /// @param surface The unqiue surface the boundary represents - /// @param inside The inside volume the bounday surface points to + /// @param surface The unique surface the boundary represents + /// @param inside The inside volume the boundary surface points to /// @param outside The outside volume the boundary surface points to BoundarySurfaceT(std::shared_ptr surface, const volume_t* inside, const volume_t* outside) @@ -69,8 +69,8 @@ class BoundarySurfaceT { /// Constructor for a Boundary with exact two Volumes attached to it /// - usually used in a volume constructor /// - /// @param surface The unqiue surface the boundary represents - /// @param inside The inside volume the bounday surface points to + /// @param surface The unique surface the boundary represents + /// @param inside The inside volume the boundary surface points to /// @param outside The outside volume the boundary surface points to BoundarySurfaceT(std::shared_ptr surface, VolumePtr inside, VolumePtr outside) @@ -83,8 +83,8 @@ class BoundarySurfaceT { /// Constructor for a Boundary with exact multiple Volumes attached to it /// - usually used in a volume constructor /// - /// @param surface The unqiue surface the boundary represents - /// @param insideArray The inside volume array the bounday surface points to + /// @param surface The unique surface the boundary represents + /// @param insideArray The inside volume array the boundary surface points to /// @param outsideArray The outside volume array the boundary surface /// points to BoundarySurfaceT(std::shared_ptr surface, @@ -104,7 +104,7 @@ class BoundarySurfaceT { /// @param gctx The current geometry context object, e.g. alignment /// @param pos The global position on surface /// @param mom The direction on the surface - /// @param dir is an aditional direction corrective + /// @param dir is an additional direction corrective /// /// @return The attached volume at that position virtual const volume_t* attachedVolume(const GeometryContext& gctx, diff --git a/Core/include/Acts/Geometry/ConeLayer.hpp b/Core/include/Acts/Geometry/ConeLayer.hpp index 933d27a5305..334ebe2d85b 100644 --- a/Core/include/Acts/Geometry/ConeLayer.hpp +++ b/Core/include/Acts/Geometry/ConeLayer.hpp @@ -28,14 +28,14 @@ class ConeLayer : virtual public ConeSurface, public Layer { public: /// Factory for shared layer /// - /// @param transform is the 3D transform that poisitions the layer in 3D frame + /// @param transform is the 3D transform that positions the layer in 3D frame /// @param cbounds is the conical bound description /// @param surfaceArray is the array of sensitive surfaces /// @param thickness is the layer thickness along the normal axis /// @param ad is the approach descriptor for navigation towards the layer /// @param laytyp is the layer type /// - /// @todo chage od and ad to unique_ptr + /// @todo change od and ad to unique_ptr /// /// @return is a shared pointer to a layer static MutableLayerPtr create( @@ -62,14 +62,14 @@ class ConeLayer : virtual public ConeSurface, public Layer { protected: /// Private constructor with arguments /// - /// @param transform is the 3D transform that poisitions the layer in 3D frame + /// @param transform is the 3D transform that positions the layer in 3D frame /// @param cbounds is the conical bound description /// @param surfaceArray is the array of sensitive surfaces /// @param thickness is the layer thickness along the normal axis /// @param ade is the approach descriptor for navigation towards the layer /// @param laytyp is the layer type /// - /// @todo chage od and ad to unique_ptr + /// @todo change od and ad to unique_ptr ConeLayer(const Transform3& transform, std::shared_ptr cbounds, std::unique_ptr surfaceArray, double thickness = 0., diff --git a/Core/include/Acts/Geometry/ConeVolumeBounds.hpp b/Core/include/Acts/Geometry/ConeVolumeBounds.hpp index 771fc0b07f8..93b7283e9ae 100644 --- a/Core/include/Acts/Geometry/ConeVolumeBounds.hpp +++ b/Core/include/Acts/Geometry/ConeVolumeBounds.hpp @@ -159,7 +159,7 @@ class ConeVolumeBounds : public VolumeBounds { /// Create the surface bounds void buildSurfaceBounds(); - /// Templated dump methos + /// Templated dump methods /// @tparam stream_t The type of the stream for dumping /// @param dt The stream object template diff --git a/Core/include/Acts/Geometry/CuboidVolumeBounds.hpp b/Core/include/Acts/Geometry/CuboidVolumeBounds.hpp index 42312c44902..bd63bd372dc 100644 --- a/Core/include/Acts/Geometry/CuboidVolumeBounds.hpp +++ b/Core/include/Acts/Geometry/CuboidVolumeBounds.hpp @@ -132,7 +132,7 @@ class CuboidVolumeBounds : public VolumeBounds { private: /// Templated dumpT method - /// @tparam stream_t The type fo the dump stream + /// @tparam stream_t The type for the dump stream /// @param dt The dump stream object template stream_t& dumpT(stream_t& dt) const; diff --git a/Core/include/Acts/Geometry/CuboidVolumeBuilder.hpp b/Core/include/Acts/Geometry/CuboidVolumeBuilder.hpp index a6e9cf003a7..3b645d4809d 100644 --- a/Core/include/Acts/Geometry/CuboidVolumeBuilder.hpp +++ b/Core/include/Acts/Geometry/CuboidVolumeBuilder.hpp @@ -78,7 +78,7 @@ class CuboidVolumeBuilder : public ITrackingVolumeBuilder { std::array envelopeY{0, 0}; // Envelope in Z std::array envelopeZ{0, 0}; - // An optional rotation fo this + // An optional rotation for this std::optional rotation{std::nullopt}; }; @@ -136,7 +136,7 @@ class CuboidVolumeBuilder : public ITrackingVolumeBuilder { std::shared_ptr buildSurface(const GeometryContext& gctx, const SurfaceConfig& cfg) const; - /// @brief This function creates a layer with a surface encaspulated with a + /// @brief This function creates a layer with a surface encapsulated with a /// given configuration. The surface gets a detector element attached if the /// template parameter is non-void. /// diff --git a/Core/include/Acts/Geometry/CutoutCylinderVolumeBounds.hpp b/Core/include/Acts/Geometry/CutoutCylinderVolumeBounds.hpp index 99c6e52af56..807e918e120 100644 --- a/Core/include/Acts/Geometry/CutoutCylinderVolumeBounds.hpp +++ b/Core/include/Acts/Geometry/CutoutCylinderVolumeBounds.hpp @@ -23,7 +23,7 @@ namespace Acts { class CylinderBounds; class DiscBounds; -/// Class which implements a cutout cylinder. This shape is bascially a +/// Class which implements a cutout cylinder. This shape is basically a /// cylinder, with another, smaller cylinder subtracted from the center. /// --------------------- rmax /// | | diff --git a/Core/include/Acts/Geometry/CylinderLayer.hpp b/Core/include/Acts/Geometry/CylinderLayer.hpp index 489b974d9df..cf6068a9b0b 100644 --- a/Core/include/Acts/Geometry/CylinderLayer.hpp +++ b/Core/include/Acts/Geometry/CylinderLayer.hpp @@ -39,7 +39,7 @@ class CylinderLayer : public CylinderSurface, public Layer { /// /// @todo ApproachDescriptor to unique_ptr /// - /// @return The return object is a shared poiter to the layer. + /// @return The return object is a shared pointer to the layer. static std::shared_ptr create( const Transform3& transform, const std::shared_ptr& cbounds, diff --git a/Core/include/Acts/Geometry/CylinderVolumeBounds.hpp b/Core/include/Acts/Geometry/CylinderVolumeBounds.hpp index 2884442e971..af16ff16692 100644 --- a/Core/include/Acts/Geometry/CylinderVolumeBounds.hpp +++ b/Core/include/Acts/Geometry/CylinderVolumeBounds.hpp @@ -207,7 +207,7 @@ class CylinderVolumeBounds : public VolumeBounds { void buildSurfaceBounds(); /// Templated dumpT method - /// @tparam stream_t The type fo the dump stream + /// @tparam stream_t The type to the dump stream /// @param dt The dump stream object template stream_t& dumpT(stream_t& dt) const; diff --git a/Core/include/Acts/Geometry/CylinderVolumeBuilder.hpp b/Core/include/Acts/Geometry/CylinderVolumeBuilder.hpp index ae00326ae2d..f18ceaa8ba8 100644 --- a/Core/include/Acts/Geometry/CylinderVolumeBuilder.hpp +++ b/Core/include/Acts/Geometry/CylinderVolumeBuilder.hpp @@ -251,7 +251,7 @@ struct WrappingConfig { cVolumeConfig.midPointAttachZ(pVolumeConfig); } // adapt r afterwards - // - easy if no exisitng volume + // - easy if no existing volume // - possible if no central volume if (!existingVolumeConfig || !cVolumeConfig) { nVolumeConfig.adaptR(containerVolumeConfig); @@ -417,7 +417,7 @@ struct WrappingConfig { sl << "New container built with configuration: " << containerVolumeConfig.toString() << '\n'; } - // go throug the new new ones first + // go through the new new ones first if (nVolumeConfig) { sl << " - n: Negative Endcap, current configuration: " << nVolumeConfig.toString() << '\n'; @@ -473,7 +473,7 @@ class CylinderVolumeBuilder : public ITrackingVolumeBuilder { /// @struct Config /// Nested configuration struct for this CylinderVolumeBuilder struct Config { - /// The trackign volume helper for construction + /// The tracking volume helper for construction std::shared_ptr trackingVolumeHelper = nullptr; /// The string based indenfication std::string volumeName = ""; @@ -496,7 +496,7 @@ class CylinderVolumeBuilder : public ITrackingVolumeBuilder { /// the additional envelope in Z to create zMin, zMax double layerEnvelopeZ = 1. * UnitConstants::mm; - // The potential boundary material (MB) options - there are 6 at maximium + // The potential boundary material (MB) options - there are 6 at maximum /// -------------------- MB (outer [1]) --------------- /// | MB [2] NEC MB [3] | B | MB [4] PEC MB [5] | /// -------------------- MB (inner [0]) --------------- @@ -509,7 +509,7 @@ class CylinderVolumeBuilder : public ITrackingVolumeBuilder { /// Constructor /// - /// @param [in] cvbConfig is the configuraiton struct to steer the builder + /// @param [in] cvbConfig is the configuration struct to steer the builder /// @param [in] logger logging instance CylinderVolumeBuilder(const Config& cvbConfig, std::unique_ptr logger = getDefaultLogger( @@ -543,7 +543,7 @@ class CylinderVolumeBuilder : public ITrackingVolumeBuilder { /// set logging instance /// - /// @param [in] newLogger is the logging istance to be set + /// @param [in] newLogger is the logging instance to be set void setLogger(std::unique_ptr newLogger); /// Analyze the config to gather needed dimension diff --git a/Core/include/Acts/Geometry/CylinderVolumeHelper.hpp b/Core/include/Acts/Geometry/CylinderVolumeHelper.hpp index 0bf01dd1523..5762552d7ec 100644 --- a/Core/include/Acts/Geometry/CylinderVolumeHelper.hpp +++ b/Core/include/Acts/Geometry/CylinderVolumeHelper.hpp @@ -70,7 +70,7 @@ class CylinderVolumeHelper : public ITrackingVolumeHelper { /// together with the volume enevlope parameters /// @param volumeMaterial material properties for this TrackingVolume /// @param volumeBounds: confinement of this TrackingVolume - /// @param mtvVector (optiona) Vector of confined TrackingVolumes + /// @param mtvVector (optional) Vector of confined TrackingVolumes /// @param transform (optional) placement of this TrackingVolume /// @param volumeName volume name to be given /// @param bType (optional) BinningType - arbitrary(default) or equidistant @@ -118,7 +118,7 @@ class CylinderVolumeHelper : public ITrackingVolumeHelper { /// @param rMax maximum radius /// @param zMin minimum z /// @param zMax maximum z - /// @param materialLayers number of material layers (aequidistant binning) + /// @param materialLayers number of material layers (equidistant binning) /// @param cylinder type of layers /// @param volumeName volume name to be given /// @@ -167,7 +167,7 @@ class CylinderVolumeHelper : public ITrackingVolumeHelper { /// Set configuration method /// - /// @param cvhConfig is the configurtion struct assigned + /// @param cvhConfig is the configuration struct assigned void setConfiguration(const Config& cvhConfig); /// Get configuration method @@ -175,7 +175,7 @@ class CylinderVolumeHelper : public ITrackingVolumeHelper { /// Set logging instance /// - /// @param newLogger is the logger isntance to be set + /// @param newLogger is the logger instance to be set void setLogger(std::unique_ptr newLogger); protected: @@ -217,7 +217,7 @@ class CylinderVolumeHelper : public ITrackingVolumeHelper { /// @param rBinned a boolean indicating if it is binned in r /// @param rMin the minimum radius of the volume /// @param rGlueMin the minimum glue radius (@todo check and document) - /// @param rMax the maximim radius of the volume + /// @param rMax the maximum radius of the volume /// @param zMin the minimum z extend of the volume /// @param zMax the maximum z extend of the volume bool interGlueTrackingVolume(const GeometryContext& gctx, @@ -234,7 +234,7 @@ class CylinderVolumeHelper : public ITrackingVolumeHelper { /// @param faceTwo is the second boundary face of the glue process /// @param rMin the minimum radius of the volume /// @param rGlueMin the minimum glue radius (@todo check and document) - /// @param rMax the maximim radius of the volume + /// @param rMax the maximum radius of the volume /// @param zMin the minimum z extend of the volume /// @param zMax the maximum z extend of the volume void glueTrackingVolumes(const GeometryContext& gctx, diff --git a/Core/include/Acts/Geometry/Extent.hpp b/Core/include/Acts/Geometry/Extent.hpp index f4aed1efc15..63e6d3ddb73 100644 --- a/Core/include/Acts/Geometry/Extent.hpp +++ b/Core/include/Acts/Geometry/Extent.hpp @@ -32,7 +32,7 @@ constexpr ExtentEnvelope zeroEnvelopes = { zeroEnvelope, zeroEnvelope, zeroEnvelope, zeroEnvelope, zeroEnvelope, zeroEnvelope, zeroEnvelope, zeroEnvelope}; -/// A class representing the geometric extent of an object in its possbile +/// A class representing the geometric extent of an object in its possible /// dimensions, these can be all dimensions that are described as BinningValues /// /// The extent object can have an optional envelope in all of those values @@ -154,7 +154,7 @@ class Extent { /// Return the histogram store /// - /// The histogram stroe can be used for automated binning detection + /// The histogram store can be used for automated binning detection const std::array, binValues>& valueHistograms() const; /// Access the minimum parameter diff --git a/Core/include/Acts/Geometry/GenericApproachDescriptor.hpp b/Core/include/Acts/Geometry/GenericApproachDescriptor.hpp index 2760928006e..0c2630e7be3 100644 --- a/Core/include/Acts/Geometry/GenericApproachDescriptor.hpp +++ b/Core/include/Acts/Geometry/GenericApproachDescriptor.hpp @@ -50,10 +50,10 @@ class GenericApproachDescriptor : public ApproachDescriptor { /// @brief Register the Layer to the surfaces /// - /// @param lay is the layer to be registerd + /// @param lay is the layer to be registered void registerLayer(const Layer& lay) override; - /// Get the aproach surface to the layer + /// Get the approach surface to the layer /// /// @param gctx The current geometry context object, e.g. alignment /// @param position The global position to start the approach from diff --git a/Core/include/Acts/Geometry/GenericCuboidVolumeBounds.hpp b/Core/include/Acts/Geometry/GenericCuboidVolumeBounds.hpp index bc32c37a8ae..80ef324afb2 100644 --- a/Core/include/Acts/Geometry/GenericCuboidVolumeBounds.hpp +++ b/Core/include/Acts/Geometry/GenericCuboidVolumeBounds.hpp @@ -102,7 +102,7 @@ class GenericCuboidVolumeBounds : public VolumeBounds { std::array m_vertices; std::array m_normals; - /// Private helper method to contruct the Volume bounds + /// Private helper method to construct the Volume bounds /// to be called by the constructors, from the ordered input vertices void construct() noexcept(false); }; diff --git a/Core/include/Acts/Geometry/GeometryHierarchyMap.hpp b/Core/include/Acts/Geometry/GeometryHierarchyMap.hpp index edb01254f92..da8b8f4928e 100644 --- a/Core/include/Acts/Geometry/GeometryHierarchyMap.hpp +++ b/Core/include/Acts/Geometry/GeometryHierarchyMap.hpp @@ -106,7 +106,7 @@ class GeometryHierarchyMap { /// /// This can be either from the element matching exactly to the given geometry /// id, if it exists, or from the element for the next available higher level - /// within the geometry hierachy. + /// within the geometry hierarchy. /// /// @param id geometry identifier for which information is requested /// @retval iterator to an existing value diff --git a/Core/include/Acts/Geometry/GeometryObjectSorter.hpp b/Core/include/Acts/Geometry/GeometryObjectSorter.hpp index 37cc4ce6ae0..a2f6ec0c095 100644 --- a/Core/include/Acts/Geometry/GeometryObjectSorter.hpp +++ b/Core/include/Acts/Geometry/GeometryObjectSorter.hpp @@ -33,7 +33,7 @@ class ObjectSorterT { /// @param one first object /// @param two second object /// - /// @return boolen indicator + /// @return boolean indicator bool operator()(T one, T two) const { using Acts::VectorHelpers::eta; using Acts::VectorHelpers::perp; @@ -98,7 +98,7 @@ class DistanceSorterT { /// @tparam one first object /// @tparam two second object /// - /// @return boolen indicator + /// @return boolean indicator bool operator()(T one, T two) const { using Acts::VectorHelpers::eta; using Acts::VectorHelpers::perp; @@ -178,7 +178,7 @@ class GeometryObjectSorterT { /// @tparam one first object /// @tparam two second object /// - /// @return boolen indicator + /// @return boolean indicator bool operator()(T one, T two) const { // get the pos one / pos two Vector3 posOne = diff --git a/Core/include/Acts/Geometry/GlueVolumesDescriptor.hpp b/Core/include/Acts/Geometry/GlueVolumesDescriptor.hpp index 94ed6e5eb97..8182d6f0fdc 100644 --- a/Core/include/Acts/Geometry/GlueVolumesDescriptor.hpp +++ b/Core/include/Acts/Geometry/GlueVolumesDescriptor.hpp @@ -40,7 +40,7 @@ class GlueVolumesDescriptor { const std::map>& gvs); - /// Desctructor + /// Destructor ~GlueVolumesDescriptor() = default; /// Register the volumes /// diff --git a/Core/include/Acts/Geometry/IConfinedTrackingVolumeBuilder.hpp b/Core/include/Acts/Geometry/IConfinedTrackingVolumeBuilder.hpp index 46bd3cc1d72..22d44a5f4e1 100644 --- a/Core/include/Acts/Geometry/IConfinedTrackingVolumeBuilder.hpp +++ b/Core/include/Acts/Geometry/IConfinedTrackingVolumeBuilder.hpp @@ -26,7 +26,7 @@ class IConfinedTrackingVolumeBuilder { /// Interface for constructing a vector of confined TrackingVolumes virtual MutableTrackingVolumeVector centralVolumes() const = 0; - /// Interface for retreiving the identification string of the confined volumes + /// Interface for retrieving the identification string of the confined volumes virtual const std::string& identification() const = 0; }; diff --git a/Core/include/Acts/Geometry/ILayerArrayCreator.hpp b/Core/include/Acts/Geometry/ILayerArrayCreator.hpp index f95be794c2b..20fe6e5210f 100644 --- a/Core/include/Acts/Geometry/ILayerArrayCreator.hpp +++ b/Core/include/Acts/Geometry/ILayerArrayCreator.hpp @@ -46,7 +46,7 @@ class ILayerArrayCreator { /// @param btype is the binning type /// @param bvalue is the value in which the binning should be done /// - /// @return unqiue pointer to a new LayerArray + /// @return unique pointer to a new LayerArray virtual std::unique_ptr layerArray( const GeometryContext& gctx, const LayerVector& layers, double min, double max, BinningType btype = arbitrary, diff --git a/Core/include/Acts/Geometry/ILayerBuilder.hpp b/Core/include/Acts/Geometry/ILayerBuilder.hpp index 19bc78372a8..41ed9d2ee2e 100644 --- a/Core/include/Acts/Geometry/ILayerBuilder.hpp +++ b/Core/include/Acts/Geometry/ILayerBuilder.hpp @@ -33,7 +33,7 @@ class ILayerBuilder { /// LayerBuilder interface method /// - /// @param gctx ist the geometry context under + /// @param gctx is the geometry context under /// which the geometry is built /// /// @return the layers at negative side @@ -42,7 +42,7 @@ class ILayerBuilder { /// LayerBuilder interface method /// - /// @param gctx ist the geometry context under + /// @param gctx is the geometry context under /// which the geometry is built /// /// @return the layers at the central sector @@ -51,7 +51,7 @@ class ILayerBuilder { /// LayerBuilder interface method /// - /// @param gctx ist the geometry context under + /// @param gctx is the geometry context under /// which the geometry is built /// /// @return the layers at positive side diff --git a/Core/include/Acts/Geometry/ITrackingGeometryBuilder.hpp b/Core/include/Acts/Geometry/ITrackingGeometryBuilder.hpp index 1744e881830..ddfd2a3e169 100644 --- a/Core/include/Acts/Geometry/ITrackingGeometryBuilder.hpp +++ b/Core/include/Acts/Geometry/ITrackingGeometryBuilder.hpp @@ -17,7 +17,7 @@ class TrackingGeometry; /// @class ITrackingGeometryBuilder /// /// Interface class for the TrackingGeometry building, -/// this is used by the TrackingGeometrySvc to build the geoemtry. +/// this is used by the TrackingGeometrySvc to build the geometry. /// /// The TrackingGeometry is written to the detector store and thus not created /// as a std::shared_ptr. @@ -30,9 +30,9 @@ class ITrackingGeometryBuilder { /// Virtual destructor virtual ~ITrackingGeometryBuilder() = default; - /// TrackingGeometry Interface methode + /// TrackingGeometry Interface method /// - /// @param gctx ist the geometry context for witch the geometry is built + /// @param gctx is the geometry context for witch the geometry is built /// /// @return unique pointer to a newly created TrackingGeometry virtual std::unique_ptr trackingGeometry( diff --git a/Core/include/Acts/Geometry/ITrackingVolumeHelper.hpp b/Core/include/Acts/Geometry/ITrackingVolumeHelper.hpp index f41d7b254dc..b7d43499877 100644 --- a/Core/include/Acts/Geometry/ITrackingVolumeHelper.hpp +++ b/Core/include/Acts/Geometry/ITrackingVolumeHelper.hpp @@ -97,7 +97,7 @@ class ITrackingVolumeHelper { /// @param volumeMaterial material properties for this TrackingVolume /// @param loc0Min, loc0Max, loc1Min, loc1Max : local position in space, /// this TrackingVolume is restricted to Translation only - /// @param materialLayers number of material layers (aequidistant binning) + /// @param materialLayers number of material layers (equidistant binning) /// @param cylinder type of layers /// @param volumeName volume name to be given /// diff --git a/Core/include/Acts/Geometry/KDTreeTrackingGeometryBuilder.hpp b/Core/include/Acts/Geometry/KDTreeTrackingGeometryBuilder.hpp index 38e72cf6c52..d2e156328b6 100644 --- a/Core/include/Acts/Geometry/KDTreeTrackingGeometryBuilder.hpp +++ b/Core/include/Acts/Geometry/KDTreeTrackingGeometryBuilder.hpp @@ -103,7 +103,7 @@ class KDTreeTrackingGeometryBuilder : public ITrackingGeometryBuilder { /// @param cCache is a cache used to extract the built detector elements /// @param gctx is the current geometry context at building /// @param kdt is the pre-filled kdt tree for the surface query - /// @param plVolume the proto volume representaion a layer to be translated + /// @param plVolume the proto volume representation a layer to be translated /// @param indent is a screen output indentation /// /// @return a new tracking volume diff --git a/Core/include/Acts/Geometry/Layer.hpp b/Core/include/Acts/Geometry/Layer.hpp index 9418b533154..4648fa741ba 100644 --- a/Core/include/Acts/Geometry/Layer.hpp +++ b/Core/include/Acts/Geometry/Layer.hpp @@ -66,7 +66,7 @@ enum LayerType { navigation = -1, passive = 0, active = 1 }; /// subSurfaces. /// A pointer to the TrackingVolume (can only be set by such) /// An active/passive code : -/// 0 - activ +/// 0 - active /// 1 - passive /// [....] - other /// @@ -126,7 +126,7 @@ class Layer : public virtual GeometryObject { /// @note using isOnSurface() with Layer specific tolerance /// /// @param gctx The current geometry context object, e.g. alignment - /// @param position is the gobal position to be checked + /// @param position is the global position to be checked /// @param bcheck is the boundary check directive /// /// @return boolean that indicates success of the operation @@ -275,7 +275,7 @@ class Layer : public virtual GeometryObject { /// Private helper method to close the geometry /// - it will assign material to the surfaces if needed /// - it will set the layer geometry ID for a unique identification - /// - it will also register the internal sub strucutre + /// - it will also register the internal sub structure /// /// @param materialDecorator is a decorator that assigns /// optionally the surface material to where they belong diff --git a/Core/include/Acts/Geometry/LayerArrayCreator.hpp b/Core/include/Acts/Geometry/LayerArrayCreator.hpp index d19cacfd255..02944f2c5ae 100644 --- a/Core/include/Acts/Geometry/LayerArrayCreator.hpp +++ b/Core/include/Acts/Geometry/LayerArrayCreator.hpp @@ -45,7 +45,7 @@ class LayerArrayCreator : public ILayerArrayCreator { /// LayerArrayCreator interface method /// - /// @param gctx ist the geometry context for witch the array is built + /// @param gctx is the geometry context for witch the array is built /// @param layersInput are the layers to be moved into an array /// @param min is the minimum value for binning /// @param max is the maximum value for binning diff --git a/Core/include/Acts/Geometry/LayerCreator.hpp b/Core/include/Acts/Geometry/LayerCreator.hpp index 08ac1b22fd0..79c62cca71f 100644 --- a/Core/include/Acts/Geometry/LayerCreator.hpp +++ b/Core/include/Acts/Geometry/LayerCreator.hpp @@ -66,7 +66,7 @@ class LayerCreator { /// returning a cylindrical layer /// - /// @param gctx ist the geometry context with which the geometry is built + /// @param gctx is the geometry context with which the geometry is built /// @param surfaces is the vector of pointers to sensitive surfaces /// represented by this layer /// @pre the pointers to the sensitive surfaces in the surfaces vectors all @@ -90,7 +90,7 @@ class LayerCreator { /// returning a cylindrical layer /// - /// @param gctx ist the geometry context with which the geometry is built + /// @param gctx is the geometry context with which the geometry is built /// @param surfaces is the vector of pointers to sensitive surfaces /// represented by this layer /// @pre the pointers to the sensitive surfaces in the surfaces vectors all @@ -115,7 +115,7 @@ class LayerCreator { /// returning a disc layer /// - /// @param gctx ist the geometry context with which the geometry is built + /// @param gctx is the geometry context with which the geometry is built /// @param surfaces is the vector of pointers to sensitive surfaces /// represented by this layer /// @pre the pointers to the sensitive surfaces in the surfaces vectors all @@ -139,7 +139,7 @@ class LayerCreator { /// returning a disc layer /// - /// @param gctx ist the geometry context with which the geometry is built + /// @param gctx is the geometry context with which the geometry is built /// @param surfaces is the vector of pointers to sensitive surfaces /// represented by this layer /// @pre the pointers to the sensitive surfaces in the surfaces vectors all @@ -164,7 +164,7 @@ class LayerCreator { /// returning a plane layer /// - /// @param gctx ist the geometry context with which the geometry is built + /// @param gctx is the geometry context with which the geometry is built /// @param [in] surfaces is the vector of pointers to sensitive surfaces /// represented by this layer /// @pre the pointers to the sensitive surfaces in the surfaces vectors all @@ -217,7 +217,7 @@ class LayerCreator { /// configuration object Config m_cfg; - /// Private acces method to the logger + /// Private access method to the logger const Logger& logger() const { return *m_logger; } /// logging instance diff --git a/Core/include/Acts/Geometry/NavigationLayer.hpp b/Core/include/Acts/Geometry/NavigationLayer.hpp index 1dd16d04754..78c66b38c39 100644 --- a/Core/include/Acts/Geometry/NavigationLayer.hpp +++ b/Core/include/Acts/Geometry/NavigationLayer.hpp @@ -77,7 +77,7 @@ class NavigationLayer : public Layer { bool isOnLayer(const GeometryContext& gctx, const Vector3& gp, const BoundaryCheck& bcheck = true) const final; - /// Accept layer according to the following colelction directives + /// Accept layer according to the following collection directives /// /// @param resolveSensitive is the prescription to find the sensitive surfaces /// @param resolveMaterial is the precription to find material surfaces diff --git a/Core/include/Acts/Geometry/PassiveLayerBuilder.hpp b/Core/include/Acts/Geometry/PassiveLayerBuilder.hpp index 4a19d56db4d..e22f6a94115 100644 --- a/Core/include/Acts/Geometry/PassiveLayerBuilder.hpp +++ b/Core/include/Acts/Geometry/PassiveLayerBuilder.hpp @@ -63,7 +63,7 @@ class PassiveLayerBuilder : public ILayerBuilder { /// LayerBuilder interface method /// - /// @param gctx ist the geometry context under + /// @param gctx is the geometry context under /// which the geometry is built /// /// @return the layers at negative side @@ -71,7 +71,7 @@ class PassiveLayerBuilder : public ILayerBuilder { /// LayerBuilder interface method /// - /// @param gctx ist the geometry context under + /// @param gctx is the geometry context under /// which the geometry is built /// /// @return the layers at the central sector @@ -79,7 +79,7 @@ class PassiveLayerBuilder : public ILayerBuilder { /// LayerBuilder interface method /// - /// @param gctx ist the geometry context under + /// @param gctx is the geometry context under /// which the geometry is built /// /// @return the layers at positive side @@ -111,7 +111,7 @@ class PassiveLayerBuilder : public ILayerBuilder { private: /// Helper interface method /// - /// @param gctx ist the geometry context under + /// @param gctx is the geometry context under /// which the geometry is built /// @param side is the side of the layer to be built /// diff --git a/Core/include/Acts/Geometry/SurfaceArrayCreator.hpp b/Core/include/Acts/Geometry/SurfaceArrayCreator.hpp index 85d10cf7e07..f0bfb055498 100644 --- a/Core/include/Acts/Geometry/SurfaceArrayCreator.hpp +++ b/Core/include/Acts/Geometry/SurfaceArrayCreator.hpp @@ -113,7 +113,7 @@ class SurfaceArrayCreator { /// to be ordered on the cylinder /// @pre the pointers to the sensitive surfaces in the surfaces vectors all /// need to be valid, since no check is performed - /// @param [in] gctx The gometry context fro this building call + /// @param [in] gctx The gometry context for this building call /// @param protoLayerOpt The proto layer containing the layer size /// @param binsPhi is the number of bins in phi for the surfaces /// @param binsZ is the number of bin in Z for the surfaces @@ -136,10 +136,10 @@ class SurfaceArrayCreator { /// to be ordered on the cylinder /// @pre the pointers to the sensitive surfaces in the surfaces vectors all /// need to be valid, since no check is performed - /// @param [in] gctx The gometry context fro this building call + /// @param [in] gctx The gometry context for this building call /// @param protoLayerOpt The proto layer containing the layer size - /// @param bTypePhi the binning type in phi direction (equidistant/aribtrary) - /// @param bTypeZ the binning type in z direction (equidistant/aribtrary) + /// @param bTypePhi the binning type in phi direction (equidistant/arbitrary) + /// @param bTypeZ the binning type in z direction (equidistant/arbitrary) /// @param transform is the (optional) additional transform applied /// /// @return a unique pointer a new SurfaceArray @@ -159,7 +159,7 @@ class SurfaceArrayCreator { /// @pre the pointers to the sensitive surfaces in the surfaces vectors all /// need to be valid, since no check is performed /// @warning This function requires the disc aligned with the z-axis - /// @param [in] gctx The gometry context fro this building call + /// @param [in] gctx The gometry context for this building call /// @param protoLayerOpt The proto layer containing the layer size /// @param binsPhi is the number of bins in phi for the surfaces /// @param binsR is the number of bin in R for the surfaces @@ -182,10 +182,10 @@ class SurfaceArrayCreator { /// @pre the pointers to the sensitive surfaces in the surfaces vectors all /// need to be valid, since no check is performed /// @warning This function requires the disc aligned with the z-axis - /// @param [in] gctx The gometry context fro this building call + /// @param [in] gctx The gometry context for this building call /// @param protoLayerOpt The proto layer containing the layer size - /// @param bTypeR the binning type in r direction (equidistant/aribtrary) - /// @param bTypePhi the binning type in phi direction (equidistant/aribtrary) + /// @param bTypeR the binning type in r direction (equidistant/arbitrary) + /// @param bTypePhi the binning type in phi direction (equidistant/arbitrary) /// @param transform is the (optional) additional transform applied /// /// @return a unique pointer a new SurfaceArray @@ -202,7 +202,7 @@ class SurfaceArrayCreator { /// SurfaceArrayCreator interface method /// - create an array on a plane /// - /// @param [in] gctx The gometry context fro this building call + /// @param [in] gctx The gometry context for this building call /// @param [in] surfaces is the vector of pointers to sensitive surfaces /// to be ordered on the plane /// @pre the pointers to the sensitive surfaces in the surfaces vectors all @@ -225,7 +225,7 @@ class SurfaceArrayCreator { std::optional protoLayerOpt = std::nullopt, const Transform3& transform = Transform3::Identity()) const; - /// Static check funtion for surface equivalent + /// Static check function for surface equivalent /// /// @param [in] gctx the geometry context for this check /// @param bValue the binning value for the binning diff --git a/Core/include/Acts/Geometry/TrackingGeometry.hpp b/Core/include/Acts/Geometry/TrackingGeometry.hpp index a5885b0e24d..fc25114b193 100644 --- a/Core/include/Acts/Geometry/TrackingGeometry.hpp +++ b/Core/include/Acts/Geometry/TrackingGeometry.hpp @@ -36,7 +36,7 @@ using MutableTrackingVolumePtr = std::shared_ptr; /// /// It enables both, a global search for an asociatedVolume /// (respectively, if existing, a global search of an associated Layer or the -/// next associated Layer), such as a continous navigation by BoundarySurfaces +/// next associated Layer), such as a continuous navigation by BoundarySurfaces /// between the confined TrackingVolumes. class TrackingGeometry { /// Give the GeometryBuilder friend rights diff --git a/Core/include/Acts/Geometry/TrackingVolume.hpp b/Core/include/Acts/Geometry/TrackingVolume.hpp index 059ebd0922e..7a34d2b2957 100644 --- a/Core/include/Acts/Geometry/TrackingVolume.hpp +++ b/Core/include/Acts/Geometry/TrackingVolume.hpp @@ -245,7 +245,7 @@ class TrackingVolume : public Volume { /// @param visitor The callable. Will be called for each sensitive surface /// that is found /// - /// If a context is needed for the vist, the vistitor has to provide this + /// If a context is needed for the visit, the vistitor has to provide this /// e.g. as a private member template void visitSurfaces(visitor_t&& visitor) const { @@ -310,7 +310,7 @@ class TrackingVolume : public Volume { /// @param gctx The current geometry context object, e.g. alignment /// @param bsfMine is the boundary face indicater where to glue /// @param neighbor is the TrackingVolume to be glued - /// @param bsfNeighbor is the boudnary surface of the neighbor + /// @param bsfNeighbor is the boundary surface of the neighbor void glueTrackingVolume(const GeometryContext& gctx, BoundarySurfaceFace bsfMine, TrackingVolume* neighbor, BoundarySurfaceFace bsfNeighbor); @@ -322,7 +322,7 @@ class TrackingVolume : public Volume { /// @param gctx The current geometry context object, e.g. alignment /// @param bsfMine is the boundary face indicater where to glue /// @param neighbors are the TrackingVolumes to be glued - /// @param bsfNeighbor are the boudnary surface of the neighbors + /// @param bsfNeighbor are the boundary surface of the neighbors void glueTrackingVolumes( const GeometryContext& gctx, BoundarySurfaceFace bsfMine, const std::shared_ptr& neighbors, @@ -331,7 +331,7 @@ class TrackingVolume : public Volume { /// Provide a new BoundarySurface from the glueing /// /// @param bsf is the boundary face indicater where to glue - /// @param bs is the new boudnary surface + /// @param bs is the new boundary surface /// @param checkmaterial is a flag how to deal with material, if true: /// - if the old boundary surface had a material description /// but the new one has not, keep the current one diff --git a/Core/include/Acts/Geometry/TrapezoidVolumeBounds.hpp b/Core/include/Acts/Geometry/TrapezoidVolumeBounds.hpp index 0d6d7223961..13c464270b7 100644 --- a/Core/include/Acts/Geometry/TrapezoidVolumeBounds.hpp +++ b/Core/include/Acts/Geometry/TrapezoidVolumeBounds.hpp @@ -48,7 +48,7 @@ class TrapezoidBounds; /// class TrapezoidVolumeBounds : public VolumeBounds { public: - /// @enum BoundValues for acces / streaming + /// @enum BoundValues for access / streaming enum BoundValues : unsigned int { eHalfLengthXnegY = 0, //!< halflength in x at negative y eHalfLengthXposY = 1, //!< halflength in x at positive y @@ -75,8 +75,8 @@ class TrapezoidVolumeBounds : public VolumeBounds { /// @param minhalex is the half length in x at minimal y /// @param haley is the half length in y /// @param halez is the half length in z - /// @param alpha is the openeing angle at -x,-y - /// @param beta is the openeing angle at +x,-y + /// @param alpha is the opening angle at -x,-y + /// @param beta is the opening angle at +x,-y TrapezoidVolumeBounds(double minhalex, double haley, double halez, double alpha, double beta) noexcept(false); @@ -162,7 +162,7 @@ class TrapezoidVolumeBounds : public VolumeBounds { /// Helper method to create the surface bounds void buildSurfaceBounds(); - /// Templated dump methos + /// Templated dump methods /// @tparam stream_t The type of the stream for dumping /// @param dt The stream object template diff --git a/Core/include/Acts/MagneticField/SolenoidBField.hpp b/Core/include/Acts/MagneticField/SolenoidBField.hpp index 2e3b774bf22..bcf9ff1a1c4 100644 --- a/Core/include/Acts/MagneticField/SolenoidBField.hpp +++ b/Core/include/Acts/MagneticField/SolenoidBField.hpp @@ -88,7 +88,7 @@ class SolenoidBField final : public MagneticFieldProvider { double bMagCenter; }; - /// @brief the constructur with a shared pointer + /// @brief the constructor with a shared pointer /// @note since it is a shared field, we enforce it to be const /// @tparam bField is the shared BField to be stored SolenoidBField(Config config); diff --git a/Core/include/Acts/Material/AccumulatedMaterialSlab.hpp b/Core/include/Acts/Material/AccumulatedMaterialSlab.hpp index 5f8b16720dd..4f41a2e50a7 100644 --- a/Core/include/Acts/Material/AccumulatedMaterialSlab.hpp +++ b/Core/include/Acts/Material/AccumulatedMaterialSlab.hpp @@ -68,7 +68,7 @@ class AccumulatedMaterialSlab { /// Each track contributes equally to the total average regardless of its /// measured path within the material. An empty per-track store, i.e. /// vanishing per-track material thickness, does not contribute to the total - /// unless explicitely requested. + /// unless explicitly requested. void trackAverage(bool useEmptyTrack = false); /// Return the average material properties from all accumulated tracks. diff --git a/Core/include/Acts/Material/AccumulatedSurfaceMaterial.hpp b/Core/include/Acts/Material/AccumulatedSurfaceMaterial.hpp index 2a978fce740..b80cfb288ee 100644 --- a/Core/include/Acts/Material/AccumulatedSurfaceMaterial.hpp +++ b/Core/include/Acts/Material/AccumulatedSurfaceMaterial.hpp @@ -79,7 +79,7 @@ class AccumulatedSurfaceMaterial { /// Return the BinUtility const BinUtility& binUtility() const; - /// Assign a material properites object + /// Assign a material properties object /// /// @param lp local position for the bin assignment /// @param mp material properties to be assigned @@ -89,7 +89,7 @@ class AccumulatedSurfaceMaterial { std::array accumulate(const Vector2& lp, const MaterialSlab& mp, double pathCorrection = 1.); - /// Assign a material properites object + /// Assign a material properties object /// /// @param gp global position for the bin assignment /// @param mp material properties to be assigned diff --git a/Core/include/Acts/Material/HomogeneousSurfaceMaterial.hpp b/Core/include/Acts/Material/HomogeneousSurfaceMaterial.hpp index cce397cfc67..0988aa72009 100644 --- a/Core/include/Acts/Material/HomogeneousSurfaceMaterial.hpp +++ b/Core/include/Acts/Material/HomogeneousSurfaceMaterial.hpp @@ -18,7 +18,7 @@ namespace Acts { /// @class HomogeneousSurfaceMaterial /// -/// It extends the ISurfaceMaterial virutal base class to describe +/// It extends the ISurfaceMaterial virtual base class to describe /// a simple homogeneous material on a surface class HomogeneousSurfaceMaterial : public ISurfaceMaterial { public: @@ -87,7 +87,7 @@ class HomogeneousSurfaceMaterial : public ISurfaceMaterial { /// The inherited methods - for MaterialSlab access using ISurfaceMaterial::materialSlab; - /// The interited methods - for scale access + /// The inherited methods - for scale access using ISurfaceMaterial::factor; /// Output Method for std::ostream diff --git a/Core/include/Acts/Material/IMaterialDecorator.hpp b/Core/include/Acts/Material/IMaterialDecorator.hpp index 3abed78b023..3b6d390210b 100644 --- a/Core/include/Acts/Material/IMaterialDecorator.hpp +++ b/Core/include/Acts/Material/IMaterialDecorator.hpp @@ -18,7 +18,7 @@ class TrackingVolume; /// Virtual base class for decorators that allow to load /// material onto a TrackingGeometry. The geometry allows material /// to be assigned either to surfaces or to volumes, hence there are -/// two decorate interface methots. +/// two decorate interface methods. /// class IMaterialDecorator { public: diff --git a/Core/include/Acts/Material/ISurfaceMaterial.hpp b/Core/include/Acts/Material/ISurfaceMaterial.hpp index 7109813ba6f..4aca9cd42dd 100644 --- a/Core/include/Acts/Material/ISurfaceMaterial.hpp +++ b/Core/include/Acts/Material/ISurfaceMaterial.hpp @@ -27,7 +27,7 @@ enum MappingType { PreMapping = -1, Default = 0, PostMapping = 1, Sensor = 2 }; /// Virtual base class of surface based material description /// /// MaterialSlab that are associated to a surface, -/// extended by certain special representations (binned, homogenous) +/// extended by certain special representations (binned, homogeneous) /// class ISurfaceMaterial { public: diff --git a/Core/include/Acts/Material/IVolumeMaterial.hpp b/Core/include/Acts/Material/IVolumeMaterial.hpp index a35ad0f2ffc..5f1d18f50e6 100644 --- a/Core/include/Acts/Material/IVolumeMaterial.hpp +++ b/Core/include/Acts/Material/IVolumeMaterial.hpp @@ -19,7 +19,7 @@ class Material; /// /// Virtual base class of volume material description // -/// Material associated with a Volume (homogenous, binned, interpolated) +/// Material associated with a Volume (homogeneous, binned, interpolated) class IVolumeMaterial { public: /// Virtual Destructor diff --git a/Core/include/Acts/Material/Interactions.hpp b/Core/include/Acts/Material/Interactions.hpp index 221235012e7..a4d2c1eb4bf 100644 --- a/Core/include/Acts/Material/Interactions.hpp +++ b/Core/include/Acts/Material/Interactions.hpp @@ -79,7 +79,7 @@ float deriveEnergyLossLandauQOverP(const MaterialSlab& slab, int pdg, float m, /// /// @see computeEnergyLossBethe for parameters description /// -/// This is the sigma paramter of a Gaussian distribution with the same +/// This is the sigma parameter of a Gaussian distribution with the same /// full-width-half-maximum as the Landau-Vavilov-Bichsel distribution. The /// computations are valid for intermediate particle energies. float computeEnergyLossLandauSigma(const MaterialSlab& slab, int pdg, float m, diff --git a/Core/include/Acts/Material/MaterialGridHelper.hpp b/Core/include/Acts/Material/MaterialGridHelper.hpp index 890a7016036..c5be680556c 100644 --- a/Core/include/Acts/Material/MaterialGridHelper.hpp +++ b/Core/include/Acts/Material/MaterialGridHelper.hpp @@ -73,7 +73,7 @@ std::function globalToLocalFromBin( Acts::BinningValue& type); /// @brief Create a 2DGrid using a BinUtility. -/// Also determine the coresponding global to local transform and grid mapping +/// Also determine the corresponding global to local transform and grid mapping /// function /// /// @param [in] bins BinUtility of the volume to be mapped @@ -85,7 +85,7 @@ Grid2D createGrid2D( std::function& transfoGlobalToLocal); /// @brief Create a 3DGrid using a BinUtility. -/// Also determine the coresponding global to local transform and grid mapping +/// Also determine the corresponding global to local transform and grid mapping /// function /// /// @param [in] bins BinUtility of the volume to be mapped diff --git a/Core/include/Acts/Material/MaterialInteraction.hpp b/Core/include/Acts/Material/MaterialInteraction.hpp index b421be00b39..bc59a08de2c 100644 --- a/Core/include/Acts/Material/MaterialInteraction.hpp +++ b/Core/include/Acts/Material/MaterialInteraction.hpp @@ -19,7 +19,7 @@ class TrackingVolume; /// @brief The Material interaction struct /// It records the surface and the passed material -/// This is only nessecary recorded when configured +/// This is only necessary recorded when configured struct MaterialInteraction { /// The particle position at the interaction. Vector3 position = Vector3(0., 0., 0); @@ -35,15 +35,15 @@ struct MaterialInteraction { double sigmaTheta2 = 0.0; /// Expected q/p variance due to the interactions. double sigmaQoP2 = 0.0; - /// The position where the interaction occured. + /// The position where the interaction occurred. Vector3 intersection = Vector3(0., 0., 0); - /// The ID where the interaction occured. + /// The ID where the interaction occurred. GeometryIdentifier intersectionID; - /// The surface where the interaction occured. + /// The surface where the interaction occurred. const Surface* surface = nullptr; - /// The volume where the interaction occured. + /// The volume where the interaction occurred. const TrackingVolume* volume = nullptr; - /// Update the volume step to implment the proper step size + /// Update the volume step to implement the proper step size bool updatedVolumeStep = false; /// The path correction factor due to non-zero incidence on the surface. double pathCorrection = 1.; diff --git a/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp b/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp index c8acdac31dc..73bf4d3928a 100644 --- a/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp +++ b/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp @@ -28,7 +28,7 @@ namespace Acts { class ProtoSurfaceMaterial : public ISurfaceMaterial { public: - /// Constructor without BinUtility - homogenous material + /// Constructor without BinUtility - homogeneous material ProtoSurfaceMaterial() = default; /// Constructor with BinUtility - multidimensional material @@ -39,12 +39,12 @@ class ProtoSurfaceMaterial : public ISurfaceMaterial { ProtoSurfaceMaterial(const BinUtility& binUtility, MappingType mappingType = MappingType::Default); - /// Copy constuctor + /// Copy constructor /// /// @param smproxy The source proxy ProtoSurfaceMaterial(const ProtoSurfaceMaterial& smproxy) = default; - /// Copy move constuctor + /// Copy move constructor /// /// @param smproxy The source proxy ProtoSurfaceMaterial(ProtoSurfaceMaterial&& smproxy) = default; @@ -58,7 +58,7 @@ class ProtoSurfaceMaterial : public ISurfaceMaterial { ProtoSurfaceMaterial& operator=(const ProtoSurfaceMaterial& smproxy) = default; - /// Assigment move operator + /// Assignment move operator /// /// @param smproxy The source proxy ProtoSurfaceMaterial& operator=(ProtoSurfaceMaterial&& smproxy) = default; @@ -90,7 +90,7 @@ class ProtoSurfaceMaterial : public ISurfaceMaterial { /// Direct access via bins to the MaterialSlab /// /// @param ib0 indicates the first bin - /// @param ib1 indicates the seconf bin + /// @param ib1 indicates the second bin /// /// @return will return dummy material const MaterialSlab& materialSlab(size_t ib0, size_t ib1) const final; diff --git a/Core/include/Acts/Material/ProtoVolumeMaterial.hpp b/Core/include/Acts/Material/ProtoVolumeMaterial.hpp index 7760cf3e387..fb0a02dfa8f 100644 --- a/Core/include/Acts/Material/ProtoVolumeMaterial.hpp +++ b/Core/include/Acts/Material/ProtoVolumeMaterial.hpp @@ -28,7 +28,7 @@ namespace Acts { class ProtoVolumeMaterial : public IVolumeMaterial { public: - /// Constructor without BinUtility - homogenous material + /// Constructor without BinUtility - homogeneous material ProtoVolumeMaterial() = default; /// Constructor with BinUtility - multidimensional material @@ -37,12 +37,12 @@ class ProtoVolumeMaterial : public IVolumeMaterial { /// and binning of the material on the volume ProtoVolumeMaterial(const BinUtility& binUtility); - /// Copy constuctor + /// Copy constructor /// /// @param vmproxy The source proxy ProtoVolumeMaterial(const ProtoVolumeMaterial& vmproxy) = default; - /// Copy move constuctor + /// Copy move constructor /// /// @param vmproxy The source proxy ProtoVolumeMaterial(ProtoVolumeMaterial&& vmproxy) = default; diff --git a/Core/include/Acts/Material/VolumeMaterialMapper.hpp b/Core/include/Acts/Material/VolumeMaterialMapper.hpp index ddd8288f3a9..13f67c64596 100644 --- a/Core/include/Acts/Material/VolumeMaterialMapper.hpp +++ b/Core/include/Acts/Material/VolumeMaterialMapper.hpp @@ -78,7 +78,7 @@ class VolumeMaterialMapper { /// /// Nested State struct which is used for the mapping prococess struct State { - /// Constructor of the Sate with contexts + /// Constructor of the State with contexts State(const GeometryContext& gctx, const MagneticFieldContext& mctx) : geoContext(gctx), magFieldContext(mctx) {} diff --git a/Core/include/Acts/Material/detail/AverageMaterials.hpp b/Core/include/Acts/Material/detail/AverageMaterials.hpp index ef4c845907e..dfabeb61de7 100644 --- a/Core/include/Acts/Material/detail/AverageMaterials.hpp +++ b/Core/include/Acts/Material/detail/AverageMaterials.hpp @@ -20,7 +20,7 @@ namespace detail { /// @returns Material slab with the combined thickness and average parameters /// /// The averaged material slab has the combined thickness of the two input slabs -/// and assumes the two input materials are homogeneously and continously mixed +/// and assumes the two input materials are homogeneously and continuously mixed /// throughout the slab. MaterialSlab combineSlabs(const MaterialSlab& slab1, const MaterialSlab& slab2); diff --git a/Core/include/Acts/Navigation/DetectorVolumeUpdators.hpp b/Core/include/Acts/Navigation/DetectorVolumeUpdators.hpp index b4e6ae46404..5b4343311b7 100644 --- a/Core/include/Acts/Navigation/DetectorVolumeUpdators.hpp +++ b/Core/include/Acts/Navigation/DetectorVolumeUpdators.hpp @@ -27,7 +27,7 @@ class DetectorVolume; /// navigation state to nullptr, usually indicates the end of /// the known world, hence the name struct EndOfWorldImpl : public INavigationDelegate { - /// @brief a null volume link - explicitely + /// @brief a null volume link - explicitly /// /// @note the method parameters are ignored inline void update(const GeometryContext& /*ignored*/, @@ -54,7 +54,7 @@ struct SingleDetectorVolumeImpl : public INavigationDelegate { SingleDetectorVolumeImpl() = delete; - /// @brief a null volume link - explicitely + /// @brief a null volume link - explicitly /// /// @note the method parameters are ignored /// diff --git a/Core/include/Acts/Navigation/NavigationState.hpp b/Core/include/Acts/Navigation/NavigationState.hpp index 7a8682ec309..0e924004ca0 100644 --- a/Core/include/Acts/Navigation/NavigationState.hpp +++ b/Core/include/Acts/Navigation/NavigationState.hpp @@ -88,8 +88,8 @@ struct NavigationState { /// An overstep tolerance ActsScalar overstepTolerance = -0.1; - /// Auxilliary attached information - std::any auxilliary; + /// Auxiliary attached information + std::any auxiliary; }; } // namespace Experimental diff --git a/Core/include/Acts/Navigation/NextNavigator.hpp b/Core/include/Acts/Navigation/NextNavigator.hpp index b0beb5268ba..acad5308ee3 100644 --- a/Core/include/Acts/Navigation/NextNavigator.hpp +++ b/Core/include/Acts/Navigation/NextNavigator.hpp @@ -163,7 +163,7 @@ class NextNavigator { /// @brief Navigator pre step call /// - /// This will invalide the current surface and current portal in order + /// This will invalid the current surface and current portal in order /// to navigate to the next ones. /// /// @tparam propagator_state_t is the type of Propagatgor state diff --git a/Core/include/Acts/Navigation/SurfaceCandidatesUpdators.hpp b/Core/include/Acts/Navigation/SurfaceCandidatesUpdators.hpp index b14085885c6..b644d7c1a42 100644 --- a/Core/include/Acts/Navigation/SurfaceCandidatesUpdators.hpp +++ b/Core/include/Acts/Navigation/SurfaceCandidatesUpdators.hpp @@ -40,7 +40,7 @@ inline static void updateCandidates(const GeometryContext& gctx, auto& nCandidates = nState.surfaceCandidates; for (auto& c : nCandidates) { - // Get the surface reprensentation: either native surfcae of portal + // Get the surface representation: either native surfcae of portal const Surface& sRep = (c.surface != nullptr) ? (*c.surface) : (c.portal->surface()); @@ -191,7 +191,7 @@ template using IndexedSurfacesImpl = IndexedUpdatorImpl; -/// @brief An indexed surface implementaion with portal access +/// @brief An indexed surface implementation with portal access template using IndexedSurfacesAllPortalsImpl = ChainedUpdatorImpl, AllPortalsImpl>; diff --git a/Core/include/Acts/Propagator/AbortList.hpp b/Core/include/Acts/Propagator/AbortList.hpp index cce062976d3..d55e317f493 100644 --- a/Core/include/Acts/Propagator/AbortList.hpp +++ b/Core/include/Acts/Propagator/AbortList.hpp @@ -92,7 +92,7 @@ struct AbortList : public detail::Extendable { } /// This is the call signature for the abort list, it broadcasts the call - /// to the tuple() memembers of the list + /// to the tuple() members of the list /// /// @tparam propagator_state_t is the state type of the propagator /// @tparam stepper_t Type of the stepper diff --git a/Core/include/Acts/Propagator/ActionList.hpp b/Core/include/Acts/Propagator/ActionList.hpp index 1e0a4fee8a0..fce63d90617 100644 --- a/Core/include/Acts/Propagator/ActionList.hpp +++ b/Core/include/Acts/Propagator/ActionList.hpp @@ -37,7 +37,7 @@ struct ActionList : public detail::Extendable { using detail::Extendable::tuple; public: - // This uses the type collector and unpacks using the `R` meta funciton + // This uses the type collector and unpacks using the `R` meta function template