ITK  5.2.0
Insight Toolkit
itkTimeVaryingVelocityFieldTransform.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 itkTimeVaryingVelocityFieldTransform_h
19 #define itkTimeVaryingVelocityFieldTransform_h
20 
22 
23 namespace itk
24 {
25 
53 template <typename TParametersValueType, unsigned int NDimensions>
54 class ITK_TEMPLATE_EXPORT TimeVaryingVelocityFieldTransform
55  : public VelocityFieldTransform<TParametersValueType, NDimensions>
56 {
57 public:
58  ITK_DISALLOW_COPY_AND_ASSIGN(TimeVaryingVelocityFieldTransform);
59 
65 
68 
70  itkNewMacro(Self);
71 
73  using InverseTransformBasePointer = typename Superclass::InverseTransformBasePointer;
74 
76  using InterpolatorType = typename Superclass::InterpolatorType;
77  using VelocityFieldIntegratorType = typename Superclass::VelocityFieldInterpolatorType;
78 
80  using DisplacementFieldType = typename Superclass::DisplacementFieldType;
81  using VelocityFieldType = typename Superclass::VelocityFieldType;
82 
84  using TimeVaryingVelocityFieldPointer = typename VelocityFieldType::Pointer;
85 
87  using ScalarType = typename Superclass::ScalarType;
88 
90  using ParametersType = typename Superclass::ParametersType;
92  using FixedParametersType = typename Superclass::FixedParametersType;
94  using NumberOfParametersType = typename Superclass::NumberOfParametersType;
95 
97  using DerivativeType = typename Superclass::DerivativeType;
98 
100 
102 #if !defined(ITK_LEGACY_REMOVE)
104  GetTimeVaryingVelocityField()
105  {
106  return this->GetModifiableVelocityField();
107  }
108 #endif
109  VelocityFieldType *
111  {
112  return this->GetModifiableVelocityField();
113  }
114  const VelocityFieldType *
116  {
117  return this->GetVelocityField();
118  }
120 
122  virtual void
124  {
125  this->SetVelocityField(field);
126  }
127 
130  void
131  IntegrateVelocityField() override;
132 
133 protected:
135  ~TimeVaryingVelocityFieldTransform() override = default;
136 };
137 
138 } // end namespace itk
139 
140 #ifndef ITK_MANUAL_INSTANTIATION
141 # include "itkTimeVaryingVelocityFieldTransform.hxx"
142 #endif
143 
144 #endif // itkTimeVaryingVelocityFieldTransform_h
itk::OptimizerParameters
Class to hold and manage different parameter types used during optimization.
Definition: itkOptimizerParameters.h:34
itk::TimeVaryingVelocityFieldTransform::VelocityFieldIntegratorType
typename Superclass::VelocityFieldInterpolatorType VelocityFieldIntegratorType
Definition: itkTimeVaryingVelocityFieldTransform.h:77
itk::TimeVaryingVelocityFieldTransform
Transform objects based on integration of a time-varying velocity field.
Definition: itkTimeVaryingVelocityFieldTransform.h:54
itk::TimeVaryingVelocityFieldTransform::VelocityFieldType
typename Superclass::VelocityFieldType VelocityFieldType
Definition: itkTimeVaryingVelocityFieldTransform.h:81
itk::OptimizerParameters::ValueType
TParametersValueType ValueType
Definition: itkOptimizerParameters.h:38
itk::SmartPointer< Self >
itk::VectorInterpolateImageFunction
Base class for all vector image interpolators.
Definition: itkVectorInterpolateImageFunction.h:47
itk::TimeVaryingVelocityFieldTransform::SetTimeVaryingVelocityField
virtual void SetTimeVaryingVelocityField(VelocityFieldType *field)
Definition: itkTimeVaryingVelocityFieldTransform.h:123
itk::DisplacementFieldTransform::DerivativeType
typename Superclass::DerivativeType DerivativeType
Definition: itkDisplacementFieldTransform.h:154
itk::DisplacementFieldTransform::ScalarType
typename Superclass::ScalarType ScalarType
Definition: itkDisplacementFieldTransform.h:107
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::TimeVaryingVelocityFieldTransform::GetModifiableTimeVaryingVelocityField
VelocityFieldType * GetModifiableTimeVaryingVelocityField()
Definition: itkTimeVaryingVelocityFieldTransform.h:110
itk::TimeVaryingVelocityFieldTransform::TimeVaryingVelocityFieldPointer
typename VelocityFieldType::Pointer TimeVaryingVelocityFieldPointer
Definition: itkTimeVaryingVelocityFieldTransform.h:84
itk::VelocityFieldTransform
Provides local/dense/high-dimensionality transformation via a a velocity field.
Definition: itkVelocityFieldTransform.h:36
itkVelocityFieldTransform.h
itk::TimeVaryingVelocityFieldTransform::GetTimeVaryingVelocityField
const VelocityFieldType * GetTimeVaryingVelocityField() const
Definition: itkTimeVaryingVelocityFieldTransform.h:115
itk::TransformBaseTemplate::FixedParametersValueType
double FixedParametersValueType
Definition: itkTransformBase.h:83
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::DisplacementFieldTransform::InverseTransformBasePointer
typename Superclass::InverseTransformBasePointer InverseTransformBasePointer
Definition: itkDisplacementFieldTransform.h:104
itk::TimeVaryingVelocityFieldTransform::TimeVaryingVelocityFieldType
VelocityFieldType TimeVaryingVelocityFieldType
Definition: itkTimeVaryingVelocityFieldTransform.h:83
itk::TransformBaseTemplate::ParametersValueType
TParametersValueType ParametersValueType
Definition: itkTransformBase.h:81
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:86
itk::TransformBaseTemplate::NumberOfParametersType
IdentifierType NumberOfParametersType
Definition: itkTransformBase.h:91
itk::Transform
Transform points and vectors from an input space to an output space.
Definition: itkTransform.h:82
itk::TimeVaryingVelocityFieldTransform::TransformPointer
typename Transform< TParametersValueType, NDimensions, NDimensions >::Pointer TransformPointer
Definition: itkTimeVaryingVelocityFieldTransform.h:99