#include <elxDeformationFieldTransform.h>
A transform based on a DeformationField.
This transform models the transformation by a deformation vector field. This transform is NOT meant to be used for optimisation. Just use it as an initial transform, or with transformix.
The parameters used in this class are:
The transform parameters necessary for transformix, additionally defined by this class, are:
DeformationFieldFileName: stores the name of the deformation field.
example: (DeformationFieldFileName "defField.mhd")
DeformationFieldInterpolationOrder: The interpolation order used for interpolating the deformation field:
example: (DeformationFieldInterpolationOrder 0)
The default value is 0. Choose from the allowed values 0 or 1.
Definition at line 54 of file elxDeformationFieldTransform.h.

Public Member Functions | |
| elxClassNameMacro ("DeformationFieldTransform") | |
| ITK_DISALLOW_COPY_AND_MOVE (DeformationFieldTransform) | |
| itkOverrideGetNameOfClassMacro (DeformationFieldTransform) | |
| itkStaticConstMacro (SpaceDimension, unsigned int, Superclass2::FixedImageDimension) | |
| void | ReadFromFile () override |
| Public Member Functions inherited from itk::AdvancedCombinationTransform< TScalarType, NDimensions > | |
| void | EvaluateJacobianWithImageGradientProduct (const InputPointType &inputPoint, const MovingImageGradientType &movingImageGradient, DerivativeType &imageJacobian, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override |
| const FixedParametersType & | GetFixedParameters () const override |
| bool | GetHasNonZeroSpatialHessian () const override |
| bool | GetInverse (Self *inverse) const |
| void | GetJacobian (const InputPointType &inputPoint, JacobianType &j, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override |
| void | GetJacobianOfSpatialHessian (const InputPointType &inputPoint, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override |
| void | GetJacobianOfSpatialHessian (const InputPointType &inputPoint, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override |
| void | GetJacobianOfSpatialJacobian (const InputPointType &inputPoint, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override |
| void | GetJacobianOfSpatialJacobian (const InputPointType &inputPoint, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override |
| const TransformTypePointer | GetNthTransform (SizeValueType n) const |
| NumberOfParametersType | GetNumberOfNonZeroJacobianIndices () const override |
| NumberOfParametersType | GetNumberOfParameters () const override |
| SizeValueType | GetNumberOfTransforms () const |
| const ParametersType & | GetParameters () const override |
| void | GetSpatialHessian (const InputPointType &inputPoint, SpatialHessianType &sh) const override |
| void | GetSpatialJacobian (const InputPointType &inputPoint, SpatialJacobianType &sj) const override |
| TransformCategoryEnum | GetTransformCategory () const override |
| virtual bool | GetUseAddition () const |
| virtual bool | GetUseComposition () const |
| bool | HasNonZeroJacobianOfSpatialHessian () const |
| bool | IsLinear () const override |
| ITK_DISALLOW_COPY_AND_MOVE (AdvancedCombinationTransform) | |
| itkGetModifiableObjectMacro (CurrentTransform, CurrentTransformType) | |
| itkGetModifiableObjectMacro (InitialTransform, InitialTransformType) | |
| itkOverrideGetNameOfClassMacro (AdvancedCombinationTransform) | |
| itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions) | |
| void | SetCurrentTransform (CurrentTransformType *_arg) |
| void | SetFixedParameters (const FixedParametersType &fixedParam) override |
| void | SetInitialTransform (InitialTransformType *_arg) |
| void | SetParameters (const ParametersType ¶m) override |
| void | SetParametersByValue (const ParametersType ¶m) override |
| void | SetUseAddition (bool _arg) |
| void | SetUseComposition (bool _arg) |
| OutputCovariantVectorType | TransformCovariantVector (const InputCovariantVectorType &) const override |
| OutputPointType | TransformPoint (const InputPointType &point) const override |
| OutputVectorType | TransformVector (const InputVectorType &) const override |
| OutputVnlVectorType | TransformVector (const InputVnlVectorType &) const override |
| Public Member Functions inherited from itk::AdvancedTransform< TScalarType, 3, 3 > | |
| void | ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override |
| virtual bool | GetHasNonZeroJacobianOfSpatialHessian () const |
| ITK_DISALLOW_COPY_AND_MOVE (AdvancedTransform) | |
| itkOverrideGetNameOfClassMacro (AdvancedTransform) | |
| itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions) | |
| Public Member Functions inherited from elastix::TransformBase< TElastix > | |
| int | BeforeAllTransformix () |
| void | ComputeAndWriteSpatialJacobianDeterminantImage () const |
| void | ComputeAndWriteSpatialJacobianMatrixImage () const |
| SpatialJacobianDeterminantImageType::Pointer | ComputeSpatialJacobianDeterminantImage () const |
| SpatialJacobianMatrixImageType::Pointer | ComputeSpatialJacobianMatrixImage () const |
| void | CreateTransformParameterMap (const ParametersType ¶m, ParameterMapType ¶meterMap, const bool includeDerivedTransformParameters=true) const |
| ITKBaseType * | GetAsITKBaseType () |
| const ITKBaseType * | GetAsITKBaseType () const |
| ITK_DISALLOW_COPY_AND_MOVE (TransformBase) | |
| itkOverrideGetNameOfClassMacro (TransformBase) | |
| itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension) | |
| itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension) | |
| void | ReadInitialTransformFromFile (const std::string &transformParameterFileName) |
| void | SetFinalParameters () |
| void | SetInitialTransform (InitialTransformType *_arg) |
| void | SetReadWriteTransformParameters (const bool _arg) |
| void | SetTransformParameterFileName (const std::string &filename) |
| template<typename TMesh> | |
| TMesh::Pointer | TransformMesh (const TMesh &mesh) const |
| void | TransformPoints () const |
| void | WriteToFile (std::ostream &transformationParameterInfo, const ParametersType ¶m) const |
| Public Member Functions inherited from elastix::BaseComponentSE< TElastix > | |
| void | AddTargetCellToIterationInfo (const char *const name) |
| const Configuration * | GetConfiguration () const |
| ElastixType * | GetElastix () const |
| auto & | GetIterationInfoAt (const char *const name) |
| itk::Statistics::MersenneTwisterRandomVariateGenerator & | GetRandomVariateGenerator () |
| RegistrationType * | GetRegistration () const |
| ITK_DISALLOW_COPY_AND_MOVE (BaseComponentSE) | |
| void | RemoveTargetCellFromIterationInfo (const char *const name) |
| void | SetConfiguration (const Configuration *_arg) |
| void | SetElastix (ElastixType *_arg) |
| Public Member Functions inherited from elastix::BaseComponent | |
| virtual void | AfterEachIteration () |
| virtual void | AfterEachIterationBase () |
| virtual void | AfterEachResolution () |
| virtual void | AfterEachResolutionBase () |
| virtual void | AfterRegistration () |
| virtual int | BeforeAll () |
| virtual void | BeforeEachResolution () |
| virtual void | BeforeEachResolutionBase () |
| virtual void | BeforeRegistration () |
| virtual const char * | elxGetClassName () const |
| const char * | GetComponentLabel () const |
| ITK_DISALLOW_COPY_AND_MOVE (BaseComponent) | |
| itkVirtualGetNameOfClassMacro (BaseComponent) | |
| void | SetComponentLabel (const char *label, unsigned int idx) |
Static Public Member Functions | |
| static Pointer | New () |
| Static Public Member Functions inherited from itk::AdvancedCombinationTransform< TScalarType, NDimensions > | |
| static Pointer | New () |
| Static Public Member Functions inherited from elastix::BaseComponent | |
| template<typename TBaseComponent> | |
| static auto | AsITKBaseType (TBaseComponent *const baseComponent) -> decltype(baseComponent->GetAsITKBaseType()) |
| static void | InitializeElastixExecutable () |
| static bool | IsElastixLibrary () |
Private Types | |
| using | DirectionType = typename DeformationFieldType::DirectionType |
Private Member Functions | |
| ParameterMapType | CreateDerivedTransformParameterMap () const override |
| void | WriteDerivedTransformDataToFile () const override |
Private Attributes | |
| elxOverrideGetSelfMacro | |
| const DeformationFieldInterpolatingTransformPointer | m_DeformationFieldInterpolatingTransform |
| DirectionType | m_OriginalDeformationFieldDirection |
Additional Inherited Members | |
| Protected Attributes inherited from itk::AdvancedTransform< TScalarType, 3, 3 > | |
| bool | m_HasNonZeroJacobianOfSpatialHessian |
| bool | m_HasNonZeroSpatialHessian |
| Protected Attributes inherited from elastix::BaseComponentSE< TElastix > | |
| Configuration::ConstPointer | m_Configuration {} |
| itk::WeakPointer< TElastix > | m_Elastix {} |
| RegistrationType * | m_Registration {} |
| using elastix::DeformationFieldTransform< TElastix >::CombinationTransformType = typename Superclass2::CombinationTransformType |
Definition at line 123 of file elxDeformationFieldTransform.h.
| using elastix::DeformationFieldTransform< TElastix >::ConstPointer = itk::SmartPointer<const Self> |
Definition at line 78 of file elxDeformationFieldTransform.h.
| using elastix::TransformBase< TElastix >::CoordinateType |
Elastix typedef's.
Definition at line 163 of file elxTransformBase.h.
| using elastix::DeformationFieldTransform< TElastix >::DeformationFieldInterpolatingTransformPointer = typename DeformationFieldInterpolatingTransformType::Pointer |
Definition at line 113 of file elxDeformationFieldTransform.h.
| using elastix::DeformationFieldTransform< TElastix >::DeformationFieldInterpolatingTransformType |
The ITK-class that provides most of the functionality, and that is set as the "CurrentTransform" in the CombinationTransform
Definition at line 67 of file elxDeformationFieldTransform.h.
| using elastix::DeformationFieldTransform< TElastix >::DeformationFieldType = typename DeformationFieldInterpolatingTransformType::DeformationFieldType |
Typedef's specific for the DeformationFieldInterpolatingTransform.
Definition at line 110 of file elxDeformationFieldTransform.h.
| using elastix::DeformationFieldTransform< TElastix >::DeformationFieldVectorType = typename DeformationFieldInterpolatingTransformType::DeformationFieldVectorType |
Definition at line 111 of file elxDeformationFieldTransform.h.
|
private |
Definition at line 146 of file elxDeformationFieldTransform.h.
| using elastix::TransformBase< TElastix >::FixedImageType |
Definition at line 164 of file elxTransformBase.h.
| using elastix::DeformationFieldTransform< TElastix >::ITKBaseType = typename Superclass2::ITKBaseType |
Definition at line 122 of file elxDeformationFieldTransform.h.
| using elastix::TransformBase< TElastix >::MovingImageType |
Definition at line 165 of file elxTransformBase.h.
| using elastix::TransformBase< TElastix >::ParameterMapType |
Typedef that is used in the elastix dll version.
Definition at line 206 of file elxTransformBase.h.
| using elastix::DeformationFieldTransform< TElastix >::Pointer = itk::SmartPointer<Self> |
Definition at line 77 of file elxDeformationFieldTransform.h.
| using elastix::DeformationFieldTransform< TElastix >::Self = DeformationFieldTransform |
Standard ITK-stuff.
Definition at line 63 of file elxDeformationFieldTransform.h.
| using elastix::DeformationFieldTransform< TElastix >::Superclass1 |
Definition at line 72 of file elxDeformationFieldTransform.h.
| using elastix::DeformationFieldTransform< TElastix >::Superclass2 = elx::TransformBase<TElastix> |
Definition at line 75 of file elxDeformationFieldTransform.h.
|
protected |
The constructor.
|
overrideprotecteddefault |
The destructor.
|
overrideprivatevirtual |
Creates a map of the parameters specific for this (derived) transform type.
Implements elastix::TransformBase< TElastix >.
| elastix::DeformationFieldTransform< TElastix >::elxClassNameMacro | ( | "DeformationFieldTransform< TElastix >" | ) |
Name of this class. Use this name in the parameter file to select this specific transform.
example: (Transform "DeformationFieldTransform")
| elastix::DeformationFieldTransform< TElastix >::ITK_DISALLOW_COPY_AND_MOVE | ( | DeformationFieldTransform< TElastix > | ) |
| elastix::DeformationFieldTransform< TElastix >::itkOverrideGetNameOfClassMacro | ( | DeformationFieldTransform< TElastix > | ) |
Run-time type information (and related methods).
| elastix::DeformationFieldTransform< TElastix >::itkStaticConstMacro | ( | SpaceDimension | , |
| unsigned int | , | ||
| Superclass2::FixedImageDimension | ) |
Dimension of the domain space.
|
static |
Method for creation through the object factory.
|
overridevirtual |
Function to read transform-parameters from a file.
Reimplemented from elastix::TransformBase< TElastix >.
|
overrideprivatevirtual |
Writes its deformation field to a file.
Reimplemented from elastix::TransformBase< TElastix >.
|
private |
Definition at line 136 of file elxDeformationFieldTransform.h.
|
private |
The transform that is set as current transform in the CcombinationTransform
Definition at line 150 of file elxDeformationFieldTransform.h.
|
private |
Original direction cosines; stored to facilitate UseDirectionCosines option.
Definition at line 155 of file elxDeformationFieldTransform.h.
Generated on 26-02-2026
for elastix by 1.16.1 (669aeeefca743c148e2d935b3d3c69535c7491e6) |