STYLE: Conform to ITK style guidelines in miscellaneous test comments

Conform to ITK SWG style guidelines in miscellaneous test comments: - Use a single whitespace between the comment characters and the comment itself. - Remove unnecessary/uninformative comments. - Reword comments where necessary to remove unnecessary/uninformative parts. - Use sentence case. Remove printing unnecessary line feeds.
InsightSoftwareConsortium · Jul 28, 2023 · be8e4f6 · be8e4f6
1 parent 19ae34f
commit be8e4f6
Show file tree

Hide file tree

Showing 32 changed files with 44 additions and 58 deletions.
diff --git a/...s/Filtering/AnisotropicSmoothing/test/itkCurvatureAnisotropicDiffusionImageFilterTest.cxx b/...s/Filtering/AnisotropicSmoothing/test/itkCurvatureAnisotropicDiffusionImageFilterTest.cxx
@@ -22,10 +22,6 @@
 #include "itkSimpleFilterWatcher.h"
 #include "itkTestingMacros.h"
 
-/**
- * Test the class instance by driving it with a null input and output.
- * Returns 0 on success and 1 on failure.
- */
 int
 itkCurvatureAnisotropicDiffusionImageFilterTest(int itkNotUsed(argc), char * itkNotUsed(argv)[])
 {
@@ -57,7 +53,7 @@ itkCurvatureAnisotropicDiffusionImageFilterTest(int itkNotUsed(argc), char * itk
   filter->SetTimeStep(timeStep);
   ITK_TEST_SET_GET_VALUE(timeStep, filter->GetTimeStep());
 
-  // Run Test
+  // Run test
   itk::Size<2> sz;
   sz[0] = 250;
   sz[1] = 250;

diff --git a/...es/Filtering/AnisotropicSmoothing/test/itkGradientAnisotropicDiffusionImageFilterTest.cxx b/...es/Filtering/AnisotropicSmoothing/test/itkGradientAnisotropicDiffusionImageFilterTest.cxx
@@ -21,10 +21,6 @@
 #include "itkNullImageToImageFilterDriver.hxx"
 #include "itkTestingMacros.h"
 
-/**
- * Test the class instance by driving it with a null input and output.
- * Returns 0 on success and 1 on failure.
- */
 int
 itkGradientAnisotropicDiffusionImageFilterTest(int itkNotUsed(argc), char * itkNotUsed(argv)[])
 {
@@ -65,7 +61,7 @@ itkGradientAnisotropicDiffusionImageFilterTest(int itkNotUsed(argc), char * itkN
   filter->SetFixedAverageGradientMagnitude(fixedAverageGradientMagnitude);
   ITK_TEST_SET_GET_VALUE(fixedAverageGradientMagnitude, filter->GetFixedAverageGradientMagnitude());
 
-  // Run Test
+  // Run test
   itk::Size<Dimension> sz;
   sz[0] = 250;
   sz[1] = 250;

diff --git a/Modules/Filtering/BinaryMathematicalMorphology/test/itkBinaryDilateImageFilterTest.cxx b/Modules/Filtering/BinaryMathematicalMorphology/test/itkBinaryDilateImageFilterTest.cxx
@@ -150,7 +150,7 @@ itkBinaryDilateImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType it2(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "Result " << std::endl;
   i = 0;
   while (!it2.IsAtEnd())

diff --git a/Modules/Filtering/BinaryMathematicalMorphology/test/itkBinaryErodeImageFilterTest.cxx b/Modules/Filtering/BinaryMathematicalMorphology/test/itkBinaryErodeImageFilterTest.cxx
@@ -150,7 +150,7 @@ itkBinaryErodeImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType it2(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "Result " << std::endl;
   i = 0;
   while (!it2.IsAtEnd())

diff --git a/...s/Filtering/BinaryMathematicalMorphology/test/itkErodeObjectMorphologyImageFilterTest.cxx b/...s/Filtering/BinaryMathematicalMorphology/test/itkErodeObjectMorphologyImageFilterTest.cxx
@@ -161,7 +161,7 @@ itkErodeObjectMorphologyImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType it2(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "Result " << std::endl;
   i = 0;
   while (!it2.IsAtEnd())

diff --git a/...ering/BinaryMathematicalMorphology/test/itkFastIncrementalBinaryDilateImageFilterTest.cxx b/...ering/BinaryMathematicalMorphology/test/itkFastIncrementalBinaryDilateImageFilterTest.cxx
@@ -153,7 +153,7 @@ itkFastIncrementalBinaryDilateImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType it2(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "Result with cross radius 1 (default)" << std::endl;
   i = 0;
   it2.GoToBegin();
@@ -182,7 +182,7 @@ itkFastIncrementalBinaryDilateImageFilterTest(int, char *[])
   // Set the iterator for going through the image output
   it2.SetRegion(outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "Result with cross radius 2" << std::endl;
   i = 0;
   it2.GoToBegin();

diff --git a/Modules/Filtering/DiffusionTensorImage/test/itkTensorFractionalAnisotropyImageFilterTest.cxx b/Modules/Filtering/DiffusionTensorImage/test/itkTensorFractionalAnisotropyImageFilterTest.cxx
@@ -142,7 +142,7 @@ itkTensorFractionalAnisotropyImageFilterTest(int, char *[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/Modules/Filtering/DiffusionTensorImage/test/itkTensorRelativeAnisotropyImageFilterTest.cxx b/Modules/Filtering/DiffusionTensorImage/test/itkTensorRelativeAnisotropyImageFilterTest.cxx
@@ -142,7 +142,7 @@ itkTensorRelativeAnisotropyImageFilterTest(int, char *[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/Modules/Filtering/ImageCompare/test/itkAbsoluteValueDifferenceImageFilterTest.cxx b/Modules/Filtering/ImageCompare/test/itkAbsoluteValueDifferenceImageFilterTest.cxx
@@ -133,7 +133,7 @@ itkAbsoluteValueDifferenceImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType4 it4(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   while (!it4.IsAtEnd())
   {

diff --git a/Modules/Filtering/ImageCompare/test/itkSquaredDifferenceImageFilterTest.cxx b/Modules/Filtering/ImageCompare/test/itkSquaredDifferenceImageFilterTest.cxx
@@ -133,7 +133,7 @@ itkSquaredDifferenceImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType4 it4(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   while (!it4.IsAtEnd())
   {

diff --git a/Modules/Filtering/ImageCompose/test/itkJoinImageFilterTest.cxx b/Modules/Filtering/ImageCompose/test/itkJoinImageFilterTest.cxx
@@ -164,7 +164,7 @@ itkJoinImageFilterTest(int, char *[])
   myFilterType::OutputImageType::Pointer outputImage = filter->GetOutput();
   myOutputIteratorType                   it3(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << std::endl;
   std::cout << "Joining #1 and #2 image " << std::endl;
   while (!it3.IsAtEnd())
@@ -177,7 +177,7 @@ itkJoinImageFilterTest(int, char *[])
   myFilterType3::OutputImageType::Pointer outputImage123 = filter123->GetOutput();
   myOutputIteratorType3                   it123(outputImage123, outputImage123->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << std::endl;
   std::cout << "Joining #1#2 and #3 image " << std::endl;
   while (!it123.IsAtEnd())
@@ -200,7 +200,7 @@ itkJoinImageFilterTest(int, char *[])
   myFilterType1::OutputImageType::Pointer outputImage1 = filter1->GetOutput();
   myOutputIteratorType1                   it4(outputImage1, outputImage1->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << std::endl;
   std::cout << "Joining #2 and #1 image " << std::endl;
   while (!it4.IsAtEnd())
@@ -223,8 +223,7 @@ itkJoinImageFilterTest(int, char *[])
   myFilterType2::OutputImageType::Pointer outputImage2 = filter2->GetOutput();
   myOutputIteratorType2                   it5(outputImage2, outputImage2->GetRequestedRegion());
 
-  //  Print the content of the result image
-  //  std::cout << std::endl;
+  // Print the content of the result image
   std::cout << "Joining #1 and #1 image " << std::endl;
   while (!it5.IsAtEnd())
   {
@@ -246,8 +245,7 @@ itkJoinImageFilterTest(int, char *[])
   myFilterType4::OutputImageType::Pointer outputImage4 = filter4->GetOutput();
   myOutputIteratorType4                   it6(outputImage4, outputImage4->GetRequestedRegion());
 
-  //  Print the content of the result image
-  //  std::cout << std::endl;
+  // Print the content of the result image
   std::cout << "Joining #2 and #2 image " << std::endl;
   while (!it6.IsAtEnd())
   {

diff --git a/Modules/Filtering/ImageFeature/test/itkBilateralImageFilterTest.cxx b/Modules/Filtering/ImageFeature/test/itkBilateralImageFilterTest.cxx
@@ -21,10 +21,6 @@
 #include "itkNullImageToImageFilterDriver.hxx"
 #include "itkTestingMacros.h"
 
-/**
- * Test the class instance by driving it with a null input and output.
- * Returns 0 on success and 1 on failure.
- */
 int
 itkBilateralImageFilterTest(int, char *[])
 {
@@ -74,7 +70,7 @@ itkBilateralImageFilterTest(int, char *[])
   filter->SetNumberOfRangeGaussianSamples(numberOfRangeGaussianSamples);
   ITK_TEST_SET_GET_VALUE(numberOfRangeGaussianSamples, filter->GetNumberOfRangeGaussianSamples());
 
-  // Run Test
+  // Run test
   itk::Size<Dimension> sz;
   sz[0] = 250;
   sz[1] = 250;

diff --git a/Modules/Filtering/ImageFeature/test/itkGradientVectorFlowImageFilterTest.cxx b/Modules/Filtering/ImageFeature/test/itkGradientVectorFlowImageFilterTest.cxx
@@ -166,7 +166,7 @@ itkGradientVectorFlowImageFilterTest(int, char *[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
 
   gtomfilter->SetInput(filter->GetOutput());

diff --git a/Modules/Filtering/ImageFeature/test/itkHessian3DToVesselnessMeasureImageFilterTest.cxx b/Modules/Filtering/ImageFeature/test/itkHessian3DToVesselnessMeasureImageFilterTest.cxx
@@ -150,7 +150,7 @@ itkHessian3DToVesselnessMeasureImageFilterTest(int argc, char * argv[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/Modules/Filtering/ImageFeature/test/itkHessianRecursiveGaussianFilterTest.cxx b/Modules/Filtering/ImageFeature/test/itkHessianRecursiveGaussianFilterTest.cxx
@@ -135,7 +135,7 @@ itkHessianRecursiveGaussianFilterTest(int argc, char * argv[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())
@@ -144,7 +144,7 @@ itkHessianRecursiveGaussianFilterTest(int argc, char * argv[])
     ++itg;
   }
 
-  // the following just tests for warnings in 2D
+  // Test for warnings in 2D
   using my2DImageType = itk::Image<float, 2>;
   using my2DFilterType = itk::HessianRecursiveGaussianImageFilter<my2DImageType>;
   auto test = my2DFilterType::New();

diff --git a/Modules/Filtering/ImageGradient/test/itkGradientMagnitudeRecursiveGaussianFilterTest.cxx b/Modules/Filtering/ImageGradient/test/itkGradientMagnitudeRecursiveGaussianFilterTest.cxx
@@ -147,7 +147,7 @@ itkGradientMagnitudeRecursiveGaussianFilterTest(int argc, char * argv[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/Modules/Filtering/ImageGradient/test/itkGradientRecursiveGaussianFilterSpeedTest.cxx b/Modules/Filtering/ImageGradient/test/itkGradientRecursiveGaussianFilterSpeedTest.cxx
@@ -140,7 +140,7 @@ itkGradientRecursiveGaussianFilterSpeedTest(int argc, char * argv[])
     // Create an iterator for going through the output image
     myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-    //  Print the content of the result image
+    // Print the content of the result image
     std::cout << " Result " << std::endl;
     itg.GoToBegin();
     std::cout << itg.Get();

diff --git a/Modules/Filtering/ImageGradient/test/itkGradientRecursiveGaussianFilterTest.cxx b/Modules/Filtering/ImageGradient/test/itkGradientRecursiveGaussianFilterTest.cxx
@@ -145,7 +145,7 @@ itkGradientRecursiveGaussianFilterTest(int argc, char * argv[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/Modules/Filtering/ImageIntensity/test/itkMaskImageFilterTest.cxx b/Modules/Filtering/ImageIntensity/test/itkMaskImageFilterTest.cxx
@@ -139,7 +139,7 @@ itkMaskImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType3 it3(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   while (!it3.IsAtEnd())
   {

diff --git a/Modules/Filtering/ImageIntensity/test/itkMaskNegatedImageFilterTest.cxx b/Modules/Filtering/ImageIntensity/test/itkMaskNegatedImageFilterTest.cxx
@@ -141,7 +141,7 @@ itkMaskNegatedImageFilterTest(int, char *[])
   // Create an iterator for going through the image output
   OutputIteratorType outputIterator(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   while (!outputIterator.IsAtEnd())
   {

diff --git a/Modules/Filtering/ImageIntensity/test/itkWeightedAddImageFilterTest.cxx b/Modules/Filtering/ImageIntensity/test/itkWeightedAddImageFilterTest.cxx
@@ -141,7 +141,7 @@ itkWeightedAddImageFilterTest(int argc, char * argv[])
   // Create an iterator for going through the image output
   myIteratorType3 it3(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   while (!it3.IsAtEnd())
   {

diff --git a/Modules/Filtering/MathematicalMorphology/test/itkGrayscaleFunctionDilateImageFilterTest.cxx b/Modules/Filtering/MathematicalMorphology/test/itkGrayscaleFunctionDilateImageFilterTest.cxx
@@ -145,7 +145,7 @@ itkGrayscaleFunctionDilateImageFilterTest(int argc, char * argv[])
   // Create an iterator for going through the image output
   myIteratorType it2(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "Result " << std::endl;
   i = 0;
   while (!it2.IsAtEnd())

diff --git a/Modules/Filtering/MathematicalMorphology/test/itkGrayscaleFunctionErodeImageFilterTest.cxx b/Modules/Filtering/MathematicalMorphology/test/itkGrayscaleFunctionErodeImageFilterTest.cxx
@@ -145,7 +145,7 @@ itkGrayscaleFunctionErodeImageFilterTest(int argc, char * argv[])
   // Create an iterator for going through the image output
   myIteratorType it2(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "Result " << std::endl;
   i = 0;
   while (!it2.IsAtEnd())

diff --git a/...iltering/MathematicalMorphology/test/itkGrayscaleMorphologicalClosingImageFilterTest2.cxx b/...iltering/MathematicalMorphology/test/itkGrayscaleMorphologicalClosingImageFilterTest2.cxx
@@ -56,7 +56,7 @@ itkGrayscaleMorphologicalClosingImageFilterTest2(int argc, char * argv[])
 
   using RadiusType = FilterType::RadiusType;
 
-  // test default values
+  // Test default values
   RadiusType r1;
   r1.Fill(1);
   ITK_TEST_SET_GET_VALUE(r1, filter->GetRadius());

diff --git a/...iltering/MathematicalMorphology/test/itkGrayscaleMorphologicalOpeningImageFilterTest2.cxx b/...iltering/MathematicalMorphology/test/itkGrayscaleMorphologicalOpeningImageFilterTest2.cxx
@@ -56,7 +56,7 @@ itkGrayscaleMorphologicalOpeningImageFilterTest2(int argc, char * argv[])
 
   using RadiusType = FilterType::RadiusType;
 
-  // test default values
+  // Test default values
   RadiusType r1;
   r1.Fill(1);
 

diff --git a/Modules/Filtering/MathematicalMorphology/test/itkObjectMorphologyImageFilterTest.cxx b/Modules/Filtering/MathematicalMorphology/test/itkObjectMorphologyImageFilterTest.cxx
@@ -157,7 +157,7 @@ itkObjectMorphologyImageFilterTest(int, char *[])
 
   elapsedTime = (end - start) / static_cast<double>(CLOCKS_PER_SEC);
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "  Success: " << std::endl;
   std::cout << "    Time = " << elapsedTime << std::endl;
 
@@ -178,7 +178,7 @@ itkObjectMorphologyImageFilterTest(int, char *[])
 
   elapsedTime = (end - start) / static_cast<double>(CLOCKS_PER_SEC);
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "  Success: " << std::endl;
   std::cout << "    Time = " << elapsedTime << std::endl;
 
@@ -245,7 +245,7 @@ itkObjectMorphologyImageFilterTest(int, char *[])
 
   elapsedTime = (end - start) / static_cast<double>(CLOCKS_PER_SEC);
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "  Success: " << std::endl;
   std::cout << "    Time = " << elapsedTime << std::endl;
 
@@ -266,7 +266,7 @@ itkObjectMorphologyImageFilterTest(int, char *[])
 
   elapsedTime = (end - start) / static_cast<double>(CLOCKS_PER_SEC);
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << "  Success: " << std::endl;
   std::cout << "    Time = " << elapsedTime << std::endl;
 

diff --git a/...s/Filtering/Smoothing/test/itkSmoothingRecursiveGaussianImageFilterOnImageAdaptorTest.cxx b/...s/Filtering/Smoothing/test/itkSmoothingRecursiveGaussianImageFilterOnImageAdaptorTest.cxx
@@ -152,7 +152,7 @@ itkSmoothingRecursiveGaussianImageFilterOnImageAdaptorTest(int, char *[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/.../Filtering/Smoothing/test/itkSmoothingRecursiveGaussianImageFilterOnImageOfVectorTest.cxx b/.../Filtering/Smoothing/test/itkSmoothingRecursiveGaussianImageFilterOnImageOfVectorTest.cxx
@@ -143,7 +143,7 @@ itkSmoothingRecursiveGaussianImageFilterOnImageOfVectorTest(int, char *[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/...es/Filtering/Smoothing/test/itkSmoothingRecursiveGaussianImageFilterOnVectorImageTest.cxx b/...es/Filtering/Smoothing/test/itkSmoothingRecursiveGaussianImageFilterOnVectorImageTest.cxx
@@ -141,7 +141,7 @@ itkSmoothingRecursiveGaussianImageFilterOnVectorImageTest(int, char *[])
   // Create an iterator for going through the output image
   myOutputIteratorType itg(outputImage, outputImage->GetRequestedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   itg.GoToBegin();
   while (!itg.IsAtEnd())

diff --git a/Modules/Nonunit/IntegratedTest/test/itkFilterImageAddTest.cxx b/Modules/Nonunit/IntegratedTest/test/itkFilterImageAddTest.cxx
@@ -118,7 +118,7 @@ itkFilterImageAddTest(int, char *[])
   // Create an iterator for going through the image output
   myIteratorType3 it3(outputImage, outputImage->GetBufferedRegion());
 
-  //  Print the content of the result image
+  // Print the content of the result image
   std::cout << " Result " << std::endl;
   while (!it3.IsAtEnd())
   {