#include <itkBSplineDeformableTransform.h>

Detailed Description

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
class itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >

Deformable transform using a BSpline representation.

Note: BSplineTransform is a newer version of this class, and it is preferred.

This class encapsulates a deformable transform of points from one N-dimensional space to another N-dimensional space. The deformation field is modeled using B-splines. A deformation is defined on a sparse regular grid of control points \( \vec{\lambda}_j \) and is varied by defining a deformation \( \vec{g}(\vec{\lambda}_j) \) of each control point. The deformation \( D(\vec{x}) \) at any point \( \vec{x} \) is obtained by using a B-spline interpolation kernel.

The deformation field grid is defined by a user specified GridRegion, GridSpacing and GridOrigin. Each grid/control point has associated with it N deformation coefficients \( \vec{\delta}_j \), representing the N directional components of the deformation. Deformation outside the grid plus support region for the BSpline interpolation is assumed to be zero.

Additionally, the user can specified an addition bulk transform \( B \) such that the transformed point is given by:

\[ \vec{y} = B(\vec{x}) + D(\vec{x}) \]

The parameters for this transform is an N x N-D grid of spline coefficients. The user specifies the parameters as one flat array: each N-D grid is represented by an array in the same way an N-D image is represented in the buffer; the N arrays are then concatenated together on form a single array.

For efficiency, this transform does not make a copy of the parameters. It only keeps a pointer to the input parameters and assumes that the memory is managed by the caller.

The following illustrates the typical usage of this class:

using TransformType = BSplineDeformableTransform<double,2,3>;
TransformType::Pointer transform = TransformType::New();
 
transform->SetGridRegion( region );
transform->SetGridSpacing( spacing );
transform->SetGridOrigin( origin );
 
// NB: the region must be set first before setting the parameters
 
TransformType::ParametersType parameters( transform->GetNumberOfParameters() );
 
// Fill the parameters with values
 
transform->SetParameters( parameters )
 
outputPoint = transform->TransformPoint( inputPoint );

An alternative way to set the B-spline coefficients is via array of images. The grid region, spacing and origin information is taken directly from the first image. It is assumed that the subsequent images are the same buffered region. The following illustrates the API:

TransformType::ImageConstPointer images[2];
 
// Fill the images up with values
 
transform->SetCoefficientImages( images );
outputPoint = transform->TransformPoint( inputPoint );

Warning: use either the SetParameters() or SetCoefficientImages() API. Mixing the two modes may results in unexpected results.

The class is templated coordinate representation type (float or double), the space dimension and the spline order.

See also: BSplineTransform

ITK Sphinx Examples:

All ITK Sphinx Examples

Global Registration Of Two Images (BSpline)

Definition at line 113 of file itkBSplineDeformableTransform.h.

Inheritance diagram for itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >:

Collaboration diagram for itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >:

Public Types
using	BulkTransformPointer = typename BulkTransformType::ConstPointer

using	BulkTransformType = Transform<TParametersValueType, Self::SpaceDimension, Self::SpaceDimension>

using	ConstPointer = SmartPointer<const Self>

using	InputPointType = Point<TParametersValueType, Self::SpaceDimension>

typedef vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >	InverseJacobianPositionType

typedef vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >	JacobianPositionType

typedef Array2D< ParametersValueType >	JacobianType

using	OutputPointType = Point<TParametersValueType, Self::SpaceDimension>

using	PhysicalDimensionsType = typename Superclass::SpacingType

using	Pointer = SmartPointer<Self>

using	ScalarType = TParametersValueType

using	Self = BSplineDeformableTransform

using	Superclass = BSplineBaseTransform<TParametersValueType, VDimension, VSplineOrder>

Public Types inherited from itk::BSplineBaseTransform< double, 3, 3 >
using	CoefficientImageArray

using	ConstPointer

using	ContinuousIndexType

typedef Array< ParametersValueType >	DerivativeType

using	DerivativeType

using	DirectionType

using	ImagePointer

using	ImageType

using	IndexType

using	InputCovariantVectorType

using	InputPointType

using	InputVectorType

using	InputVnlVectorType

typedef vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >	InverseJacobianPositionType

using	InverseJacobianPositionType

typedef vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >	JacobianPositionType

using	JacobianPositionType

