itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField > Class Template Reference
[Finite Difference Functions]

#include <itkDemonsRegistrationFunction.h>

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

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

[legend]List of all members.

Public Types
typedef DemonsRegistrationFunction	Self
typedef PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::MovingImagePointer	MovingImagePointer
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::FixedImagePointer	FixedImagePointer
typedef FixedImageType::IndexType	IndexType
typedef FixedImageType::SizeType	SizeType
typedef FixedImageType::SpacingType	SpacingType
typedef Superclass::DeformationFieldType	DeformationFieldType
typedef Superclass::DeformationFieldTypePointer	DeformationFieldTypePointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RadiusType	RadiusType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef Superclass::TimeStepType	TimeStepType
typedef double	CoordRepType
typedef InterpolateImageFunction< MovingImageType, CoordRepType >	InterpolatorType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef InterpolatorType::PointType	PointType
typedef LinearInterpolateImageFunction< MovingImageType, CoordRepType >	DefaultInterpolatorType
typedef CovariantVector< double, itkGetStaticConstMacro(ImageDimension)	CovariantVectorType )
typedef CentralDifferenceImageFunction< FixedImageType >	GradientCalculatorType
typedef GradientCalculatorType::Pointer	GradientCalculatorPointer
typedef CentralDifferenceImageFunction< MovingImageType, CoordRepType >	MovingImageGradientCalculatorType
typedef MovingImageGradientCalculatorType::Pointer	MovingImageGradientCalculatorPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
void	SetMovingImageInterpolator (InterpolatorType *ptr)
InterpolatorType *	GetMovingImageInterpolator (void)
virtual TimeStepType	ComputeGlobalTimeStep (void *) const
virtual void	ReleaseGlobalDataPointer (void *GlobalData) const
virtual void	InitializeIteration ()
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))
virtual double	GetMetric () const
virtual double	GetRMSChange () const
virtual void *	GetGlobalDataPointer () const
virtual void	SetUseMovingImageGradient (bool flag)
virtual bool	GetUseMovingImageGradient () const
virtual void	SetIntensityDifferenceThreshold (double)
virtual double	GetIntensityDifferenceThreshold () const
Static Public Member Functions
Pointer	New ()
Protected Types
typedef ConstNeighborhoodIterator< FixedImageType >	FixedImageNeighborhoodIteratorType
Protected Member Functions
	DemonsRegistrationFunction ()
	~DemonsRegistrationFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

This class encapsulate the PDE which drives the demons registration algorithm. It is used by DemonsRegistrationFilter to compute the output deformation field which will map a moving image onto a a fixed image.

Non-integer moving image values are obtained by using interpolation. The default interpolator is of type LinearInterpolateImageFunction. The user may set other interpolators via method SetMovingImageInterpolator. Note that the input interpolator must derive from baseclass InterpolateImageFunction.

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

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:

DemonsRegistrationFilter

Definition at line 53 of file itkDemonsRegistrationFunction.h.

---

Member Typedef Documentation

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

Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 66 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef double itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::CoordRepType

Interpolator type. Definition at line 103 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef CovariantVector<double,itkGetStaticConstMacro(ImageDimension) itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::CovariantVectorType)

Covariant vector type. Definition at line 113 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef LinearInterpolateImageFunction<MovingImageType,CoordRepType> itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::DefaultInterpolatorType

Definition at line 109 of file itkDemonsRegistrationFunction.h.

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

Deformation field type. Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 87 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::DeformationFieldTypePointer itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::DeformationFieldTypePointer

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

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef ConstNeighborhoodIterator<FixedImageType> itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::FixedImageNeighborhoodIteratorType [protected]

FixedImage image neighborhood iterator type. Definition at line 199 of file itkDemonsRegistrationFunction.h. Referenced by itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::~DemonsRegistrationFunction().

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

Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 81 of file itkDemonsRegistrationFunction.h.

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

FixedImage image type. Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 80 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::FloatOffsetType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::FloatOffsetType

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood. Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >. Definition at line 99 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef GradientCalculatorType::Pointer itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GradientCalculatorPointer

Definition at line 119 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef CentralDifferenceImageFunction<FixedImageType> itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GradientCalculatorType

Fixed image gradient calculator type. Definition at line 117 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef FixedImageType::IndexType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::IndexType

