fixing typos using codespell in the geometry package

Author: Matilde Carminati

geometry/bfieldmap/include/BFieldComponentQuad.h

@@ -50,12 +50,12 @@ namespace Belle2 {
     struct ParamPoint3 {
       double s{0};   /**< s in [cm] */
       double L{0};   /**< element length in [cm] */
-      double mxx{0}; /**< xx coefficents to calculate Bx */
-      double mxy{0}; /**< xy coefficents to calculate Bx */
-      double mx0{0}; /**< x0 coefficents to calculate Bx */
-      double myx{0}; /**< yx coefficents to calculate By */
-      double myy{0}; /**< yy coefficents to calculate By */
-      double my0{0}; /**< y0 coefficents to calculate By */
+      double mxx{0}; /**< xx coefficients to calculate Bx */
+      double mxy{0}; /**< xy coefficients to calculate Bx */
+      double mx0{0}; /**< x0 coefficients to calculate Bx */
+      double myx{0}; /**< yx coefficients to calculate By */
+      double myy{0}; /**< yy coefficients to calculate By */
+      double my0{0}; /**< y0 coefficients to calculate By */
       /**
        * Calculates the X component of the magnetic field vector at
        * the specified space point from a quadrupole lense.
@@ -93,7 +93,7 @@ namespace Belle2 {
       }
     };
 
-    /** start and stop indicies to narrow search in array */
+    /** start and stop indices to narrow search in array */
     struct irange_t {
       short int i0{0}; /**< start index */
       short int i1{0}; /**< stop index */

geometry/bfieldmap/include/BFieldFrameworkInterface.h

@@ -20,7 +20,7 @@ namespace Belle2 {
     BFieldFrameworkInterface(): MagneticFieldComponent(true) {}
     /** everything is inside this component */
     virtual bool inside(const ROOT::Math::XYZVector&) const final override { return true; }
-    /** and we return the values from the exsiting BFieldMap */
+    /** and we return the values from the existing BFieldMap */
     virtual ROOT::Math::XYZVector getField(const ROOT::Math::XYZVector& position) const final override
     {
       return BFieldMap::Instance().getBField(position) * Unit::T;

geometry/bfieldmap/src/BFieldComponentBeamline.cc

@@ -38,7 +38,7 @@ namespace Belle2 {
     short int n2{0};
   };
 
-  /** A simple 2d vector stucture */
+  /** A simple 2d vector structure */
   struct xy_t {
     double x{0}; /**< x component */
     double y{0}; /**< y component */
@@ -56,7 +56,7 @@ namespace Belle2 {
    */
   class TriangularInterpolation {
   public:
-    /** returns list of verticies */
+    /** returns list of vertices */
     [[nodiscard]] const vector<xy_t>& getPoints() const { return m_points;}
     /** returns list of triangles */
     [[nodiscard]] const vector<triangle_t>& getTriangles() const { return m_triangles;}
@@ -77,7 +77,7 @@ namespace Belle2 {
      * Calculate extents of a triangular mesh and build spatial
      * index. Moves vector contents inside the class.
      *
-     * @param points    List of verticies
+     * @param points    List of vertices
      * @param triangles List of triangles
      * @param d         Hint how close spatial index should be built
      */

geometry/bfieldmap/src/BFieldComponentQuad.cc

@@ -60,7 +60,7 @@ void BFieldComponentQuad::initialize()
     return;
   }
 
-  // check if input files exsits
+  // check if input files exist
   string fullPathMapHER = FileSystem::findFile("/data/" + m_mapFilenameHER);
   if (!FileSystem::fileExists(fullPathMapHER)) {
     B2FATAL("The HER quadrupole magnetic field map file '" << m_mapFilenameHER << "' could not be found !");
@@ -225,7 +225,7 @@ void BFieldComponentQuad::initialize()
   m_l3 = proc3(params_ler, p0_LER);
 
   /** In case several maps in the same position we can simply
-   * sum up all matricies since magnetic field has superposition
+   * sum up all matrices since magnetic field has superposition
    * properties as well as keep only one vector of parameters for each
    * beamline
    *
@@ -246,7 +246,7 @@ void BFieldComponentQuad::initialize()
   };
   merge(m_h3, hleak3);
 
-  /** calculate ranges where quadrupole lenses continously fill the
+  /** calculate ranges where quadrupole lenses continuously fill the
    * beamline
    *
    * @param v lense vector
@@ -300,7 +300,7 @@ void BFieldComponentQuad::initialize()
    *
    * @param ap the vector of lenses
    * @param v  the vector of ranges
-   * @return   the vector of iterators which points to the begining of the continous area of lenses
+   * @return   the vector of iterators which points to the beginning of the continuous area of lenses
    */
   auto associate_lenses = [](const vector<ParamPoint3>& ap, const ranges_t& v) {
     vector<std::vector<ParamPoint3>::const_iterator> res;

geometry/dbobjects/include/GeoMaterial.h

@@ -14,7 +14,7 @@
 #include <geometry/dbobjects/GeoMaterialComponent.h>
 
 namespace Belle2 {
-  /** Class to represent a material informaion in the Database */
+  /** Class to represent a material information in the Database */
   class GeoMaterial: public TObject {
   public:
     /** default constructor */

geometry/examples/create_and_plot_magneticfield.py

@@ -10,7 +10,7 @@
 
 ##############################################################################
 # This steering file creates the Belle II Magnetic field map and plots the
-# result overlayed over the Material distribution
+# result overlaid over the Material distribution
 ##############################################################################
 
 from matplotlib.backends.backend_pdf import PdfPages

geometry/examples/create_geometry_payloads.py

@@ -12,7 +12,7 @@
 
 """
 Create a full set of consistent geometry payloads for nominal geometry, phase 2
-geometry, and early phase 3 gometry from XML files.
+geometry, and early phase 3 geometry from XML files.
 
 Optionally one can give a list of payload names to keep only a subset of payloads
 """

geometry/include/CreatorBase.h

@@ -47,7 +47,7 @@ namespace Belle2 {
       virtual void createFromDB(const std::string& name, G4LogicalVolume& topVolume, GeometryTypes type);
 
       /** Function to create the geometry database.
-       * This function should be implemented to convert Gearbox parameters to one ore more database payloads
+       * This function should be implemented to convert Gearbox parameters to one or more database payloads
        * @param content GearDir pointing to the parameters which should be used for construction
        * @param iov interval of validity to use when generating payloads
        */

geometry/include/CreatorFactory.h

@@ -21,7 +21,7 @@ namespace Belle2 {
      *
      * CreatorFactory<Classname> Classname_factory("CreatorName");
      *
-     * or similiar to the source file to automatically provide the needed
+     * or similar to the source file to automatically provide the needed
      * factory function and register the creator with the CreatorManager
      */
     template<class T> struct CreatorFactory {

geometry/include/GeometryManager.h

@@ -27,7 +27,7 @@ namespace Belle2 {
     class CreatorBase;
 
     /**
-     * Flag indiciating the type of geometry to be used
+     * Flag indicating the type of geometry to be used
      */
     enum GeometryTypes {
       FullGeometry,     /**< Full geometry for simulation */
@@ -110,7 +110,7 @@ namespace Belle2 {
       }
 
       /**
-       * Set the names of addtional components to be added to the default set.
+       * Set the names of additional components to be added to the default set.
        * This member allows to set a list of component names. When creating the
        * the geometry, components matching names in the list will be added if
        * they are not disabled by default. If a list of components is already

geometry/include/Materials.h

@@ -67,7 +67,7 @@ namespace Belle2 {
        * G4_Si, G4_Al and other materials are defined all uppercase, e.g.
        * G4_AIR, G4_TEFLON.
        *
-       * Found materials are cached internaly using an MRU cache so repitive
+       * Found materials are cached internally using an MRU cache so repetitive
        * access to materials should be O(1) in most cases
        *
        * @param name Name of the material to be found

geometry/include/utilities.h

@@ -80,7 +80,7 @@ namespace Belle2 {
     G4Polycone* createPolyCone(const std::string& name, const GearDir& params, double& minZ, double& maxZ);
 
     /**
-     * Create a solid by roating two polylines around the Z-Axis.
+     * Create a solid by rotating two polylines around the Z-Axis.
      * This function will create a polycone shape directly from Gearbox
      * Parameters describing the inner and the outer envelope of the polycone.
      * The XML Parameters should be of the form

geometry/modules/fbxWriter/include/FBXWriterModule.h

@@ -96,7 +96,7 @@ namespace Belle2 {
     //! Once-only flag to write FBX only on the first event
     bool m_First{true};
 
-    //! User-specified flag to select whether to write and re-use logical- and physical-volume
+    //! User-specified flag to select whether to write and reuse logical- and physical-volume
     //! prototypes once (true) or to write duplicates of each such volume (false).
     bool m_UsePrototypes{false};
 

geometry/modules/src/DensityScalerModule.cc

@@ -40,7 +40,7 @@ change the density of all materials which are created using the Materials servic
            "can be used to scale all components by the same factor. If a component is "
            "specified manually and '*' is present the result will be the product of both)");
   addParam("ignoredMaterials", m_ignoredMaterials, "A set of material names which should "
-           "**not** be scaled, usually things like vaccum or air. To scale everything this "
+           "**not** be scaled, usually things like vacuum or air. To scale everything this "
            "parameter should be set to an empty set (``{}`` or ``set()``)",
            geometry::Materials::getInstance().getDensityScaleIgnoredMaterials());
 }

geometry/src/Materials.cc

@@ -38,7 +38,7 @@ namespace Belle2 {
       {
         // check if we have properties defined for this material
         if (parameters.getNumberNodes("Property") > 0) {
-          //Apparantly we have properties, so lets add them to the Material
+          //Apparently we have properties, so lets add them to the Material
           for (const GearDir& property : parameters.getNodes("Property")) {
             string name;
             try {
@@ -176,7 +176,7 @@ namespace Belle2 {
           //elements do not have density
           if (component.getIselement()) {
             B2ERROR("createMaterial " << parameters.getName()
-                    << ": Cannot calculate density when adding elements, please provde a density");
+                    << ": Cannot calculate density when adding elements, please provide a density");
             return nullptr;
           }
           G4Material* mat = getMaterial(component.getName());

geometry/src/utilities.cc

@@ -149,7 +149,7 @@ namespace Belle2 {
        * This function subdivides the polyline given by segments to contain a
        * point at every z position in points.  Furthermore, the polyline will
        * be extended to cover the same range of z as the points by appending
-       * the first or last point of points to the polyline if neccessary.
+       * the first or last point of points to the polyline if necessary.
        *
        * This function also checks if the points have ascending z positions.
        *
@@ -186,7 +186,7 @@ namespace Belle2 {
         }
 
         //Now make sure the polyline extend over the same z range by adding the
-        //first/last point of points when neccessary
+        //first/last point of points when necessary
         if (points.front().first < segments.front().first) {
           segments.insert(segments.begin(), points.front());
         }
@@ -230,7 +230,7 @@ namespace Belle2 {
         //We could have more than one point at the same z position for segments
         //going directly along x. because of that we check that the z
         //coordinates for inner and outer line are always the same, reusing one
-        //point if neccessary
+        //point if necessary
         if (!innerPoints.empty() && innerPoints.front().first <= outerPoints.front().first) {
           boost::tie(innerZ, innerX) = innerPoints.front();
           popInner = true;

geometry/tests/test_density_scaler.py

@@ -8,7 +8,7 @@
 
 '''
 Test if the DensityScaler module works.
-N.B.: this test can not be run in a light-release enviroment.
+N.B.: this test can not be run in a light-release environment.
 '''
 
 import basf2 as b2