itk::VelocityFieldTransform< TParametersValueType, VDimension > Class Template Reference

#include <itkVelocityFieldTransform.h>

Detailed Description

template<typename TParametersValueType, unsigned int VDimension>
class itk::VelocityFieldTransform< TParametersValueType, VDimension >

Provides local/dense/high-dimensionality transformation via a a velocity field.

Author

Nick Tustison

Brian Avants

Definition at line 36 of file itkVelocityFieldTransform.h.

Inheritance diagram for itk::VelocityFieldTransform< TParametersValueType, VDimension >:

Collaboration diagram for itk::VelocityFieldTransform< TParametersValueType, VDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DirectionType = typename VelocityFieldType::DirectionType
using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer
using	IndexType = typename VelocityFieldType::IndexType
using	OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper< ScalarType, Dimension, VelocityFieldDimension >
using	PixelType = typename VelocityFieldType::PixelType
using	Pointer = SmartPointer< Self >
using	PointType = typename VelocityFieldType::PointType
using	RegionType = typename VelocityFieldType::RegionType
using	Self = VelocityFieldTransform
using	SizeType = typename VelocityFieldType::SizeType
using	SpacingType = typename VelocityFieldType::SpacingType
using	Superclass = DisplacementFieldTransform< TParametersValueType, VDimension >
using	VelocityFieldInterpolatorPointer = typename VelocityFieldInterpolatorType::Pointer
using	VelocityFieldInterpolatorType = VectorInterpolateImageFunction< VelocityFieldType, ScalarType >
using	VelocityFieldPointer = typename VelocityFieldType::Pointer
using	VelocityFieldType = Image< OutputVectorType, VelocityFieldDimension >
Public Types inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
using	ConstPointer = SmartPointer< const Self >
using	DirectionType = typename DisplacementFieldType::DirectionType
using	DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer
using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer
using	DisplacementFieldType = Image< OutputVectorType, Dimension >
using	IndexType = typename DisplacementFieldType::IndexType
using	InputTensorEigenVectorType = CovariantVector< ScalarType, InputDiffusionTensor3DType::Dimension >
using	InterpolatorType = VectorInterpolateImageFunction< DisplacementFieldType, ScalarType >
using	OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper< ScalarType, OutputVectorType::Dimension, Dimension >
using	OutputTensorEigenVectorType = CovariantVector< ScalarType, OutputDiffusionTensor3DType::Dimension >
using	PixelType = typename DisplacementFieldType::PixelType
using	Pointer = SmartPointer< Self >
using	PointType = typename DisplacementFieldType::PointType
using	RegionType = typename DisplacementFieldType::RegionType
using	Self = DisplacementFieldTransform
using	SizeType = typename DisplacementFieldType::SizeType
using	SpacingType = typename DisplacementFieldType::SpacingType
using	Superclass = Transform< TParametersValueType, VDimension, VDimension >
using	VectorImageDisplacementFieldType = VectorImage< TParametersValueType, Dimension >
Public Types inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = Array< ParametersValueType >
using	DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >
using	FixedParametersType = OptimizerParameters< FixedParametersValueType >
using	FixedParametersValueType = double
using	InputCovariantVectorType = CovariantVector< TParametersValueType, VInputDimension >
using	InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
using	InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >
using	InputPointType = Point< TParametersValueType, VInputDimension >
using	InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >
using	InputVectorPixelType = VariableLengthVector< TParametersValueType >
using	InputVectorType = Vector< TParametersValueType, VInputDimension >
using	InputVnlVectorType = vnl_vector_fixed< TParametersValueType, VInputDimension >
using	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
using	InverseTransformBaseType = Transform< TParametersValueType, VOutputDimension, VInputDimension >
using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
using	JacobianType = Array2D< ParametersValueType >
using	MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
using	NumberOfParametersType = IdentifierType
using	OutputCovariantVectorType = CovariantVector< TParametersValueType, VOutputDimension >
using	OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
using	OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >
using	OutputPointType = Point< TParametersValueType, VOutputDimension >
using	OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >
using	OutputVectorPixelType = VariableLengthVector< TParametersValueType >
using	OutputVectorType = Vector< TParametersValueType, VOutputDimension >
using	OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, VOutputDimension >
using	ParametersType = OptimizerParameters< ParametersValueType >
using	ParametersValueType = TParametersValueType
using	Pointer = SmartPointer< Self >
using	ScalarType = ParametersValueType
using	Self = Transform
using	Superclass = TransformBaseTemplate< TParametersValueType >
using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
Public Types inherited from TransformBaseTemplate< TParametersValueType >
using	ConstPointer = SmartPointer< const Self >
using	FixedParametersType = OptimizerParameters< FixedParametersValueType >
using	FixedParametersValueType = double
using	NumberOfParametersType = IdentifierType
using	ParametersType = OptimizerParameters< ParametersValueType >
using	ParametersValueType = TParametersValueType
using	Pointer = SmartPointer< Self >
using	Self = TransformBaseTemplate
using	Superclass = Object
using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
using	TransformCategoryType = TransformCategoryEnum

