STYLE: Replace elastix::Deref with ITK 5.4 itk::Deref

Following ITK pull request InsightSoftwareConsortium/ITK#4278 commit InsightSoftwareConsortium/ITK@042d423 "ENH: Add `Deref(T *)`, to ease dereferencing a pointer safely".
SuperElastix · Jun 10, 2024 · 995f471 · 995f471
1 parent f03cef1
commit 995f471
Show file tree

Hide file tree

Showing 40 changed files with 145 additions and 185 deletions.
diff --git a/Common/ImageSamplers/itkImageFullSampler.hxx b/Common/ImageSamplers/itkImageFullSampler.hxx
@@ -21,7 +21,7 @@
 #include "itkImageFullSampler.h"
 
 #include "itkImageRegionConstIteratorWithIndex.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 #include <algorithm> // For copy_n and min.
 #include <cassert>
@@ -155,8 +155,8 @@ void
 ImageFullSampler<TInputImage>::GenerateData()
 {
   /** Get handles to the input image, output sample container, and the mask. */
-  const InputImageType &     inputImage = elastix::Deref(this->GetInput());
-  ImageSampleContainerType & sampleContainer = elastix::Deref(this->GetOutput());
+  const InputImageType &     inputImage = Deref(this->GetInput());
+  ImageSampleContainerType & sampleContainer = Deref(this->GetOutput());
   const MaskType * const     mask = this->Superclass::GetMask();
 
   if (mask)
@@ -173,7 +173,7 @@ ImageFullSampler<TInputImage>::GenerateData()
 
   if (Superclass::m_UseMultiThread)
   {
-    MultiThreadedGenerateData(elastix::Deref(this->ProcessObject::GetMultiThreader()),
+    MultiThreadedGenerateData(Deref(this->ProcessObject::GetMultiThreader()),
                               ProcessObject::GetNumberOfWorkUnits(),
                               inputImage,
                               mask,

diff --git a/Common/ImageSamplers/itkImageGridSampler.hxx b/Common/ImageSamplers/itkImageGridSampler.hxx
@@ -21,7 +21,7 @@
 #include "itkImageGridSampler.h"
 
 #include "itkImageRegionConstIteratorWithIndex.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 #include <algorithm> // For accumulate.
 #include <cassert>
@@ -258,8 +258,8 @@ void
 ImageGridSampler<TInputImage>::GenerateData()
 {
   /** Get handles to the input image, output sample container, and the mask. */
-  const InputImageType &     inputImage = elastix::Deref(this->GetInput());
-  ImageSampleContainerType & sampleContainer = elastix::Deref(this->GetOutput());
+  const InputImageType &     inputImage = Deref(this->GetInput());
+  ImageSampleContainerType & sampleContainer = Deref(this->GetOutput());
   const MaskType * const     mask = this->Superclass::GetMask();
 
   if (mask)
@@ -279,7 +279,7 @@ ImageGridSampler<TInputImage>::GenerateData()
 
   if (Superclass::m_UseMultiThread)
   {
-    MultiThreadedGenerateData(elastix::Deref(this->ProcessObject::GetMultiThreader()),
+    MultiThreadedGenerateData(Deref(this->ProcessObject::GetMultiThreader()),
                               ProcessObject::GetNumberOfWorkUnits(),
                               inputImage,
                               mask,

diff --git a/Common/ImageSamplers/itkImageRandomCoordinateSampler.hxx b/Common/ImageSamplers/itkImageRandomCoordinateSampler.hxx
@@ -19,7 +19,7 @@
 #define itkImageRandomCoordinateSampler_hxx
 
 #include "itkImageRandomCoordinateSampler.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 #include <vnl/vnl_math.h>
 #include <cassert>
 
@@ -35,8 +35,8 @@ void
 ImageRandomCoordinateSampler<TInputImage>::GenerateData()
 {
   /** Get handles to the input image, output sample container, and interpolator. */
-  const InputImageType &             inputImage = elastix::Deref(this->GetInput());
-  auto &                             samples = elastix::Deref(this->GetOutput()).CastToSTLContainer();
+  const InputImageType &             inputImage = Deref(this->GetInput());
+  auto &                             samples = Deref(this->GetOutput()).CastToSTLContainer();
   typename InterpolatorType::Pointer interpolator = this->GetModifiableInterpolator();
 
   /** Set up the interpolator. */
@@ -75,8 +75,7 @@ ImageRandomCoordinateSampler<TInputImage>::GenerateData()
 
     UserData userData{ m_RandomCoordinates, inputImage, *interpolator, samples };
 
-    elastix::Deref(this->ProcessObject::GetMultiThreader())
-      .SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
+    Deref(this->ProcessObject::GetMultiThreader()).SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
     return;
   }
 

diff --git a/Common/ImageSamplers/itkImageRandomSampler.hxx b/Common/ImageSamplers/itkImageRandomSampler.hxx
@@ -22,7 +22,7 @@
 
 #include "itkMersenneTwisterRandomVariateGenerator.h"
 #include "itkImageRandomConstIteratorWithIndex.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 #include <cassert>
 
 namespace itk
@@ -37,8 +37,8 @@ void
 ImageRandomSampler<TInputImage>::GenerateData()
 {
   /** Get handles to the input image, output sample container. */
-  const InputImageType & inputImage = elastix::Deref(this->GetInput());
-  auto &                 samples = elastix::Deref(this->GetOutput()).CastToSTLContainer();
+  const InputImageType & inputImage = Deref(this->GetInput());
+  auto &                 samples = Deref(this->GetOutput()).CastToSTLContainer();
 
   /** Get a handle to the mask. If there was no mask supplied we exercise a multi-threaded version. */
   const MaskType * const mask = this->Superclass::GetMask();
@@ -53,8 +53,7 @@ ImageRandomSampler<TInputImage>::GenerateData()
       randomNumberList, inputImage, croppedInputImageRegion.GetIndex(), croppedInputImageRegion.GetSize(), samples
     };
 
-    elastix::Deref(this->ProcessObject::GetMultiThreader())
-      .SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
+    Deref(this->ProcessObject::GetMultiThreader()).SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
     return;
   }
 

diff --git a/Common/ImageSamplers/itkImageRandomSamplerSparseMask.hxx b/Common/ImageSamplers/itkImageRandomSamplerSparseMask.hxx
@@ -19,7 +19,7 @@
 #define itkImageRandomSamplerSparseMask_hxx
 
 #include "itkImageRandomSamplerSparseMask.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 #include <cassert>
 
 namespace itk
@@ -45,8 +45,8 @@ ImageRandomSamplerSparseMask<TInputImage>::GenerateData()
   }
 
   /** Get handles to the input image and output sample container. */
-  const InputImageType &     inputImage = elastix::Deref(this->GetInput());
-  ImageSampleContainerType & sampleContainer = elastix::Deref(this->GetOutput());
+  const InputImageType &     inputImage = Deref(this->GetInput());
+  ImageSampleContainerType & sampleContainer = Deref(this->GetOutput());
 
   // Take capacity from the output container, and clear it.
   std::vector<ImageSampleType> sampleVector;
@@ -72,7 +72,7 @@ ImageRandomSamplerSparseMask<TInputImage>::GenerateData()
   }
 
   /** Get a handle to the full sampler output. */
-  const ImageSampleContainerType & allValidSamples = elastix::Deref(this->m_InternalFullSampler->GetOutput());
+  const ImageSampleContainerType & allValidSamples = Deref(this->m_InternalFullSampler->GetOutput());
   unsigned long                    numberOfValidSamples = allValidSamples.Size();
 
 
@@ -92,8 +92,7 @@ ImageRandomSamplerSparseMask<TInputImage>::GenerateData()
 
     UserData userData{ allValidSamples.CastToSTLConstContainer(), m_RandomIndices, samples };
 
-    elastix::Deref(this->ProcessObject::GetMultiThreader())
-      .SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
+    Deref(this->ProcessObject::GetMultiThreader()).SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
     return;
   }
 

diff --git a/Common/ImageSamplers/itkImageSamplerBase.hxx b/Common/ImageSamplers/itkImageSamplerBase.hxx
@@ -19,7 +19,7 @@
 #define itkImageSamplerBase_hxx
 
 #include "itkImageSamplerBase.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 #include <itkMultiThreaderBase.h>
 #include <cassert>
 #include <numeric> // For accumulate.
@@ -170,7 +170,7 @@ ImageSamplerBase<TInputImage>::GenerateInputRequestedRegion()
   }
 
   /** Get a non-const reference to the input image. */
-  auto & inputImage = const_cast<InputImageType &>(elastix::Deref(this->GetInput()));
+  auto & inputImage = const_cast<InputImageType &>(Deref(this->GetInput()));
 
   /** Get and set the region. */
   if (this->GetInputImageRegion().GetNumberOfPixels() != 0)

diff --git a/Common/ImageSamplers/itkMultiInputImageRandomCoordinateSampler.hxx b/Common/ImageSamplers/itkMultiInputImageRandomCoordinateSampler.hxx
@@ -21,7 +21,7 @@
 #include "itkMultiInputImageRandomCoordinateSampler.h"
 #include <vnl/vnl_inverse.h>
 #include "itkConfigure.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 namespace itk
 {
@@ -41,8 +41,8 @@ MultiInputImageRandomCoordinateSampler<TInputImage>::GenerateData()
   }
 
   /** Get handles to the input image, output sample container, and mask. */
-  const InputImageType &             inputImage = elastix::Deref(this->GetInput());
-  auto &                             samples = elastix::Deref(this->GetOutput()).CastToSTLContainer();
+  const InputImageType &             inputImage = Deref(this->GetInput());
+  auto &                             samples = Deref(this->GetOutput()).CastToSTLContainer();
   const MaskType * const             mask = this->Superclass::GetMask();
   typename InterpolatorType::Pointer interpolator = this->GetModifiableInterpolator();
 

diff --git a/Common/elxDeref.h b/Common/elxDeref.h
diff --git a/Common/elxMaskHasSameImageDomain.h b/Common/elxMaskHasSameImageDomain.h
@@ -21,7 +21,7 @@
 
 #include <itkImageBase.h>
 #include <itkImageMaskSpatialObject.h>
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 namespace elastix
 {
@@ -40,7 +40,7 @@ bool
 MaskHasSameImageDomain(const itk::ImageMaskSpatialObject<VImageDimension> & mask,
                        const itk::ImageBase<VImageDimension> &              inputImage)
 {
-  const auto & maskImage = Deref(mask.GetImage());
+  const auto & maskImage = itk::Deref(mask.GetImage());
   return maskImage.GetLargestPossibleRegion() == inputImage.GetLargestPossibleRegion() &&
          maskImage.GetOrigin() == inputImage.GetOrigin() && maskImage.GetSpacing() == inputImage.GetSpacing() &&
          maskImage.GetDirection() == inputImage.GetDirection();

diff --git a/Components/ImageSamplers/Grid/elxGridSampler.hxx b/Components/ImageSamplers/Grid/elxGridSampler.hxx
@@ -20,7 +20,7 @@
 #define elxGridSampler_hxx
 
 #include "elxGridSampler.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 namespace elastix
 {
@@ -33,7 +33,7 @@ template <class TElastix>
 void
 GridSampler<TElastix>::BeforeEachResolution()
 {
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   const unsigned int level = this->m_Registration->GetAsITKBaseType()->GetCurrentLevel();
 

diff --git a/Components/ImageSamplers/MultInputRandomCoordinate/elxMultiInputRandomCoordinateSampler.hxx b/Components/ImageSamplers/MultInputRandomCoordinate/elxMultiInputRandomCoordinateSampler.hxx
@@ -20,7 +20,7 @@
 #define elxMultiInputRandomCoordinateSampler_hxx
 
 #include "elxMultiInputRandomCoordinateSampler.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 namespace elastix
 {
@@ -33,7 +33,7 @@ template <class TElastix>
 void
 MultiInputRandomCoordinateSampler<TElastix>::BeforeEachResolution()
 {
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   const unsigned int level = (this->m_Registration->GetAsITKBaseType())->GetCurrentLevel();
 

diff --git a/Components/ImageSamplers/Random/elxRandomSampler.hxx b/Components/ImageSamplers/Random/elxRandomSampler.hxx
@@ -19,7 +19,7 @@
 #define elxRandomSampler_hxx
 
 #include "elxRandomSampler.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 namespace elastix
 {
@@ -32,7 +32,7 @@ template <class TElastix>
 void
 RandomSampler<TElastix>::BeforeEachResolution()
 {
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   const unsigned int level = (this->m_Registration->GetAsITKBaseType())->GetCurrentLevel();
 

diff --git a/Components/ImageSamplers/RandomCoordinate/elxRandomCoordinateSampler.hxx b/Components/ImageSamplers/RandomCoordinate/elxRandomCoordinateSampler.hxx
@@ -19,7 +19,7 @@
 #define elxRandomCoordinateSampler_hxx
 
 #include "elxRandomCoordinateSampler.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 #include "itkLinearInterpolateImageFunction.h"
 
 namespace elastix
@@ -33,7 +33,7 @@ template <class TElastix>
 void
 RandomCoordinateSampler<TElastix>::BeforeEachResolution()
 {
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   const unsigned int level = this->m_Registration->GetAsITKBaseType()->GetCurrentLevel();
 

diff --git a/Components/ImageSamplers/RandomSparseMask/elxRandomSamplerSparseMask.hxx b/Components/ImageSamplers/RandomSparseMask/elxRandomSamplerSparseMask.hxx
@@ -20,7 +20,7 @@
 #define elxRandomSamplerSparseMask_hxx
 
 #include "elxRandomSamplerSparseMask.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 namespace elastix
 {
@@ -33,7 +33,7 @@ template <class TElastix>
 void
 RandomSamplerSparseMask<TElastix>::BeforeEachResolution()
 {
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   const unsigned int level = (this->m_Registration->GetAsITKBaseType())->GetCurrentLevel();
 

diff --git a/Components/Metrics/AdvancedNormalizedCorrelation/elxAdvancedNormalizedCorrelationMetric.hxx b/Components/Metrics/AdvancedNormalizedCorrelation/elxAdvancedNormalizedCorrelationMetric.hxx
@@ -32,7 +32,7 @@ template <class TElastix>
 void
 AdvancedNormalizedCorrelationMetric<TElastix>::BeforeEachResolution()
 {
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   if (configuration.HasParameter("SubtractMean"))
   {

diff --git a/Components/Optimizers/AdaGrad/elxAdaGrad.hxx b/Components/Optimizers/AdaGrad/elxAdaGrad.hxx
@@ -19,7 +19,7 @@
 #define elxAdaGrad_hxx
 
 #include "elxAdaGrad.h"
-#include "elxDeref.h"
+#include <itkDeref.h>
 
 #include <cmath> // For abs.
 #include <iomanip>
@@ -113,7 +113,7 @@ AdaGrad<TElastix>::BeforeEachResolution()
 
   const unsigned int P = this->GetElastix()->GetElxTransformBase()->GetAsITKBaseType()->GetNumberOfParameters();
 
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   /** Set the maximumNumberOfIterations. */
   SizeValueType maximumNumberOfIterations = 500;
@@ -578,7 +578,7 @@ AdaGrad<TElastix>::AutomaticPreconditionerEstimation()
   preconditionerEstimator->SetConditionNumber( this->m_ConditionNumber );
   preconditionerEstimator->SetUseScales( false ); // Make sure scales are not used
 #endif
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   /** Construct the preconditioner and initialize. */
   this->m_PreconditionVector = ParametersType(P);
@@ -780,7 +780,7 @@ AdaGrad<TElastix>::SampleGradients(const ParametersType & mu0, double perturbati
 
   } // end if NewSamplesEveryIteration.
 
-  const Configuration & configuration = Deref(Superclass2::GetConfiguration());
+  const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
 
   /** Prepare for progress printing. */
   const bool showProgressPercentage = configuration.RetrieveParameterValue(false, "ShowProgressPercentage", 0, false);