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

#include <itkImageRegistrationMethod.h>

+ Inheritance diagram for itk::ImageRegistrationMethod< TFixedImage, TMovingImage >:
+ Collaboration diagram for itk::ImageRegistrationMethod< TFixedImage, TMovingImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef DataObject::Pointer DataObjectPointer
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef
FixedImageType::ConstPointer 
FixedImageConstPointer
typedef
MetricType::FixedImageRegionType 
FixedImageRegionType
typedef TFixedImage FixedImageType
typedef InterpolatorType::Pointer InterpolatorPointer
typedef
MetricType::InterpolatorType 
InterpolatorType
typedef MetricType::Pointer MetricPointer
typedef ImageToImageMetric
< FixedImageType,
MovingImageType
MetricType
typedef
MovingImageType::ConstPointer 
MovingImageConstPointer
typedef TMovingImage MovingImageType
typedef
SingleValuedNonLinearOptimizer 
OptimizerType
typedef
MetricType::TransformParametersType 
ParametersType
typedef SmartPointer< SelfPointer
typedef ImageRegistrationMethod Self
typedef ProcessObject Superclass
typedef
TransformOutputType::ConstPointer 
TransformOutputConstPointer
typedef
TransformOutputType::Pointer 
TransformOutputPointer
typedef DataObjectDecorator
< TransformType
TransformOutputType
typedef TransformType::Pointer TransformPointer
typedef MetricType::TransformType TransformType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const FixedImageTypeGetFixedImage ()
virtual const
FixedImageRegionType
GetFixedImageRegion ()
virtual bool GetFixedImageRegionDefined () const
virtual const ParametersTypeGetInitialTransformParameters ()
virtual const ParametersTypeGetLastTransformParameters ()
virtual const MovingImageTypeGetMovingImage ()
unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
const TransformOutputTypeGetOutput () const
virtual void Initialize () throw ( ExceptionObject )
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
void SetFixedImage (const FixedImageType *fixedImage)
void SetFixedImageRegion (const FixedImageRegionType &region)
virtual void SetFixedImageRegionDefined (bool _arg)
virtual void SetInitialTransformParameters (const ParametersType &param)
void SetMovingImage (const MovingImageType *movingImage)
virtual void SetOptimizer (OptimizerType *_arg)
virtual OptimizerTypeGetOptimizer ()
virtual void SetMetric (MetricType *_arg)
virtual MetricTypeGetMetric ()
virtual void SetTransform (TransformType *_arg)
virtual TransformTypeGetTransform ()
virtual void SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorTypeGetInterpolator ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void GenerateData ()
 ImageRegistrationMethod ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual void SetLastTransformParameters (ParametersType _arg)
void StartOptimization (void)
void StartRegistration (void)
virtual ~ImageRegistrationMethod ()

Private Member Functions

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

Private Attributes

FixedImageConstPointer m_FixedImage
FixedImageRegionType m_FixedImageRegion
bool m_FixedImageRegionDefined
ParametersType m_InitialTransformParameters
InterpolatorPointer m_Interpolator
ParametersType m_LastTransformParameters
MetricPointer m_Metric
MovingImageConstPointer m_MovingImage
OptimizerType::Pointer m_Optimizer
TransformPointer m_Transform

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::ImageRegistrationMethod< TFixedImage, TMovingImage >

Base class for Image Registration Methods.

This Class define the generic interface for a registration method.

This class is templated over the type of the two image to be registered. A generic Transform is used by this class. That allows to select at run time the particular type of transformation that is to be applied for registering the images.

This method use a generic Metric in order to compare the two images. the final goal of the registration method is to find the set of parameters of the Transformation that optimizes the metric.

The registration method also support a generic optimizer that can be selected at run-time. The only restriction for the optimizer is that it should be able to operate in single-valued cost functions given that the metrics used to compare images provide a single value as output.

The terms : Fixed image and Moving image are used in this class to indicate what image is being mapped by the transform.

This class uses the coordinate system of the Fixed image as a reference and searchs for a Transform that will map points from the space of the Fixed image to the space of the Moving image.