Public Member Functions
bool	GetInverse (Self *inverse) const
InverseTransformBasePointer	GetInverseTransform () const override
virtual ScalarType	GetLowerTimeBound () const
const char *	GetNameOfClass () const override
virtual unsigned int	GetNumberOfIntegrationSteps () const
virtual ScalarType	GetUpperTimeBound () const
virtual const unsigned long &	GetVelocityFieldSetTime () const
virtual void	IntegrateVelocityField ()
void	SetFixedParameters (const FixedParametersType &) override
virtual void	SetLowerTimeBound (ScalarType _arg)
virtual void	SetNumberOfIntegrationSteps (unsigned int _arg)
virtual void	SetUpperTimeBound (ScalarType _arg)
void	UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
virtual void	SetVelocityField (VelocityFieldType *)
virtual VelocityFieldType *	GetModifiableVelocityField ()
virtual void	SetVelocityFieldInterpolator (VelocityFieldInterpolatorType *)
virtual VelocityFieldInterpolatorType *	GetModifiableVelocityFieldInterpolator ()
void	SetDisplacementField (DisplacementFieldType *displacementField) override
Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &point, InverseJacobianPositionType &jacobian) const override
virtual void	ComputeJacobianWithRespectToParameters (const IndexType &, JacobianType &j) const
virtual void	ComputeJacobianWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian) const
void	ComputeJacobianWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian) const override
virtual const ModifiedTimeType &	GetDisplacementFieldSetTime () const
bool	GetInverse (Self *inverse) const
virtual void	GetInverseJacobianOfForwardFieldWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian, bool useSVD=false) const
virtual void	GetInverseJacobianOfForwardFieldWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian, bool useSVD=false) const
InverseTransformBasePointer	GetInverseTransform () const override
const char *	GetNameOfClass () const override
NumberOfParametersType	GetNumberOfLocalParameters () const override
TransformCategoryEnum	GetTransformCategory () const override
void	SetFixedParameters (const FixedParametersType &) override
virtual void	SetIdentity ()
OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const override
OutputVectorPixelType	TransformDiffusionTensor (const InputVectorPixelType &) const
OutputPointType	TransformPoint (const InputPointType &inputPoint) const override
OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const override
OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override
void	UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
virtual void	SetDisplacementField (VectorImageDisplacementFieldType *field)
void	SetDisplacementField (std::nullptr_t)=delete
virtual DisplacementFieldType *	GetModifiableDisplacementField ()
virtual void	SetInverseDisplacementField (DisplacementFieldType *inverseField)
virtual DisplacementFieldType *	GetModifiableInverseDisplacementField ()
virtual void	SetInterpolator (InterpolatorType *interpolator)
virtual InterpolatorType *	GetModifiableInterpolator ()
virtual void	SetInverseInterpolator (InterpolatorType *interpolator)
virtual InterpolatorType *	GetModifiableInverseInterpolator ()
OutputVectorType	TransformVector (const InputVectorType &) const override
OutputDiffusionTensor3DType	TransformDiffusionTensor (const InputDiffusionTensor3DType &) const
OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override
void	SetParameters (const ParametersType &params) override
void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &j) const override
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
virtual void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
void	CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
void	CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
const FixedParametersType &	GetFixedParameters () const override
unsigned int	GetInputSpaceDimension () const override
bool	GetInverse (Self *) const
virtual InverseTransformBasePointer	GetInverseTransform () const
const char *	GetNameOfClass () const override
virtual NumberOfParametersType	GetNumberOfFixedParameters () const
virtual NumberOfParametersType	GetNumberOfLocalParameters () const
NumberOfParametersType	GetNumberOfParameters () const override
unsigned int	GetOutputSpaceDimension () const override
const ParametersType &	GetParameters () const override
TransformCategoryEnum	GetTransformCategory () const override
std::string	GetTransformTypeAsString () const override
virtual bool	IsLinear () const
	itkCloneMacro (Self)
