pcm::PhaseCorrelationOptimizer< TImage > Class Template Reference

#include <itkPhaseCorrelationOptimizer.h>

List of all members.


Detailed Description

template<typename TImage>
class pcm::PhaseCorrelationOptimizer< TImage >

Defines common interface for optimizers, that estimates the shift from correlation surface.

The class is templated over the input image type, as some optimizers operate real correlation surface and some on complex correlation surface.

This class implements input and output handling, while the computation has to be performed by ComputeOffset() method, that must be overriden in childs.

Author:
Jakub Bican, jakub.bican@matfyz.cz, Department of Image Processing, Institute of Information Theory and Automation, Academy of Sciences of the Czech Republic.


Public Types

typedef TImage ImageType
 Type of the input image.
typedef ImageType::PointType OffsetType
 Type for the output parameters.
typedef itk::SimpleDataObjectDecorator<
OffsetType
OffsetOutputType
 Type for the output: Using Decorator pattern for enabling the offset to be passed in the data pipeline.
typedef itk::DataObject::Pointer DataObjectPointer
 Smart Pointer type to a DataObject.

Public Member Functions

 itkTypeMacro (PhaseCorrelationOptimizer, itk::ProcessObject)
 Run-time type information (and related methods).
 itkStaticConstMacro (ImageDimension, unsigned int, Dimension)
 Dimensionality of input and output data.
 itkGetConstReferenceMacro (Offset, OffsetType)
 Get the computed offset.
void SetInput (const ImageType *image)
 Sets the input image to the optimizer.
const OffsetOutputTypeGetOutput () const
 Returns the offset resulting from the registration process.
virtual DataObjectPointer MakeOutput (unsigned int idx)
 Make a DataObject of the correct type to be used as the specified output.

Protected Member Functions

void GenerateData ()
 Method invoked by the pipeline in order to trigger the computation of the output values.
virtual void ComputeOffset ()=0
 This method is executed by this type and must be reimplemented by child filter to perform the computation.
 itkSetMacro (Offset, OffsetType)
 Provides derived classes with the ability to set this private var.


Member Typedef Documentation

template<typename TImage>
typedef TImage pcm::PhaseCorrelationOptimizer< TImage >::ImageType

Type of the input image.

Reimplemented in pcm::MaxPhaseCorrelationOptimizer< TRegistrationMethod >.

template<typename TImage>
typedef ImageType::PointType pcm::PhaseCorrelationOptimizer< TImage >::OffsetType

Type for the output parameters.

It defines a position in the optimization search space.

Reimplemented in pcm::MaxPhaseCorrelationOptimizer< TRegistrationMethod >.

template<typename TImage>
typedef itk::DataObject::Pointer pcm::PhaseCorrelationOptimizer< TImage >::DataObjectPointer

Smart Pointer type to a DataObject.


Member Function Documentation

template<typename TImage>
pcm::PhaseCorrelationOptimizer< TImage >::itkTypeMacro ( PhaseCorrelationOptimizer< TImage >  ,
itk::ProcessObject   
)

Run-time type information (and related methods).

template<typename TImage>
pcm::PhaseCorrelationOptimizer< TImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
Dimension   
)

Dimensionality of input and output data.

template<typename TImage>
pcm::PhaseCorrelationOptimizer< TImage >::itkGetConstReferenceMacro ( Offset  ,
OffsetType   
)

Get the computed offset.

template<typename TImage>
void pcm::PhaseCorrelationOptimizer< TImage >::SetInput ( const ImageType image  ) 

Sets the input image to the optimizer.

template<typename TImage>
virtual DataObjectPointer pcm::PhaseCorrelationOptimizer< TImage >::MakeOutput ( unsigned int  idx  )  [virtual]

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

template<typename TImage>
void pcm::PhaseCorrelationOptimizer< TImage >::GenerateData (  )  [protected]

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


The documentation for this class was generated from the following file:
Generated on Fri Aug 28 14:04:34 2009 for R3DImageTools by  doxygen 1.5.2