typedef Array2D< ParametersValueType >	JacobianType

using	JacobianType

using	MeshSizeType

using	OriginType

using	OutputCovariantVectorType

using	OutputPointType

using	OutputVectorType

using	OutputVnlVectorType

using	ParameterIndexArrayType

using	ParametersValueType

using	PhysicalDimensionsType

using	PixelType

using	Pointer

using	RegionType

typedef ParametersValueType	ScalarType

using	ScalarType

using	Self

using	SizeType

using	SpacingType

using	Superclass

using	WeightsFunctionType

using	WeightsType

Public Types inherited from itk::Transform< double, VDimension, VDimension >
using	ConstPointer

using	DerivativeType

using	DirectionChangeMatrix

typedef OptimizerParameters< FixedParametersValueType >	FixedParametersType

using	FixedParametersType

typedef double	FixedParametersValueType

using	FixedParametersValueType

using	InputCovariantVectorType

using	InputDiffusionTensor3DType

using	InputDirectionMatrix

using	InputPointType

using	InputSymmetricSecondRankTensorType

using	InputVectorPixelType

using	InputVectorType

using	InputVnlVectorType

using	InverseJacobianPositionType

using	InverseTransformBasePointer

using	InverseTransformBaseType

using	JacobianPositionType

using	JacobianType

using	MatrixType

typedef IdentifierType	NumberOfParametersType

using	NumberOfParametersType

using	OutputCovariantVectorType

using	OutputDiffusionTensor3DType

using	OutputDirectionMatrix

using	OutputPointType

using	OutputSymmetricSecondRankTensorType

using	OutputVectorPixelType

using	OutputVectorType

using	OutputVnlVectorType

typedef OptimizerParameters< ParametersValueType >	ParametersType

using	ParametersType

typedef double	ParametersValueType

using	ParametersValueType

using	Pointer

using	ScalarType

using	Self

using	Superclass

typedef TransformBaseTemplateEnums::TransformCategory	TransformCategoryEnum

using	TransformCategoryEnum

Public Types inherited from itk::TransformBaseTemplate< double >
using	ConstPointer

using	FixedParametersType

using	FixedParametersValueType

using	NumberOfParametersType

using	ParametersType

using	ParametersValueType

using	Pointer

using	Self

using	Superclass

using	TransformCategoryEnum

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
void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override

itk::LightObject::Pointer	CreateAnother () const override

virtual DirectionType	GetGridDirection () const

virtual OriginType	GetGridOrigin () const

virtual RegionType	GetGridRegion () const

virtual SpacingType	GetGridSpacing () const

const char *	GetNameOfClass () const override

NumberOfParametersType	GetNumberOfParameters () const override

NumberOfParametersType	GetNumberOfParametersPerDimension () const override

virtual const RegionType &	GetValidRegion () const

	itkCloneMacro (Self)

void	SetCoefficientImages (const CoefficientImageArray &images) override

void	SetFixedParameters (const FixedParametersType &passedParameters) override

virtual void	SetGridDirection (const DirectionType &)

virtual void	SetGridOrigin (const OriginType &)

virtual void	SetGridRegion (const RegionType &)

virtual void	SetGridSpacing (const SpacingType &)

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

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

OutputPointType	TransformPoint (const InputPointType &point) const override


virtual void	SetBulkTransform (const BulkTransformType *_arg)

virtual const BulkTransformType *	GetBulkTransform () const

Public Member Functions inherited from itk::BSplineBaseTransform< double, 3, 3 >
void	ComputeJacobianFromBSplineWeightsWithRespectToPosition (const InputPointType &, WeightsType &, ParameterIndexArrayType &) const

void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override=0

void	ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const override

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jacobian) const

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jacobian) const

const CoefficientImageArray	GetCoefficientImages () const

const FixedParametersType &	GetFixedParameters () const override

unsigned int	GetNumberOfAffectedWeights () const

NumberOfParametersType	GetNumberOfLocalParameters () const override

const ParametersType &	GetParameters () const override

TransformCategoryEnum	GetTransformCategory () const override

	itkCloneMacro (Self)

void	SetIdentity ()

void	SetParameters (const ParametersType &parameters) override

void	SetParametersByValue (const ParametersType &parameters) override

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const

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

