#include <itkBSplineTransform.h>

Inheritance diagram for itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >:

Collaboration diagram for itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >:

Detailed Description

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>
class itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >

Deformable transform using a BSpline representation.

This class encapsulates a deformable transform of points from one N-dimensional space to another N-dimensional space. The deformation field is modelled 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 transform domain (origin, physical dimensions, direction) and B-spline mesh size where the mesh size is the number of polynomial patches comprising the finite domain of support. The relationship between the mesh size ( number of polynomical pieces) and the number of control points in any given dimension is

mesh size = number of control points - spline order

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.

The parameters for this transform is 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 concatentated 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:

* typedef BSplineTransform<double,2,3> TransformType;
* TransformType::Pointer transform = TransformType::New();
*
* transform->SetTransformDomainOrigin( origin );
* transform->SetTransformDomainPhysicalDimensions( physicalDimensions );
* transform->SetTransformDomainDirection( direction );
* transform->SetTransformDomainMeshSize( meshSize );
*
* // 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 fixed parameters of the transform are 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.

A global registration of two images

Examples:: IO/TransformReadWrite.cxx, RegistrationITKv3/BSplineWarping1.cxx, RegistrationITKv3/BSplineWarping2.cxx, RegistrationITKv3/DeformableRegistration12.cxx, RegistrationITKv3/DeformableRegistration13.cxx, RegistrationITKv3/DeformableRegistration14.cxx, RegistrationITKv3/DeformableRegistration15.cxx, RegistrationITKv3/DeformableRegistration4.cxx, RegistrationITKv3/DeformableRegistration6.cxx, RegistrationITKv3/DeformableRegistration7.cxx, RegistrationITKv3/DeformableRegistration8.cxx, RegistrationITKv4/BSplineWarping1.cxx, RegistrationITKv4/BSplineWarping2.cxx, RegistrationITKv4/DeformableRegistration12.cxx, RegistrationITKv4/DeformableRegistration13.cxx, RegistrationITKv4/DeformableRegistration14.cxx, RegistrationITKv4/DeformableRegistration15.cxx, RegistrationITKv4/DeformableRegistration4.cxx, RegistrationITKv4/DeformableRegistration6.cxx, RegistrationITKv4/DeformableRegistration7.cxx, and RegistrationITKv4/DeformableRegistration8.cxx.

Definition at line 110 of file itkBSplineTransform.h.

Public Types
typedef Superclass::CoefficientImageArray	CoefficientImageArray

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ContinuousIndexType	ContinuousIndexType

typedef Superclass::DirectionType	DirectionType

typedef Superclass::ImagePointer	ImagePointer

typedef Superclass::ImageType	ImageType

typedef Superclass::IndexType	IndexType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MeshSizeType	MeshSizeType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::OriginType	OriginType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParameterIndexArrayType	ParameterIndexArrayType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef Superclass::SpacingType	PhysicalDimensionsType

typedef Superclass::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RegionType	RegionType

typedef Superclass::ScalarType	ScalarType

typedef BSplineTransform	Self

typedef Superclass::SizeType	SizeType

typedef Superclass::SpacingType	SpacingType

typedef BSplineBaseTransform < TScalar, NDimensions, VSplineOrder >	Superclass

typedef Superclass::WeightsFunctionType	WeightsFunctionType

typedef Superclass::WeightsType	WeightsType

Public Types inherited from itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >
typedef FixedArray < ImagePointer, NDimensions >	CoefficientImageArray

typedef SmartPointer< const Self >	ConstPointer

typedef WeightsFunctionType::ContinuousIndexType	ContinuousIndexType

typedef Superclass::DerivativeType	DerivativeType

typedef ImageType::DirectionType	DirectionType

typedef ImageType::Pointer	ImagePointer

typedef Image < ParametersValueType, itkGetStaticConstMacro(SpaceDimension)>	ImageType

typedef RegionType::IndexType	IndexType

typedef vnl_vector_fixed < TScalar, SpaceDimension >	InputVnlVectorType

typedef Superclass::JacobianType	JacobianType