For doing so, a Metric will be continously applied to compare the Fixed image with the Transformed Moving image. This process also requires to interpolate values from the Moving image.

Wiki Examples:

Definition at line 70 of file itkImageRegistrationMethod.h.


Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage >
typedef SmartPointer< const Self > itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ConstPointer

Reimplemented from itk::ProcessObject.

Definition at line 77 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef DataObject::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 120 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef ProcessObject::DataObjectPointerArraySizeType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::DataObjectPointerArraySizeType

Make a DataObject of the correct type to be used as the specified output.

Reimplemented from itk::ProcessObject.

Definition at line 195 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef FixedImageType::ConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 87 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef MetricType::FixedImageRegionType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageRegionType

Definition at line 96 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef TFixedImage itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageType

Type of the Fixed image.

Definition at line 83 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef InterpolatorType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorPointer

Definition at line 110 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef MetricType::InterpolatorType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorType

Type of the Interpolator.

Definition at line 109 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef MetricType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MetricPointer

Definition at line 95 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef ImageToImageMetric< FixedImageType, MovingImageType > itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MetricType

Type of the metric.

Definition at line 94 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef MovingImageType::ConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageConstPointer

Definition at line 91 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef TMovingImage itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageType

Type of the Moving image.

Definition at line 90 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef SingleValuedNonLinearOptimizer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::OptimizerType

Type of the optimizer.

Definition at line 113 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef MetricType::TransformParametersType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ParametersType

Type of the Transformation parameters This is the same type used to represent the search space of the optimization algorithm

Definition at line 117 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef SmartPointer< Self > itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Pointer

Reimplemented from itk::ProcessObject.

Definition at line 76 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef ImageRegistrationMethod itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Definition at line 74 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef ProcessObject itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 75 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef TransformOutputType::ConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputConstPointer

Definition at line 106 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef TransformOutputType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputPointer

Definition at line 105 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef DataObjectDecorator< TransformType > itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputType

Type for the output: Using Decorator pattern for enabling the Transform to be passed in the data pipeline

Definition at line 104 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef TransformType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformPointer

Definition at line 100 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
typedef MetricType::TransformType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformType

Type of the Transform .

Definition at line 99 of file itkImageRegistrationMethod.h.


Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage >
itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod ( ) [protected]
template<typename TFixedImage , typename TMovingImage >
virtual itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::~ImageRegistrationMethod ( ) [inline, protected, virtual]

Definition at line 205 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod ( const Self ) [private]

Member Function Documentation

template<typename TFixedImage , typename TMovingImage >
virtual::itk::LightObject::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::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::Object.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GenerateData ( ) [protected, virtual]

Method invoked by the pipeline in order to trigger the computation of the registration.

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage >
virtual const FixedImageType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImage ( ) [virtual]
template<typename TFixedImage , typename TMovingImage >
virtual const FixedImageRegionType& itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImageRegion ( ) [virtual]

Get the region of the fixed image to be considered as region of interest during the registration. This region will be passed to the ImageMetric in order to restrict the metric computation to consider only this region.

template<typename TFixedImage , typename TMovingImage >
virtual bool itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImageRegionDefined ( ) const [virtual]

True if a region has been defined for the fixed image to which the ImageMetric will limit its computation

template<typename TFixedImage , typename TMovingImage >
virtual const ParametersType& itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetInitialTransformParameters ( ) [virtual]
template<typename TFixedImage , typename TMovingImage >
virtual InterpolatorType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetInterpolator ( ) [virtual]

Set/Get the Interpolator.

template<typename TFixedImage , typename TMovingImage >
virtual const ParametersType& itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetLastTransformParameters ( ) [virtual]

Get the last transformation parameters visited by the optimizer.

template<typename TFixedImage , typename TMovingImage >
virtual MetricType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetMetric ( ) [virtual]

Set/Get the Metric.

