STYLE: Use ITK 5.4 MultiThreaderBase::SetSingleMethodAndExecute

Following ITK pull request InsightSoftwareConsortium/ITK#4370 commit InsightSoftwareConsortium/ITK@972b577 "ENH: Add `MultiThreaderBase::SetSingleMethodAndExecute` member function".
SuperElastix · Jun 10, 2024 · 2b764d7 · 2b764d7
1 parent ca36292
commit 2b764d7
Show file tree

Hide file tree

Showing 20 changed files with 52 additions and 86 deletions.
diff --git a/Common/CostFunctions/itkAdvancedImageToImageMetric.hxx b/Common/CostFunctions/itkAdvancedImageToImageMetric.hxx
@@ -686,11 +686,8 @@ template <class TFixedImage, class TMovingImage>
 void
 AdvancedImageToImageMetric<TFixedImage, TMovingImage>::LaunchGetValueThreaderCallback() const
 {
-  /** Setup threader. */
-  Superclass::m_Threader->SetSingleMethod(this->GetValueThreaderCallback, &m_ThreaderMetricParameters);
-
-  /** Launch. */
-  Superclass::m_Threader->SingleMethodExecute();
+  /** Setup threader and launch. */
+  Superclass::m_Threader->SetSingleMethodAndExecute(this->GetValueThreaderCallback, &m_ThreaderMetricParameters);
 
 } // end LaunchGetValueThreaderCallback()
 
@@ -728,11 +725,9 @@ template <class TFixedImage, class TMovingImage>
 void
 AdvancedImageToImageMetric<TFixedImage, TMovingImage>::LaunchGetValueAndDerivativeThreaderCallback() const
 {
-  /** Setup threader. */
-  Superclass::m_Threader->SetSingleMethod(this->GetValueAndDerivativeThreaderCallback, &m_ThreaderMetricParameters);
-
-  /** Launch. */
-  Superclass::m_Threader->SingleMethodExecute();
+  /** Setup threader and launch. */
+  Superclass::m_Threader->SetSingleMethodAndExecute(this->GetValueAndDerivativeThreaderCallback,
+                                                    &m_ThreaderMetricParameters);
 
 } // end LaunchGetValueAndDerivativeThreaderCallback()
 

