itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField > Class Template Reference
[Deformable Registration Methods]

Deformably register two images using the demons algorithm. More...

#include <itkSymmetricForcesDemonsRegistrationFilter.h>

Inheritance diagram for itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >:

[legend]Collaboration diagram for itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >:

[legend]List of all members.

Public Types
typedef SymmetricForcesDemonsRegistrationFilter	Self
typedef PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::FixedImagePointer	FixedImagePointer
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::MovingImagePointer	MovingImagePointer
typedef Superclass::DeformationFieldType	DeformationFieldType
typedef Superclass::DeformationFieldPointer	DeformationFieldPointer
typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType
typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType
typedef SymmetricForcesDemonsRegistrationFunction< FixedImageType, MovingImageType, DeformationFieldType >	DemonsRegistrationFunctionType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual double	GetMetric () const
virtual const double &	GetRMSChange () const
virtual void	SetIntensityDifferenceThreshold (double)
virtual double	GetIntensityDifferenceThreshold () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	SymmetricForcesDemonsRegistrationFilter ()
	~SymmetricForcesDemonsRegistrationFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	InitializeIteration ()
virtual void	ApplyUpdate (TimeStepType dt)

---

Detailed Description

template<class TFixedImage, class TMovingImage, class TDeformationField>
class itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >

Deformably register two images using the demons algorithm.

This class was contributed by Corinne Mattmann, ETH Zurich, Switzerland. based on a variation of the DemonsRegistrationFilter. The basic modification is to use equation (5) from Thirion's paper along with the modification for avoiding large deformations when gradients have small values.

SymmetricForcesDemonsRegistrationFilter implements the demons deformable algorithm that register two images by computing the deformation field which will map a moving image onto a fixed image.

A deformation field is represented as a image whose pixel type is some vector type with at least N elements, where N is the dimension of the fixed image. The vector type must support element access via operator []. It is assumed that the vector elements behave like floating point scalars.

This class is templated over the fixed image type, moving image type and the deformation field type.

The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial deformation field maybe set via SetInitialDeformationField or SetInput. If no initial field is set, a zero field is used as the initial condition.

The algorithm has one parameters: the number of iteration to be performed.

The output deformation field can be obtained via methods GetOutput or GetDeformationField.

This class make use of the finite difference solver hierarchy. Update for each iteration is computed in DemonsRegistrationFunction.

Warning:

This filter assumes that the fixed image type, moving image type and deformation field type all have the same number of dimensions.

See also:

SymmetricForcesDemonsRegistrationFunction

DemonsRegistrationFilter

DemonsRegistrationFunction

Definition at line 68 of file itkSymmetricForcesDemonsRegistrationFilter.h.

---

Member Typedef Documentation

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef SmartPointer<const Self> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::ConstPointer

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 78 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::DeformationFieldPointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::DeformationFieldPointer

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 99 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::DeformationFieldType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::DeformationFieldType

Deformation field type. Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 97 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef SymmetricForcesDemonsRegistrationFunction<FixedImageType,MovingImageType, DeformationFieldType> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::DemonsRegistrationFunctionType

DemonsRegistrationFilterFunction type. Definition at line 111 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::FiniteDifferenceFunctionType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FiniteDifferenceFunctionType

FiniteDifferenceFunction type. Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 103 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::FixedImagePointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FixedImagePointer

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 89 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::FixedImageType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FixedImageType

FixedImage image type. Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 88 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::MovingImagePointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::MovingImagePointer

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 93 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::MovingImageType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::MovingImageType

MovingImage image type. Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 92 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef SmartPointer<Self> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Pointer

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 77 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef SymmetricForcesDemonsRegistrationFilter itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Self

Standard class typedefs. Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 74 of file itkSymmetricForcesDemonsRegistrationFilter.h. Referenced by itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::~SymmetricForcesDemonsRegistrationFilter().

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef PDEDeformableRegistrationFilter< TFixedImage, TMovingImage,TDeformationField> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Superclass

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. Definition at line 76 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef FiniteDifferenceFunctionType::TimeStepType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::TimeStepType

Take timestep type from the FiniteDifferenceFunction. Reimplemented from itk::DenseFiniteDifferenceImageFilter< TDeformationField, TDeformationField >. Definition at line 106 of file itkSymmetricForcesDemonsRegistrationFilter.h. Referenced by itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::~SymmetricForcesDemonsRegistrationFilter().

---

Constructor & Destructor Documentation

template<class TFixedImage, class TMovingImage, class TDeformationField> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SymmetricForcesDemonsRegistrationFilter (   )  [protected]

template<class TFixedImage, class TMovingImage, class TDeformationField> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::~SymmetricForcesDemonsRegistrationFilter (   )  [inline, protected]

Definition at line 131 of file itkSymmetricForcesDemonsRegistrationFilter.h. References itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Self, and itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::TimeStepType.

---

Member Function Documentation

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::ApplyUpdate (  TimeStepType  dt  )  [protected, virtual]

Apply update. Reimplemented from itk::DenseFiniteDifferenceImageFilter< TDeformationField, TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual double itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetIntensityDifferenceThreshold (   )  const [virtual]

Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual double itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetMetric (   )  const [virtual]

Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images. This value is calculated for the current iteration

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual const char* itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual const double& itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetRMSChange (   )  const [virtual]

Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images. This value is calculated for the current iteration

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::InitializeIteration (   )  [protected, virtual]

Initialize the state of filter and equation before each iteration. Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> Pointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::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::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetIntensityDifferenceThreshold (  double   )  [virtual]

Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.

---

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

• itkSymmetricForcesDemonsRegistrationFilter.h

---