ITK  6.0.0
Insight Toolkit
itkConstantVelocityFieldTransform.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 itkConstantVelocityFieldTransform_h
19#define itkConstantVelocityFieldTransform_h
20
22
23namespace itk
24{
25
35template <typename TParametersValueType, unsigned int VDimension>
36class ITK_TEMPLATE_EXPORT ConstantVelocityFieldTransform
37 : public DisplacementFieldTransform<TParametersValueType, VDimension>
38{
39public:
40 ITK_DISALLOW_COPY_AND_MOVE(ConstantVelocityFieldTransform);
41
47
49 itkOverrideGetNameOfClassMacro(ConstantVelocityFieldTransform);
50
52 itkNewMacro(Self);
53
55 using typename Superclass::InverseTransformBasePointer;
56
58 using typename Superclass::ScalarType;
59
61 using typename Superclass::FixedParametersType;
62 using typename Superclass::FixedParametersValueType;
63 using typename Superclass::ParametersType;
64 using typename Superclass::ParametersValueType;
65
67 using typename Superclass::TransformCategoryEnum;
68
70 using typename Superclass::NumberOfParametersType;
71
73 using typename Superclass::InputPointType;
74 using typename Superclass::OutputPointType;
75
77 using typename Superclass::InputVectorType;
78 using typename Superclass::OutputVectorType;
79
80 using typename Superclass::InputVectorPixelType;
81 using typename Superclass::OutputVectorPixelType;
82
84 using typename Superclass::DerivativeType;
85
87 static constexpr unsigned int ConstantVelocityFieldDimension = VDimension;
88
90 static constexpr unsigned int Dimension = VDimension;
91
93 using typename Superclass::DisplacementFieldType;
95
99
108
110
113
117
122 virtual void
124 itkGetModifiableObjectMacro(ConstantVelocityField, ConstantVelocityFieldType);
127 void
129
132 virtual void
134 itkGetModifiableObjectMacro(ConstantVelocityFieldInterpolator, ConstantVelocityFieldInterpolatorType);
138 itkGetConstReferenceMacro(ConstantVelocityFieldSetTime, ModifiedTimeType);
139
140 void
141 UpdateTransformParameters(const DerivativeType & update, ScalarType factor = 1.0) override;
142
144 bool
145 GetInverse(Self * inverse) const;
146
149 GetInverseTransform() const override;
150
153 virtual void
155
156 // Set/get compute number of exp. integration steps automatically
157 itkSetMacro(CalculateNumberOfIntegrationStepsAutomatically, bool);
158 itkGetConstMacro(CalculateNumberOfIntegrationStepsAutomatically, bool);
159 itkBooleanMacro(CalculateNumberOfIntegrationStepsAutomatically);
160
165 itkSetClampMacro(LowerTimeBound, ScalarType, 0, 1);
166
171 itkGetConstMacro(LowerTimeBound, ScalarType);
172
177 itkSetClampMacro(UpperTimeBound, ScalarType, 0, 1);
178
183 itkGetConstMacro(UpperTimeBound, ScalarType);
184
188 itkSetMacro(NumberOfIntegrationSteps, unsigned int);
189
193 itkGetConstMacro(NumberOfIntegrationSteps, unsigned int);
194
195protected:
198 void
199 PrintSelf(std::ostream & os, Indent indent) const override;
200
202 typename LightObject::Pointer
203 InternalClone() const override;
204
207
208 ConstantVelocityFieldPointer m_ConstantVelocityField{};
209
210 bool m_CalculateNumberOfIntegrationStepsAutomatically{ false };
211
213 ConstantVelocityFieldInterpolatorPointer m_ConstantVelocityFieldInterpolator{};
214
217 ModifiedTimeType m_ConstantVelocityFieldSetTime{ 0 };
218
219 ScalarType m_LowerTimeBound{};
220 ScalarType m_UpperTimeBound{};
221
222 unsigned int m_NumberOfIntegrationSteps{};
223
224private:
229 virtual void
231};
232
233} // end namespace itk
234
235#ifndef ITK_MANUAL_INSTANTIATION
236# include "itkConstantVelocityFieldTransform.hxx"
237#endif
238
239#endif // itkConstantVelocityFieldTransform_h
OptimizerParameters< FixedParametersValueType > FixedParametersType
SmartPointer< const Self > ConstPointer
SmartPointer< Self > Pointer
Array class with size defined at construction time.
Definition: itkArray.h:48
Provides local/dense/high-dimensionality transformation via a a constant velocity field.
virtual void SetConstantVelocityFieldInterpolator(ConstantVelocityFieldInterpolatorType *)
~ConstantVelocityFieldTransform() override=default
DisplacementFieldType::Pointer CopyDisplacementField(const DisplacementFieldType *) const
virtual void SetConstantVelocityField(ConstantVelocityFieldType *)
virtual void SetFixedParametersFromConstantVelocityField() const
typename ConstantVelocityFieldType::SizeType SizeType
typename ConstantVelocityFieldType::DirectionType DirectionType
void SetFixedParameters(const FixedParametersType &) override
typename ConstantVelocityFieldInterpolatorType::Pointer ConstantVelocityFieldInterpolatorPointer
LightObject::Pointer InternalClone() const override
typename ConstantVelocityFieldType::RegionType RegionType
typename ConstantVelocityFieldType::PixelType PixelType
typename DisplacementFieldType::Pointer DisplacementFieldPointer
typename ConstantVelocityFieldType::IndexType IndexType
void PrintSelf(std::ostream &os, Indent indent) const override
typename ConstantVelocityFieldType::SpacingType SpacingType
typename ConstantVelocityFieldType::Pointer ConstantVelocityFieldPointer
typename ConstantVelocityFieldType::PointType PointType
InverseTransformBasePointer GetInverseTransform() const override
bool GetInverse(Self *inverse) const
void UpdateTransformParameters(const DerivativeType &update, ScalarType factor=1.0) override
Provides local/dense/high-dimensionality transformation via a a displacement field.
Class to hold and manage parameters of type Image<Vector<...>,...>, used in Transforms,...
Templated n-dimensional image class.
Definition: itkImage.h:89
TPixel PixelType
Definition: itkImage.h:108
Control indentation during Print() invocation.
Definition: itkIndent.h:50
typename InverseTransformBaseType::Pointer InverseTransformBasePointer
Definition: itkTransform.h:167
Base class for all vector image interpolators.
SmartPointer< Self > Pointer
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
SizeValueType ModifiedTimeType
Definition: itkIntTypes.h:105