ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > Class Template Reference

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

#include <itkDemonsRegistrationFilter.h>

Inheritance diagram for itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >:
Collaboration diagram for itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
DemonsRegistrationFunction
< FixedImageType,
MovingImageType,
DisplacementFieldType
DemonsRegistrationFunctionType
typedef
Superclass::DisplacementFieldPointer 
DisplacementFieldPointer
typedef
Superclass::DisplacementFieldType 
DisplacementFieldType
typedef
Superclass::FiniteDifferenceFunctionType 
FiniteDifferenceFunctionType
typedef
Superclass::FixedImagePointer 
FixedImagePointer
typedef Superclass::FixedImageType FixedImageType
typedef
Superclass::MovingImagePointer 
MovingImagePointer
typedef Superclass::MovingImageType MovingImageType
typedef SmartPointer< SelfPointer
typedef DemonsRegistrationFilter Self
typedef
PDEDeformableRegistrationFilter
< TFixedImage, TMovingImage,
TDisplacementField > 
Superclass
typedef Superclass::TimeStepType TimeStepType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual double GetIntensityDifferenceThreshold () const
virtual double GetMetric () const
virtual const char * GetNameOfClass () const
virtual void SetIntensityDifferenceThreshold (double)
virtual void SetUseMovingImageGradient (bool _arg)
virtual bool GetUseMovingImageGradient () const
virtual void UseMovingImageGradientOn ()
virtual void UseMovingImageGradientOff ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual void ApplyUpdate (const TimeStepType &dt)
 DemonsRegistrationFilter ()
virtual void InitializeIteration ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual void VerifyInputInformation ()

Private Member Functions

 DemonsRegistrationFilter (const Self &)
void operator= (const Self &)

Private Attributes

bool m_UseMovingImageGradient

Detailed Description

template<class TFixedImage, class TMovingImage, class TDisplacementField>
class itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Deformably register two images using the demons algorithm.

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

A displacement 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 displacement field type.

The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial displacement field maybe set via SetInitialDisplacementField 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 displacement field can be obtained via methods GetOutput or GetDisplacementField.

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 displacement field type all have the same number of dimensions.
See also:
DemonsRegistrationFunction

Definition at line 63 of file itkDemonsRegistrationFilter.h.


Member Typedef Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef SmartPointer< const Self > itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef DemonsRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType > itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DemonsRegistrationFunctionType

DemonsRegistrationFilterFunction type.

Definition at line 107 of file itkDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::DisplacementFieldPointer itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldPointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::DisplacementFieldType itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::FiniteDifferenceFunctionType itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FiniteDifferenceFunctionType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::FixedImagePointer itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::FixedImageType itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::MovingImagePointer itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::MovingImageType itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef SmartPointer< Self > itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Pointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef DemonsRegistrationFilter itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Self
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Superclass
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::TimeStepType itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType

Inherit types from superclass.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.

Definition at line 79 of file itkDemonsRegistrationFilter.h.


Constructor & Destructor Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >
itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DemonsRegistrationFilter ( ) [protected]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DemonsRegistrationFilter ( const Self ) [private]

Member Function Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ApplyUpdate ( const TimeStepType dt) [protected, virtual]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual::itk::LightObject::Pointer itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::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::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual double itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetIntensityDifferenceThreshold ( ) const [virtual]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual double itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::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 TDisplacementField >
virtual const char* itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual bool itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetUseMovingImageGradient ( ) const [virtual]

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

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

Initialize the state of filter and equation before each iteration.

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

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

Method for creation through the object factory.

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Set/Get the desired limits of the Gaussian kernel width.

See also:
GaussianOperator.

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::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 TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetUseMovingImageGradient ( bool  _arg) [virtual]

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

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

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

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

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

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::VerifyInputInformation ( ) [inline, protected, virtual]

Override VeriyInputInformation() since this filter's inputs do not need to occoupy the same physical space.

See also:
ProcessObject::VerifyInputInformation

Reimplemented from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >.

Definition at line 147 of file itkDemonsRegistrationFilter.h.


Member Data Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >
bool itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_UseMovingImageGradient [private]

Definition at line 153 of file itkDemonsRegistrationFilter.h.


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