itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions > Class Template Reference

Representation of a smooth deformation field with B-splines. More...

#include <itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h>

Inheritance diagram for itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >:

Collaboration diagram for itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >:

List of all members.

Public Types
typedef BSplineFilterType::ArrayType	ArrayType
typedef ArrayType::ValueType	ArrayValueType
typedef BSplineScatteredDataPointSetToImageFilter < PointSetType, DisplacementFieldType >	BSplineFilterType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DerivativeType	DerivativeType
typedef DerivativeType::ValueType	DerivativeValueType
typedef BSplineFilterType::PointDataImageType	DisplacementFieldControlPointLatticeType
typedef Superclass::DisplacementFieldPointer	DisplacementFieldPointer
typedef Superclass::DisplacementFieldType	DisplacementFieldType
typedef DisplacementFieldType::PixelType	DisplacementVectorType
typedef SmartPointer< Self >	Pointer
typedef PointSet < DisplacementVectorType, Dimension >	PointSetType
typedef Superclass::ScalarType	ScalarType
typedef BSplineSmoothingOnUpdateDisplacementFieldTransform	Self
typedef unsigned int	SplineOrderType
typedef DisplacementFieldTransform < TScalar, NDimensions >	Superclass
typedef BSplineFilterType::WeightsContainerType	WeightsContainerType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual ArrayType	GetNumberOfControlPointsForTheTotalField () const
virtual ArrayType	GetNumberOfControlPointsForTheUpdateField () const
virtual SplineOrderType	GetSplineOrder () const
void	SetMeshSizeForTheTotalField (const ArrayType &)
void	SetMeshSizeForTheUpdateField (const ArrayType &)
virtual void	SetNumberOfControlPointsForTheTotalField (ArrayType _arg)
virtual void	SetNumberOfControlPointsForTheUpdateField (ArrayType _arg)
virtual void	SetSplineOrder (SplineOrderType _arg)
virtual void	UpdateTransformParameters (DerivativeType &update, ScalarType factor=1.0)
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	Dimension = NDimensions
Protected Member Functions
DisplacementFieldPointer	BSplineSmoothDisplacementField (const DisplacementFieldType *, const ArrayType &)
	BSplineSmoothingOnUpdateDisplacementFieldTransform ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~BSplineSmoothingOnUpdateDisplacementFieldTransform ()
Private Member Functions
	BSplineSmoothingOnUpdateDisplacementFieldTransform (const Self &)
void	operator= (const Self &)
Private Attributes
ArrayType	m_NumberOfControlPointsForTheTotalField
ArrayType	m_NumberOfControlPointsForTheUpdateField
SplineOrderType	m_SplineOrder

---

Detailed Description

template<class TScalar, unsigned int NDimensions>
class itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >

Representation of a smooth deformation field with B-splines.

Although there already exists a B-spline transform in ITK which can be used for processes such as image registration, if these processes involve a dense sampling of an image a significant computational speed-up can be achieved by densely sampling the B-spline transform prior to invoking transformations.

This class takes as input a displacement field, smooths it on demand using the specified B-spline parameters. This represents an alternative approach to B-spline (FFD) registration and is explained more in detail in the reference given below.

Author:

Nicholas J. Tustison

REFERENCE

NJ Tustison, BB Avants, JC Gee, "Directly Manipulated Free-Form Deformation Image Registration", IEEE Transactions on Image Processing, 18(3):624-635, 2009.

Definition at line 52 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

---

Member Typedef Documentation

template<class TScalar , unsigned int NDimensions>

typedef BSplineFilterType::ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::ArrayType

Definition at line 88 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef ArrayType::ValueType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::ArrayValueType

Definition at line 89 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef BSplineScatteredDataPointSetToImageFilter<PointSetType, DisplacementFieldType> itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::BSplineFilterType

Definition at line 85 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

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

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 60 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef Superclass::DerivativeType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::DerivativeType

Derivative type

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 73 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef DerivativeType::ValueType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::DerivativeValueType

Definition at line 74 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef BSplineFilterType::PointDataImageType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::DisplacementFieldControlPointLatticeType

Definition at line 87 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef Superclass::DisplacementFieldPointer itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::DisplacementFieldPointer

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 76 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef Superclass::DisplacementFieldType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::DisplacementFieldType

Define the displacement field type and corresponding interpolator type.

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 75 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef DisplacementFieldType::PixelType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::DisplacementVectorType

typedefs for projecting the input displacement field onto a B-spline field.

Definition at line 82 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef SmartPointer<Self> itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::Pointer

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 59 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef PointSet<DisplacementVectorType, Dimension> itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::PointSetType

Definition at line 83 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef Superclass::ScalarType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::ScalarType

Types from superclass

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 72 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef BSplineSmoothingOnUpdateDisplacementFieldTransform itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::Self

