Merge pull request #6504 from hjmjohnson/future-legacy-ingested-trivial

COMP: Modernize deprecated macros in ingested filter/IO modules

Author: hjmjohnson

Documentation/docs/migration_guides/itk_6_migration_guide.md

@@ -845,3 +845,24 @@ whereas `vnl_svd`'s signs depend on solver internals. Sign-invariant operations
 reads individual `U`/`V` columns as directions may see the same geometry from a
 different, equally-valid representative. Pass `canonicalizeSigns = false` to
 reproduce `vnl_svd`'s raw signs (e.g. for equivalence testing).
+
+## `FixedPointInverseDisplacementFieldImageFilter::OutputIterator` is now `ImageRegionIteratorWithIndex`
+
+The public nested type alias
+`FixedPointInverseDisplacementFieldImageFilter<...>::OutputIterator` changed from
+`ImageRegionIterator<OutputImageType>` to
+`ImageRegionIteratorWithIndex<OutputImageType>`. The filter calls `GetIndex()` on
+this iterator, which `ImageRegionIterator` only provides under the removed
+`ITK_FUTURE_LEGACY_REMOVE` API; `ImageRegionIteratorWithIndex` supplies it
+natively.
+
+### What you need to do
+
+Downstream code that names the concrete alias explicitly -- e.g. a template
+specialization or overload keyed on `ImageRegionIterator<OutputImageType>`, or a
+variable declared as `FilterType::OutputIterator` and then passed where an
+`ImageRegionIterator` is required -- must accept
+`ImageRegionIteratorWithIndex<OutputImageType>` instead. The two iterators are
+siblings in the iterator hierarchy, not subclasses, so such uses do not convert
+implicitly. Code that only iterates (`GoToBegin`/`IsAtEnd`/`Get`/`Set`) needs no
+change.

Modules/Filtering/Cuberille/include/itkCuberilleImageToMeshFilter.h

@@ -127,7 +127,7 @@ class CuberilleImageToMeshFilter : public ImageToMeshFilter<TInputImage, TOutput
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(CuberilleImageToMeshFilter, ImageToMeshFilter);
+  itkOverrideGetNameOfClassMacro(CuberilleImageToMeshFilter);
 
   /** Compile-time configuration flags (formerly preprocessor macros).
    * Flip a flag to true and rebuild to enable the corresponding alternative

Modules/Filtering/FixedPointInverseDisplacementField/include/itkFixedPointInverseDisplacementFieldImageFilter.h

@@ -24,6 +24,7 @@
 #include "itkWarpVectorImageFilter.h"
 #include "itkVectorLinearInterpolateImageFunction.h"
 #include "itkImageRegionIterator.h"
+#include "itkImageRegionIteratorWithIndex.h"
 #include "itkTimeProbe.h"
 
 namespace itk
@@ -70,7 +71,7 @@ class ITK_TEMPLATE_EXPORT FixedPointInverseDisplacementFieldImageFilter
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(FixedPointInverseDisplacementFieldImageFilter, ImageToImageFilter);
+  itkOverrideGetNameOfClassMacro(FixedPointInverseDisplacementFieldImageFilter);
 
 
   /** Some type alias. */
@@ -101,7 +102,7 @@ class ITK_TEMPLATE_EXPORT FixedPointInverseDisplacementFieldImageFilter
   using InputConstIterator = ImageRegionConstIterator<InputImageType>;
   using InputIterator = ImageRegionIterator<InputImageType>;
   using OutputConstIterator = ImageRegionConstIterator<OutputImageType>;
-  using OutputIterator = ImageRegionIterator<OutputImageType>;
+  using OutputIterator = ImageRegionIteratorWithIndex<OutputImageType>;
 
   using VectorWarperType = WarpVectorImageFilter<TOutputImage, TInputImage, TOutputImage>;
   using InterpolatorVectorType = typename NumericTraits<typename TOutputImage::PixelType>::RealType;

