ITK: itk::ImageRegistrationMethod< TFixedImage, TMovingImage

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

Detailed Description

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

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.

Member Typedef Documentation

template<typename TFixedImage, typename TMovingImage>

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

Reimplemented from itk::ProcessObject.

Definition at line 70 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 114 of file itkImageRegistrationMethod.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 80 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 90 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Type of the Fixed image.

Definition at line 76 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 104 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Type of the Interpolator.

Definition at line 103 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 89 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 88 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 84 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Type of the Moving image.

Definition at line 83 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Type of the optimizer.

Definition at line 107 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 111 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Reimplemented from itk::ProcessObject.

Definition at line 69 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 67 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Reimplemented from itk::ProcessObject.

Definition at line 68 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 100 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 99 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 98 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Definition at line 94 of file itkImageRegistrationMethod.h.

template<typename TFixedImage, typename TMovingImage>

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

Type of the Transform .

Definition at line 93 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 209 of file itkImageRegistrationMethod.h.

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 225 of file itkProcessObject.h.

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.

virtual void itk::ProcessObject::GenerateInputRequestedRegion ( ) [protected, virtual, inherited]

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	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< Self >	Pointer
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 void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const FixedImageRegionType &	GetFixedImageRegion ()
virtual bool	GetFixedImageRegionDefined ()
DataObjectPointerArray &	GetInputs ()
virtual const ParametersType &	GetLastTransformParameters ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
const TransformOutputType *	GetOutput () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
virtual void	Initialize () throw (ExceptionObject)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetFixedImageRegion (const FixedImageRegionType &region)
virtual void	SetFixedImageRegionDefined (bool _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
void	StartOptimization (void)
void	StartRegistration (void)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual const FixedImageType *	GetFixedImage ()
void	SetFixedImage (const FixedImageType *fixedImage)

virtual const ParametersType &	GetInitialTransformParameters ()
virtual void	SetInitialTransformParameters (const ParametersType &param)

virtual InterpolatorType *	GetInterpolator ()
virtual void	SetInterpolator (InterpolatorType *_arg)

virtual MetricType *	GetMetric ()
virtual void	SetMetric (MetricType *_arg)

virtual const MovingImageType *	GetMovingImage ()
void	SetMovingImage (const MovingImageType *movingImage)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
DataObjectPointerArray &	GetOutputs ()

virtual const int &	GetNumberOfThreads ()
virtual void	SetNumberOfThreads (int _arg)

virtual OptimizerType *	GetOptimizer ()
virtual void	SetOptimizer (OptimizerType *_arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetReleaseDataFlag (bool flag)

virtual TransformType *	GetTransform ()
virtual void	SetTransform (TransformType *_arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
virtual void	CacheInputReleaseDataFlags ()
void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
	ImageRegistrationMethod ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetLastTransformParameters (ParametersType _arg)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual	~ImageRegistrationMethod ()

virtual void	AddInput (DataObject *input)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)

virtual void	AddOutput (DataObject *output)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

const DataObject *	GetInput (unsigned int idx) const
DataObject *	GetInput (unsigned int idx)

const DataObject *	GetOutput (unsigned int idx) const
DataObject *	GetOutput (unsigned int idx)

virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
TimeStamp	m_OutputInformationMTime
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

itk::ImageRegistrationMethod< TFixedImage, TMovingImage > Class Template Reference [Registration Filters]

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

itk::ImageRegistrationMethod< TFixedImage, TMovingImage > Class Template Reference
[Registration Filters]

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