ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkBSplineTransform.h>
Deformable transform using a BSpline representation.
This class encapsulates a deformable transform of points from one N-dimensional one 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 and is varied by defining a deformation of each control point. The deformation at any point 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 , 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.
Definition at line 110 of file itkBSplineTransform.h.
typedef Superclass::CoefficientImageArray itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::CoefficientImageArray |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 190 of file itkBSplineTransform.h.
typedef SmartPointer<const Self> itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ConstPointer |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 118 of file itkBSplineTransform.h.
typedef Superclass::ContinuousIndexType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ContinuousIndexType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 218 of file itkBSplineTransform.h.
typedef Superclass::DirectionType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::DirectionType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 211 of file itkBSplineTransform.h.
typedef Superclass::ImagePointer itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ImagePointer |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 189 of file itkBSplineTransform.h.
typedef Superclass::ImageType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ImageType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 188 of file itkBSplineTransform.h.
typedef Superclass::IndexType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::IndexType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 208 of file itkBSplineTransform.h.
typedef Superclass::InputCovariantVectorType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::InputCovariantVectorType |
Standard covariant vector type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 149 of file itkBSplineTransform.h.
typedef Superclass::InputPointType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::InputPointType |
Standard coordinate point type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 157 of file itkBSplineTransform.h.
typedef Superclass::InputVectorType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::InputVectorType |
Standard vector type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 145 of file itkBSplineTransform.h.
typedef Superclass::InputVnlVectorType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::InputVnlVectorType |
Standard vnl_vector type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 153 of file itkBSplineTransform.h.
typedef Superclass::JacobianType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::JacobianType |
Standard Jacobian container.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 139 of file itkBSplineTransform.h.
typedef Superclass::MeshSizeType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::MeshSizeType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 247 of file itkBSplineTransform.h.
typedef Superclass::NumberOfParametersType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::NumberOfParametersType |
The number of parameters defininig this transform.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 142 of file itkBSplineTransform.h.
typedef Superclass::OriginType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::OriginType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 212 of file itkBSplineTransform.h.
typedef Superclass::OutputCovariantVectorType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::OutputCovariantVectorType |
Standard covariant vector type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 150 of file itkBSplineTransform.h.
typedef Superclass::OutputPointType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::OutputPointType |
Standard coordinate point type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 158 of file itkBSplineTransform.h.
typedef Superclass::OutputVectorType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::OutputVectorType |
Standard vector type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 146 of file itkBSplineTransform.h.
typedef Superclass::OutputVnlVectorType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::OutputVnlVectorType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 154 of file itkBSplineTransform.h.
typedef Superclass::ParameterIndexArrayType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ParameterIndexArrayType |
Parameter index array type.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 221 of file itkBSplineTransform.h.
typedef Superclass::ParametersType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ParametersType |
Standard parameters container.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 136 of file itkBSplineTransform.h.
typedef Superclass::ParametersValueType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ParametersValueType |
Parameters as SpaceDimension number of images.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 187 of file itkBSplineTransform.h.
typedef Superclass::SpacingType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::PhysicalDimensionsType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 244 of file itkBSplineTransform.h.
typedef Superclass::PixelType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::PixelType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 245 of file itkBSplineTransform.h.
typedef SmartPointer<Self> itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::Pointer |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 117 of file itkBSplineTransform.h.
typedef Superclass::RegionType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::RegionType |
Typedefs for specifying the extent of the grid.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 206 of file itkBSplineTransform.h.
typedef Superclass::ScalarType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ScalarType |
Standard scalar type for this class.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 133 of file itkBSplineTransform.h.
typedef BSplineTransform itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::Self |
Standard class typedefs.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 115 of file itkBSplineTransform.h.
typedef Superclass::SizeType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SizeType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 209 of file itkBSplineTransform.h.
typedef Superclass::SpacingType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SpacingType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 210 of file itkBSplineTransform.h.
typedef BSplineBaseTransform<TScalarType,NDimensions,VSplineOrder> itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::Superclass |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 116 of file itkBSplineTransform.h.
typedef Superclass::WeightsFunctionType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::WeightsFunctionType |
Interpolation weights function type.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 215 of file itkBSplineTransform.h.
typedef Superclass::WeightsType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::WeightsType |
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 217 of file itkBSplineTransform.h.
itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::BSplineTransform | ( | ) | [protected] |
virtual itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::~BSplineTransform | ( | ) | [protected, virtual] |
itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::BSplineTransform | ( | const Self & | ) | [private] |
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::ComputeJacobianWithRespectToParameters | ( | const InputPointType & | , |
JacobianType & | |||
) | const [virtual] |
virtual::itk::LightObject::Pointer itk::BSplineTransform< TScalarType, 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.
virtual const char* itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual NumberOfParametersType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::GetNumberOfParameters | ( | ) | const [virtual] |
Return the number of parameters that completely define the Transfom
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
NumberOfParametersType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::GetNumberOfParametersPerDimension | ( | ) | const [virtual] |
Return the number of parameters per dimension
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual DirectionType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::GetTransformDomainDirection | ( | ) | const [virtual] |
Function to retrieve the transform domain direction.
virtual MeshSizeType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::GetTransformDomainMeshSize | ( | ) | const [virtual] |
Function to retrieve the transform domain mesh size.
virtual OriginType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::GetTransformDomainOrigin | ( | ) | const [virtual] |
Function to retrieve the transform domain origin.
virtual PhysicalDimensionsType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::GetTransformDomainPhysicalDimensions | ( | ) | const [virtual] |
Function to retrieve the transform domain physical dimensions.
virtual bool itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::HasLocalSupport | ( | ) | const [inline, virtual] |
Indicates if this transform is a "global" transform e.g. an affine transform, or a local one, e.g. a deformation field.
Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.
Definition at line 273 of file itkBSplineTransform.h.
virtual bool itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::InsideValidRegion | ( | ContinuousIndexType & | ) | const [private, virtual] |
Check if a continuous index is inside the valid region.
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
static Pointer itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::New | ( | ) | [static] |
New macro for creation of through the object factory.
Reimplemented from itk::Object.
void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::operator= | ( | const Self & | ) | [private] |
Mutex lock to protect modification to the reference count
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::PrintSelf | ( | std::ostream & | os, |
Indent | indent | ||
) | const [protected, virtual] |
Print contents of an BSplineTransform.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetCoefficientImageInformationFromFixedParameters | ( | ) | [private, virtual] |
Construct control point grid size from transform domain information
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual void itk::BSplineTransform< TScalarType, 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< TScalarType, NDimensions, VSplineOrder >.
virtual void itk::BSplineTransform< TScalarType, 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.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetFixedParametersGridDirectionFromTransformDomainInformation | ( | ) | const [private, virtual] |
Construct control point grid direction from transform domain information
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetFixedParametersGridOriginFromTransformDomainInformation | ( | ) | const [private, virtual] |
Construct control point grid origin from transform domain information
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetFixedParametersGridSizeFromTransformDomainInformation | ( | ) | const [private, virtual] |
Construct control point grid size from transform domain information
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetFixedParametersGridSpacingFromTransformDomainInformation | ( | ) | const [private, virtual] |
Construct control point grid spacing from transform domain information
Implements itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetTransformDomainDirection | ( | const DirectionType & | ) | [virtual] |
Function to specify the transform domain direction.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetTransformDomainMeshSize | ( | const MeshSizeType & | ) | [virtual] |
Function to specify the transform domain mesh size.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetTransformDomainOrigin | ( | const OriginType & | ) | [virtual] |
Function to specify the transform domain origin.
virtual void itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SetTransformDomainPhysicalDimensions | ( | const PhysicalDimensionsType & | ) | [virtual] |
Function to specify the transform domain physical dimensions.
virtual void itk::BSplineTransform< TScalarType, 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< TScalarType, NDimensions, VSplineOrder >.
DirectionType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::m_TransformDomainDirection [private] |
Definition at line 310 of file itkBSplineTransform.h.
DirectionType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::m_TransformDomainDirectionInverse [private] |
Definition at line 311 of file itkBSplineTransform.h.
MeshSizeType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::m_TransformDomainMeshSize [private] |
Definition at line 313 of file itkBSplineTransform.h.
OriginType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::m_TransformDomainOrigin [private] |
Definition at line 308 of file itkBSplineTransform.h.
PhysicalDimensionsType itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::m_TransformDomainPhysicalDimensions [private] |
Definition at line 309 of file itkBSplineTransform.h.
const unsigned int itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SpaceDimension = NDimensions [static] |
Dimension of the domain space.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 127 of file itkBSplineTransform.h.
const unsigned int itk::BSplineTransform< TScalarType, NDimensions, VSplineOrder >::SplineOrder = VSplineOrder [static] |
The BSpline order.
Reimplemented from itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.
Definition at line 130 of file itkBSplineTransform.h.