#include <itkDeformationVectorFieldTransform.h>

Detailed Description

template<class TScalarType = double, unsigned int NDimensions = 3>
class itk::DeformationVectorFieldTransform< TScalarType, NDimensions >

An itk transform based on a DeformationVectorField.

This class makes it easy to set a deformation vector field as a Transform-object.

The class inherits from the 0th-order AdvancedBSplineDeformableTransform, and converts a VectorImage to the B-spline CoefficientImage.

This is useful if you know for example how to deform each voxel in an image and want to apply it to that image.

Note: Better use the DeformationFieldInterpolatingTransform. It is more flexible, since it allows runtime specification of the spline order.

Definition at line 46 of file itkDeformationVectorFieldTransform.h.

Inheritance diagram for itk::DeformationVectorFieldTransform< TScalarType, NDimensions >:

Public Types
typedef Superclass::ImagePointer	CoefficientImagePointer

typedef Superclass::ImageType	CoefficientImageType

typedef Superclass::PixelType	CoefficientPixelType

typedef CoefficientVectorImageType::Pointer	CoefficientVectorImagePointer

typedef Image< CoefficientVectorPixelType, itkGetStaticConstMacro(SpaceDimension) >	CoefficientVectorImageType

typedef Vector< float, itkGetStaticConstMacro(SpaceDimension) >	CoefficientVectorPixelType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef DeformationVectorFieldTransform	Self

typedef AdvancedBSplineDeformableTransform< TScalarType, NDimensions, 0 >	Superclass

Public Types inherited from itk::AdvancedBSplineDeformableTransform< double, 3, 0 >
typedef SmartPointer< const Self >	ConstPointer

typedef WeightsFunctionType::ContinuousIndexType	ContinuousIndexType

typedef Superclass::DerivativeType	DerivativeType

typedef DerivativeWeightsFunctionType::Pointer	DerivativeWeightsFunctionPointer

typedef BSplineInterpolationDerivativeWeightFunction< ScalarType, itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SplineOrder) >	DerivativeWeightsFunctionType

typedef Superclass::DirectionType	DirectionType

typedef Superclass::GridOffsetType	GridOffsetType

typedef Superclass::ImagePointer	ImagePointer

typedef Superclass::ImageType	ImageType

typedef Superclass::IndexType	IndexType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef Superclass::InternalMatrixType	InternalMatrixType

typedef Superclass::JacobianOfSpatialHessianType	JacobianOfSpatialHessianType

typedef Superclass::JacobianOfSpatialJacobianType	JacobianOfSpatialJacobianType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MovingImageGradientType	MovingImageGradientType

typedef Superclass::MovingImageGradientValueType	MovingImageGradientValueType

typedef Superclass::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::OriginType	OriginType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParameterIndexArrayType	ParameterIndexArrayType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RegionType	RegionType

typedef Superclass::ScalarType	ScalarType

typedef AdvancedBSplineDeformableTransform	Self

typedef Superclass::SizeType	SizeType

typedef SODerivativeWeightsFunctionType::Pointer	SODerivativeWeightsFunctionPointer

typedef BSplineInterpolationSecondOrderDerivativeWeightFunction< ScalarType, itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SplineOrder) >	SODerivativeWeightsFunctionType

typedef Superclass::SpacingType	SpacingType

typedef Superclass::SpatialHessianType	SpatialHessianType

typedef Superclass::SpatialJacobianType	SpatialJacobianType

typedef AdvancedBSplineDeformableTransformBase< double, NDimensions >	Superclass

typedef WeightsFunctionType::Pointer	WeightsFunctionPointer

typedef BSplineInterpolationWeightFunction2< ScalarType, itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SplineOrder) >	WeightsFunctionType

typedef WeightsFunctionType::WeightsType	WeightsType

Public Types inherited from itk::AdvancedBSplineDeformableTransformBase< double, NDimensions >
typedef SmartPointer< const Self >	ConstPointer

typedef ContinuousIndex< ScalarType, SpaceDimension >	ContinuousIndexType

typedef Superclass::DerivativeType	DerivativeType

typedef ImageType::DirectionType	DirectionType

typedef Superclass::FixedParametersType	FixedParametersType

typedef IndexType	GridOffsetType

typedef ImageType::Pointer	ImagePointer

typedef Image< PixelType, itkGetStaticConstMacro(SpaceDimension) >	ImageType

typedef RegionType::IndexType	IndexType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef Superclass::InternalMatrixType	InternalMatrixType

typedef Superclass::JacobianOfSpatialHessianType	JacobianOfSpatialHessianType

typedef Superclass::JacobianOfSpatialJacobianType	JacobianOfSpatialJacobianType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MovingImageGradientType	MovingImageGradientType

typedef Superclass::MovingImageGradientValueType	MovingImageGradientValueType

typedef Superclass::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef ImageType::PointType	OriginType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Array< unsigned long >	ParameterIndexArrayType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef ImageRegion< itkGetStaticConstMacro(SpaceDimension) >	RegionType

