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

#include <itkTimeVaryingBSplineVelocityFieldTransform.h>

Detailed Description

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

Integrate a time-varying velocity field represented by a B-spline control point lattice.

Diffeomorphisms are topology-preserving mappings that are useful for describing biologically plausible deformations. Mathematically, a diffeomorphism, \( \phi \), is generated from a time-varying velocity field, v, as described by the integral equation:

\[\phi(t_b) = \phi(t_a) + \int_{t_a}^{t_b} v(\phi(t),t) dt \]

In typical registration applications it is computationally more efficient to sample the B-spline transform to its corresponding displacement field. Therefore, the user needs to specify the domain parameters of that displacement field using the following functions:

• SetDisplacementFieldSpacing()
• SetDisplacementFieldOrigin()
• SetDisplacementFieldSize()
• SetDisplacementFieldDirection()

It's important that these parameters match up with the fixed parameters of this transform which are defined as the parameters of the (N+1)-D B-spline grid representing the continuous velocity field. This control point lattice is set using SetTimeVaryingVelocityFieldControlPointLattice() or it can be created by setting the fixed parameters.

Note: For readability of the code, it is important to note that we store the control point lattice in the m_VelocityField variable since they are of the same type. It's only when we call IntegrateVelocityField() that a sampled velocity field is created from the control point lattice.

Author

Nick Tustison

Brian Avants