Standard class typedefs.

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 57 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef unsigned int itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::SplineOrderType

Definition at line 84 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef DisplacementFieldTransform<TScalar, NDimensions> itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::Superclass

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 58 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

typedef BSplineFilterType::WeightsContainerType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::WeightsContainerType

Definition at line 86 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

---

Constructor & Destructor Documentation

template<class TScalar , unsigned int NDimensions>

itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::BSplineSmoothingOnUpdateDisplacementFieldTransform

(

)

[protected]

template<class TScalar , unsigned int NDimensions>

virtual itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::~BSplineSmoothingOnUpdateDisplacementFieldTransform

(

)

[protected, virtual]

template<class TScalar , unsigned int NDimensions>

itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::BSplineSmoothingOnUpdateDisplacementFieldTransform

(

const Self &

)

[private]

---

Member Function Documentation

template<class TScalar , unsigned int NDimensions>

DisplacementFieldPointer itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::BSplineSmoothDisplacementField	(	const DisplacementFieldType *	,
		const ArrayType &
	)		[protected]

Smooth the displacement field using B-splines.

template<class TScalar , unsigned int NDimensions>

virtual::itk::LightObject::Pointer itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::CreateAnother

(

void

)

const [virtual]

Leave CreateAnother undefined. To fully implement here, it must be sure to copy all members. It may be called from transform-cloning that only copies parameters, so override here to prevent its use without copying full members.

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

template<class TScalar , unsigned int NDimensions>

virtual const char* itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

template<class TScalar , unsigned int NDimensions>

virtual ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::GetNumberOfControlPointsForTheTotalField

(

)

const [virtual]

Get the control point grid size definining the B-spline estimate of the scalar bias field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

template<class TScalar , unsigned int NDimensions>

virtual ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::GetNumberOfControlPointsForTheUpdateField

(

)

const [virtual]

Get the control point grid size definining the B-spline estimate of the update field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

template<class TScalar , unsigned int NDimensions>

virtual SplineOrderType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::GetSplineOrder

(

)

const [virtual]

Get the spline order defining the displacement field estimate. Default = 3.

template<class TScalar , unsigned int NDimensions>

static Pointer itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::New

(

)

[static]

New macro for creation of through a Smart Pointer

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

template<class TScalar , unsigned int NDimensions>

void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::operator=

(

const Self &

)

[private]

Create an identity jacobian for use in ComputeJacobianWithRespectToParameters.

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

template<class TScalar , unsigned int NDimensions>

void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

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

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

template<class TScalar , unsigned int NDimensions>

void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::SetMeshSizeForTheTotalField

(

const ArrayType &

)

Set the total field mesh size which is used to specify the control point grid size. The mesh size in each dimension is calculated as the difference between the control point grid size and the spline order, i.e. meshSize = controlPointGridSize - SplineOrder.

template<class TScalar , unsigned int NDimensions>

void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::SetMeshSizeForTheUpdateField

(

const ArrayType &

)

Set the update field mesh size which is used to specify the control point grid size. The mesh size in each dimension is calculated as the difference between the control point grid size and the spline order, i.e. meshSize = controlPointGridSize - SplineOrder.

template<class TScalar , unsigned int NDimensions>

virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::SetNumberOfControlPointsForTheTotalField

(

ArrayType

_arg

)

[virtual]

Set the control point grid size definining the B-spline estimate of the total field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

template<class TScalar , unsigned int NDimensions>

virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::SetNumberOfControlPointsForTheUpdateField

(

ArrayType

_arg

)

[virtual]

Set the control point grid size definining the B-spline estimate of the update field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

template<class TScalar , unsigned int NDimensions>

virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::SetSplineOrder

(

SplineOrderType

_arg

)

[virtual]

Set the spline order defining the bias field estimate. Default = 3.

template<class TScalar , unsigned int NDimensions>

virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::UpdateTransformParameters	(	DerivativeType &	update,
		ScalarType	factor = 1.0
	)		[virtual]

Update the transform's parameters by the values in update. We assume update is of the same length as Parameters. Throw exception otherwise. The update process performs an smoothing on the displacement field by using BSplines. factor is a scalar multiplier for each value in update. BSplineSmoothDisplacementField is called after the update is added to the field. See base class for more details.

---

Member Data Documentation

template<class TScalar , unsigned int NDimensions>

const unsigned int itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::Dimension = NDimensions [static]

Dimension of the domain spaces.

Reimplemented from itk::DisplacementFieldTransform< TScalar, NDimensions >.

Definition at line 69 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::m_NumberOfControlPointsForTheTotalField [private]

Definition at line 182 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::m_NumberOfControlPointsForTheUpdateField [private]

Definition at line 181 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

template<class TScalar , unsigned int NDimensions>

SplineOrderType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::m_SplineOrder [private]

Definition at line 180 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

---

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

• itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h