Definition at line 82 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef InterpolatorType::Pointer itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::InterpolatorPointer

Definition at line 106 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef InterpolateImageFunction<MovingImageType,CoordRepType> itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::InterpolatorType

Definition at line 105 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef MovingImageGradientCalculatorType::Pointer itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::MovingImageGradientCalculatorPointer

Definition at line 125 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef CentralDifferenceImageFunction<MovingImageType,CoordRepType> itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::MovingImageGradientCalculatorType

Moving image gradient calculator type. Definition at line 123 of file itkDemonsRegistrationFunction.h.

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

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

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

MovingImage image type. Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 76 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::NeighborhoodType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::NeighborhoodType

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary. Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >. Definition at line 98 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::PixelType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::PixelType

Inherit some enums from the superclass. Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >. Definition at line 96 of file itkDemonsRegistrationFunction.h.

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

Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 65 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef InterpolatorType::PointType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::PointType

Definition at line 107 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef Superclass::RadiusType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::RadiusType

Neighborhood radius type Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >. Definition at line 97 of file itkDemonsRegistrationFunction.h.

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

Standard class typedefs. Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 61 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef FixedImageType::SizeType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SizeType

Definition at line 83 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef FixedImageType::SpacingType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SpacingType

Definition at line 84 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> typedef PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField > itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::Superclass

Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >. Definition at line 64 of file itkDemonsRegistrationFunction.h.

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

Define the TimeStepType to always be double. Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >. Definition at line 100 of file itkDemonsRegistrationFunction.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 194 of file itkDemonsRegistrationFunction.h. References itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::FixedImageNeighborhoodIteratorType.

---

Member Function Documentation

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual TimeStepType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeGlobalTimeStep (  void *   )  const [inline, virtual]

This class uses a constant timestep of 1. Implements itk::FiniteDifferenceFunction< TDeformationField >. Definition at line 136 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual PixelType itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate (  const NeighborhoodType &  neighborhood, void *  globalData, const FloatOffsetType &  offset = FloatOffsetType(0.0) )  [virtual]

This method is called by a finite difference solver image filter at each pixel that does not lie on a data set boundary Implements itk::FiniteDifferenceFunction< TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void* itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetGlobalDataPointer (   )  const [inline, virtual]

Return a pointer to a global data structure that is passed to this object from the solver at each calculation. Implements itk::FiniteDifferenceFunction< TDeformationField >. Definition at line 142 of file itkDemonsRegistrationFunction.h. References itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GlobalDataStruct::m_NumberOfPixelsProcessed, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GlobalDataStruct::m_SumOfSquaredChange, and itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GlobalDataStruct::m_SumOfSquaredDifference.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual double itk::DemonsRegistrationFunction< 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::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetMetric (   )  const [inline, 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. Definition at line 168 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> InterpolatorType* itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetMovingImageInterpolator (  void   )  [inline]

Get the moving image interpolator. Definition at line 132 of file itkDemonsRegistrationFunction.h.

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

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

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

Get the rms change in deformation field. Definition at line 172 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual bool itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetUseMovingImageGradient (   )  const [inline, virtual]

Select if the fixed image or moving image gradient is used for the computating the demon forces. The fixed image gradient is used by default. Definition at line 180 of file itkDemonsRegistrationFunction.h.

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

Set the object's state before each iteration. Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::itkStaticConstMacro (  ImageDimension  , unsigned  int, Superclass::ImageDimension  )

Inherit some enums from the superclass.

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

Method for creation through the object factory. Reimplemented from itk::LightObject.

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

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ReleaseGlobalDataPointer (  void *  GlobalData  )  const [virtual]

Release memory for global data structure. Implements itk::FiniteDifferenceFunction< TDeformationField >.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::DemonsRegistrationFunction< 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> void itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SetMovingImageInterpolator (  InterpolatorType *  ptr  )  [inline]

Set the moving image interpolator. Definition at line 128 of file itkDemonsRegistrationFunction.h.

template<class TFixedImage, class TMovingImage, class TDeformationField> virtual void itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SetUseMovingImageGradient (  bool  flag  )  [inline, virtual]

Select if the fixed image or moving image gradient is used for the computating the demon forces. The fixed image gradient is used by default. Definition at line 178 of file itkDemonsRegistrationFunction.h.

---

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

• itkDemonsRegistrationFunction.h

---