forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkTimeVaryingVelocityFieldTransformParametersAdaptor.h
144 lines (124 loc) · 5.28 KB
/
itkTimeVaryingVelocityFieldTransformParametersAdaptor.h
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
/*=========================================================================
*
* 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
*
* http://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 itkTimeVaryingVelocityFieldTransformParametersAdaptor_h
#define itkTimeVaryingVelocityFieldTransformParametersAdaptor_h
#include "itkTransformParametersAdaptor.h"
namespace itk
{
/** \class TimeVaryingVelocityFieldTransformParametersAdaptor
* \brief TimeVaryingVelocityFieldTransformParametersAdaptor is a helper class intended to
* definition.
*
* The fixed parameters store the following information:
* field size
* field origin
* field spacing
* field direction
* During multiresolution image registration it is often desired to also increase
* the displacement field resolution for greater flexibility in optimizing the
* transform. As defined in the base class, the user can change the resolution via
*
\code
transformAdaptor->SetTransform( transform );
transformAdaptor->SetRequiredFixedParameters( fixedParameters );
transformAdaptor->AdaptTransformParameters();
\endcode
*
* or the user can use the more intuitive API for setting the fixed parameters.
* E.g., often the user will want to maintain the same transform domain spatial
* extent but only increase the field size and decrease the spacing. This can
* be done as follows:
*
\code
transformAdaptor->SetTransform( transform );
transformAdaptor->SetRequiredOrigin( displacementField->GetOrigin() );
transformAdaptor->SetRequiredDirection( displacementField->GetDirection() );
transformAdaptor->SetRequiredSize( requiredSize );
transformAdaptor->SetRequiredSpacing( requiredSpacing );
transformAdaptor->AdaptTransformParameters();
\endcode
*
* \author Nick Tustison
* \author Brian Avants
*
* \ingroup ITKRegistrationCommon
*/
template <typename TTransform>
class ITK_TEMPLATE_EXPORT TimeVaryingVelocityFieldTransformParametersAdaptor
: public TransformParametersAdaptor<TTransform>
{
public:
ITK_DISALLOW_COPY_AND_ASSIGN(TimeVaryingVelocityFieldTransformParametersAdaptor);
/** Standard class type aliases. */
using Self = TimeVaryingVelocityFieldTransformParametersAdaptor;
using Superclass = TransformParametersAdaptor<TTransform>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** New macro for creation of through a Smart Pointer. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(TimeVaryingVelocityFieldTransformParametersAdaptor, TransformParametersAdaptor);
/** Typedefs associated with the transform */
using TransformType = TTransform;
using TransformPointer = typename TransformType::Pointer;
using ParametersType = typename TransformType::ParametersType;
using ParametersValueType = typename TransformType::ParametersValueType;
using TimeVaryingVelocityFieldType = typename TransformType::TimeVaryingVelocityFieldType;
using TimeVaryingVelocityFieldPointer = typename TimeVaryingVelocityFieldType::Pointer;
using PointType = typename TimeVaryingVelocityFieldType::PointType;
using SizeType = typename TimeVaryingVelocityFieldType::SizeType;
using DirectionType = typename TimeVaryingVelocityFieldType::DirectionType;
using SpacingType = typename TimeVaryingVelocityFieldType::SpacingType;
/** Dimension of parameters. */
static constexpr unsigned int TotalDimension = TransformType::Dimension + 1;
/** Alternative method for setting the required size. */
void
SetRequiredSize(const SizeType &);
/** Get the required size. */
virtual const SizeType
GetRequiredSize() const;
/** Alternative method for setting the required origin. */
void
SetRequiredOrigin(const PointType &);
/** Get the required origin. */
virtual const PointType
GetRequiredOrigin() const;
/** Alternative method for setting the required spacing. */
void
SetRequiredSpacing(const SpacingType &);
/** Get the required spacing. */
virtual const SpacingType
GetRequiredSpacing() const;
/** Alternative method for setting the required direction. */
void
SetRequiredDirection(const DirectionType &);
/** Get the required direction. */
virtual const DirectionType
GetRequiredDirection() const;
/** Initialize the transform using the specified fixed parameters */
void
AdaptTransformParameters() override;
protected:
TimeVaryingVelocityFieldTransformParametersAdaptor();
~TimeVaryingVelocityFieldTransformParametersAdaptor() override = default;
}; // class TimeVaryingVelocityFieldTransformParametersAdaptor
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkTimeVaryingVelocityFieldTransformParametersAdaptor.hxx"
#endif
#endif /* itkTimeVaryingVelocityFieldTransformParametersAdaptor_h */