Definition at line 68 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>
using	DisplacementFieldDirectionType = typename DisplacementFieldType::DirectionType
using	DisplacementFieldPointType = typename DisplacementFieldType::PointType
using	DisplacementFieldSizeType = typename DisplacementFieldType::SizeType
using	DisplacementFieldSpacingType = typename DisplacementFieldType::SpacingType
using	DisplacementVectorType = typename DisplacementFieldType::PixelType
using	FixedParametersValueType = typename FixedParametersType::ValueType
using	ParametersValueType = typename ParametersType::ValueType
using	Pointer = SmartPointer<Self>
using	Self = TimeVaryingBSplineVelocityFieldTransform
using	Superclass = VelocityFieldTransform<TParametersValueType, VDimension>
using	TimeVaryingVelocityFieldControlPointLatticePointer = typename VelocityFieldType::Pointer
using	TimeVaryingVelocityFieldControlPointLatticeType = VelocityFieldType
using	VelocityFieldDirectionType = typename VelocityFieldType::DirectionType
using	VelocityFieldIntegratorType = typename Superclass::VelocityFieldInterpolatorType
using	VelocityFieldPointType = typename VelocityFieldType::PointType
using	VelocityFieldSizeType = typename VelocityFieldType::SizeType
using	VelocityFieldSpacingType = typename VelocityFieldType::SpacingType
using	VelocityFieldType
Public Types inherited from itk::VelocityFieldTransform< TParametersValueType, VDimension >
using	ConstPointer = SmartPointer<const Self>
using	DerivativeType
using	DirectionType = typename VelocityFieldType::DirectionType
using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer
using	DisplacementFieldType
typedef OptimizerParameters< FixedParametersValueType >	FixedParametersType
typedef double	FixedParametersValueType
using	IndexType = typename VelocityFieldType::IndexType
using	InputPointType
using	InputVectorPixelType
using	InputVectorType
using	InverseTransformBasePointer
typedef IdentifierType	NumberOfParametersType
using	OptimizerParametersHelperType
using	OutputPointType
using	OutputVectorPixelType
using	OutputVectorType
typedef OptimizerParameters< ParametersValueType >	ParametersType
typedef TParametersValueType	ParametersValueType
using	PixelType = typename VelocityFieldType::PixelType
using	Pointer = SmartPointer<Self>
using	PointType = typename VelocityFieldType::PointType
using	RegionType = typename VelocityFieldType::RegionType
using	ScalarType
using	Self = VelocityFieldTransform
using	SizeType = typename VelocityFieldType::SizeType
using	SpacingType = typename VelocityFieldType::SpacingType
using	Superclass = DisplacementFieldTransform<TParametersValueType, VDimension>
typedef TransformBaseTemplateEnums::TransformCategory	TransformCategoryEnum
using	VectorImageDisplacementFieldType
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	DerivativeType
using	DirectionType = typename DisplacementFieldType::DirectionType
using	DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer
using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer
using	DisplacementFieldType = Image<OutputVectorType, Dimension>
typedef OptimizerParameters< FixedParametersValueType >	FixedParametersType
typedef double	FixedParametersValueType
using	IndexType = typename DisplacementFieldType::IndexType
using	InputCovariantVectorType
using	InputDiffusionTensor3DType
using	InputPointType
using	InputTensorEigenVectorType = CovariantVector<ScalarType, InputDiffusionTensor3DType::Dimension>
using	InputVectorPixelType
using	InputVectorType
using	InputVnlVectorType
using	InterpolatorType = VectorInterpolateImageFunction<DisplacementFieldType, ScalarType>
using	InverseJacobianPositionType
using	InverseTransformBasePointer
using	JacobianPositionType
using	JacobianType
typedef IdentifierType	NumberOfParametersType
using	OptimizerParametersHelperType
using	OutputCovariantVectorType
using	OutputDiffusionTensor3DType
using	OutputPointType
using	OutputTensorEigenVectorType = CovariantVector<ScalarType, OutputDiffusionTensor3DType::Dimension>
using	OutputVectorPixelType
using	OutputVectorType
using	OutputVnlVectorType
typedef OptimizerParameters< ParametersValueType >	ParametersType
typedef TParametersValueType	ParametersValueType
using	PixelType = typename DisplacementFieldType::PixelType
using	Pointer = SmartPointer<Self>
using	PointType = typename DisplacementFieldType::PointType
using	RegionType = typename DisplacementFieldType::RegionType
using	ScalarType
using	Self = DisplacementFieldTransform
using	SizeType = typename DisplacementFieldType::SizeType
using	SpacingType = typename DisplacementFieldType::SpacingType
using	Superclass = Transform<TParametersValueType, VDimension, VDimension>
typedef TransformBaseTemplateEnums::TransformCategory	TransformCategoryEnum
using	VectorImageDisplacementFieldType = VectorImage<TParametersValueType, Dimension>
Public Types inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
using	ConstPointer
using	ConstPointer
using	DerivativeType
using	DerivativeType
using	DirectionChangeMatrix
using	DirectionChangeMatrix
typedef OptimizerParameters< FixedParametersValueType >	FixedParametersType
using	FixedParametersType
typedef double	FixedParametersValueType
using	FixedParametersValueType
using	InputCovariantVectorType
using	InputCovariantVectorType
using	InputDiffusionTensor3DType
using	InputDiffusionTensor3DType
using	InputDirectionMatrix
using	InputDirectionMatrix
using	InputPointType
using	InputPointType
using	InputSymmetricSecondRankTensorType
using	InputSymmetricSecondRankTensorType
using	InputVectorPixelType
using	InputVectorPixelType
using	InputVectorType
using	InputVectorType
using	InputVnlVectorType
using	InputVnlVectorType
using	InverseJacobianPositionType
using	InverseJacobianPositionType
using	InverseTransformBasePointer
using	InverseTransformBasePointer
using	InverseTransformBaseType
using	InverseTransformBaseType
using	JacobianPositionType
using	JacobianPositionType
using	JacobianType
using	JacobianType
using	MatrixType
using	MatrixType
typedef IdentifierType	NumberOfParametersType
using	NumberOfParametersType
using	OutputCovariantVectorType
using	OutputCovariantVectorType
using	OutputDiffusionTensor3DType
using	OutputDiffusionTensor3DType
using	OutputDirectionMatrix
using	OutputDirectionMatrix
using	OutputPointType
using	OutputPointType
using	OutputSymmetricSecondRankTensorType
using	OutputSymmetricSecondRankTensorType
using	OutputVectorPixelType
using	OutputVectorPixelType
using	OutputVectorType
using	OutputVectorType
using	OutputVnlVectorType
using	OutputVnlVectorType
typedef OptimizerParameters< ParametersValueType >	ParametersType
using	ParametersType
typedef TParametersValueType	ParametersValueType
using	ParametersValueType
using	Pointer
using	Pointer
using	ScalarType
using	ScalarType
using	Self
using	Self
using	Superclass
using	Superclass
typedef TransformBaseTemplateEnums::TransformCategory	TransformCategoryEnum
using	TransformCategoryEnum
Public Types inherited from itk::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
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>
using	Pointer = SmartPointer<Self>
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>
using	Pointer = SmartPointer<Self>
using	Self = LightObject