OutputPointType	TransformPoint (const InputPointType &point) const override

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual OutputVectorType	TransformVector (const InputVectorType &) const

virtual OutputVectorType	TransformVector (const InputVectorType &) const

OutputVectorType	TransformVector (const InputVectorType &) const override

virtual OutputVectorType	TransformVector (const InputVectorType &vector, const InputPointType &point) const

virtual OutputVectorType	TransformVector (const InputVectorType &vector, const InputPointType &point) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const

OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const

void	UpdateTransformParameters (const DerivativeType &update, double factor=1.0) override

Public Member Functions inherited from itk::Transform< double, VDimension, VDimension >
virtual void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &pnt, InverseJacobianPositionType &jacobian) const

virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const=0

virtual void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &cachedJacobian) const

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jacobian) 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 *inverseTransform) const

virtual InverseTransformBasePointer	GetInverseTransform () const

const char *	GetNameOfClass () const override

virtual NumberOfParametersType	GetNumberOfFixedParameters () 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	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 &vector) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const

virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const

virtual OutputPointType	TransformPoint (const InputPointType &) const=0

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector) 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

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< double >
virtual const std::string &	GetInputSpaceName () const

virtual const std::string &	GetInputSpaceName () const

const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

virtual const std::string &	GetOutputSpaceName () const

virtual const std::string &	GetOutputSpaceName () const

virtual void	SetInputSpaceName (std::string _arg)

virtual void	SetInputSpaceName (std::string _arg)