typedef SizeType	MeshSizeType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef ImageType::PointType	OriginType

typedef vnl_vector_fixed < TScalar, SpaceDimension >	OutputVnlVectorType

typedef Array< unsigned long >	ParameterIndexArrayType

typedef Superclass::ParametersType	ParametersType

typedef ParametersType::ValueType	ParametersValueType

typedef ImageType::SpacingType	PhysicalDimensionsType

typedef ImageType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef ImageRegion < itkGetStaticConstMacro(SpaceDimension)>	RegionType

typedef Superclass::ScalarType	ScalarType

typedef BSplineBaseTransform	Self

typedef RegionType::SizeType	SizeType

typedef ImageType::SpacingType	SpacingType

typedef Transform< TScalar, NDimensions, NDimensions >	Superclass

typedef Superclass::TransformCategoryType	TransformCategoryType

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

typedef WeightsFunctionType::WeightsType	WeightsType

typedef Vector< TScalar, itkGetStaticConstMacro(SpaceDimension)>	InputVectorType

typedef Vector< TScalar, itkGetStaticConstMacro(SpaceDimension)>	OutputVectorType

typedef CovariantVector < TScalar, itkGetStaticConstMacro(SpaceDimension)>	InputCovariantVectorType

typedef CovariantVector < TScalar, itkGetStaticConstMacro(SpaceDimension)>	OutputCovariantVectorType

typedef Point< TScalar, itkGetStaticConstMacro(SpaceDimension)>	InputPointType

typedef Point< TScalar, itkGetStaticConstMacro(SpaceDimension)>	OutputPointType

Public Types inherited from itk::Transform< TScalar, NDimensions, NDimensions >
typedef SmartPointer< const Self >	ConstPointer

typedef Array < ParametersValueType >	DerivativeType

typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	DirectionChangeMatrix

typedef CovariantVector < TScalar, NInputDimensions >	InputCovariantVectorType

typedef DiffusionTensor3D < TScalar >	InputDiffusionTensor3DType

typedef Matrix< double, itkGetStaticConstMacro(InputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	InputDirectionMatrix

typedef Point< TScalar, NInputDimensions >	InputPointType

typedef SymmetricSecondRankTensor < TScalar, NInputDimensions >	InputSymmetricSecondRankTensorType

typedef VariableLengthVector < TScalar >	InputVectorPixelType

typedef Vector< TScalar, NInputDimensions >	InputVectorType

typedef vnl_vector_fixed < TScalar, NInputDimensions >	InputVnlVectorType

typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer

typedef Transform< TScalar, NOutputDimensions, NInputDimensions >	InverseTransformBaseType

typedef Array2D < ParametersValueType >	JacobianType

typedef Matrix< TScalar, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	MatrixType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef CovariantVector < TScalar, NOutputDimensions >	OutputCovariantVectorType

typedef DiffusionTensor3D < TScalar >	OutputDiffusionTensor3DType

typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(OutputSpaceDimension)>	OutputDirectionMatrix

typedef Point< TScalar, NOutputDimensions >	OutputPointType

typedef SymmetricSecondRankTensor < TScalar, NOutputDimensions >	OutputSymmetricSecondRankTensorType

typedef VariableLengthVector < TScalar >	OutputVectorPixelType

typedef Vector< TScalar, NOutputDimensions >	OutputVectorType

typedef vnl_vector_fixed < TScalar, NOutputDimensions >	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef TScalar	ScalarType

typedef Transform	Self

typedef TransformBaseTemplate < TScalar >	Superclass

typedef Superclass::TransformCategoryType	TransformCategoryType

Public Types inherited from itk::TransformBaseTemplate< TScalar >
typedef SmartPointer< const Self >	ConstPointer

typedef IdentifierType	NumberOfParametersType

typedef OptimizerParameters < ParametersValueType >	ParametersType

typedef TScalar	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef TransformBaseTemplate	Self

typedef Object	Superclass

enum	TransformCategoryType { UnknownTransformCategory =0, Linear =1, BSpline =2, Spline =3, DisplacementField =4, VelocityField =5 }

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const

virtual NumberOfParametersType	GetNumberOfParameters () const

NumberOfParametersType	GetNumberOfParametersPerDimension () const

virtual DirectionType	GetTransformDomainDirection () const

virtual MeshSizeType	GetTransformDomainMeshSize () const

virtual OriginType	GetTransformDomainOrigin () const

virtual PhysicalDimensionsType	GetTransformDomainPhysicalDimensions () const

virtual void	SetCoefficientImages (const CoefficientImageArray &images)

virtual void	SetTransformDomainDirection (const DirectionType &)

virtual void	SetTransformDomainMeshSize (const MeshSizeType &)

virtual void	SetTransformDomainOrigin (const OriginType &)

virtual void	SetTransformDomainPhysicalDimensions (const PhysicalDimensionsType &)


virtual void	SetFixedParameters (const ParametersType &parameters)


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

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

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianType &) const