Public Member Functions
virtual::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
VelocityFieldType *	GetTimeVaryingVelocityFieldControlPointLattice ()
void	IntegrateVelocityField () override
virtual void	SetTimeVaryingVelocityFieldControlPointLattice (VelocityFieldType *fieldLattice)
void	UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
virtual void	SetVelocityFieldOrigin (VelocityFieldPointType _arg)
virtual VelocityFieldPointType	GetVelocityFieldOrigin () const
virtual void	SetVelocityFieldSpacing (VelocityFieldSpacingType _arg)
virtual VelocityFieldSpacingType	GetVelocityFieldSpacing () const
virtual void	SetVelocityFieldSize (VelocityFieldSizeType _arg)
virtual VelocityFieldSizeType	GetVelocityFieldSize () const
virtual void	SetVelocityFieldDirection (VelocityFieldDirectionType _arg)
virtual VelocityFieldDirectionType	GetVelocityFieldDirection () const
virtual void	SetSplineOrder (unsigned int _arg)
virtual unsigned int	GetSplineOrder () const
Public Member Functions inherited from itk::VelocityFieldTransform< TParametersValueType, VDimension >
virtual::itk::LightObject::Pointer	CreateAnother () const
bool	GetInverse (Self *inverse) const
InverseTransformBasePointer	GetInverseTransform () const override
virtual ScalarType	GetLowerTimeBound () const
virtual unsigned int	GetNumberOfIntegrationSteps () const
virtual ScalarType	GetUpperTimeBound () const
virtual const unsigned long &	GetVelocityFieldSetTime () const
void	SetDisplacementField (DisplacementFieldType *displacementField) override
void	SetDisplacementField (std::nullptr_t)=delete
virtual void	SetDisplacementField (VectorImageDisplacementFieldType *field)
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 const VelocityFieldType *	GetVelocityField () const
virtual void	SetVelocityFieldInterpolator (VelocityFieldInterpolatorType *)
virtual VelocityFieldInterpolatorType *	GetModifiableVelocityFieldInterpolator ()
virtual const VelocityFieldInterpolatorType *	GetVelocityFieldInterpolator () const
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
void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &j) const override
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
NumberOfParametersType	GetNumberOfLocalParameters () const override
TransformCategoryEnum	GetTransformCategory () const override
virtual void	SetIdentity ()
void	SetParameters (const ParametersType &params) override
OutputPointType	TransformPoint (const InputPointType &inputPoint) const override
void	SetDisplacementField (std::nullptr_t)=delete
virtual DisplacementFieldType *	GetModifiableDisplacementField ()
virtual const DisplacementFieldType *	GetDisplacementField () const
virtual void	SetInverseDisplacementField (DisplacementFieldType *inverseField)
virtual DisplacementFieldType *	GetModifiableInverseDisplacementField ()
virtual const DisplacementFieldType *	GetInverseDisplacementField () const
virtual void	SetInterpolator (InterpolatorType *interpolator)
virtual InterpolatorType *	GetModifiableInterpolator ()
virtual const InterpolatorType *	GetInterpolator () const
virtual void	SetInverseInterpolator (InterpolatorType *interpolator)
virtual InterpolatorType *	GetModifiableInverseInterpolator ()
virtual const InterpolatorType *	GetInverseInterpolator () const
OutputVectorType	TransformVector (const InputVectorType &) const override
OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const override
OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override
virtual OutputVectorType	TransformVector (const InputVectorType &vector, const InputPointType &point) const
virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
OutputDiffusionTensor3DType	TransformDiffusionTensor (const InputDiffusionTensor3DType &) const
OutputVectorPixelType	TransformDiffusionTensor (const InputVectorPixelType &) const
virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const
virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const
virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override
OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const override
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
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 &cachedJacobian) const
virtual void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &cachedJacobian) const
void	CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
void	CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
void	CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
void	CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
const FixedParametersType &	GetFixedParameters () const override
const FixedParametersType &	GetFixedParameters () const override
unsigned int	GetInputSpaceDimension () const override
unsigned int	GetInputSpaceDimension () const override
bool	GetInverse (Self *inverseTransform) const
bool	GetInverse (Self *inverseTransform) const
virtual NumberOfParametersType	GetNumberOfFixedParameters () const
virtual NumberOfParametersType	GetNumberOfFixedParameters () const
NumberOfParametersType	GetNumberOfParameters () const override
NumberOfParametersType	GetNumberOfParameters () const override
unsigned int	GetOutputSpaceDimension () const override
unsigned int	GetOutputSpaceDimension () const override
const ParametersType &	GetParameters () const override
const ParametersType &	GetParameters () const override
TransformCategoryEnum	GetTransformCategory () const override
TransformCategoryEnum	GetTransformCategory () const override
std::string	GetTransformTypeAsString () const override
std::string	GetTransformTypeAsString () const override
virtual bool	IsLinear () const
virtual bool	IsLinear () const
	itkCloneMacro (Self)
	itkCloneMacro (Self)