diff --git a/Common/CostFunctions/itkParzenWindowHistogramImageToImageMetric.hxx b/Common/CostFunctions/itkParzenWindowHistogramImageToImageMetric.hxx
@@ -1244,14 +1244,11 @@ template <class TFixedImage, class TMovingImage>
 void
 ParzenWindowHistogramImageToImageMetric<TFixedImage, TMovingImage>::LaunchComputePDFsThreaderCallback() const
 {
-  /** Setup threader. */
-  this->m_Threader->SetSingleMethod(
+  /** Setup threader and launch. */
+  this->m_Threader->SetSingleMethodAndExecute(
     this->ComputePDFsThreaderCallback,
     const_cast<void *>(static_cast<const void *>(&this->m_ParzenWindowHistogramThreaderParameters)));
 
-  /** Launch. */
-  this->m_Threader->SingleMethodExecute();
-
 } // end LaunchComputePDFsThreaderCallback()
 
 

diff --git a/Common/ImageSamplers/itkImageFullSampler.hxx b/Common/ImageSamplers/itkImageFullSampler.hxx
@@ -118,16 +118,16 @@ ImageFullSampler<TInputImage>::MultiThreadedGenerateData(MultiThreaderBase &
 
   if (mask)
   {
-    multiThreader.SetSingleMethod(elastix::MaskHasSameImageDomain(*mask, inputImage)
-                                    ? &Self::ThreaderCallback<elastix::MaskCondition::HasSameImageDomain>
-                                    : &Self::ThreaderCallback<elastix::MaskCondition::HasDifferentImageDomain>,
-                                  &userData);
+    multiThreader.SetSingleMethodAndExecute(
+      elastix::MaskHasSameImageDomain(*mask, inputImage)
+        ? &Self::ThreaderCallback<elastix::MaskCondition::HasSameImageDomain>
+        : &Self::ThreaderCallback<elastix::MaskCondition::HasDifferentImageDomain>,
+      &userData);
   }
   else
   {
-    multiThreader.SetSingleMethod(&Self::ThreaderCallback<elastix::MaskCondition::IsNull>, &userData);
+    multiThreader.SetSingleMethodAndExecute(&Self::ThreaderCallback<elastix::MaskCondition::IsNull>, &userData);
   }
-  multiThreader.SingleMethodExecute();
 
   if (mask)
   {

diff --git a/Common/ImageSamplers/itkImageGridSampler.hxx b/Common/ImageSamplers/itkImageGridSampler.hxx
@@ -228,16 +228,15 @@ ImageGridSampler<TInputImage>::MultiThreadedGenerateData(MultiThreaderBase &
 
   if (mask)
   {
-    multiThreader.SetSingleMethod(maskHasSameImageDomain
-                                    ? &Self::ThreaderCallback<elastix::MaskCondition::HasSameImageDomain>
-                                    : &Self::ThreaderCallback<elastix::MaskCondition::HasDifferentImageDomain>,
-                                  &userData);
+    multiThreader.SetSingleMethodAndExecute(
+      maskHasSameImageDomain ? &Self::ThreaderCallback<elastix::MaskCondition::HasSameImageDomain>
+                             : &Self::ThreaderCallback<elastix::MaskCondition::HasDifferentImageDomain>,
+      &userData);
   }
   else
   {
-    multiThreader.SetSingleMethod(&Self::ThreaderCallback<elastix::MaskCondition::IsNull>, &userData);
+    multiThreader.SetSingleMethodAndExecute(&Self::ThreaderCallback<elastix::MaskCondition::IsNull>, &userData);
   }
-  multiThreader.SingleMethodExecute();
 
   if (mask)
   {

diff --git a/Common/ImageSamplers/itkImageRandomCoordinateSampler.hxx b/Common/ImageSamplers/itkImageRandomCoordinateSampler.hxx
@@ -75,9 +75,8 @@ ImageRandomCoordinateSampler<TInputImage>::GenerateData()
 
     UserData userData{ m_RandomCoordinates, inputImage, *interpolator, samples };
 
-    MultiThreaderBase & multiThreader = elastix::Deref(this->ProcessObject::GetMultiThreader());
-    multiThreader.SetSingleMethod(&Self::ThreaderCallback, &userData);
-    multiThreader.SingleMethodExecute();
+    elastix::Deref(this->ProcessObject::GetMultiThreader())
+      .SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
     return;
   }
 

diff --git a/Common/ImageSamplers/itkImageRandomSampler.hxx b/Common/ImageSamplers/itkImageRandomSampler.hxx
@@ -53,9 +53,8 @@ ImageRandomSampler<TInputImage>::GenerateData()
       randomNumberList, inputImage, croppedInputImageRegion.GetIndex(), croppedInputImageRegion.GetSize(), samples
     };
 
-    MultiThreaderBase & multiThreader = elastix::Deref(this->ProcessObject::GetMultiThreader());
-    multiThreader.SetSingleMethod(&Self::ThreaderCallback, &userData);
-    multiThreader.SingleMethodExecute();
+    elastix::Deref(this->ProcessObject::GetMultiThreader())
+      .SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
     return;
   }
 

diff --git a/Common/ImageSamplers/itkImageRandomSamplerSparseMask.hxx b/Common/ImageSamplers/itkImageRandomSamplerSparseMask.hxx
@@ -92,9 +92,8 @@ ImageRandomSamplerSparseMask<TInputImage>::GenerateData()
 
     UserData userData{ allValidSamples.CastToSTLConstContainer(), m_RandomIndices, samples };
 
-    MultiThreaderBase & multiThreader = elastix::Deref(this->ProcessObject::GetMultiThreader());
-    multiThreader.SetSingleMethod(&Self::ThreaderCallback, &userData);
-    multiThreader.SingleMethodExecute();
+    elastix::Deref(this->ProcessObject::GetMultiThreader())
+      .SetSingleMethodAndExecute(&Self::ThreaderCallback, &userData);
     return;
   }
 

diff --git a/Common/Transforms/itkAdvancedImageMomentsCalculator.hxx b/Common/Transforms/itkAdvancedImageMomentsCalculator.hxx
@@ -218,11 +218,8 @@ template <typename TImage>
 void
 AdvancedImageMomentsCalculator<TImage>::LaunchComputeThreaderCallback() const
 {
-  /** Setup threader. */
-  this->m_Threader->SetSingleMethod(this->ComputeThreaderCallback, &m_ThreaderParameters);
-
-  /** Launch. */
-  this->m_Threader->SingleMethodExecute();
+  /** Setup threader and launch. */
+  this->m_Threader->SetSingleMethodAndExecute(this->ComputeThreaderCallback, &m_ThreaderParameters);
 
 } // end LaunchComputeThreaderCallback()
 

diff --git a/Common/itkComputeDisplacementDistribution.hxx b/Common/itkComputeDisplacementDistribution.hxx
@@ -284,11 +284,8 @@ template <class TFixedImage, class TTransform>
 void
 ComputeDisplacementDistribution<TFixedImage, TTransform>::LaunchComputeThreaderCallback() const
 {
-  /** Setup threader. */
-  this->m_Threader->SetSingleMethod(this->ComputeThreaderCallback, &m_ThreaderParameters);
-
-  /** Launch. */
-  this->m_Threader->SingleMethodExecute();
+  /** Setup threader and launch. */
+  this->m_Threader->SetSingleMethodAndExecute(this->ComputeThreaderCallback, &m_ThreaderParameters);
 
 } // end LaunchComputeThreaderCallback()
 

diff --git a/Components/Metrics/AdvancedKappaStatistic/itkAdvancedKappaStatisticImageToImageMetric.hxx b/Components/Metrics/AdvancedKappaStatistic/itkAdvancedKappaStatisticImageToImageMetric.hxx
@@ -619,8 +619,7 @@ AdvancedKappaStatisticImageToImageMetric<TFixedImage, TMovingImage>::AfterThread
     userData.st_Coefficient2 = tmp2;
     userData.st_DerivativePointer = derivative.begin();
 
-    this->m_Threader->SetSingleMethod(AccumulateDerivativesThreaderCallback, &userData);
-    this->m_Threader->SingleMethodExecute();
+    this->m_Threader->SetSingleMethodAndExecute(AccumulateDerivativesThreaderCallback, &userData);
   }
 
 } // end AfterThreadedGetValueAndDerivative()

