ITK  6.0.0
Insight Toolkit
itkFastSymmetricForcesDemonsRegistrationFunction.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * https://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkFastSymmetricForcesDemonsRegistrationFunction_h
19 #define itkFastSymmetricForcesDemonsRegistrationFunction_h
20 
22 #include "itkPoint.h"
25 #include "itkWarpImageFilter.h"
26 #include <mutex>
27 
28 namespace itk
29 {
46 template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
48  : public PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>
49 {
50 public:
51  ITK_DISALLOW_COPY_AND_MOVE(FastSymmetricForcesDemonsRegistrationFunction);
52 
58 
60  itkNewMacro(Self);
61 
63  itkOverrideGetNameOfClassMacro(FastSymmetricForcesDemonsRegistrationFunction);
64 
66  using typename Superclass::MovingImageType;
67  using typename Superclass::MovingImagePointer;
68 
70  using typename Superclass::FixedImageType;
71  using typename Superclass::FixedImagePointer;
74  using SpacingType = typename FixedImageType::SpacingType;
75 
77  using typename Superclass::DisplacementFieldType;
78  using typename Superclass::DisplacementFieldTypePointer;
79 
81  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
82 
84  using typename Superclass::PixelType;
85  using typename Superclass::RadiusType;
86  using typename Superclass::NeighborhoodType;
87  using typename Superclass::FloatOffsetType;
88  using typename Superclass::TimeStepType;
89 
91  using CoordinateType = double;
92 #ifndef ITK_FUTURE_LEGACY_REMOVE
93  using CoordRepType [[deprecated("ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!")]] =
95 #endif
100 
104 
107 
111 
114 
116  void
118  {
119  m_MovingImageInterpolator = ptr;
120  m_MovingImageWarper->SetInterpolator(ptr);
121  }
125  InterpolatorType *
127  {
128  return m_MovingImageInterpolator;
129  }
130 
132  TimeStepType
133  ComputeGlobalTimeStep(void * itkNotUsed(GlobalData)) const override
134  {
135  return m_TimeStep;
136  }
137 
140  void *
141  GetGlobalDataPointer() const override
142  {
143  auto * global = new GlobalDataStruct();
144 
145  global->m_SumOfSquaredDifference = 0.0;
146  global->m_NumberOfPixelsProcessed = 0L;
147  global->m_SumOfSquaredChange = 0;
148  return global;
149  }
150 
155  void
156  ReleaseGlobalDataPointer(void * GlobalData) const override;
157 
159  void
160  InitializeIteration() override;
161 
166  PixelType
167  ComputeUpdate(const NeighborhoodType & neighborhood,
168  void * globalData,
169  const FloatOffsetType & offset = FloatOffsetType(0.0)) override;
170 
174  virtual double
175  GetMetric() const
176  {
177  return m_Metric;
178  }
179 
181  virtual const double &
182  GetRMSChange() const
183  {
184  return m_RMSChange;
185  }
186 
191  virtual void
192  SetIntensityDifferenceThreshold(double);
193 
194  virtual double
195  GetIntensityDifferenceThreshold() const;
196 
197 protected:
199  ~FastSymmetricForcesDemonsRegistrationFunction() override = default;
200  void
201  PrintSelf(std::ostream & os, Indent indent) const override;
202 
205 
209  {
213  };
214 
215 private:
217  double m_Normalizer{};
218 
220  GradientCalculatorPointer m_FixedImageGradientCalculator{};
221 
223  MovingGradientCalculatorPointer m_WarpedMovingImageGradientCalculator{};
224 
226  InterpolatorPointer m_MovingImageInterpolator{};
227 
229  WarperPointer m_MovingImageWarper{};
230 
232  TimeStepType m_TimeStep{};
233 
235  double m_DenominatorThreshold{};
236 
238  double m_IntensityDifferenceThreshold{};
239 
243  mutable double m_Metric{};
244  mutable double m_SumOfSquaredDifference{};
245  mutable SizeValueType m_NumberOfPixelsProcessed{};
246  mutable double m_RMSChange{};
247  mutable double m_SumOfSquaredChange{};
248 
250  mutable std::mutex m_MetricCalculationMutex{};
251 };
252 } // end namespace itk
253 
254 #ifndef ITK_MANUAL_INSTANTIATION
255 # include "itkFastSymmetricForcesDemonsRegistrationFunction.hxx"
256 #endif
257 
258 #endif
Pointer
SmartPointer< Self > Pointer
Definition: itkAddImageFilter.h:93
itk::FastSymmetricForcesDemonsRegistrationFunction::GetRMSChange
virtual const double & GetRMSChange() const
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:182
itk::FiniteDifferenceFunction< TDisplacementField >::RadiusType
typename ConstNeighborhoodIterator< TDisplacementField >::RadiusType RadiusType
Definition: itkFiniteDifferenceFunction.h:97
itk::FastSymmetricForcesDemonsRegistrationFunction::GlobalDataStruct::m_NumberOfPixelsProcessed
SizeValueType m_NumberOfPixelsProcessed
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:211
itkPoint.h
itk::FastSymmetricForcesDemonsRegistrationFunction::GetMovingImageInterpolator
InterpolatorType * GetMovingImageInterpolator()
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:126
itk::GTest::TypedefsAndConstructors::Dimension2::PointType
ImageBaseType::PointType PointType
Definition: itkGTestTypedefsAndConstructors.h:51
itkPDEDeformableRegistrationFunction.h
itk::CentralDifferenceImageFunction
Calculate the derivative by central differencing.
Definition: itkCentralDifferenceImageFunction.h:76
itk::Vector
A templated class holding a n-Dimensional vector.
Definition: itkVector.h:62
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::FastSymmetricForcesDemonsRegistrationFunction::CoordinateType
double CoordinateType
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:91
itk::FastSymmetricForcesDemonsRegistrationFunction
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:47
itk::FastSymmetricForcesDemonsRegistrationFunction::WarperPointer
typename WarperType::Pointer WarperPointer
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:103
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::FastSymmetricForcesDemonsRegistrationFunction::GetGlobalDataPointer
void * GetGlobalDataPointer() const override
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:141
itk::FastSymmetricForcesDemonsRegistrationFunction::MovingGradientCalculatorPointer
typename MovingGradientCalculatorType::Pointer MovingGradientCalculatorPointer
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:113
itkWarpImageFilter.h
itk::FastSymmetricForcesDemonsRegistrationFunction::SpacingType
typename FixedImageType::SpacingType SpacingType
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:74
itk::FastSymmetricForcesDemonsRegistrationFunction::GlobalDataStruct::m_SumOfSquaredDifference
double m_SumOfSquaredDifference
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:210
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::LinearInterpolateImageFunction
Linearly interpolate an image at specified positions.
Definition: itkLinearInterpolateImageFunction.h:51
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:55
itkCentralDifferenceImageFunction.h
itk::FastSymmetricForcesDemonsRegistrationFunction::GlobalDataStruct
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:208
itk::FastSymmetricForcesDemonsRegistrationFunction::PointType
typename InterpolatorType::PointType PointType
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:98
itk::FastSymmetricForcesDemonsRegistrationFunction::SizeType
typename FixedImageType::SizeType SizeType
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:73
itk::FastSymmetricForcesDemonsRegistrationFunction::GradientCalculatorPointer
typename GradientCalculatorType::Pointer GradientCalculatorPointer
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:110
itk::PDEDeformableRegistrationFunction
Definition: itkPDEDeformableRegistrationFunction.h:41
itk::FiniteDifferenceFunction< TDisplacementField >::PixelType
typename ImageType::PixelType PixelType
Definition: itkFiniteDifferenceFunction.h:83
itk::CovariantVector
A templated class holding a n-Dimensional covariant vector.
Definition: itkCovariantVector.h:70
itk::FastSymmetricForcesDemonsRegistrationFunction::ComputeGlobalTimeStep
TimeStepType ComputeGlobalTimeStep(void *) const override
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:133
itk::FastSymmetricForcesDemonsRegistrationFunction::IndexType
typename FixedImageType::IndexType IndexType
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:72
itk::FastSymmetricForcesDemonsRegistrationFunction::SetMovingImageInterpolator
void SetMovingImageInterpolator(InterpolatorType *ptr)
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:117
itk::WarpImageFilter
Warps an image using an input displacement field.
Definition: itkWarpImageFilter.h:85
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnatomicalOrientation.h:29
itk::ConstNeighborhoodIterator
Const version of NeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pi...
Definition: itkConstNeighborhoodIterator.h:51
itk::FiniteDifferenceFunction< TDisplacementField >
itk::FastSymmetricForcesDemonsRegistrationFunction::GlobalDataStruct::m_SumOfSquaredChange
double m_SumOfSquaredChange
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:212
itkInterpolateImageFunction.h
itk::FastSymmetricForcesDemonsRegistrationFunction::InterpolatorPointer
typename InterpolatorType::Pointer InterpolatorPointer
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:97
itk::FastSymmetricForcesDemonsRegistrationFunction::GetMetric
virtual double GetMetric() const
Definition: itkFastSymmetricForcesDemonsRegistrationFunction.h:175
itk::InterpolateImageFunction
Base class for all image interpolators.
Definition: itkInterpolateImageFunction.h:45
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:86
itk::FiniteDifferenceFunction< TDisplacementField >::TimeStepType
double TimeStepType
Definition: itkFiniteDifferenceFunction.h:90