void	SetParametersByValue (const ParametersType &p) override
void	SetParametersByValue (const ParametersType &p) override
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (TImage *image) const
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (SmartPointer< TImage > image) const
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (TImage *image) const
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (SmartPointer< TImage > image) const
Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
virtual const std::string &	GetInputSpaceName () const
virtual const std::string &	GetOutputSpaceName () const
virtual void	SetInputSpaceName (std::string _arg)
virtual void	SetOutputSpaceName (std::string _arg)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag) const
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::VelocityFieldTransform< TParametersValueType, VDimension >
static Pointer	New ()
Static Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
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::VelocityFieldTransform< TParametersValueType, VDimension >
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	InputSpaceDimension
static constexpr unsigned int	OutputSpaceDimension
static constexpr unsigned int	OutputSpaceDimension

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override
	TimeVaryingBSplineVelocityFieldTransform ()
	~TimeVaryingBSplineVelocityFieldTransform () override=default
Protected Member Functions inherited from itk::VelocityFieldTransform< TParametersValueType, VDimension >
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 ()
	~DisplacementFieldTransform () override=default
Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
	Transform ()=default
	Transform ()=default
	Transform (NumberOfParametersType numberOfParameters)
	Transform (NumberOfParametersType numberOfParameters)
	~Transform () override=default
	~Transform () override=default
Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
	TransformBaseTemplate ()=default
	~TransformBaseTemplate () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~Object () override