diff --git a/...cs/AdvancedMattesMutualInformation/itkParzenWindowMutualInformationImageToImageMetric.hxx b/...cs/AdvancedMattesMutualInformation/itkParzenWindowMutualInformationImageToImageMetric.hxx
@@ -592,9 +592,8 @@ ParzenWindowMutualInformationImageToImageMetric<TFixedImage, TMovingImage>::Afte
     Superclass::m_ThreaderMetricParameters.st_DerivativePointer = derivative.begin();
     Superclass::m_ThreaderMetricParameters.st_NormalizationFactor = 1.0;
 
-    this->m_Threader->SetSingleMethod(this->AccumulateDerivativesThreaderCallback,
-                                      &(Superclass::m_ThreaderMetricParameters));
-    this->m_Threader->SingleMethodExecute();
+    this->m_Threader->SetSingleMethodAndExecute(this->AccumulateDerivativesThreaderCallback,
+                                                &(Superclass::m_ThreaderMetricParameters));
   }
 
 } // end AfterThreadedComputeDerivativeLowMemory()
@@ -632,14 +631,11 @@ void
 ParzenWindowMutualInformationImageToImageMetric<TFixedImage,
                                                 TMovingImage>::LaunchComputeDerivativeLowMemoryThreaderCallback() const
 {
-  /** Setup threader. */
-  this->m_Threader->SetSingleMethod(
+  /** Setup threader and launch. */
+  this->m_Threader->SetSingleMethodAndExecute(
     this->ComputeDerivativeLowMemoryThreaderCallback,
     const_cast<void *>(static_cast<const void *>(&this->m_ParzenWindowMutualInformationThreaderParameters)));
 
-  /** Launch. */
-  this->m_Threader->SingleMethodExecute();
-
 } // end LaunchComputeDerivativeLowMemoryThreaderCallback()
 
 

diff --git a/Components/Metrics/AdvancedMeanSquares/itkAdvancedMeanSquaresImageToImageMetric.hxx b/Components/Metrics/AdvancedMeanSquares/itkAdvancedMeanSquaresImageToImageMetric.hxx
@@ -686,9 +686,8 @@ AdvancedMeanSquaresImageToImageMetric<TFixedImage, TMovingImage>::AfterThreadedG
     Superclass::m_ThreaderMetricParameters.st_DerivativePointer = derivative.begin();
     Superclass::m_ThreaderMetricParameters.st_NormalizationFactor = 1.0 / normal_sum;
 
-    this->m_Threader->SetSingleMethod(this->AccumulateDerivativesThreaderCallback,
-                                      &(Superclass::m_ThreaderMetricParameters));
-    this->m_Threader->SingleMethodExecute();
+    this->m_Threader->SetSingleMethodAndExecute(this->AccumulateDerivativesThreaderCallback,
+                                                &(Superclass::m_ThreaderMetricParameters));
   }
 #ifdef ELASTIX_USE_OPENMP
   // compute multi-threadedly with openmp