void	SetFixedParameters (const FixedParametersType &) override=0
void	SetParameters (const ParametersType &) override=0
void	SetParametersByValue (const ParametersType &p) override
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const
virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &) const
virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
virtual OutputPointType	TransformPoint (const InputPointType &) const=0
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const
virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
virtual OutputVectorType	TransformVector (const InputVectorType &) const
virtual OutputVectorType	TransformVector (const InputVectorType &vector, const InputPointType &point) const
virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const
virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
virtual void	UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
template< typename TImage > std std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (SmartPointer< TImage > image) const
Public Member Functions inherited from TransformBaseTemplate< TParametersValueType >
virtual void	CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end)=0
virtual void	CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end)=0
virtual const FixedParametersType &	GetFixedParameters () const =0
virtual unsigned int	GetInputSpaceDimension () const =0
virtual NumberOfParametersType	GetNumberOfParameters () const =0
virtual unsigned int	GetOutputSpaceDimension () const =0
virtual const ParametersType &	GetParameters () const =0
virtual TransformCategoryEnum	GetTransformCategory () const =0
virtual std::string	GetTransformTypeAsString () const =0
	ITK_DISALLOW_COPY_AND_MOVE (TransformBaseTemplate)
	itkGetConstReferenceMacro (InputSpaceName, std::string)
	itkGetConstReferenceMacro (OutputSpaceName, std::string)
	itkOverrideGetNameOfClassMacro (TransformBaseTemplate)
	itkSetMacro (InputSpaceName, std::string)
	itkSetMacro (OutputSpaceName, std::string)
virtual void	SetFixedParameters (const FixedParametersType &)=0
virtual void	SetParameters (const ParametersType &)=0
virtual void	SetParametersByValue (const ParametersType &p)=0

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	Dimension = VDimension
static constexpr unsigned int	VelocityFieldDimension = VDimension + 1
Static Public Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
static constexpr unsigned int	Dimension = VDimension
Static Public Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static constexpr unsigned int	InputSpaceDimension
static constexpr unsigned int	OutputSpaceDimension
Static Public Attributes inherited from TransformBaseTemplate< TParametersValueType >
static constexpr TransformCategoryEnum	BSpline = TransformCategoryEnum::BSpline
static constexpr TransformCategoryEnum	DisplacementField = TransformCategoryEnum::DisplacementField
static constexpr TransformCategoryEnum	Linear = TransformCategoryEnum::Linear
static constexpr TransformCategoryEnum	Spline = TransformCategoryEnum::Spline
static constexpr TransformCategoryEnum	UnknownTransformCategory = TransformCategoryEnum::UnknownTransformCategory
static constexpr TransformCategoryEnum	VelocityField = TransformCategoryEnum::VelocityField