const CoefficientImageArray	GetCoefficientImages () const

virtual const ParametersType &	GetFixedParameters () const

unsigned int	GetNumberOfAffectedWeights () const

virtual NumberOfParametersType	GetNumberOfLocalParameters () const

unsigned long	GetNumberOfWeights () const

virtual const ParametersType &	GetParameters () const

virtual TransformCategoryType	GetTransformCategory () const

	itkCloneMacro (Self)

void	SetIdentity ()

void	SetParameters (const ParametersType &parameters)

void	SetParametersByValue (const ParametersType &parameters)

OutputPointType	TransformPoint (const InputPointType &point) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const

virtual void	UpdateTransformParameters (const DerivativeType &update, TScalar factor=1.0)

virtual OutputVectorType	TransformVector (const InputVectorType &) const

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const

Public Member Functions inherited from itk::Transform< TScalar, NDimensions, NDimensions >
virtual void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jacobian) const

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

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

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianType &) const

unsigned int	GetInputSpaceDimension (void) const

bool	GetInverse (Self *) const

virtual InverseTransformBasePointer	GetInverseTransform () const

unsigned int	GetOutputSpaceDimension (void) const

virtual std::string	GetTransformTypeAsString () const

virtual bool	IsLinear () const

	itkCloneMacro (Self)

virtual void	SetFixedParameters (const ParametersType &)=0

virtual void	SetParameters (const ParametersType &)=0

virtual void	SetParametersByValue (const ParametersType &p)

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const

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

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const

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

virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const

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

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &) const

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

virtual OutputPointType	TransformPoint (const InputPointType &) const =0

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

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const

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

virtual OutputVectorType	TransformVector (const InputVectorType &) const

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

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const

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

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const

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

virtual void	UpdateTransformParameters (const DerivativeType &update, TScalar factor=1.0)

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) 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

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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 flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	SpaceDimension = NDimensions

static const unsigned int	SplineOrder = VSplineOrder

Static Public Attributes inherited from itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >
static const unsigned int	SpaceDimension = NDimensions

static const unsigned int	SplineOrder = VSplineOrder

Static Public Attributes inherited from itk::Transform< TScalar, NDimensions, NDimensions >
static const unsigned int	InputSpaceDimension

static const unsigned int	OutputSpaceDimension

Protected Member Functions
	BSplineTransform ()

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

virtual	~BSplineTransform ()

Protected Member Functions inherited from itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >
	BSplineBaseTransform ()

void	SetFixedParametersFromTransformDomainInformation () const

void	WrapAsImages ()

virtual	~BSplineBaseTransform ()

virtual void	SetWeightsFunction (WeightsFunctionType *_arg)

virtual WeightsFunctionType *	GetModifiableWeightsFunction ()

virtual const WeightsFunctionType *	GetWeightsFunction () const

Protected Member Functions inherited from itk::Transform< TScalar, NDimensions, NDimensions >
virtual LightObject::Pointer	InternalClone () const

OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType, const JacobianType) const

	Transform ()

	Transform (NumberOfParametersType NumberOfParameters)

virtual	~Transform ()

Protected Member Functions inherited from itk::TransformBaseTemplate< TScalar >
	TransformBaseTemplate ()