virtual void	SetOutputSpaceName (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

LightObject::Pointer	CreateAnother () const override

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::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	SpaceDimension = VDimension

static constexpr unsigned int	SplineOrder = VSplineOrder

Static Public Attributes inherited from itk::BSplineBaseTransform< double, 3, 3 >
static constexpr unsigned int	NumberOfWeights

static constexpr unsigned int	SpaceDimension

static constexpr unsigned int	SplineOrder

Static Public Attributes inherited from itk::Transform< double, VDimension, VDimension >
static constexpr unsigned int	InputSpaceDimension

static constexpr unsigned int	OutputSpaceDimension

Protected Member Functions
	BSplineDeformableTransform ()

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

	~BSplineDeformableTransform () override=default

Protected Member Functions inherited from itk::BSplineBaseTransform< double, 3, 3 >
	BSplineBaseTransform ()=default

void	SetFixedParametersFromTransformDomainInformation () const

void	WrapAsImages ()

	~BSplineBaseTransform () override=default

virtual void	SetWeightsFunction (WeightsFunctionType *_arg)

virtual WeightsFunctionType *	GetModifiableWeightsFunction ()

virtual const WeightsFunctionType *	GetWeightsFunction () const

Protected Member Functions inherited from itk::Transform< double, 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 itk::TransformBaseTemplate< double >
	TransformBaseTemplate ()=default

	TransformBaseTemplate ()=default

	~TransformBaseTemplate () override=default

	~TransformBaseTemplate () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

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 Member Functions
bool	InsideValidRegion (ContinuousIndexType &) const override

void	SetCoefficientImageInformationFromFixedParameters () override

void	SetFixedParametersGridDirectionFromTransformDomainInformation () const override

void	SetFixedParametersGridOriginFromTransformDomainInformation () const override

void	SetFixedParametersGridSizeFromTransformDomainInformation () const override

void	SetFixedParametersGridSpacingFromTransformDomainInformation () const override

void	UpdateValidGridRegion ()

Private Attributes
BulkTransformPointer	m_BulkTransform {}

const DirectionType &	m_GridDirection

const OriginType &	m_GridOrigin {}

const RegionType &	m_GridRegion {}

const SpacingType &	m_GridSpacing {}

unsigned long	m_Offset {}

bool	m_SplineOrderOdd {}

RegionType	m_ValidRegion {}

IndexType	m_ValidRegionFirst {}

IndexType	m_ValidRegionLast {}

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

Protected Attributes inherited from itk::BSplineBaseTransform< double, 3, 3 >
CoefficientImageArray	m_CoefficientImages

ParametersType	m_InternalParametersBuffer

WeightsFunctionType::Pointer	m_WeightsFunction

Protected Attributes inherited from itk::Transform< double, VDimension, VDimension >
FixedParametersType	m_FixedParameters

ParametersType	m_Parameters

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ BulkTransformPointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::BulkTransformPointer = typename BulkTransformType::ConstPointer

Definition at line 305 of file itkBSplineDeformableTransform.h.

◆ BulkTransformType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::BulkTransformType = Transform<TParametersValueType, Self::SpaceDimension, Self::SpaceDimension>

Definition at line 304 of file itkBSplineDeformableTransform.h.

◆ ConstPointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

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

Definition at line 123 of file itkBSplineDeformableTransform.h.

◆ InputPointType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::InputPointType = Point<TParametersValueType, Self::SpaceDimension>

Standard coordinate point type for this class.

Definition at line 184 of file itkBSplineDeformableTransform.h.

◆ InverseJacobianPositionType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

◆ JacobianPositionType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

◆ JacobianType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

Type of the Jacobian matrix.

◆ OutputPointType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::OutputPointType = Point<TParametersValueType, Self::SpaceDimension>

Definition at line 185 of file itkBSplineDeformableTransform.h.

◆ PhysicalDimensionsType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::PhysicalDimensionsType = typename Superclass::SpacingType

Definition at line 271 of file itkBSplineDeformableTransform.h.

◆ Pointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

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

Definition at line 122 of file itkBSplineDeformableTransform.h.

◆ ScalarType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::ScalarType = TParametersValueType

Standard scalar type for this class.

Definition at line 155 of file itkBSplineDeformableTransform.h.

◆ Self

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::Self = BSplineDeformableTransform

Standard class type aliases.

Definition at line 120 of file itkBSplineDeformableTransform.h.

◆ Superclass

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

using itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::Superclass = BSplineBaseTransform<TParametersValueType, VDimension, VSplineOrder>

Definition at line 121 of file itkBSplineDeformableTransform.h.

Constructor & Destructor Documentation

◆ BSplineDeformableTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::BSplineDeformableTransform ( )

protected

Referenced by GetNameOfClass().

◆ ~BSplineDeformableTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::~BSplineDeformableTransform ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::ComputeJacobianWithRespectToParameters	(	const InputPointType &	,
		JacobianType &	) const

override

◆ CreateAnother()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

itk::LightObject::Pointer itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::CreateAnother ( ) const

inlineoverridevirtual

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::LightObject.

Definition at line 132 of file itkBSplineDeformableTransform.h.

References GetBulkTransform(), and New().

◆ GetBulkTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual const BulkTransformType * itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetBulkTransform ( ) const

virtual

This method specifies the bulk transform to be applied. The default is the identity transform.

Referenced by CreateAnother().

◆ GetGridDirection()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual DirectionType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetGridDirection ( ) const

virtual

Function to retrieve the transform domain direction.

◆ GetGridOrigin()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual OriginType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetGridOrigin ( ) const

virtual

Function to retrieve the transform domain origin.

◆ GetGridRegion()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual RegionType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetGridRegion ( ) const

virtual

Function to retrieve the transform domain mesh size.

◆ GetGridSpacing()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual SpacingType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetGridSpacing ( ) const

virtual

This method retrieve the grid spacing or resolution.

◆ GetNameOfClass()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::BSplineBaseTransform< double, 3, 3 >.

References BSplineDeformableTransform().

◆ GetNumberOfParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

NumberOfParametersType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetNumberOfParameters ( ) const

overridevirtual

Return the number of parameters that completely define the Transform

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ GetNumberOfParametersPerDimension()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

NumberOfParametersType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetNumberOfParametersPerDimension ( ) const

overridevirtual

Return the number of parameters per dimension

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ GetValidRegion()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual const RegionType & itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::GetValidRegion ( ) const

virtual

Return the region of the grid wholly within the support region

◆ InsideValidRegion()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

bool itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::InsideValidRegion ( ContinuousIndexType & ) const

overrideprivatevirtual

Check if a continuous index is inside the valid region.

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ itkCloneMacro()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::itkCloneMacro ( Self )

implement type-specific clone method

◆ New()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

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

static

New macro for creation of through the object factory.

Referenced by CreateAnother().

◆ PrintSelf()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

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

overrideprotectedvirtual

Print contents of an BSplineDeformableTransform.

Reimplemented from itk::BSplineBaseTransform< double, 3, 3 >.

◆ SetBulkTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetBulkTransform ( const BulkTransformType * _arg )

virtual

This method specifies the bulk transform to be applied. The default is the identity transform.

◆ SetCoefficientImageInformationFromFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetCoefficientImageInformationFromFixedParameters ( )

overrideprivatevirtual

Construct control point grid size from transform domain information

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ SetCoefficientImages()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetCoefficientImages ( const CoefficientImageArray & images )

overridevirtual

Set the array of coefficient images.

This is an alternative API for setting the BSpline coefficients as an array of SpaceDimension images. The fixed parameters are taken from the first image. It is assumed that the buffered region of all the subsequent images are the same as the first image. Note that no error checking is done.

Warning: use either the SetParameters() or SetCoefficientImages() API. Mixing the two modes may results in unexpected results.

Implements itk::BSplineBaseTransform< double, 3, 3 >.

References itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::TransformPoint().

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParameters ( const FixedParametersType & passedParameters )

overridevirtual

This method sets the fixed parameters of the transform. For a BSpline deformation transform, the parameters are the following: Grid Size, Grid Origin, and Grid Spacing

The fixed parameters are the three times the size of the templated dimensions. This function has the effect of make the following calls: transform->SetGridSpacing( spacing ); transform->SetGridOrigin( origin ); transform->SetGridDirection( direction ); transform->SetGridRegion( bsplineRegion );

This function was added to allow the transform to work with the itkTransformReader/Writer I/O filters.

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ SetFixedParametersGridDirectionFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridDirectionFromTransformDomainInformation ( ) const

overrideprivatevirtual

Construct control point grid direction from transform domain information

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ SetFixedParametersGridOriginFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridOriginFromTransformDomainInformation ( ) const

overrideprivatevirtual

Construct control point grid origin from transform domain information

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ SetFixedParametersGridSizeFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridSizeFromTransformDomainInformation ( ) const

overrideprivatevirtual

Construct control point grid size from transform domain information

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ SetFixedParametersGridSpacingFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridSpacingFromTransformDomainInformation ( ) const

overrideprivatevirtual

Construct control point grid spacing from transform domain information

Implements itk::BSplineBaseTransform< double, 3, 3 >.

◆ SetGridDirection()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetGridDirection ( const DirectionType & )

virtual

Function to specify the transform domain direction.

◆ SetGridOrigin()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetGridOrigin ( const OriginType & )

virtual

Function to specify the transform domain origin.

◆ SetGridRegion()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetGridRegion ( const RegionType & )

virtual

Function to specify the transform domain mesh size.

◆ SetGridSpacing()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SetGridSpacing ( const SpacingType & )

virtual

This method specifies the grid spacing or resolution.

◆ TransformPoint() [1/3]

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::TransformPoint	(	const InputPointType &	inputPoint,
		OutputPointType &	outputPoint,
		WeightsType &	weights,
		ParameterIndexArrayType &	indices,
		bool &	inside ) const

Transform points by a BSpline deformable transformation. On return, weights contains the interpolation weights used to compute the deformation and indices of the x (zeroth) dimension coefficient parameters in the support region used to compute the deformation. Parameter indices for the i-th dimension can be obtained by adding ( i * this->GetNumberOfParametersPerDimension() ) to the indices array.

◆ TransformPoint() [2/3]

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::TransformPoint	(	const InputPointType &	inputPoint,
		OutputPointType &	outputPoint,
		WeightsType &	weights,
		ParameterIndexArrayType &	indices,
		bool &	inside ) const

override

◆ TransformPoint() [3/3]

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

OutputPointType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::TransformPoint ( const InputPointType & point ) const

override

Transform points by a BSpline deformable transformation. On return, weights contains the interpolation weights used to compute the deformation and indices of the x (zeroth) dimension coefficient parameters in the support region used to compute the deformation. Parameter indices for the i-th dimension can be obtained by adding ( i * this->GetNumberOfParametersPerDimension() ) to the indices array.

◆ UpdateValidGridRegion()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

void itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::UpdateValidGridRegion ( )

private

Member Data Documentation

◆ m_BulkTransform

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

BulkTransformPointer itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_BulkTransform {}

private

The bulk transform.

Definition at line 363 of file itkBSplineDeformableTransform.h.

◆ m_GridDirection

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

const DirectionType& itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_GridDirection

private

Definition at line 360 of file itkBSplineDeformableTransform.h.

◆ m_GridOrigin

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

const OriginType& itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_GridOrigin {}

private

Definition at line 358 of file itkBSplineDeformableTransform.h.

◆ m_GridRegion

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

const RegionType& itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_GridRegion {}

private

The variables defining the coefficient grid domain for the InternalParametersBuffer are taken from the m_CoefficientImages[0] image, and must be kept in sync with them. by using references to that instance, this is more naturally enforced and does not introduce a speed penalty of dereferencing through the pointers (although it does enforce some internal class synchronization).

Definition at line 357 of file itkBSplineDeformableTransform.h.

◆ m_GridSpacing

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

const SpacingType& itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_GridSpacing {}

private

Definition at line 359 of file itkBSplineDeformableTransform.h.

◆ m_Offset

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

unsigned long itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_Offset {}

private

Variables defining the interpolation support region.

Definition at line 368 of file itkBSplineDeformableTransform.h.

◆ m_SplineOrderOdd

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

bool itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_SplineOrderOdd {}

private

Definition at line 369 of file itkBSplineDeformableTransform.h.

◆ m_ValidRegion

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

RegionType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_ValidRegion {}

private

Definition at line 365 of file itkBSplineDeformableTransform.h.

◆ m_ValidRegionFirst

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

IndexType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_ValidRegionFirst {}

private

Definition at line 371 of file itkBSplineDeformableTransform.h.

◆ m_ValidRegionLast

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

IndexType itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::m_ValidRegionLast {}

private

Definition at line 370 of file itkBSplineDeformableTransform.h.

◆ SpaceDimension

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

unsigned int itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SpaceDimension = VDimension

staticconstexpr

Dimension of the domain space.

Definition at line 149 of file itkBSplineDeformableTransform.h.

◆ SplineOrder

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>

unsigned int itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >::SplineOrder = VSplineOrder

staticconstexpr

The BSpline order.

Definition at line 152 of file itkBSplineDeformableTransform.h.

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

itkBSplineDeformableTransform.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ BulkTransformPointer

◆ BulkTransformType

◆ ConstPointer

◆ InputPointType

◆ InverseJacobianPositionType

◆ JacobianPositionType

◆ JacobianType

◆ OutputPointType

◆ PhysicalDimensionsType

◆ Pointer

◆ ScalarType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BSplineDeformableTransform()

◆ ~BSplineDeformableTransform()

Member Function Documentation

◆ ComputeJacobianWithRespectToParameters()

◆ CreateAnother()

◆ GetBulkTransform()

◆ GetGridDirection()

◆ GetGridOrigin()

◆ GetGridRegion()

◆ GetGridSpacing()

◆ GetNameOfClass()

◆ GetNumberOfParameters()

◆ GetNumberOfParametersPerDimension()

◆ GetValidRegion()

◆ InsideValidRegion()

◆ itkCloneMacro()

◆ New()

◆ PrintSelf()

◆ SetBulkTransform()

◆ SetCoefficientImageInformationFromFixedParameters()

◆ SetCoefficientImages()

◆ SetFixedParameters()

◆ SetFixedParametersGridDirectionFromTransformDomainInformation()

◆ SetFixedParametersGridOriginFromTransformDomainInformation()

◆ SetFixedParametersGridSizeFromTransformDomainInformation()

◆ SetFixedParametersGridSpacingFromTransformDomainInformation()

◆ SetGridDirection()

◆ SetGridOrigin()

◆ SetGridRegion()

◆ SetGridSpacing()

◆ TransformPoint() [1/3]

◆ TransformPoint() [2/3]

◆ TransformPoint() [3/3]

◆ UpdateValidGridRegion()

Member Data Documentation

◆ m_BulkTransform

◆ m_GridDirection

◆ m_GridOrigin

◆ m_GridRegion

◆ m_GridSpacing

◆ m_Offset

◆ m_SplineOrderOdd

◆ m_ValidRegion

◆ m_ValidRegionFirst

◆ m_ValidRegionLast

◆ SpaceDimension

◆ SplineOrder