Protected Member Functions
DisplacementFieldType::Pointer	CopyDisplacementField (const DisplacementFieldType *) const
LightObject::Pointer	InternalClone () const override
void	PrintSelf (std::ostream &os, Indent indent) const override
	VelocityFieldTransform ()
	~VelocityFieldTransform () override=default
Protected Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
	DisplacementFieldTransform ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~DisplacementFieldTransform () override=default
Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
LightObject::Pointer	InternalClone () const override
OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
	Transform ()=default
	Transform (NumberOfParametersType numberOfParameters)
	~Transform () override=default
Protected Member Functions inherited from TransformBaseTemplate< TParametersValueType >
	TransformBaseTemplate ()=default
	~TransformBaseTemplate () override=default

Protected Attributes
ScalarType	m_LowerTimeBound {}
unsigned int	m_NumberOfIntegrationSteps {}
ScalarType	m_UpperTimeBound {}
VelocityFieldPointer	m_VelocityField {}
VelocityFieldInterpolatorType::Pointer	m_VelocityFieldInterpolator {}
unsigned long	m_VelocityFieldSetTime {}
Protected Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
DisplacementFieldType::Pointer	m_DisplacementField {}
ModifiedTimeType	m_DisplacementFieldSetTime { 0 }
JacobianType	m_IdentityJacobian {}
InterpolatorType::Pointer	m_Interpolator {}
DisplacementFieldType::Pointer	m_InverseDisplacementField {}
InterpolatorType::Pointer	m_InverseInterpolator {}
Protected Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
FixedParametersType	m_FixedParameters
ParametersType	m_Parameters

Private Member Functions
virtual void	SetFixedParametersFromVelocityField () const

Additional Inherited Members
Public Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
InverseJacobianPositionType &jacobian	const
Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static InverseTransformBasePointer	InvertTransform (const TTransform &transform)

Member Typedef Documentation

ConstPointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkVelocityFieldTransform.h.

DirectionType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::DirectionType = typename VelocityFieldType::DirectionType

Definition at line 107 of file itkVelocityFieldTransform.h.

DisplacementFieldPointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::DisplacementFieldPointer = typename DisplacementFieldType::Pointer

Definition at line 93 of file itkVelocityFieldTransform.h.

IndexType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::IndexType = typename VelocityFieldType::IndexType

Standard types for the velocity Field

Definition at line 103 of file itkVelocityFieldTransform.h.

OptimizerParametersHelperType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper<ScalarType, Dimension, VelocityFieldDimension>

Define the internal parameter helper used to access the field

Definition at line 115 of file itkVelocityFieldTransform.h.

PixelType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::PixelType = typename VelocityFieldType::PixelType

Definition at line 109 of file itkVelocityFieldTransform.h.

Pointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::Pointer = SmartPointer<Self>

Definition at line 44 of file itkVelocityFieldTransform.h.

PointType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::PointType = typename VelocityFieldType::PointType

Definition at line 108 of file itkVelocityFieldTransform.h.

RegionType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::RegionType = typename VelocityFieldType::RegionType

Definition at line 104 of file itkVelocityFieldTransform.h.

Self

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::Self = VelocityFieldTransform

Standard class type aliases.

Definition at line 42 of file itkVelocityFieldTransform.h.

SizeType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::SizeType = typename VelocityFieldType::SizeType

Definition at line 105 of file itkVelocityFieldTransform.h.

SpacingType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::SpacingType = typename VelocityFieldType::SpacingType

Definition at line 106 of file itkVelocityFieldTransform.h.

Superclass

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::Superclass = DisplacementFieldTransform<TParametersValueType, VDimension>

Definition at line 43 of file itkVelocityFieldTransform.h.

VelocityFieldInterpolatorPointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldInterpolatorPointer = typename VelocityFieldInterpolatorType::Pointer

Definition at line 112 of file itkVelocityFieldTransform.h.

VelocityFieldInterpolatorType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldInterpolatorType = VectorInterpolateImageFunction<VelocityFieldType, ScalarType>