template<typename TFixedImage , typename TMovingImage >
virtual const MovingImageType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetMovingImage ( ) [virtual]
template<typename TFixedImage , typename TMovingImage >
unsigned long itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetMTime ( ) const [virtual]

Method to return the latest modified time of this object or any of its cached ivars

Reimplemented from itk::Object.

template<typename TFixedImage , typename TMovingImage >
virtual const char* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage >
virtual OptimizerType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetOptimizer ( ) [virtual]

Set/Get the Optimizer.

template<typename TFixedImage , typename TMovingImage >
const TransformOutputType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetOutput ( ) const

Returns the transform resulting from the registration process

template<typename TFixedImage , typename TMovingImage >
virtual TransformType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetTransform ( ) [virtual]

Set/Get the Transfrom.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Initialize ( ) throw ( ExceptionObject ) [virtual]

Initialize by setting the interconnects between the components.

template<typename TFixedImage , typename TMovingImage >
virtual DataObjectPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MakeOutput ( DataObjectPointerArraySizeType  idx) [virtual]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage >
static Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::operator= ( const Self ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::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::ProcessObject.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImage ( const FixedImageType fixedImage)

Set/Get the Fixed image.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImageRegion ( const FixedImageRegionType region)

Set the region of the fixed image to be considered as region of interest during the registration. This region will be passed to the ImageMetric in order to restrict the metric computation to consider only this region.

Warning:
The same region can also be set directly into the metric. please avoid to set the region in both places since this can lead to inconsistent configurations.
template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImageRegionDefined ( bool  _arg) [virtual]

Turn on/off the use of a fixed image region to which the ImageMetric will limit its computation.

Warning:
The region must have been previously defined using the SetFixedImageRegion member function
template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetInitialTransformParameters ( const ParametersType param) [virtual]

Set/Get the initial transformation parameters.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetInterpolator ( InterpolatorType _arg) [virtual]

Set/Get the Interpolator.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetLastTransformParameters ( ParametersType  _arg) [protected, virtual]

Provides derived classes with the ability to set this private var

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetMetric ( MetricType _arg) [virtual]

Set/Get the Metric.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetMovingImage ( const MovingImageType movingImage)

Set/Get the Moving image.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetOptimizer ( OptimizerType _arg) [virtual]

Set/Get the Optimizer.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetTransform ( TransformType _arg) [virtual]

Set/Get the Transfrom.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::StartOptimization ( void  ) [protected]

Method that initiates the optimization process. This method should not be called directly by the users. Instead, this method is intended to be invoked internally by the StartRegistration() which is in turn invoked by the Update() method. This method should be declared protected.

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::StartRegistration ( void  ) [protected]

Method that initiates the registration. This will Initialize and ensure that all inputs the registration needs are in place, via a call to Initialize() will then start the optimization process via a call to StartOptimization() StartRegistration is an old API from before ImageRegistrationMethod was a subclass of ProcessObject. Historically, one could call StartRegistration() instead of calling Update(). However, when called directly by the user, the inputs to ImageRegistrationMethod may not be up to date. This may cause an unexpected behavior.

Since we cannot eliminate StartRegistration for backward compability reasons, we check whether StartRegistration was called directly or whether Update() (which in turn called StartRegistration()).


Member Data Documentation

template<typename TFixedImage , typename TMovingImage >
FixedImageConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_FixedImage [private]

Definition at line 251 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
FixedImageRegionType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_FixedImageRegion [private]

Definition at line 260 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
bool itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_FixedImageRegionDefined [private]

Definition at line 259 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
ParametersType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_InitialTransformParameters [private]

Definition at line 256 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
InterpolatorPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Interpolator [private]

Definition at line 254 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
ParametersType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_LastTransformParameters [private]

Definition at line 257 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
MetricPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Metric [private]

Definition at line 247 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
MovingImageConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_MovingImage [private]

Definition at line 250 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
OptimizerType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Optimizer [private]

Definition at line 248 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >
TransformPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Transform [private]

Definition at line 253 of file itkImageRegistrationMethod.h.


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