typedef Superclass::ScalarType	ScalarType

typedef AdvancedBSplineDeformableTransformBase	Self

typedef RegionType::SizeType	SizeType

typedef ImageType::SpacingType	SpacingType

typedef Superclass::SpatialHessianType	SpatialHessianType

typedef Superclass::SpatialJacobianType	SpatialJacobianType

typedef AdvancedTransform< double, NDimensions, NDimensions >	Superclass

typedef Superclass::TransformCategoryEnum	TransformCategoryEnum

Public Types inherited from itk::AdvancedTransform< double, NDimensions, NDimensions >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef SpatialJacobianType::InternalMatrixType	InternalMatrixType

typedef Superclass::InverseTransformBasePointer	InverseTransformBasePointer

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef std::vector< SpatialHessianType >	JacobianOfSpatialHessianType

typedef std::vector< SpatialJacobianType >	JacobianOfSpatialJacobianType

typedef Superclass::JacobianType	JacobianType

typedef OutputCovariantVectorType	MovingImageGradientType

typedef MovingImageGradientType::ValueType	MovingImageGradientValueType

typedef std::vector< unsigned long >	NonZeroJacobianIndicesType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef AdvancedTransform	Self

typedef FixedArray< Matrix< ScalarType, InputSpaceDimension, InputSpaceDimension >, OutputSpaceDimension >	SpatialHessianType

typedef Matrix< ScalarType, OutputSpaceDimension, InputSpaceDimension >	SpatialJacobianType

typedef Transform< double, NInputDimensions, NOutputDimensions >	Superclass

typedef Transform< double, NInputDimensions, NOutputDimensions >	TransformType

typedef TransformType::ConstPointer	TransformTypeConstPointer

typedef TransformType::Pointer	TransformTypePointer

Public Member Functions
virtual const char *	GetClassName () const

virtual void	GetCoefficientVectorImage (CoefficientVectorImagePointer &vecImage) const

	itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)

	itkStaticConstMacro (SplineOrder, unsigned int, Superclass::SplineOrder)

virtual void	SetCoefficientVectorImage (const CoefficientVectorImageType *vecImage)

Public Member Functions inherited from itk::AdvancedBSplineDeformableTransform< double, 3, 0 >
void	EvaluateJacobianWithImageGradientProduct (const InputPointType &ipp, const MovingImageGradientType &movingImageGradient, DerivativeType &imageJacobian, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

virtual const char *	GetClassName () const

void	GetJacobian (const InputPointType &ipp, JacobianType &j, NonZeroJacobianIndicesType &nzji) const override

void	GetJacobianOfSpatialHessian (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

unsigned int	GetNumberOfAffectedWeights (void) const override

NumberOfParametersType	GetNumberOfNonZeroJacobianIndices (void) const override

unsigned long	GetNumberOfWeights (void) const

void	GetSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh) const override

void	GetSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj) const override

	itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)

	itkStaticConstMacro (SplineOrder, unsigned int, VSplineOrder)

void	SetGridRegion (const RegionType &region) override

virtual void	TransformPoint (const InputPointType &inputPoint, OutputPointType &outputPoint, WeightsType &weights, ParameterIndexArrayType &indices, bool &inside) const

OutputPointType	TransformPoint (const InputPointType &point) const override

Public Member Functions inherited from itk::AdvancedBSplineDeformableTransformBase< double, NDimensions >
virtual const char *	GetClassName () const

virtual const ImagePointer *	GetCoefficientImages (void) const

const FixedParametersType &	GetFixedParameters (void) const override

virtual DirectionType	GetGridDirection () const

virtual OriginType	GetGridOrigin () const

virtual RegionType	GetGridRegion () const

virtual SpacingType	GetGridSpacing () const

virtual unsigned int	GetNumberOfAffectedWeights (void) const=0

NumberOfParametersType	GetNumberOfNonZeroJacobianIndices (void) const override=0

NumberOfParametersType	GetNumberOfParameters (void) const override

virtual NumberOfParametersType	GetNumberOfParametersPerDimension (void) const

const ParametersType &	GetParameters (void) const override

TransformCategoryEnum	GetTransformCategory (void) const override

virtual const RegionType &	GetValidRegion ()

bool	IsLinear (void) const override

	itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)

virtual void	SetCoefficientImages (ImagePointer images[])

void	SetFixedParameters (const FixedParametersType &parameters) override

virtual void	SetGridDirection (const DirectionType &direction)

virtual void	SetGridOrigin (const OriginType &origin)

virtual void	SetGridRegion (const RegionType &region)=0

virtual void	SetGridSpacing (const SpacingType &spacing)

void	SetIdentity (void)

void	SetParameters (const ParametersType &parameters) override

void	SetParametersByValue (const ParametersType &parameters) override

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override

OutputVectorType	TransformVector (const InputVectorType &) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override

Public Member Functions inherited from itk::AdvancedTransform< double, NDimensions, NDimensions >
void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override