Definition at line 111 of file itkVelocityFieldTransform.h.

VelocityFieldPointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldPointer = typename VelocityFieldType::Pointer

Definition at line 100 of file itkVelocityFieldTransform.h.

VelocityFieldType

template<typename TParametersValueType , unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldType = Image<OutputVectorType, VelocityFieldDimension>

Define the displacement field type and corresponding interpolator type.

Definition at line 99 of file itkVelocityFieldTransform.h.

Constructor & Destructor Documentation

VelocityFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>

itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldTransform ( )

protected

~VelocityFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>

itk::VelocityFieldTransform< TParametersValueType, VDimension >::~VelocityFieldTransform ( )

overrideprotecteddefault

Member Function Documentation

CopyDisplacementField()

template<typename TParametersValueType , unsigned int VDimension>

DisplacementFieldType::Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::CopyDisplacementField ( const DisplacementFieldType *  ) const

protected

GetInverse()

template<typename TParametersValueType , unsigned int VDimension>

bool itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetInverse

(

Self *

inverse

)

const

Get the inverse of the transform.

GetInverseTransform()

template<typename TParametersValueType , unsigned int VDimension>

InverseTransformBasePointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetInverseTransform ( ) const

overridevirtual

Get the inverse of the transform.

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

GetLowerTimeBound()

template<typename TParametersValueType , unsigned int VDimension>

virtual ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetLowerTimeBound ( ) const

virtual

Get the lower time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

GetModifiableVelocityField()

template<typename TParametersValueType , unsigned int VDimension>

virtual VelocityFieldType * itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetModifiableVelocityField ( )

virtual

Get/Set the velocity field. Set the displacement field. Create special set accessor to update interpolator and assign displacement field to transform parameters container.

GetModifiableVelocityFieldInterpolator()

template<typename TParametersValueType , unsigned int VDimension>

virtual VelocityFieldInterpolatorType * itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetModifiableVelocityFieldInterpolator ( )

virtual

Get/Set the interpolator. Create out own set accessor that assigns the velocity field

GetNameOfClass()

template<typename TParametersValueType , unsigned int VDimension>

const char * itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetNameOfClass ( ) const

override

See also

LightObject::GetNameOfClass()

GetNumberOfIntegrationSteps()

template<typename TParametersValueType , unsigned int VDimension>

virtual unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetNumberOfIntegrationSteps ( ) const

virtual

Get the number of integration steps. Default = 100;

GetUpperTimeBound()

template<typename TParametersValueType , unsigned int VDimension>

virtual ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetUpperTimeBound ( ) const

virtual

Get the upper time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

GetVelocityFieldSetTime()

template<typename TParametersValueType , unsigned int VDimension>

virtual const unsigned long & itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetVelocityFieldSetTime ( ) const

virtual

Get the modification time of velocity field

IntegrateVelocityField()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::IntegrateVelocityField ( )

inlinevirtual

Trigger the computation of the displacement field by integrating the velocity field.

Reimplemented in itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >, and itk::TimeVaryingVelocityFieldTransform< TParametersValueType, VDimension >.

Definition at line 172 of file itkVelocityFieldTransform.h.

InternalClone()

template<typename TParametersValueType , unsigned int VDimension>

LightObject::Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::InternalClone ( ) const

overrideprotected

Clone the current transform

New()

template<typename TParametersValueType , unsigned int VDimension>

static Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::New ( )

static

New macro for creation of through a Smart Pointer

PrintSelf()

template<typename TParametersValueType , unsigned int VDimension>

void itk::VelocityFieldTransform< TParametersValueType, VDimension >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotected

SetDisplacementField()

template<typename TParametersValueType , unsigned int VDimension>

void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetDisplacementField ( DisplacementFieldType *  displacementField )

inlineoverridevirtual

Set the deformation field. We want to override the base class implementation since we don't want to optimize over the deformation field for this class but rather the time-varying velocity field

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

Definition at line 148 of file itkVelocityFieldTransform.h.