virtual	~TransformBaseTemplate ()

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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
	BSplineTransform (const Self &)

virtual bool	InsideValidRegion (ContinuousIndexType &) const

void	operator= (const Self &)

virtual void	SetCoefficientImageInformationFromFixedParameters ()

virtual void	SetFixedParametersGridDirectionFromTransformDomainInformation () const

virtual void	SetFixedParametersGridOriginFromTransformDomainInformation () const

virtual void	SetFixedParametersGridSizeFromTransformDomainInformation () const

virtual void	SetFixedParametersGridSpacingFromTransformDomainInformation () const

Private Attributes
DirectionType	m_TransformDomainDirection

DirectionType	m_TransformDomainDirectionInverse

MeshSizeType	m_TransformDomainMeshSize

OriginType	m_TransformDomainOrigin

PhysicalDimensionsType	m_TransformDomainPhysicalDimensions

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >
CoefficientImageArray	m_CoefficientImages

ParametersType	m_InternalParametersBuffer

WeightsFunctionType::Pointer	m_WeightsFunction

Protected Attributes inherited from itk::Transform< TScalar, NDimensions, NDimensions >
DirectionChangeMatrix	m_DirectionChange

ParametersType	m_FixedParameters

ParametersType	m_Parameters

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::CoefficientImageArray itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::CoefficientImageArray

Definition at line 190 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef SmartPointer<const Self> itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ConstPointer

Definition at line 118 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ContinuousIndexType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ContinuousIndexType

Definition at line 218 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::DirectionType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::DirectionType

Definition at line 211 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ImagePointer itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ImagePointer

Definition at line 189 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ImageType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ImageType

Definition at line 188 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::IndexType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::IndexType

Definition at line 208 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::InputCovariantVectorType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::InputCovariantVectorType

Standard covariant vector type for this class.

Definition at line 149 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::InputPointType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::InputPointType

Standard coordinate point type for this class.

Definition at line 157 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::InputVectorType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::InputVectorType

Standard vector type for this class.

Definition at line 145 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::InputVnlVectorType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::InputVnlVectorType

Standard vnl_vector type for this class.

Definition at line 153 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::JacobianType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::JacobianType

Standard Jacobian container.

Definition at line 139 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::MeshSizeType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::MeshSizeType

Definition at line 247 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::NumberOfParametersType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::NumberOfParametersType

The number of parameters defininig this transform.

Definition at line 142 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::OriginType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::OriginType

Definition at line 212 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::OutputCovariantVectorType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::OutputCovariantVectorType

Definition at line 150 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::OutputPointType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::OutputPointType

Definition at line 158 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::OutputVectorType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::OutputVectorType

Definition at line 146 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::OutputVnlVectorType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::OutputVnlVectorType

Definition at line 154 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ParameterIndexArrayType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ParameterIndexArrayType

Parameter index array type.

Definition at line 221 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ParametersType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ParametersType

Standard parameters container.

Definition at line 136 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ParametersValueType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ParametersValueType

Parameters as SpaceDimension number of images.

Definition at line 187 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::SpacingType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::PhysicalDimensionsType

Definition at line 244 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::PixelType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::PixelType

Definition at line 245 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef SmartPointer<Self> itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::Pointer

Definition at line 117 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::RegionType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::RegionType

Typedefs for specifying the extent of the grid.

Definition at line 206 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ScalarType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ScalarType

Standard scalar type for this class.

Definition at line 133 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef BSplineTransform itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::Self

Standard class typedefs.

Definition at line 115 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::SizeType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SizeType

Definition at line 209 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::SpacingType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SpacingType

Definition at line 210 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef BSplineBaseTransform<TScalar,NDimensions,VSplineOrder> itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::Superclass

Definition at line 116 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::WeightsFunctionType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::WeightsFunctionType

Interpolation weights function type.

Definition at line 215 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::WeightsType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::WeightsType

Definition at line 217 of file itkBSplineTransform.h.

Constructor & Destructor Documentation

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::BSplineTransform ( )

protected

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::~BSplineTransform ( )

protectedvirtual

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::BSplineTransform ( const Self & )

