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

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

#include <itkDemonsRegistrationFilter.h>

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

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

[legend]List of all members.

Public Types
typedef DemonsRegistrationFilter	Self
typedef PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::TimeStepType	TimeStepType
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 DemonsRegistrationFunction< FixedImageType, MovingImageType, DeformationFieldType >	DemonsRegistrationFunctionType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual double	GetMetric () const
virtual void	SetUseMovingImageGradient (bool _arg)
virtual bool	GetUseMovingImageGradient ()
virtual void	UseMovingImageGradientOn ()
virtual void	UseMovingImageGradientOff ()
virtual void	SetIntensityDifferenceThreshold (double)
virtual double	GetIntensityDifferenceThreshold () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	DemonsRegistrationFilter ()
	~DemonsRegistrationFilter ()
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::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >

Deformably register two images using the demons algorithm.

DemonsRegistrationFilter 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:

DemonsRegistrationFunction

Definition at line 61 of file itkDemonsRegistrationFilter.h.

---

Member Typedef Documentation

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

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

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

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

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

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

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef DemonsRegistrationFunction<FixedImageType,MovingImageType, DeformationFieldType> itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::DemonsRegistrationFunctionType

DemonsRegistrationFilterFunction type. Definition at line 103 of file itkDemonsRegistrationFilter.h.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::TimeStepType itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::TimeStepType

Inherit types from superclass. Reimplemented from itk::DenseFiniteDifferenceImageFilter< TDeformationField, TDeformationField >. Definition at line 81 of file itkDemonsRegistrationFilter.h. Referenced by itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::~DemonsRegistrationFilter().

---

Constructor & Destructor Documentation

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

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

Definition at line 129 of file itkDemonsRegistrationFilter.h. References itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Self, and itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::TimeStepType.

---

Member Function Documentation

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::DemonsRegistrationFilter< 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::DemonsRegistrationFilter< 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::DemonsRegistrationFilter< 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 is value is only available for the previous iteration and NOT the current iteration.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual const char* itk::DemonsRegistrationFilter< 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 bool itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetUseMovingImageGradient (   )  [virtual]

Switch between using the fixed image and moving image gradient for computing the deformation field updates.

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

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetUseMovingImageGradient (  bool  _arg  )  [virtual]

Switch between using the fixed image and moving image gradient for computing the deformation field updates.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::UseMovingImageGradientOff (   )  [virtual]

Switch between using the fixed image and moving image gradient for computing the deformation field updates.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::UseMovingImageGradientOn (   )  [virtual]

Switch between using the fixed image and moving image gradient for computing the deformation field updates.

---

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

• itkDemonsRegistrationFilter.h

---