SetFixedParameters()

template<typename TParametersValueType , unsigned int VDimension>

void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetFixedParameters ( const FixedParametersType &  )

overridevirtual

This method sets the fixed parameters of the transform. For a displacement field transform, the fixed parameters are the following: field size, field origin, field spacing, and field direction.

Note: If a displacement field already exists, this function creates a new one with zero displacement (identity transform). If an inverse displacement field exists, a new one is also created.

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

SetFixedParametersFromVelocityField()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetFixedParametersFromVelocityField ( ) const

privatevirtual

Convenience method which reads the information from the current velocity field into m_FixedParameters.

SetLowerTimeBound()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetLowerTimeBound ( ScalarType  _arg )

virtual

Set the lower time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

SetNumberOfIntegrationSteps()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetNumberOfIntegrationSteps ( unsigned int  _arg )

virtual

Set the number of integration steps. Default = 100;

SetUpperTimeBound()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetUpperTimeBound ( ScalarType  _arg )

virtual

Set the upper time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

SetVelocityField()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityField ( VelocityFieldType *  )

virtual

Get/Set the velocity field. Set the displacement field. Create special set accessor to update interpolator and assign displacement field to transform parameters container.

SetVelocityFieldInterpolator()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityFieldInterpolator ( VelocityFieldInterpolatorType *  )

virtual

Get/Set the interpolator. Create out own set accessor that assigns the velocity field

UpdateTransformParameters()

template<typename TParametersValueType , unsigned int VDimension>

void itk::VelocityFieldTransform< TParametersValueType, VDimension >::UpdateTransformParameters ( const DerivativeType &  update, ScalarType  factor = 1.0  )

overridevirtual

Update the transform's parameters by the values in update.

Parameters

update	must be of the same length as returned by GetNumberOfParameters(). Throw an exception otherwise.
factor	is a scalar multiplier for each value in update. SetParameters is called at the end of this method, to allow the transform to perform any required operations on the updated parameters - typically a conversion to member variables for use in TransformPoint.

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

Member Data Documentation

Dimension

template<typename TParametersValueType , unsigned int VDimension>

constexpr unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::Dimension = VDimension

staticconstexpr

Dimension of the vector spaces.

Definition at line 89 of file itkVelocityFieldTransform.h.

m_LowerTimeBound

template<typename TParametersValueType , unsigned int VDimension>

ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_LowerTimeBound {}

protected

Definition at line 222 of file itkVelocityFieldTransform.h.

m_NumberOfIntegrationSteps

template<typename TParametersValueType , unsigned int VDimension>

unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_NumberOfIntegrationSteps {}

protected

Definition at line 225 of file itkVelocityFieldTransform.h.

m_UpperTimeBound

template<typename TParametersValueType , unsigned int VDimension>

ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_UpperTimeBound {}

protected

Definition at line 223 of file itkVelocityFieldTransform.h.

m_VelocityField

template<typename TParametersValueType , unsigned int VDimension>

VelocityFieldPointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityField {}

protected

Definition at line 227 of file itkVelocityFieldTransform.h.

m_VelocityFieldInterpolator

template<typename TParametersValueType , unsigned int VDimension>

VelocityFieldInterpolatorType::Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldInterpolator {}

protected

The interpolator.

Definition at line 230 of file itkVelocityFieldTransform.h.

m_VelocityFieldSetTime

template<typename TParametersValueType , unsigned int VDimension>

unsigned long itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldSetTime {}

protected

Track when the VELOCITY field was last set/assigned, as distinct from when it may have had its contents modified.

Definition at line 234 of file itkVelocityFieldTransform.h.

VelocityFieldDimension

template<typename TParametersValueType , unsigned int VDimension>

constexpr unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldDimension = VDimension + 1

staticconstexpr

Dimension of the velocity field .

Definition at line 86 of file itkVelocityFieldTransform.h.

---

The documentation for this class was generated from the following file:

• itkVelocityFieldTransform.h