private

Member Function Documentation

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ComputeJacobianWithRespectToParameters	(	const InputPointType &	,
		JacobianType &
	)		const

virtual

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual::itk::LightObject::Pointer itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::CreateAnother ( void ) 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::Object.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual const char* itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual NumberOfParametersType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::GetNumberOfParameters ( ) const

virtual

Return the number of parameters that completely define the Transfom

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

NumberOfParametersType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::GetNumberOfParametersPerDimension ( ) const

virtual

Return the number of parameters per dimension

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual DirectionType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::GetTransformDomainDirection ( ) const

virtual

Function to retrieve the transform domain direction.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual MeshSizeType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::GetTransformDomainMeshSize ( ) const

virtual

Function to retrieve the transform domain mesh size.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual OriginType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::GetTransformDomainOrigin ( ) const

virtual

Function to retrieve the transform domain origin.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual PhysicalDimensionsType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::GetTransformDomainPhysicalDimensions ( ) const

virtual

Function to retrieve the transform domain physical dimensions.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual bool itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::InsideValidRegion ( ContinuousIndexType & ) const

privatevirtual

Check if a continuous index is inside the valid region.

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

static Pointer itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::New ( )

static

New macro for creation of through the object factory.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::operator= ( const Self & )

private

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

Print contents of an BSplineTransform.

Reimplemented from itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetCoefficientImageInformationFromFixedParameters ( )

privatevirtual

Construct control point grid size from transform domain information

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetCoefficientImages ( const CoefficientImageArray & images )

virtual

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< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetFixedParameters ( const ParametersType & parameters )

virtual

This method sets the fixed parameters of the transform. For a BSpline deformation transform, the fixed parameters are the following: grid size, grid origin, grid spacing, and grid direction. However, all of these are set via the much more intuitive SetTransformDomainXXX() functions

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

With recent updates to this transform, however, all these parameters are set indirectly by setting the transform domain parameters unless the user sets them with SetFixedParameters().

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

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetFixedParametersGridDirectionFromTransformDomainInformation ( ) const

privatevirtual

Construct control point grid direction from transform domain information

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetFixedParametersGridOriginFromTransformDomainInformation ( ) const

privatevirtual

Construct control point grid origin from transform domain information

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetFixedParametersGridSizeFromTransformDomainInformation ( ) const

privatevirtual

Construct control point grid size from transform domain information

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetFixedParametersGridSpacingFromTransformDomainInformation ( ) const

privatevirtual

Construct control point grid spacing from transform domain information

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetTransformDomainDirection ( const DirectionType & )

virtual

Function to specify the transform domain direction.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetTransformDomainMeshSize ( const MeshSizeType & )

virtual

Function to specify the transform domain mesh size.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetTransformDomainOrigin ( const OriginType & )

virtual

Function to specify the transform domain origin.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SetTransformDomainPhysicalDimensions ( const PhysicalDimensionsType & )

virtual

Function to specify the transform domain physical dimensions.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::TransformPoint	(	const InputPointType &	inputPoint,
		OutputPointType &	outputPoint,
		WeightsType &	weights,
		ParameterIndexArrayType &	indices,
		bool &	inside
	)		const

virtual

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.

Implements itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >.

Member Data Documentation

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

DirectionType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::m_TransformDomainDirection

private

Definition at line 305 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

DirectionType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::m_TransformDomainDirectionInverse

private

Definition at line 306 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

MeshSizeType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::m_TransformDomainMeshSize

private

Definition at line 308 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

OriginType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::m_TransformDomainOrigin

private

Definition at line 303 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

PhysicalDimensionsType itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::m_TransformDomainPhysicalDimensions

private

Definition at line 304 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

const unsigned int itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SpaceDimension = NDimensions

static

Dimension of the domain space.

Definition at line 127 of file itkBSplineTransform.h.

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

const unsigned int itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::SplineOrder = VSplineOrder

static

The BSpline order.

Definition at line 130 of file itkBSplineTransform.h.

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

itkBSplineTransform.h

Detailed Description

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3> class itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename TScalar = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>
class itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >