DOC: Spell precommit

.pre-commit-config.yaml

@@ -83,6 +83,18 @@ repos:
     -   id: pyupgrade
         exclude: ".*build.*|\\/ThirdParty\\/|\\/Data\\/"
         args: [--py39-plus]
+- repo: https://github.com/SimpleITK/CommentSpellCheck.git
+  rev: v0.4.3
+  hooks:
+    - id: comment-spell-check
+      args: ['--miss', '--dict','https://raw.githubusercontent.com/SimpleITK/SimpleITK/master/.github/workflows/additional_dictionary.txt', '--dict', '.github/workflows/itk_dict.txt', '--bibtex', 'Documentation/Doxygen/doxygen.bib', '--prefix', '\"gdcm\"', ]
+      exclude: |
+          (?x)
+          | /ThirdParty/        # Exclude files in subdirectories named ThirdParty/
+          | ^Wrapping/          # Exclude files directly under Wrapping/
+          | ^Utilities/         # Exclude files directly under Utilities/
+          | \.md$               # Exclude .md files
+          | \.c$                # Exclude .c files
 - repo: local
   hooks:
     - id: local-prepare-commit-msg

Documentation/Doxygen/Registration.dox

@@ -39,7 +39,7 @@ elements. They are:
 \li \b Optimizer: the method used to find the \e Transform parameters that optimize the \e Metric.
 
 A particular registration method is defined by selecting specific implementations of each one of these basic elements.
-In order to determine the registration method appropriated for a particular problem, is will be useful to answer the following questions:
+In order to determine the registration method appropriate for a particular problem, is will be useful to answer the following questions:
 
 
 

Examples/Filtering/DigitallyReconstructedRadiograph1.cxx

@@ -625,7 +625,7 @@ main(int argc, char * argv[])
 
   // Software Guide : BeginLatex
   //
-  // Having initialised the interpolator we pass the object to the
+  // Having initialized the interpolator we pass the object to the
   // resample filter.
   //
   // Software Guide : EndLatex

Modules/Core/Common/CMake/itkCheckHasGNUAttributeAligned.cxx

@@ -22,7 +22,7 @@ namespace itk
 }
 
 //
-// Check if the compoler support the GNU attribute extension for
+// Check if the compiler support the GNU attribute extension for
 // alignment, and does not contain a bug which causes internal
 // compiler segfault.
 //

Modules/Core/Common/src/itkFloatingPointExceptions_win.cxx

@@ -56,7 +56,7 @@ FloatingPointExceptions::HasFloatingPointExceptionsSupport()
 
 #else // defined(_MSC_VER)
 
-// MinGW has troubles include'ing float.h.
+// MinGW has troubles include-ing float.h.
 
 void
 FloatingPointExceptions::Enable()

Modules/Core/Common/src/itkImageRegionSplitterMultidimensional.cxx

@@ -114,7 +114,7 @@ ImageRegionSplitterMultidimensional::ComputeSplits(unsigned int         dim,
                                                    const SizeValueType  regionSize[],
                                                    unsigned int         splits[])
 {
-  // size of each splited region
+  // size of each split region
   std::vector<double> splitRegionSize(dim); // Note: stack allocation preferred
   unsigned int        numberOfPieces = 1;
 

Modules/Core/Common/src/itkMultiThreaderBase.cxx

@@ -66,7 +66,7 @@ struct MultiThreaderBaseGlobals
 
   // GlobalDefaultThreaderTypeIsInitialized is used only in this
   // file to ensure that the ITK_GLOBAL_DEFAULT_THREADER or
-  // ITK_USE_THREADPOOL environmenal variables are
+  // ITK_USE_THREADPOOL environmental variables are
   // only used as a fall back option.  If the SetGlobalDefaultThreader
   // API is ever used by the developer, the developers choice is
   // respected over the environmental variable.

Modules/Core/Common/test/itkImageIteratorWithIndexTest.cxx

@@ -87,7 +87,7 @@ class itkImageIteratorWithIndexTestIteratorTester
     while (!it.IsAtEnd())
     {
       const PixelType value = it.Get();
-      if (itk::Math::NotExactlyEquals(value, it.Get())) // check repeatibility
+      if (itk::Math::NotExactlyEquals(value, it.Get())) // check repeatability
       {
         std::cerr << "TestConstIterator failed!" << std::endl;
         return false;
@@ -112,7 +112,7 @@ class itkImageIteratorWithIndexTestIteratorTester
     while (!it.IsAtReverseEnd())
     {
       const PixelType value = it.Get();
-      if (itk::Math::NotExactlyEquals(value, it.Get())) // check repeatibility
+      if (itk::Math::NotExactlyEquals(value, it.Get())) // check repeatability
       {
         std::cerr << "TestReverseIteration failed!" << std::endl;
         return false;

Modules/Core/Common/test/itkImageRegionConstIteratorWithOnlyIndexTest.cxx

@@ -88,7 +88,7 @@ class itkImageRegionConstIteratorWithOnlyIndexTestIteratorTester
         std::cout << "Index is not inside region! - " << index << std::endl;
         return false;
       }
-      // check repeatibility
+      // check repeatability
       if (index != it.GetIndex())
       {
         std::cout << "Failed to repeat GetIndex." << std::endl;
@@ -112,7 +112,7 @@ class itkImageRegionConstIteratorWithOnlyIndexTestIteratorTester
         return false;
       }
       ++step;
-      // check repeatibility after decrement
+      // check repeatability after decrement
       --it;
       if (index != it.GetIndex())
       {

Modules/Core/Common/test/itkLightObjectTest.cxx

@@ -18,7 +18,7 @@
 
 #include "itkLightObject.h"
 
-// Excersise the LightObject methods
+// Exercise the LightObject methods
 int
 itkLightObjectTest(int, char *[])
 {

Modules/Core/Common/test/itkLineIteratorTest.cxx

@@ -86,7 +86,7 @@ itkLineIteratorTest(int argc, char * argv[])
   }
 
   // Third test: draw some lines and read the baseline txt file to compare
-  // the point indexies
+  // the point indices.
 
   std::ifstream baselineFile(argv[1]);
   if (baselineFile.fail())

Modules/Core/Common/test/itkMetaDataDictionaryGTest.cxx

@@ -347,7 +347,7 @@ TEST(MetaDataDictionary, SupportsCStyleArrays)
   constexpr size_t numberOfColumns{ 4 };
   int              twoDimensionalArray[numberOfRows][numberOfColumns];
 
-  // Just ensure that each element of the two-dimentional array has a different value.
+  // Just ensure that each element of the two-dimensional array has a different value.
   int * const beginOfData = &(twoDimensionalArray[0][0]);
   std::iota(beginOfData, beginOfData + numberOfRows * numberOfColumns, 1);
 

Modules/Core/Common/test/itkObjectFactoryTest2.cxx

@@ -98,7 +98,7 @@ itkObjectFactoryTest2(int argc, char * argv[])
   // This is needed on WIndows to see warnings in the test output
   itk::OutputWindow::SetInstance(itk::TextOutput::New());
 
-  // Build up a path from the argumentes
+  // Build up a path from the arguments
 #ifdef _WIN32
   std::string pathSeparator = ";";
 #else

Modules/Core/Common/test/itkShapedImageNeighborhoodRangeGTest.cxx

@@ -33,7 +33,7 @@
 #include <array>
 #include <numeric> // For std::inner_product
 
-// Test template instantiations for various ImageDimenion values, and const Image:
+// Test template instantiations for various ImageDimension values, and const Image:
 template class itk::ShapedImageNeighborhoodRange<itk::Image<short, 1>>;
 template class itk::ShapedImageNeighborhoodRange<itk::Image<short, 2>>;
 template class itk::ShapedImageNeighborhoodRange<itk::Image<short, 3>>;
@@ -317,7 +317,7 @@ TEST(ShapedImageNeighborhoodRange, IteratorConvertsToConstIterator)
 }
 
 
-// Tests that the iterators of a NeigborhoodRange can be used as first and
+// Tests that the iterators of a NeighborhoodRange can be used as first and
 // second argument of an std::vector constructor.
 TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdVectorConstructor)
 {
@@ -343,7 +343,7 @@ TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdVectorConstructor)
 }
 
 
-// Tests that the iterators of a NeigborhoodRange can be used as first and
+// Tests that the iterators of a NeighborhoodRange can be used as first and
 // second argument of std::reverse (which requires bidirectional iterators).
 TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdReverseCopy)
 {
@@ -388,7 +388,7 @@ TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdReverseCopy)
 }
 
 
-// Tests that the iterators of a NeigborhoodRange can be used as first and
+// Tests that the iterators of a NeighborhoodRange can be used as first and
 // second argument of std::inner_product.
 TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdInnerProduct)
 {
@@ -413,7 +413,7 @@ TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdInnerProduct)
 }
 
 
-// Tests that the iterators of a NeigborhoodRange can be used as first and
+// Tests that the iterators of a NeighborhoodRange can be used as first and
 // second argument of std::for_each.
 TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdForEach)
 {
@@ -436,7 +436,7 @@ TEST(ShapedImageNeighborhoodRange, IteratorsCanBePassedToStdForEach)
 }
 
 
-// Tests that a NeigborhoodRange can be used as the "range expression" of a
+// Tests that a NeighborhoodRange can be used as the "range expression" of a
 // C++11 range-based for loop.
 TEST(ShapedImageNeighborhoodRange, CanBeUsedAsExpressionOfRangeBasedForLoop)
 {

Modules/Core/Common/test/itkSobelOperatorImageConvolutionTest.cxx

@@ -115,7 +115,7 @@ itkSobelOperatorImageConvolutionTest(int argc, char * argv[])
   //{
   /*
    * Demonstrate that signed types do **NOT** work with SobelOperator
-   * The unsigned checks require disableing Signed ConceptChecking in SobelOperator
+   * The unsigned checks require disabling Signed ConceptChecking in SobelOperator
    * added in March 2023.
    */
   /*

Modules/Core/Common/test/itkVariableSizeMatrixTest.cxx

@@ -117,7 +117,7 @@ itkVariableSizeMatrixTest(int, char *[])
   d13(0, 1) = 1;
   d13(0, 2) = -2;
 
-  // Verify the 4 conditions of the pseudoinverse
+  // Verify the 4 conditions of the pseudo-inverse
   std::cout << "***** d13" << std::endl << d13 << std::endl;
   std::cout << "***** d13 inverse (d31+)" << std::endl << d13.GetInverse() << std::endl;
 

Modules/Core/ImageFunction/include/itkRayCastInterpolateImageFunction.hxx

@@ -422,7 +422,7 @@ RayCastInterpolateImageFunction<TInputImage, TCoordinate>::RayCastHelper::CalcPl
     // find constant
     const double D = -(A * m_BoundingCorner[c1][0] + B * m_BoundingCorner[c1][1] + C * m_BoundingCorner[c1][2]);
 
-    // initialise plane value and normalise
+    // initialize plane value and normalise
     m_BoundingPlane[j][0] = A / std::sqrt(A * A + B * B + C * C);
     m_BoundingPlane[j][1] = B / std::sqrt(A * A + B * B + C * C);
     m_BoundingPlane[j][2] = C / std::sqrt(A * A + B * B + C * C);

Modules/Core/ImageFunction/test/itkBSplineInterpolateImageFunctionTest.cxx

@@ -279,7 +279,7 @@ test1DCubicSpline()
   interp->Print(std::cout);
 
   // Test evaluation at continuous indices and corresponding
-  // gemetric points
+  // geometric points
   std::cout << "Testing 1D Cubic B-Spline:\n";
   std::cout << "Evaluate at: " << std::endl;
 
@@ -349,7 +349,7 @@ test2DSpline()
     interp->Print(std::cout);
 
     /* Test evaluation at continuous indices and corresponding
-    gemetric points */
+    geometric points */
     std::cout << "Testing 2D B-Spline of Order " << splineOrder << ":\n";
     std::cout << "Evaluate at: " << std::endl;
 
@@ -421,7 +421,7 @@ test3DSpline()
     interp->Print(std::cout);
 
     /* Test evaluation at continuous indices and corresponding
-    gemetric points */
+    geometric points */
     std::cout << "Testing 3D B-Spline of Order " << splineOrder << ":\n";
     std::cout << "Evaluate at: " << std::endl;
 
@@ -496,7 +496,7 @@ test3DSplineDerivative()
     interp->Print(std::cout);
 
     /* Test evaluation at continuous indices and corresponding
-    gemetric points */
+    geometric points */
     std::cout << "Testing Derivatives of 3D B-Spline of Order " << splineOrder << ":\n";
     std::cout << "Evaluate at: " << std::endl;
 
@@ -563,7 +563,7 @@ testInteger3DSpline()
     interp->Print(std::cout);
 
     /* Test evaluation at continuous indices and corresponding
-    gemetric points */
+    geometric points */
     std::cout << "Testing 3D Integer B-Spline of Order " << splineOrder << ":\n";
     std::cout << "Evaluate at: " << std::endl;
 

Modules/Core/ImageFunction/test/itkCentralDifferenceImageFunctionTest.cxx

@@ -354,7 +354,7 @@ itkCentralDifferenceImageFunctionTest(int, char *[])
   }
 
   // test an out-of-bounds point with swapped dimensions
-  // it should yield a deriviative of 0
+  // it should yield a derivative of 0
   point[0] = 1.0;
   point[1] = 8.0;
   function->SetUseImageDirection(false);

Modules/Core/ImageFunction/test/itkImageAdaptorInterpolateImageFunctionTest.cxx

@@ -205,7 +205,7 @@ itkImageAdaptorInterpolateImageFunctionTest(int, char *[])
   interp->Print(std::cout);
 
   /* Test evaluation at continuous indices and corresponding
-     gemetric points */
+     geometric points */
   std::cout << "Evaluate at: " << std::endl;
   OutputType          output = NAN;
   ContinuousIndexType cindex;

Modules/Core/ImageFunction/test/itkInterpolateTest.cxx

@@ -156,7 +156,7 @@ itkInterpolateTest(int, char *[])
   interp->Print(std::cout);
 
   /* Test evaluation at continuous indices and corresponding
-     gemetric points */
+     geometric points */
   std::cout << "Evaluate at: " << std::endl;
 
   // an integer position inside the image

Modules/Core/ImageFunction/test/itkRGBInterpolateImageFunctionTest.cxx

@@ -222,7 +222,7 @@ itkRGBInterpolateImageFunctionTest(int, char *[])
   interp->Print(std::cout);
 
   /* Test evaluation at continuous indices and corresponding
-     gemetric points */
+     geometric points */
   std::cout << "Evaluate at: " << std::endl;
   int flag = 0;
   // an integer position inside the image

Modules/Core/ImageFunction/test/itkWindowedSincInterpolateImageFunctionTest.cxx

@@ -190,7 +190,7 @@ itkWindowedSincInterpolateImageFunctionTest(int, char *[])
   }
 
   /* Test evaluation at continuous indices and corresponding
-     gemetric points */
+     geometric points */
   std::cout << "Evaluate at: " << std::endl;
   OutputType          output = NAN;
   ContinuousIndexType cindex;

Modules/Core/QuadEdgeMesh/include/itkGeometricalQuadEdge.h

@@ -144,12 +144,12 @@ class ITK_TEMPLATE_EXPORT GeometricalQuadEdge : public QuadEdge
   /**
    * Set the Left() of all the edges in the Lnext() ring of "this"
    * with the same given geometrical information.
-   * @param  faceGeom Looks at most maxSize edges in the Lnext() ring.
+   * @param  faceGeometry Looks at most maxSize edges in the Lnext() ring.
    * @param  maxSize Sets at most maxSize edges in the Lnext() ring.
    * @return Returns true on success. False otherwise.
    */
   bool
-  SetLnextRingWithSameLeftFace(const DualOriginRefType faceGeom, int maxSize = 100);
+  SetLnextRingWithSameLeftFace(const DualOriginRefType faceGeometry, int maxSize = 100);
 
   inline void
   UnsetOrigin()

Modules/Core/QuadEdgeMesh/include/itkGeometricalQuadEdge.hxx

@@ -44,7 +44,7 @@ GeometricalQuadEdge<TVRef, TFRef, TPrimalData, TDualData, PrimalDual>::Geometric
 template <typename TVRef, typename TFRef, typename TPrimalData, typename TDualData, bool PrimalDual>
 bool
 GeometricalQuadEdge<TVRef, TFRef, TPrimalData, TDualData, PrimalDual>::SetLnextRingWithSameLeftFace(
-  const DualOriginRefType faceGeom,
+  const DualOriginRefType faceGeometry,
   int                     maxSize)
 {
 #ifndef NDEBUG
@@ -59,7 +59,7 @@ GeometricalQuadEdge<TVRef, TFRef, TPrimalData, TDualData, PrimalDual>::SetLnextR
 
   while (maxSize && (it != this->EndGeomLnext()))
   {
-    it.Value()->SetLeft(faceGeom);
+    it.Value()->SetLeft(faceGeometry);
     ++it;
     --maxSize;
   }