Modules/Filtering/SubdivisionQuadEdgeMeshFilter/include/itkModifiedButterflyTriangleEdgeCellSubdivisionQuadEdgeMeshFilter.h

@@ -76,8 +76,7 @@ class ModifiedButterflyTriangleEdgeCellSubdivisionQuadEdgeMeshFilter
   using OutputPointIdIterator = typename Superclass::OutputPointIdIterator;
 
   /** Run-time type information (and related methods).   */
-  itkTypeMacro(ModifiedButterflyTriangleEdgeCellSubdivisionQuadEdgeMeshFilter,
-               TriangleEdgeCellSubdivisionQuadEdgeMeshFilter);
+  itkOverrideGetNameOfClassMacro(ModifiedButterflyTriangleEdgeCellSubdivisionQuadEdgeMeshFilter);
 
   /** New macro for creation of through a Smart Pointer   */
   itkNewMacro(Self);

Modules/Filtering/TotalVariation/include/itkProxTVImageFilter.h

@@ -56,7 +56,7 @@ class ProxTVImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
   using ConstPointer = SmartPointer<const Self>;
 
   /** Run-time type information. */
-  itkTypeMacro(ProxTVImageFilter, ImageToImageFilter);
+  itkOverrideGetNameOfClassMacro(ProxTVImageFilter);
 
   /** Standard New macro. */
   itkNewMacro(Self);

Modules/IO/IOMeshSTL/include/itkSTLMeshIO.h

@@ -50,7 +50,7 @@ class IOMeshSTL_EXPORT STLMeshIO : public MeshIOBase
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(STLMeshIO, MeshIOBase);
+  itkOverrideGetNameOfClassMacro(STLMeshIO);
 
   /**-------- This part of the interfaces deals with reading data. ----- */
 

Modules/IO/IOMeshSTL/include/itkSTLMeshIOFactory.h

@@ -52,7 +52,7 @@ class IOMeshSTL_EXPORT STLMeshIOFactory : public ObjectFactoryBase
   itkFactorylessNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(STLMeshIOFactory, ObjectFactoryBase);
+  itkOverrideGetNameOfClassMacro(STLMeshIOFactory);
 
   /** Register one factory of this type  */
   static void

Modules/Registration/RANSAC/include/itkLandmarkRegistrationEstimator.h

@@ -50,7 +50,7 @@ class LandmarkRegistrationEstimator : public itk::ParametersEstimator<Point<doub
   using PointsLocatorType = itk::PointsLocator<itk::VectorContainer<IdentifierType, itk::Point<double, 3>>>;
   using PointsContainer = itk::VectorContainer<IdentifierType, itk::Point<double, 3>>;
 
-  itkTypeMacro(LandmarkRegistrationEstimator, ParametersEstimator);
+  itkOverrideGetNameOfClassMacro(LandmarkRegistrationEstimator);
   /** New method for creating an object using a factory. */
   itkNewMacro(Self);
 

Modules/Registration/RANSAC/include/itkParametersEstimator.h

@@ -55,7 +55,7 @@ class ITK_TEMPLATE_EXPORT ParametersEstimator : public Object
   typedef SmartPointer<Self>       Pointer;
   typedef SmartPointer<const Self> ConstPointer;
 
-  itkTypeMacro(ParametersEstimator, Object);
+  itkOverrideGetNameOfClassMacro(ParametersEstimator);
 
   /**
    * Exact estimation of parameters.

Modules/Registration/RANSAC/include/itkRANSAC.h

@@ -86,7 +86,7 @@ class ITK_TEMPLATE_EXPORT RANSAC : public Object
   using ParametersEstimatorPointer = typename itk::ParametersEstimator<T, SType>::Pointer;
   using ParametersEstimatorType = typename itk::ParametersEstimator<T, SType>;
 
-  itkTypeMacro(RANSAC, Object);
+  itkOverrideGetNameOfClassMacro(RANSAC);
   /** New method for creating an object using a factory. */
   itkNewMacro(Self);