Merge pull request #5812 from N-Dekker/MakeIndexRange

Add `itk::MakeIndexRange` functions and use them

Author: thewtex

Modules/Core/Common/include/itkBSplineInterpolationWeightFunction.hxx

@@ -49,7 +49,7 @@ BSplineInterpolationWeightFunction<TCoordinate, VSpaceDimension, VSplineOrder>::
 {
   static constexpr auto offsetToIndexTable = [] {
     FixedArray<IndexType, NumberOfWeights> table{};
-    auto                                   indexIterator = ZeroBasedIndexRange<SpaceDimension>(SupportSize).cbegin();
+    auto                                   indexIterator = MakeIndexRange(SupportSize).cbegin();
 
     for (size_t i{}; i < NumberOfWeights; ++i)
     {

Modules/Core/Common/include/itkIndexRange.h

@@ -41,9 +41,8 @@ namespace itk
     \code
     constexpr unsigned int Dimension{ 2 };
     const Size<Dimension> size = { {2, 3} };
-    const ZeroBasedIndexRange<Dimension> indexRange{ size };
 
-    for (const Index<Dimension> index : indexRange)
+    for (const Index<Dimension> index : MakeIndexRange(size))
     {
       std::cout << index;
     }
@@ -474,6 +473,30 @@ using ImageRegionIndexRange = IndexRange<VDimension, false>;
 template <unsigned int VDimension>
 using ZeroBasedIndexRange = IndexRange<VDimension, true>;
 
+/* Creates a range of indices for the specified grid size. */
+template <unsigned int VDimension>
+[[nodiscard]] constexpr auto
+MakeIndexRange(const Size<VDimension> & gridSize)
+{
+  return ZeroBasedIndexRange<VDimension>(gridSize);
+}
+
+/* Creates a range of indices for the specified image region. */
+template <unsigned int VDimension>
+[[nodiscard]] auto
+MakeIndexRange(const ImageRegion<VDimension> & imageRegion)
+{
+  return ImageRegionIndexRange<VDimension>(imageRegion);
+}
+
+/* Creates a range of indices for the image region specified by its index and size. */
+template <unsigned int VDimension>
+[[nodiscard]] auto
+MakeIndexRange(const Index<VDimension> & imageRegionIndex, const Size<VDimension> & imageRegionSize)
+{
+  return ImageRegionIndexRange<VDimension>(ImageRegion<VDimension>{ imageRegionIndex, imageRegionSize });
+}
+
 } // namespace itk
 
 #endif

Modules/Core/Common/include/itkSobelOperator.hxx

@@ -39,8 +39,7 @@ SobelOperator<TPixel, VDimension, TAllocator>::Fill(const CoefficientVector & co
   using IndexType = Index<VDimension>;
 
   unsigned int coeff_index = 0;
-  for (const IndexType & index :
-       ImageRegionIndexRange<VDimension>(ImageRegion{ IndexType::Filled(-1), SizeType::Filled(3) }))
+  for (const IndexType & index : MakeIndexRange(IndexType::Filled(-1), SizeType::Filled(3)))
   {
     auto pos = static_cast<int>(center);
 

Modules/Core/Common/test/itkImageRegionGTest.cxx

@@ -104,7 +104,7 @@ TEST(ImageRegion, OneSizedRegionIsInsideIffItsIndexIsInside)
     auto paddedRegion = region;
     paddedRegion.PadByRadius(1);
 
-    for (const auto & index : itk::ImageRegionIndexRange<RegionType::ImageDimension>(paddedRegion))
+    for (const auto & index : itk::MakeIndexRange(paddedRegion))
     {
       const RegionType oneSizedRegion{ index, SizeType::Filled(1) };
 

Modules/Core/Common/test/itkIndexRangeGTest.cxx

@@ -35,13 +35,26 @@ template class itk::IndexRange<2, false>;
 
 using itk::IndexRange;
 using itk::ImageRegionIndexRange;
+using itk::MakeIndexRange;
 using itk::ZeroBasedIndexRange;
 using itk::RangeGTestUtilities;
 
 
 static_assert(sizeof(ZeroBasedIndexRange<3>) < sizeof(ImageRegionIndexRange<3>),
               "ZeroBasedIndexRange does not need to store the index of a region, so it should take less memory.");
 
+static_assert(std::is_same_v<decltype(MakeIndexRange(itk::Size<2>{})), ZeroBasedIndexRange<2>> &&
+                std::is_same_v<decltype(MakeIndexRange(itk::Size<3>{})), ZeroBasedIndexRange<3>>,
+              "MakeIndexRange(size) should return a ZeroBasedIndexRange.");
+
+static_assert(std::is_same_v<decltype(MakeIndexRange(itk::ImageRegion<2>{})), ImageRegionIndexRange<2>> &&
+                std::is_same_v<decltype(MakeIndexRange(itk::ImageRegion<3>{})), ImageRegionIndexRange<3>>,
+              "MakeIndexRange(imageRegion) should return an ImageRegionIndexRange.");
+
+static_assert(std::is_same_v<decltype(MakeIndexRange(itk::Index<2>{}, itk::Size<2>{})), ImageRegionIndexRange<2>> &&
+                std::is_same_v<decltype(MakeIndexRange(itk::Index<3>{}, itk::Size<3>{})), ImageRegionIndexRange<3>>,
+              "MakeIndexRange(index, size) should return an ImageRegionIndexRange.");
+
 namespace
 {
 template <unsigned int VDimension>
@@ -107,7 +120,9 @@ ExpectRangeIsEmptyWhenRegionSizeIsZero(std::mt19937 & randomNumberEngine)
   const itk::Index<VDimension>       randomRegionIndex = GenerateRandomIndex<VDimension>(randomNumberEngine);
   const itk::ImageRegion<VDimension> zeroSizedImageRegion{ randomRegionIndex, zeroSize };
 
-  EXPECT_TRUE(ImageRegionIndexRange<VDimension>{ zeroSizedImageRegion }.empty());
+  EXPECT_TRUE(MakeIndexRange(zeroSize).empty());
+  EXPECT_TRUE(MakeIndexRange(zeroSizedImageRegion).empty());
+  EXPECT_TRUE(MakeIndexRange(randomRegionIndex, zeroSize).empty());
 }
 
 

Modules/Core/ImageFunction/test/itkGaussianInterpolateImageFunctionTest.cxx

@@ -58,7 +58,7 @@ itkGaussianInterpolateImageFunctionTest(int, char *[])
   image->SetOrigin(origin);
   image->SetSpacing(spacing);
 
-  for (const auto index : itk::ZeroBasedIndexRange<ImageType::ImageDimension>(size))
+  for (const auto index : itk::MakeIndexRange(size))
   {
     image->SetPixel(index, index[0] + index[1]);
   }

Modules/Core/ImageFunction/test/itkSumOfSquaresImageFunctionGTest.cxx

@@ -64,7 +64,7 @@ Expect_EvaluateAtIndex_returns_zero_when_all_pixels_are_zero(const typename TIma
 
   imageFunction->SetInputImage(image);
 
-  for (const auto index : itk::ZeroBasedIndexRange<TImage::ImageDimension>{ imageSize })
+  for (const auto index : itk::MakeIndexRange(imageSize))
   {
     EXPECT_EQ(imageFunction->EvaluateAtIndex(index), 0);
   }
@@ -88,7 +88,7 @@ Expect_EvaluateAtIndex_returns_number_of_neigbors_when_all_pixels_are_one(const
 
   const auto numberOfNeighbors = std::pow(2.0 * radius + 1.0, TImage::ImageDimension);
 
-  for (const auto index : itk::ZeroBasedIndexRange<TImage::ImageDimension>{ imageSize })
+  for (const auto index : itk::MakeIndexRange(imageSize))
   {
     EXPECT_EQ(imageFunction->EvaluateAtIndex(index), numberOfNeighbors);
   }

Modules/Core/SpatialObjects/test/itkImageMaskSpatialObjectGTest.cxx

@@ -91,15 +91,13 @@ Expect_AxisAlignedBoundingBoxRegion_equals_region_of_single_pixel_when_it_is_the
   image->SetRegions(imageRegion);
   image->AllocateInitialized();
 
-  const itk::ImageRegionIndexRange<VImageDimension> indexRange{ imageRegion };
-
   // Expected size: the "region size" of a single pixel (1x1, in 2D, 1x1x1 in 3D).
   const itk::Size<VImageDimension> expectedSize = [] {
     auto size = itk::Size<VImageDimension>::Filled(1);
     return size;
   }();
 
-  for (const auto & index : indexRange)
+  for (const auto & index : MakeIndexRange(imageRegion))
   {
     // Set only one pixel value non-zero.
     image->SetPixel(index, 1);

Modules/Filtering/ImageGradient/test/itkGradientImageFilterGTest.cxx

@@ -87,7 +87,7 @@ TEST(GradientImageFilter, ConstantGradientInputImage)
     inputImage->SetRegions(imageSize);
     inputImage->Allocate(false);
 
-    for (const auto & index : itk::ZeroBasedIndexRange<Dimension>(imageSize))
+    for (const auto & index : itk::MakeIndexRange(imageSize))
     {
       // A constant gradient along the first dimension of the image.
       inputImage->SetPixel(index, static_cast<PixelType>(inputGradientValue * index[0]));
@@ -102,7 +102,7 @@ TEST(GradientImageFilter, ConstantGradientInputImage)
     // Only look at the inner region, to avoid boundary effects (which are beyond the scope of this unit test).
     const itk::ImageRegion innerRegion{ IndexType::Filled(1), imageSize - SizeType::Filled(2) };
 
-    for (const auto & index : itk::ImageRegionIndexRange<Dimension>(innerRegion))
+    for (const auto & index : itk::MakeIndexRange(innerRegion))
     {
       const auto outputPixelValue = output.GetPixel(index);
 

Modules/Filtering/Path/include/itkContourExtractor2DImageFilter.h

@@ -145,7 +145,11 @@ class ITK_TEMPLATE_EXPORT ContourExtractor2DImageFilter
   using InputRealType = typename NumericTraits<InputPixelType>::RealType;
 
   /** Ranges and iterators for regions */
-  using RegionIndexRange = ImageRegionIndexRange<InputImageType::ImageDimension>;
+#ifndef ITK_FUTURE_LEGACY_REMOVE
+  using RegionIndexRange ITK_FUTURE_DEPRECATED(
+    "Please use `itk::ImageRegionIndexRange` or `itk::MakeIndexRange` directly!") =
+    ImageRegionIndexRange<InputImageType::ImageDimension>;
+#endif
   using RegionRange = ImageRegionRange<InputImageType>;
   using RegionConstRange = ImageRegionRange<const InputImageType>;