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

Deformably register two images using a symmetric forces demons algorithm. More...

#include <itkFastSymmetricForcesDemonsRegistrationFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
ESMDemonsRegistrationFunction
< FixedImageType,
MovingImageType,
DisplacementFieldType
DemonsRegistrationFunctionType
typedef
Superclass::DisplacementFieldPointer 
DisplacementFieldPointer
typedef
Superclass::DisplacementFieldType 
DisplacementFieldType
typedef
Superclass::FixedImagePointer 
FixedImagePointer
typedef Superclass::FixedImageType FixedImageType
typedef
DemonsRegistrationFunctionType::GradientType 
GradientType
typedef
Superclass::MovingImagePointer 
MovingImagePointer
typedef Superclass::MovingImageType MovingImageType
typedef SmartPointer< SelfPointer
typedef
FastSymmetricForcesDemonsRegistrationFilter 
Self
typedef
PDEDeformableRegistrationFilter
< TFixedImage, TMovingImage,
TDisplacementField > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual double GetIntensityDifferenceThreshold () const
virtual double GetMaximumUpdateStepLength () const
virtual double GetMetric () const
virtual const char * GetNameOfClass () const
virtual const double & GetRMSChange () const
virtual GradientType GetUseGradientType () const
virtual void SetIntensityDifferenceThreshold (double)
virtual void SetMaximumUpdateStepLength (double)
virtual void SetUseGradientType (GradientType gtype)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = FixedImageType::ImageDimension

Protected Types

typedef AdderType::Pointer AdderPointer
typedef AddImageFilter
< DisplacementFieldType,
DisplacementFieldType,
DisplacementFieldType
AdderType
typedef
Superclass::FiniteDifferenceFunctionType 
FiniteDifferenceFunctionType
typedef
MultiplyByConstantType::Pointer 
MultiplyByConstantPointer
typedef MultiplyImageFilter
< DisplacementFieldType,
itk::Image< TimeStepType,
ImageDimension >
, DisplacementFieldType
MultiplyByConstantType
typedef
FiniteDifferenceFunctionType::TimeStepType 
TimeStepType

Protected Member Functions

virtual void AllocateUpdateBuffer ()
virtual void ApplyUpdate (const TimeStepType &dt)
 FastSymmetricForcesDemonsRegistrationFilter ()
virtual void InitializeIteration ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~FastSymmetricForcesDemonsRegistrationFilter ()

Private Member Functions

DemonsRegistrationFunctionTypeDownCastDifferenceFunctionType ()
const
DemonsRegistrationFunctionType
DownCastDifferenceFunctionType () const
 FastSymmetricForcesDemonsRegistrationFilter (const Self &)
void operator= (const Self &)

Private Attributes

AdderPointer m_Adder
MultiplyByConstantPointer m_Multiplier

Detailed Description

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

Deformably register two images using a symmetric forces demons algorithm.

This class was contributed by Tom Vercauteren, INRIA & Mauna Kea Technologies based on a variation of the DemonsRegistrationFilter.

FastSymmetricForcesDemonsRegistrationFilter 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 SetInitialDisplacementField or SetInput. If no initial field is set, a zero field is used as the initial condition.

The output deformation 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.

Author:
Tom Vercauteren, INRIA & Mauna Kea Technologies

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/510

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
DemonsRegistrationFunction

Definition at line 73 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.


Member Typedef Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef AdderType::Pointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::AdderPointer [protected]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef AddImageFilter< DisplacementFieldType, DisplacementFieldType, DisplacementFieldType > itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::AdderType [protected]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef SmartPointer< const Self > itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef ESMDemonsRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType > itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DemonsRegistrationFunctionType

DemonsRegistrationFilterFunction type.

FIXME: Why is this the only permissible function ?

Definition at line 121 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::DisplacementFieldPointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldPointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::DisplacementFieldType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::FiniteDifferenceFunctionType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FiniteDifferenceFunctionType [protected]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::FixedImagePointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::FixedImageType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef DemonsRegistrationFunctionType::GradientType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GradientType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::MovingImagePointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef Superclass::MovingImageType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef MultiplyByConstantType::Pointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MultiplyByConstantPointer [protected]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef MultiplyImageFilter< DisplacementFieldType, itk::Image<TimeStepType, ImageDimension>, DisplacementFieldType > itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MultiplyByConstantType [protected]

other typedefs

Definition at line 167 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef SmartPointer< Self > itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Pointer
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef FastSymmetricForcesDemonsRegistrationFilter itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Self
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Superclass
template<class TFixedImage , class TMovingImage , class TDisplacementField >
typedef FiniteDifferenceFunctionType::TimeStepType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType [protected]

Constructor & Destructor Documentation

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

Member Function Documentation

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

This method allocates storage in m_UpdateBuffer. It is called from FiniteDifferenceFilter::GenerateData().

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

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual void itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ApplyUpdate ( const TimeStepType dt) [protected, virtual]

Apply update.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual::itk::LightObject::Pointer itk::FastSymmetricForcesDemonsRegistrationFilter< 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 >
DemonsRegistrationFunctionType* itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DownCastDifferenceFunctionType ( ) [private]

Downcast the DifferenceFunction using a dynamic_cast to ensure that it is of the correct type. this method will throw an exception if the function is not of the expected type.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
const DemonsRegistrationFunctionType* itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DownCastDifferenceFunctionType ( ) const [private]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual double itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetIntensityDifferenceThreshold ( ) const [virtual]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual double itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetMaximumUpdateStepLength ( ) const [virtual]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual double itk::FastSymmetricForcesDemonsRegistrationFilter< 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 value is calculated for the current iteration

template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual const char* itk::FastSymmetricForcesDemonsRegistrationFilter< 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 const double& itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange ( ) const [virtual]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual GradientType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetUseGradientType ( ) const [virtual]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual void itk::FastSymmetricForcesDemonsRegistrationFilter< 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::FastSymmetricForcesDemonsRegistrationFilter< 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::FastSymmetricForcesDemonsRegistrationFilter< 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::FastSymmetricForcesDemonsRegistrationFilter< 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::FastSymmetricForcesDemonsRegistrationFilter< 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::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetMaximumUpdateStepLength ( double  ) [virtual]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
virtual void itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetUseGradientType ( GradientType  gtype) [virtual]

Member Data Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >
const unsigned int itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ImageDimension = FixedImageType::ImageDimension [static]

Inherit some enums and typedefs from the superclass.

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

Definition at line 104 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >
AdderPointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_Adder [private]
template<class TFixedImage , class TMovingImage , class TDisplacementField >
MultiplyByConstantPointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_Multiplier [private]

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