diff --git a/...rics/AdvancedNormalizedCorrelation/itkAdvancedNormalizedCorrelationImageToImageMetric.hxx b/...rics/AdvancedNormalizedCorrelation/itkAdvancedNormalizedCorrelationImageToImageMetric.hxx
@@ -679,8 +679,7 @@ AdvancedNormalizedCorrelationImageToImageMetric<TFixedImage, TMovingImage>::Afte
     userData.st_InvertedDenominator = 1.0 / denom;
     userData.st_DerivativePointer = derivative.begin();
 
-    this->m_Threader->SetSingleMethod(AccumulateDerivativesThreaderCallback, &userData);
-    this->m_Threader->SingleMethodExecute();
+    this->m_Threader->SetSingleMethodAndExecute(AccumulateDerivativesThreaderCallback, &userData);
   }
 #ifdef ELASTIX_USE_OPENMP
   // compute multi-threadedly with openmp

diff --git a/Components/Metrics/BendingEnergyPenalty/itkTransformBendingEnergyPenaltyTerm.hxx b/Components/Metrics/BendingEnergyPenalty/itkTransformBendingEnergyPenaltyTerm.hxx
@@ -587,9 +587,8 @@ TransformBendingEnergyPenaltyTerm<TFixedImage, TScalarType>::AfterThreadedGetVal
     Superclass::m_ThreaderMetricParameters.st_NormalizationFactor =
       static_cast<DerivativeValueType>(this->m_NumberOfPixelsCounted);
 
-    this->m_Threader->SetSingleMethod(this->AccumulateDerivativesThreaderCallback,
-                                      &(Superclass::m_ThreaderMetricParameters));
-    this->m_Threader->SingleMethodExecute();
+    this->m_Threader->SetSingleMethodAndExecute(this->AccumulateDerivativesThreaderCallback,
+                                                &(Superclass::m_ThreaderMetricParameters));
   }
 #ifdef ELASTIX_USE_OPENMP
   // compute multi-threadedly with openmp

diff --git a/Components/Metrics/PCAMetric/itkPCAMetric_F_multithreaded.hxx b/Components/Metrics/PCAMetric/itkPCAMetric_F_multithreaded.hxx
@@ -884,11 +884,9 @@ PCAMetric<TFixedImage, TMovingImage>::LaunchGetSamplesThreaderCallback() const
   // \todo: is a global threader better performance-wise? check
   auto local_threader = ThreaderType::New();
   local_threader->SetNumberOfWorkUnits(Self::GetNumberOfWorkUnits());
-  local_threader->SetSingleMethod(this->GetSamplesThreaderCallback,
-                                  const_cast<void *>(static_cast<const void *>(&this->m_PCAMetricThreaderParameters)));
-
-  /** Launch. */
-  local_threader->SingleMethodExecute();
+  local_threader->SetSingleMethodAndExecute(
+    this->GetSamplesThreaderCallback,
+    const_cast<void *>(static_cast<const void *>(&this->m_PCAMetricThreaderParameters)));
 
 } // end LaunchGetSamplesThreaderCallback()
 
@@ -1084,15 +1082,13 @@ template <class TFixedImage, class TMovingImage>
 void
 PCAMetric<TFixedImage, TMovingImage>::LaunchComputeDerivativeThreaderCallback() const
 {
-  /** Setup local threader. */
+  /** Setup local threader and launch. */
   // \todo: is a global threader better performance-wise? check
   auto local_threader = ThreaderType::New();
   local_threader->SetNumberOfWorkUnits(Self::GetNumberOfWorkUnits());
-  local_threader->SetSingleMethod(this->ComputeDerivativeThreaderCallback,
-                                  const_cast<void *>(static_cast<const void *>(&this->m_PCAMetricThreaderParameters)));
-
-  /** Launch. */
-  local_threader->SingleMethodExecute();
+  local_threader->SetSingleMethodAndExecute(
+    this->ComputeDerivativeThreaderCallback,
+    const_cast<void *>(static_cast<const void *>(&this->m_PCAMetricThreaderParameters)));
 
 } // end LaunchComputeDerivativeThreaderCallback()
 

