1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkPDEDeformableRegistrationFunction_h
#define itkPDEDeformableRegistrationFunction_h
#include "itkFiniteDifferenceFunction.h"
namespace itk
{
/** \class PDEDeformableRegistrationFunction
*
* This is an abstract base class for all PDE functions which drives a
* deformable registration algorithm. It is used by
* PDEDeformationRegistrationFilter subclasses to compute the
* output deformation field which will map a moving image onto
* a fixed image.
*
* This class is templated over the fixed image type, moving image type
* and the deformation field type.
*
* \sa PDEDeformableRegistrationFilter
* \ingroup FiniteDifferenceFunctions
* \ingroup ITKRegistrationCommon
*/
template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class ITK_TEMPLATE_EXPORT PDEDeformableRegistrationFunction : public FiniteDifferenceFunction<TDisplacementField>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(PDEDeformableRegistrationFunction);
/** Standard class type aliases. */
using Self = PDEDeformableRegistrationFunction;
using Superclass = FiniteDifferenceFunction<TDisplacementField>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(PDEDeformableRegistrationFunction);
/** MovingImage image type. */
using MovingImageType = TMovingImage;
using MovingImagePointer = typename MovingImageType::ConstPointer;
/** FixedImage image type. */
using FixedImageType = TFixedImage;
using FixedImagePointer = typename FixedImageType::ConstPointer;
/** Deformation field type. */
using DisplacementFieldType = TDisplacementField;
using DisplacementFieldTypePointer = typename DisplacementFieldType::Pointer;
/** Set the moving image. */
void
SetMovingImage(const MovingImageType * ptr)
{
m_MovingImage = ptr;
}
/** Get the moving image. */
const MovingImageType *
GetMovingImage() const
{
return m_MovingImage;
}
/** Set the fixed image. */
void
SetFixedImage(const FixedImageType * ptr)
{
m_FixedImage = ptr;
}
/** Get the fixed image. */
const FixedImageType *
GetFixedImage() const
{
return m_FixedImage;
}
/** Set the deformation field image. */
void
SetDisplacementField(DisplacementFieldTypePointer ptr)
{
m_DisplacementField = ptr;
}
/** Get the deformation field. This function should have been
* declared const. It is not for backward compatibility reasons. */
DisplacementFieldType *
GetDisplacementField()
{
return m_DisplacementField;
}
void
SetEnergy(double e)
{
m_Energy = e;
}
double
GetEnergy() const
{
return m_Energy;
}
void
SetGradientStep(double e)
{
m_GradientStep = e;
}
double
GetGradientStep() const
{
return m_GradientStep;
}
void
SetNormalizeGradient(bool e)
{
m_NormalizeGradient = e;
}
bool
GetNormalizeGradient() const
{
return m_NormalizeGradient;
}
protected:
PDEDeformableRegistrationFunction()
{
m_MovingImage = nullptr;
m_FixedImage = nullptr;
m_DisplacementField = nullptr;
m_Energy = 0.0;
m_NormalizeGradient = true;
m_GradientStep = 1.0;
}
~PDEDeformableRegistrationFunction() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override
{
Superclass::PrintSelf(os, indent);
os << indent << "MovingImage: ";
os << m_MovingImage.GetPointer() << std::endl;
os << indent << "FixedImage: ";
os << m_FixedImage.GetPointer() << std::endl;
}
/** The moving image. */
MovingImagePointer m_MovingImage{};
/** The fixed image. */
FixedImagePointer m_FixedImage{};
/** The deformation field. */
DisplacementFieldTypePointer m_DisplacementField{};
mutable double m_Energy{};
bool m_NormalizeGradient{};
mutable double m_GradientStep{};
};
} // end namespace itk
#endif
|