virtual void	EvaluateJacobianWithImageGradientProduct (const InputPointType &ipp, const MovingImageGradientType &movingImageGradient, DerivativeType &imageJacobian, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

virtual const char *	GetClassName () const

virtual bool	GetHasNonZeroJacobianOfSpatialHessian () const

virtual bool	GetHasNonZeroSpatialHessian () const

virtual void	GetJacobian (const InputPointType &ipp, JacobianType &j, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialHessian (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual NumberOfParametersType	GetNumberOfNonZeroJacobianIndices (void) const

virtual void	GetSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh) const=0

virtual void	GetSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj) const=0

	itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions)

	itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::AdvancedBSplineDeformableTransform< double, 3, 0 >
static Pointer	New ()

Protected Member Functions
	DeformationVectorFieldTransform ()

	~DeformationVectorFieldTransform () override

Protected Member Functions inherited from itk::AdvancedBSplineDeformableTransform< double, 3, 0 >
	AdvancedBSplineDeformableTransform ()

void	ComputeNonZeroJacobianIndices (NonZeroJacobianIndicesType &nonZeroJacobianIndices, const RegionType &supportRegion) const override

	itkGetModifiableObjectMacro (WeightsFunction, WeightsFunctionType)

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetWeightsFunction (WeightsFunctionType *_arg)

void	WrapAsImages (void)

	~AdvancedBSplineDeformableTransform () override

Protected Member Functions inherited from itk::AdvancedBSplineDeformableTransformBase< double, NDimensions >
	AdvancedBSplineDeformableTransformBase ()

virtual void	ComputeNonZeroJacobianIndices (NonZeroJacobianIndicesType &nonZeroJacobianIndices, const RegionType &supportRegion) const=0

virtual bool	InsideValidRegion (const ContinuousIndexType &index) const

void	PrintSelf (std::ostream &os, Indent indent) const override

void	TransformPointToContinuousGridIndex (const InputPointType &point, ContinuousIndexType &index) const

void	UpdateGridOffsetTable (void)

void	UpdatePointIndexConversions (void)

void	WrapAsImages (void)

	~AdvancedBSplineDeformableTransformBase () override

Protected Member Functions inherited from itk::AdvancedTransform< double, NDimensions, NDimensions >
	AdvancedTransform ()

	AdvancedTransform (NumberOfParametersType numberOfParameters)

	~AdvancedTransform () override

Private Member Functions
	DeformationVectorFieldTransform (const Self &)

void	operator= (const Self &)

Private Attributes
CoefficientImagePointer	m_Images [SpaceDimension]

Additional Inherited Members
Protected Types inherited from itk::AdvancedBSplineDeformableTransform< double, 3, 0 >
typedef Superclass::JacobianImageType	JacobianImageType

typedef Superclass::JacobianPixelType	JacobianPixelType

Protected Types inherited from itk::AdvancedBSplineDeformableTransformBase< double, NDimensions >
typedef Image< JacobianPixelType, itkGetStaticConstMacro(SpaceDimension) >	JacobianImageType

typedef JacobianType::ValueType	JacobianPixelType

Protected Attributes inherited from itk::AdvancedBSplineDeformableTransform< double, 3, 0 >
std::vector< DerivativeWeightsFunctionPointer >	m_DerivativeWeightsFunctions

std::vector< std::vector< SODerivativeWeightsFunctionPointer > >	m_SODerivativeWeightsFunctions

WeightsFunctionPointer	m_WeightsFunction

Protected Attributes inherited from itk::AdvancedBSplineDeformableTransformBase< double, NDimensions >
ImagePointer	m_CoefficientImages [NDimensions]

DirectionType	m_GridDirection

GridOffsetType	m_GridOffsetTable

OriginType	m_GridOrigin

RegionType	m_GridRegion

SpacingType	m_GridSpacing

DirectionType	m_IndexToPoint

const ParametersType *	m_InputParametersPointer

ParametersType	m_InternalParametersBuffer

JacobianImageType::Pointer	m_JacobianImage [NDimensions]

IndexType	m_LastJacobianIndex

unsigned long	m_Offset

DirectionType	m_PointToIndexMatrix

SpatialJacobianType	m_PointToIndexMatrix2

FixedArray< ScalarType, NDimensions >	m_PointToIndexMatrixDiagonal

FixedArray< ScalarType, NDimensions *NDimensions >	m_PointToIndexMatrixDiagonalProducts

bool	m_PointToIndexMatrixIsDiagonal

DirectionType	m_PointToIndexMatrixTransposed

SpatialJacobianType	m_PointToIndexMatrixTransposed2

bool	m_SplineOrderOdd

SizeType	m_SupportSize

RegionType	m_ValidRegion

ContinuousIndexType	m_ValidRegionBegin

ContinuousIndexType	m_ValidRegionEnd

ImagePointer	m_WrappedImage [NDimensions]

Protected Attributes inherited from itk::AdvancedTransform< double, NDimensions, NDimensions >
bool	m_HasNonZeroJacobianOfSpatialHessian

bool	m_HasNonZeroSpatialHessian