diff --git a/...redTissueVolumeDifferenceMetric/itkSumSquaredTissueVolumeDifferenceImageToImageMetric.hxx b/...redTissueVolumeDifferenceMetric/itkSumSquaredTissueVolumeDifferenceImageToImageMetric.hxx
@@ -651,9 +651,8 @@ SumSquaredTissueVolumeDifferenceImageToImageMetric<TFixedImage, TMovingImage>::A
     Superclass::m_ThreaderMetricParameters.st_NormalizationFactor =
       static_cast<DerivativeValueType>(this->m_NumberOfPixelsCounted);
 
-    this->m_Threader->SetSingleMethod(this->AccumulateDerivativesThreaderCallback,
-                                      &(Superclass::m_ThreaderMetricParameters));
-    this->m_Threader->SingleMethodExecute();
+    this->m_Threader->SetSingleMethodAndExecute(this->AccumulateDerivativesThreaderCallback,
+                                                &(Superclass::m_ThreaderMetricParameters));
   }
 
 #ifdef ELASTIX_USE_OPENMP

diff --git a/...tochasticVarianceReducedGradient/itkStochasticVarianceReducedGradientDescentOptimizer.cxx b/...tochasticVarianceReducedGradient/itkStochasticVarianceReducedGradientDescentOptimizer.cxx
@@ -291,8 +291,7 @@ StochasticVarianceReducedGradientDescentOptimizer::AdvanceOneStep()
     /** Call multi-threaded AdvanceOneStep(). */
     auto local_threader = ThreaderType::New();
     local_threader->SetNumberOfWorkUnits(this->m_Threader->GetNumberOfWorkUnits());
-    local_threader->SetSingleMethod(AdvanceOneStepThreaderCallback, &temp);
-    local_threader->SingleMethodExecute();
+    local_threader->SetSingleMethodAndExecute(AdvanceOneStepThreaderCallback, &temp);
   }
 
   this->InvokeEvent(IterationEvent());

diff --git a/...ts/Optimizers/StandardStochasticGradientDescent/itkStochasticGradientDescentOptimizer.cxx b/...ts/Optimizers/StandardStochasticGradientDescent/itkStochasticGradientDescentOptimizer.cxx
@@ -290,8 +290,7 @@ StochasticGradientDescentOptimizer::AdvanceOneStep()
     /** Call multi-threaded AdvanceOneStep(). */
     auto local_threader = ThreaderType::New();
     local_threader->SetNumberOfWorkUnits(this->m_Threader->GetNumberOfWorkUnits());
-    local_threader->SetSingleMethod(AdvanceOneStepThreaderCallback, &temp);
-    local_threader->SingleMethodExecute();
+    local_threader->SetSingleMethodAndExecute(AdvanceOneStepThreaderCallback, &temp);
   }
 
   this->InvokeEvent(IterationEvent());

diff --git a/Testing/itkAccumulateDerivativesParallellizationTest.cxx b/Testing/itkAccumulateDerivativesParallellizationTest.cxx
@@ -120,8 +120,8 @@ class MetricTEMP : public itk::Object
       this->m_ThreaderMetricParameters.st_DerivativePointer = derivative.begin();
       this->m_ThreaderMetricParameters.st_NormalizationFactor = 1.0 / normal_sum;
 
-      this->m_Threader->SetSingleMethod(this->AccumulateDerivativesThreaderCallback, &this->m_ThreaderMetricParameters);
-      this->m_Threader->SingleMethodExecute();
+      this->m_Threader->SetSingleMethodAndExecute(this->AccumulateDerivativesThreaderCallback,
+                                                  &this->m_ThreaderMetricParameters);
     }
 #ifdef ELASTIX_USE_OPENMP
     // compute multi-threadedly with openmp

diff --git a/Testing/itkAdvanceOneStepParallellizationTest.cxx b/Testing/itkAdvanceOneStepParallellizationTest.cxx
@@ -162,8 +162,7 @@ class OptimizerTEMP : public itk::Object
       userData.t_Optimizer = this;
 
       /** Call multi-threaded AdvanceOneStep(). */
-      this->m_Threader->SetSingleMethod(AdvanceOneStepThreaderCallback, &userData);
-      this->m_Threader->SingleMethodExecute();
+      this->m_Threader->SetSingleMethodAndExecute(AdvanceOneStepThreaderCallback, &userData);
     }
   } // end