Protected Member Functions inherited from itk::LightObject
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Attributes
unsigned int	m_SplineOrder {}
bool	m_TemporalPeriodicity {}
VelocityFieldDirectionType	m_VelocityFieldDirection {}
VelocityFieldPointType	m_VelocityFieldOrigin {}
VelocityFieldSizeType	m_VelocityFieldSize {}
VelocityFieldSpacingType	m_VelocityFieldSpacing {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static InverseTransformBasePointer	InvertTransform (const TTransform &transform)
static InverseTransformBasePointer	InvertTransform (const TTransform &transform)
Protected Attributes inherited from itk::VelocityFieldTransform< TParametersValueType, VDimension >
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
FixedParametersType	m_FixedParameters
ParametersType	m_Parameters
ParametersType	m_Parameters
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

template<typename TParametersValueType, unsigned int VDimension>

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

Definition at line 78 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

DisplacementFieldDirectionType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::DisplacementFieldDirectionType = typename DisplacementFieldType::DirectionType

Definition at line 128 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

DisplacementFieldPointType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::DisplacementFieldPointType = typename DisplacementFieldType::PointType

Definition at line 127 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

DisplacementFieldSizeType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::DisplacementFieldSizeType = typename DisplacementFieldType::SizeType

Definition at line 125 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

DisplacementFieldSpacingType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::DisplacementFieldSpacingType = typename DisplacementFieldType::SpacingType

Definition at line 126 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

DisplacementVectorType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::DisplacementVectorType = typename DisplacementFieldType::PixelType

Definition at line 124 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

FixedParametersValueType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::FixedParametersValueType = typename FixedParametersType::ValueType

Definition at line 104 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

ParametersValueType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::ParametersValueType = typename ParametersType::ValueType

Definition at line 102 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

Pointer

template<typename TParametersValueType, unsigned int VDimension>

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

Definition at line 77 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

Self

template<typename TParametersValueType, unsigned int VDimension>

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

Standard class type aliases.

Definition at line 75 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

Superclass

template<typename TParametersValueType, unsigned int VDimension>

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

Definition at line 76 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

TimeVaryingVelocityFieldControlPointLatticePointer

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::TimeVaryingVelocityFieldControlPointLatticePointer = typename VelocityFieldType::Pointer

Definition at line 122 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

TimeVaryingVelocityFieldControlPointLatticeType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::TimeVaryingVelocityFieldControlPointLatticeType = VelocityFieldType

Definition at line 121 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

VelocityFieldDirectionType

template<typename TParametersValueType, unsigned int VDimension>

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

Definition at line 119 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

VelocityFieldIntegratorType

template<typename TParametersValueType, unsigned int VDimension>

using itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldIntegratorType = typename Superclass::VelocityFieldInterpolatorType

Definition at line 91 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

VelocityFieldPointType

template<typename TParametersValueType, unsigned int VDimension>

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

Definition at line 116 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

VelocityFieldSizeType

template<typename TParametersValueType, unsigned int VDimension>

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

Definition at line 117 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

VelocityFieldSpacingType

template<typename TParametersValueType, unsigned int VDimension>

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

Definition at line 118 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

VelocityFieldType

template<typename TParametersValueType, unsigned int VDimension>

using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldType

Define the displacement field type and corresponding interpolator type.

Definition at line 99 of file itkVelocityFieldTransform.h.

Constructor & Destructor Documentation

TimeVaryingBSplineVelocityFieldTransform()

template<typename TParametersValueType, unsigned int VDimension>

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

protected

Referenced by GetNameOfClass().

~TimeVaryingBSplineVelocityFieldTransform()

template<typename TParametersValueType, unsigned int VDimension>

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

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TParametersValueType, unsigned int VDimension>

virtual::itk::LightObject::Pointer itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

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

GetNameOfClass()

template<typename TParametersValueType, unsigned int VDimension>

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

virtual

See also

LightObject::GetNameOfClass()

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

References TimeVaryingBSplineVelocityFieldTransform().

GetSplineOrder()

template<typename TParametersValueType, unsigned int VDimension>

virtual unsigned int itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::GetSplineOrder ( ) const

virtual

Set/Get the spline order.

GetTimeVaryingVelocityFieldControlPointLattice()

template<typename TParametersValueType, unsigned int VDimension>

VelocityFieldType * itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::GetTimeVaryingVelocityFieldControlPointLattice ( )

inline

Get the time-varying velocity field control point lattice.

Definition at line 132 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

References itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetModifiableVelocityField().

GetVelocityFieldDirection()

template<typename TParametersValueType, unsigned int VDimension>

virtual VelocityFieldDirectionType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::GetVelocityFieldDirection ( ) const

virtual

Set/Get sampled velocity field direction

GetVelocityFieldOrigin()

template<typename TParametersValueType, unsigned int VDimension>

virtual VelocityFieldPointType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::GetVelocityFieldOrigin ( ) const

virtual

Set/Get sampled velocity field origin

GetVelocityFieldSize()

template<typename TParametersValueType, unsigned int VDimension>

virtual VelocityFieldSizeType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::GetVelocityFieldSize ( ) const

virtual

Set/Get sampled velocity field size

GetVelocityFieldSpacing()

template<typename TParametersValueType, unsigned int VDimension>

virtual VelocityFieldSpacingType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::GetVelocityFieldSpacing ( ) const

virtual

Set/Get sampled velocity field spacing

IntegrateVelocityField()

template<typename TParametersValueType, unsigned int VDimension>

void itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::IntegrateVelocityField ( )

overridevirtual

Trigger the computation of the displacement field by integrating the time-varying velocity field.

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

New()

template<typename TParametersValueType, unsigned int VDimension>

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

static

New macro for creation of through a Smart Pointer

PrintSelf()

template<typename TParametersValueType, unsigned int VDimension>

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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

SetSplineOrder()

template<typename TParametersValueType, unsigned int VDimension>

virtual void itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::SetSplineOrder ( unsigned int _arg )

virtual

Set/Get the spline order.

SetTimeVaryingVelocityFieldControlPointLattice()

template<typename TParametersValueType, unsigned int VDimension>

virtual void itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::SetTimeVaryingVelocityFieldControlPointLattice ( VelocityFieldType * fieldLattice )

inlinevirtual

Set the time-varying velocity field control point lattice.

Definition at line 139 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

References itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityField().

SetVelocityFieldDirection()

template<typename TParametersValueType, unsigned int VDimension>

virtual void itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityFieldDirection ( VelocityFieldDirectionType _arg )

virtual

Set/Get sampled velocity field direction

SetVelocityFieldOrigin()

template<typename TParametersValueType, unsigned int VDimension>

virtual void itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityFieldOrigin ( VelocityFieldPointType _arg )

virtual

Set/Get sampled velocity field origin

SetVelocityFieldSize()

template<typename TParametersValueType, unsigned int VDimension>

virtual void itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityFieldSize ( VelocityFieldSizeType _arg )

virtual

Set/Get sampled velocity field size

SetVelocityFieldSpacing()

template<typename TParametersValueType, unsigned int VDimension>

virtual void itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityFieldSpacing ( VelocityFieldSpacingType _arg )

virtual

Set/Get sampled velocity field spacing

UpdateTransformParameters()

template<typename TParametersValueType, unsigned int VDimension>

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

override

Update the transform's parameters by the adding values in update to current parameter values. We assume update is of the same length as Parameters. Throw exception otherwise. factor is a scalar multiplier for each value in update. SetParameters is called at the end of this method, to allow transforms to perform any required operations on the update parameters, typically a conversion to member variables for use in TransformPoint.

Member Data Documentation

Dimension

template<typename TParametersValueType, unsigned int VDimension>

unsigned int itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::Dimension = VDimension

staticconstexpr

Dimension of the domain spaces.

Definition at line 111 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

m_SplineOrder

template<typename TParametersValueType, unsigned int VDimension>

unsigned int itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::m_SplineOrder {}

private

Definition at line 190 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

m_TemporalPeriodicity

template<typename TParametersValueType, unsigned int VDimension>

bool itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::m_TemporalPeriodicity {}

private

Definition at line 191 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

m_VelocityFieldDirection

template<typename TParametersValueType, unsigned int VDimension>

VelocityFieldDirectionType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldDirection {}

private

Definition at line 195 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

m_VelocityFieldOrigin

template<typename TParametersValueType, unsigned int VDimension>

VelocityFieldPointType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldOrigin {}

private

Definition at line 193 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

m_VelocityFieldSize

template<typename TParametersValueType, unsigned int VDimension>

VelocityFieldSizeType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldSize {}

private

Definition at line 196 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

m_VelocityFieldSpacing

template<typename TParametersValueType, unsigned int VDimension>

VelocityFieldSpacingType itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldSpacing {}

private

Definition at line 194 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

VelocityFieldDimension

template<typename TParametersValueType, unsigned int VDimension>

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

staticconstexpr

Dimension of the time varying velocity field.

Definition at line 114 of file itkTimeVaryingBSplineVelocityFieldTransform.h.

---

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

• itkTimeVaryingBSplineVelocityFieldTransform.h