ITK  5.3.0
Insight Toolkit
itkDemonsRegistrationFunction.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  * http://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 itkDemonsRegistrationFunction_h
19 #define itkDemonsRegistrationFunction_h
20 
22 #include "itkPoint.h"
25 #include <mutex>
26 
27 namespace itk
28 {
53 template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
54 class ITK_TEMPLATE_EXPORT DemonsRegistrationFunction
55  : public PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>
56 {
57 public:
58  ITK_DISALLOW_COPY_AND_MOVE(DemonsRegistrationFunction);
59 
65 
67  itkNewMacro(Self);
68 
71 
73  using typename Superclass::MovingImageType;
74  using typename Superclass::MovingImagePointer;
75 
77  using typename Superclass::FixedImageType;
78  using typename Superclass::FixedImagePointer;
81  using SpacingType = typename FixedImageType::SpacingType;
82 
84  using typename Superclass::DisplacementFieldType;
85  using typename Superclass::DisplacementFieldTypePointer;
86 
88  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
89 
91  using typename Superclass::PixelType;
92  using typename Superclass::RadiusType;
93  using typename Superclass::NeighborhoodType;
94  using typename Superclass::FloatOffsetType;
95  using typename Superclass::TimeStepType;
96 
98  using CoordRepType = double;
103 
106 
110 
114 
116  void
118  {
119  m_MovingImageInterpolator = ptr;
120  }
121 
123  InterpolatorType *
125  {
126  return m_MovingImageInterpolator;
127  }
128 
130  TimeStepType
131  ComputeGlobalTimeStep(void * itkNotUsed(GlobalData)) const override
132  {
133  return m_TimeStep;
134  }
135 
138  void *
139  GetGlobalDataPointer() const override
140  {
141  auto * global = new GlobalDataStruct();
142 
143  global->m_SumOfSquaredDifference = 0.0;
144  global->m_NumberOfPixelsProcessed = 0L;
145  global->m_SumOfSquaredChange = 0;
146  return global;
147  }
148 
150  void
151  ReleaseGlobalDataPointer(void * gd) const override;
152 
154  void
155  InitializeIteration() override;
156 
159  PixelType
160  ComputeUpdate(const NeighborhoodType & it, void * gd, const FloatOffsetType & offset = FloatOffsetType(0.0)) override;
161 
165  virtual double
166  GetMetric() const
167  {
168  return m_Metric;
169  }
170 
172  virtual double
173  GetRMSChange() const
174  {
175  return m_RMSChange;
176  }
177 
181  virtual void
183  {
184  m_UseMovingImageGradient = flag;
185  }
186  virtual bool
188  {
189  return m_UseMovingImageGradient;
190  }
192 
197  virtual void
198  SetIntensityDifferenceThreshold(double);
199 
200  virtual double
201  GetIntensityDifferenceThreshold() const;
202 
203 protected:
205  ~DemonsRegistrationFunction() override = default;
206  void
207  PrintSelf(std::ostream & os, Indent indent) const override;
208 
211 
215  {
219  };
220 
221 private:
223  // SpacingType m_FixedImageSpacing;
224  // PointType m_FixedImageOrigin;
226  double m_Normalizer;
227 
230 
234 
237 
240 
243 
246 
250  mutable double m_Metric;
251  mutable double m_SumOfSquaredDifference;
253  mutable double m_RMSChange;
254  mutable double m_SumOfSquaredChange;
255 
257  mutable std::mutex m_MetricCalculationLock;
258 };
259 } // end namespace itk
260 
261 #ifndef ITK_MANUAL_INSTANTIATION
262 # include "itkDemonsRegistrationFunction.hxx"
263 #endif
264 
265 #endif
itk::DemonsRegistrationFunction::m_IntensityDifferenceThreshold
double m_IntensityDifferenceThreshold
Definition: itkDemonsRegistrationFunction.h:245
itk::FiniteDifferenceFunction< TDisplacementField >::RadiusType
typename ConstNeighborhoodIterator< TDisplacementField >::RadiusType RadiusType
Definition: itkFiniteDifferenceFunction.h:97
itk::DemonsRegistrationFunction
Definition: itkDemonsRegistrationFunction.h:54
itk::DemonsRegistrationFunction::m_MovingImageGradientCalculator
MovingImageGradientCalculatorPointer m_MovingImageGradientCalculator
Definition: itkDemonsRegistrationFunction.h:232
itk::DemonsRegistrationFunction::SpacingType
typename FixedImageType::SpacingType SpacingType
Definition: itkDemonsRegistrationFunction.h:81
itk::DemonsRegistrationFunction::GlobalDataStruct::m_NumberOfPixelsProcessed
SizeValueType m_NumberOfPixelsProcessed
Definition: itkDemonsRegistrationFunction.h:217
itkLinearInterpolateImageFunction.h
itk::DemonsRegistrationFunction::m_MetricCalculationLock
std::mutex m_MetricCalculationLock
Definition: itkDemonsRegistrationFunction.h:257
itkPoint.h
itk::DemonsRegistrationFunction::m_DenominatorThreshold
double m_DenominatorThreshold
Definition: itkDemonsRegistrationFunction.h:242
itk::DemonsRegistrationFunction::GlobalDataStruct::m_SumOfSquaredChange
double m_SumOfSquaredChange
Definition: itkDemonsRegistrationFunction.h:218
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::DemonsRegistrationFunction::m_ZeroUpdateReturn
PixelType m_ZeroUpdateReturn
Definition: itkDemonsRegistrationFunction.h:225
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::DemonsRegistrationFunction::m_MovingImageInterpolator
InterpolatorPointer m_MovingImageInterpolator
Definition: itkDemonsRegistrationFunction.h:236
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::DemonsRegistrationFunction::m_Metric
double m_Metric
Definition: itkDemonsRegistrationFunction.h:250
itk::DemonsRegistrationFunction::m_FixedImageGradientCalculator
GradientCalculatorPointer m_FixedImageGradientCalculator
Definition: itkDemonsRegistrationFunction.h:229
itk::DemonsRegistrationFunction::m_UseMovingImageGradient
bool m_UseMovingImageGradient
Definition: itkDemonsRegistrationFunction.h:233
itk::DemonsRegistrationFunction::GetUseMovingImageGradient
virtual bool GetUseMovingImageGradient() const
Definition: itkDemonsRegistrationFunction.h:187
itk::DemonsRegistrationFunction::PointType
typename InterpolatorType::PointType PointType
Definition: itkDemonsRegistrationFunction.h:101
itk::DemonsRegistrationFunction::SizeType
typename FixedImageType::SizeType SizeType
Definition: itkDemonsRegistrationFunction.h:80
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::DemonsRegistrationFunction::GetGlobalDataPointer
void * GetGlobalDataPointer() const override
Definition: itkDemonsRegistrationFunction.h:139
itk::LinearInterpolateImageFunction
Linearly interpolate an image at specified positions.
Definition: itkLinearInterpolateImageFunction.h:50
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::DemonsRegistrationFunction::IndexType
typename FixedImageType::IndexType IndexType
Definition: itkDemonsRegistrationFunction.h:79
itkCentralDifferenceImageFunction.h
itk::DemonsRegistrationFunction::CoordRepType
double CoordRepType
Definition: itkDemonsRegistrationFunction.h:98
itk::DemonsRegistrationFunction::InterpolatorPointer
typename InterpolatorType::Pointer InterpolatorPointer
Definition: itkDemonsRegistrationFunction.h:100
itk::DemonsRegistrationFunction::m_SumOfSquaredChange
double m_SumOfSquaredChange
Definition: itkDemonsRegistrationFunction.h:254
itk::DemonsRegistrationFunction::GetMetric
virtual double GetMetric() const
Definition: itkDemonsRegistrationFunction.h:166
itk::PDEDeformableRegistrationFunction
Definition: itkPDEDeformableRegistrationFunction.h:41
itk::FiniteDifferenceFunction< TDisplacementField >::PixelType
typename ImageType::PixelType PixelType
Definition: itkFiniteDifferenceFunction.h:83
itk::DemonsRegistrationFunction::GetRMSChange
virtual double GetRMSChange() const
Definition: itkDemonsRegistrationFunction.h:173
itk::DemonsRegistrationFunction::ComputeGlobalTimeStep
TimeStepType ComputeGlobalTimeStep(void *) const override
Definition: itkDemonsRegistrationFunction.h:131
itk::CovariantVector
A templated class holding a n-Dimensional covariant vector.
Definition: itkCovariantVector.h:70
itk::DemonsRegistrationFunction::SetMovingImageInterpolator
void SetMovingImageInterpolator(InterpolatorType *ptr)
Definition: itkDemonsRegistrationFunction.h:117
itk::DemonsRegistrationFunction::SetUseMovingImageGradient
virtual void SetUseMovingImageGradient(bool flag)
Definition: itkDemonsRegistrationFunction.h:182
itk::DemonsRegistrationFunction::m_SumOfSquaredDifference
double m_SumOfSquaredDifference
Definition: itkDemonsRegistrationFunction.h:251
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::DemonsRegistrationFunction::m_RMSChange
double m_RMSChange
Definition: itkDemonsRegistrationFunction.h:253
itk::ConstNeighborhoodIterator
Const version of NeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pi...
Definition: itkConstNeighborhoodIterator.h:51
itk::DemonsRegistrationFunction::MovingImageGradientCalculatorPointer
typename MovingImageGradientCalculatorType::Pointer MovingImageGradientCalculatorPointer
Definition: itkDemonsRegistrationFunction.h:113
itk::DemonsRegistrationFunction::GlobalDataStruct::m_SumOfSquaredDifference
double m_SumOfSquaredDifference
Definition: itkDemonsRegistrationFunction.h:216
itk::DemonsRegistrationFunction::GetMovingImageInterpolator
InterpolatorType * GetMovingImageInterpolator()
Definition: itkDemonsRegistrationFunction.h:124
itk::DemonsRegistrationFunction::m_TimeStep
TimeStepType m_TimeStep
Definition: itkDemonsRegistrationFunction.h:239
itk::FiniteDifferenceFunction< TDisplacementField >
itk::DemonsRegistrationFunction::m_NumberOfPixelsProcessed
SizeValueType m_NumberOfPixelsProcessed
Definition: itkDemonsRegistrationFunction.h:252
itk::DemonsRegistrationFunction::GlobalDataStruct
Definition: itkDemonsRegistrationFunction.h:214
itk::DemonsRegistrationFunction::GradientCalculatorPointer
typename GradientCalculatorType::Pointer GradientCalculatorPointer
Definition: itkDemonsRegistrationFunction.h:109
itk::InterpolateImageFunction
Base class for all image interpolators.
Definition: itkInterpolateImageFunction.h:45
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83
itk::DemonsRegistrationFunction::m_Normalizer
double m_Normalizer
Definition: itkDemonsRegistrationFunction.h:226
itk::FiniteDifferenceFunction< TDisplacementField >::TimeStepType
double TimeStepType
Definition: itkFiniteDifferenceFunction.h:90