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
28namespace itk
29{
46template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
48 : public PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>
49{
50public:
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 CoordRepType = double;
96
100
103
107
110
112 void
114 {
115 m_MovingImageInterpolator = ptr;
116 m_MovingImageWarper->SetInterpolator(ptr);
117 }
121 InterpolatorType *
123 {
124 return m_MovingImageInterpolator;
125 }
126
128 TimeStepType
129 ComputeGlobalTimeStep(void * itkNotUsed(GlobalData)) const override
130 {
131 return m_TimeStep;
132 }
133
136 void *
137 GetGlobalDataPointer() const override
138 {
139 auto * global = new GlobalDataStruct();
140
141 global->m_SumOfSquaredDifference = 0.0;
142 global->m_NumberOfPixelsProcessed = 0L;
143 global->m_SumOfSquaredChange = 0;
144 return global;
145 }
146
151 void
152 ReleaseGlobalDataPointer(void * GlobalData) const override;
153
155 void
157
163 ComputeUpdate(const NeighborhoodType & neighborhood,
164 void * globalData,
165 const FloatOffsetType & offset = FloatOffsetType(0.0)) override;
166
170 virtual double
171 GetMetric() const
172 {
173 return m_Metric;
174 }
175
177 virtual const double &
179 {
180 return m_RMSChange;
181 }
182
187 virtual void
189
190 virtual double
192
193protected:
196 void
197 PrintSelf(std::ostream & os, Indent indent) const override;
198
201
205 {
209 };
210
211private:
213 double m_Normalizer{};
214
216 GradientCalculatorPointer m_FixedImageGradientCalculator{};
217
219 MovingGradientCalculatorPointer m_WarpedMovingImageGradientCalculator{};
220
222 InterpolatorPointer m_MovingImageInterpolator{};
223
225 WarperPointer m_MovingImageWarper{};
226
228 TimeStepType m_TimeStep{};
229
231 double m_DenominatorThreshold{};
232
234 double m_IntensityDifferenceThreshold{};
235
239 mutable double m_Metric{};
240 mutable double m_SumOfSquaredDifference{};
241 mutable SizeValueType m_NumberOfPixelsProcessed{};
242 mutable double m_RMSChange{};
243 mutable double m_SumOfSquaredChange{};
244
246 mutable std::mutex m_MetricCalculationMutex{};
247};
248} // end namespace itk
249
250#ifndef ITK_MANUAL_INSTANTIATION
251# include "itkFastSymmetricForcesDemonsRegistrationFunction.hxx"
252#endif
253
254#endif
Calculate the derivative by central differencing.
Const version of NeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pi...
A templated class holding a n-Dimensional covariant vector.
PixelType ComputeUpdate(const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
void ReleaseGlobalDataPointer(void *GlobalData) const override
void PrintSelf(std::ostream &os, Indent indent) const override
typename ConstNeighborhoodIterator< TDisplacementField >::RadiusType RadiusType
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Base class for all image interpolators.
Light weight base class for most itk classes.
Linearly interpolate an image at specified positions.
A templated class holding a n-Dimensional vector.
Definition: itkVector.h:63
Warps an image using an input displacement field.
SmartPointer< Self > Pointer
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
unsigned long SizeValueType
Definition: itkIntTypes.h:86