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

#include <itkImageToSpatialObjectMetric.h>

+ Inheritance diagram for itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >:
+ Collaboration diagram for itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
Superclass::ParametersValueType 
CoordinateRepresentationType
typedef Superclass::DerivativeType DerivativeType
typedef
FixedImageType::ConstPointer 
FixedImageConstPointer
typedef FixedImageType::Pointer FixedImagePointer
typedef TFixedImage FixedImageType
typedef
TransformType::InputPointType 
InputPointType
typedef InterpolatorType::Pointer InterpolatorPointer
typedef
LinearInterpolateImageFunction
< TFixedImage,
CoordinateRepresentationType
InterpolatorType
typedef Superclass::MeasureType MeasureType
typedef
MovingSpatialObjectType::ConstPointer 
MovingSpatialObjectConstPointer
typedef
MovingSpatialObjectType::Pointer 
MovingSpatialObjectPointer
typedef TMovingSpatialObject MovingSpatialObjectType
typedef
TransformType::OutputPointType 
OutputPointType
typedef Superclass::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef ImageToSpatialObjectMetric Self
typedef SingleValuedCostFunction Superclass
typedef TransformType::JacobianType TransformJacobianType
typedef
TransformType::ParametersType 
TransformParametersType
typedef TransformType::Pointer TransformPointer
typedef Transform
< CoordinateRepresentationType,
itkGetStaticConstMacro(ObjectDimension),
itkGetStaticConstMacro(ImageDimension) > 
TransformType
typedef vnl_vector_fixed
< double,
itkGetStaticConstMacro(ObjectDimension) > 
VectorType

Public Member Functions

virtual const FixedImageTypeGetFixedImage ()
virtual InterpolatorTypeGetInterpolator ()
virtual const ParametersTypeGetLastTransformParameters ()
virtual const
MovingSpatialObjectType
GetMovingSpatialObject ()
virtual const char * GetNameOfClass () const
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const =0
virtual void Initialize (void) throw ( ExceptionObject )
virtual void SetFixedImage (const FixedImageType *_arg)
virtual void SetInterpolator (InterpolatorType *_arg)
virtual void SetMovingSpatialObject (const MovingSpatialObjectType *_arg)
virtual void SetTransform (TransformType *_arg)

Static Public Attributes

static const unsigned int ImageDimension = FixedImageType::ImageDimension
static const unsigned int ObjectDimension = MovingSpatialObjectType::ObjectDimension

Protected Member Functions

 ImageToSpatialObjectMetric ()
 ImageToSpatialObjectMetric (const Self &)
void operator= (const Self &)
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~ImageToSpatialObjectMetric ()

Protected Attributes

FixedImageConstPointer m_FixedImage
InterpolatorPointer m_Interpolator
ParametersType m_LastTransformParameters
MeasureType m_MatchMeasure
DerivativeType m_MatchMeasureDerivatives
MovingSpatialObjectConstPointer m_MovingSpatialObject
TransformPointer m_Transform

Detailed Description

template<class TFixedImage, class TMovingSpatialObject>
class itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >

Computes similarity between a moving spatial obejct and an Image to be registered.

The ImageToSpatialObjectMetric is different from the rest of the registration framework in ITK regarding the interpretation of the Transform with respect to the Fixed and Moving objects. In most of the ITK registration framework, the Transform computed by the optimizer is the one that maps points from the space of the Fixed object into the space of the Moving object. This direction of the transform is the one that makes easier to resample the Moving object into the space of the Fixed object.

In the particular case of the ImageToSpatialObject registration, the Transform to be computed is the one mapping points from the SpatialObject into the Image, despite the fact that the SpatialObject is called the "Moving" object and the image is called the "Fixed" object. This change of reference system is the consequence of using this type of registration in applications that are based on Visualization. In the context of such visualizations it is simpler to think in terms of the Transform that can be used for displaying the SpatialObject in the appropriate position with respect to the image. Since this process does not involve resampling, but providing a Transform to a visualization routine, it is usually more natural to use the Transform that maps points from the SpatialObject space the image space.

A full discussion of the Transform directions in the ITK registration framework can be found in the ITK Software Guide.

Definition at line 61 of file itkImageToSpatialObjectMetric.h.


Member Typedef Documentation

template<class TFixedImage , class TMovingSpatialObject >
typedef SmartPointer< const Self > itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ConstPointer

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 68 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef Superclass::ParametersValueType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::CoordinateRepresentationType

Type used for representing point components

Definition at line 77 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef Superclass::DerivativeType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::DerivativeType

Type of the derivative of the match measure

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 113 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef FixedImageType::ConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImageConstPointer

Const pointer type for the FixedImage

Definition at line 123 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef FixedImageType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImagePointer

Pointer type for the FixedImage

Definition at line 116 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef TFixedImage itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImageType

Type of the fixed image

Definition at line 71 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef TransformType::InputPointType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InputPointType

Definition at line 93 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef InterpolatorType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InterpolatorPointer

Definition at line 103 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef LinearInterpolateImageFunction< TFixedImage, CoordinateRepresentationType > itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InterpolatorType

Type of the Interpolator Base class

Definition at line 101 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef Superclass::MeasureType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MeasureType

Type of the match measure

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 110 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef MovingSpatialObjectType::ConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectConstPointer

Const pointer type for the MovingSpatialObject

Definition at line 126 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef MovingSpatialObjectType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectPointer

Pointer type for the MovingSpatialObject

Definition at line 120 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef TMovingSpatialObject itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectType

Type of the MovingSpatialObject

Definition at line 74 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef TransformType::OutputPointType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::OutputPointType

Definition at line 94 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef Superclass::ParametersType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ParametersType

ParametersType typedef. It defines a position in the optimization search space.

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 130 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef SmartPointer< Self > itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Pointer

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 67 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef ImageToSpatialObjectMetric itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Self

Standard class typedefs.

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 65 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef SingleValuedCostFunction itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Superclass

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 66 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef TransformType::JacobianType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformJacobianType

Definition at line 96 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef TransformType::ParametersType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformParametersType

Definition at line 95 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef TransformType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformPointer

Definition at line 92 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef Transform< CoordinateRepresentationType, itkGetStaticConstMacro(ObjectDimension), itkGetStaticConstMacro(ImageDimension) > itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformType

Type of the Transform Base class

Definition at line 90 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
typedef vnl_vector_fixed< double, itkGetStaticConstMacro(ObjectDimension) > itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::VectorType

Typede of the vector type to return derivatives

Definition at line 107 of file itkImageToSpatialObjectMetric.h.


Constructor & Destructor Documentation

template<class TFixedImage , class TMovingSpatialObject >
itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectMetric ( ) [protected]
template<class TFixedImage , class TMovingSpatialObject >
virtual itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::~ImageToSpatialObjectMetric ( ) [inline, protected, virtual]

Definition at line 171 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectMetric ( const Self ) [inline, protected]

Definition at line 172 of file itkImageToSpatialObjectMetric.h.


Member Function Documentation

template<class TFixedImage , class TMovingSpatialObject >
virtual const FixedImageType* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetFixedImage ( ) [virtual]

Get the FixedImage.

template<class TFixedImage , class TMovingSpatialObject >
virtual InterpolatorType* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetInterpolator ( ) [virtual]

Get the Interpolator.

template<class TFixedImage , class TMovingSpatialObject >
virtual const ParametersType& itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetLastTransformParameters ( ) [virtual]

Get the last transformation parameters visited by the optimizer. This function overload the superclass's one

template<class TFixedImage , class TMovingSpatialObject >
virtual const MovingSpatialObjectType* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetMovingSpatialObject ( ) [virtual]

Get the MovingSpatialObject.

template<class TFixedImage , class TMovingSpatialObject >
virtual const char* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedCostFunction.

template<class TFixedImage , class TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetValueAndDerivative ( const ParametersType parameters,
MeasureType Value,
DerivativeType Derivative 
) const [pure virtual]

Get Value and Derivatives for MultipleValuedOptimizers

Reimplemented from itk::SingleValuedCostFunction.

template<class TFixedImage , class TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Initialize ( void  ) throw ( ExceptionObject ) [virtual]

Initialize the metric

template<class TFixedImage , class TMovingSpatialObject >
void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::operator= ( const Self ) [inline, protected]

Mutex lock to protect modification to the reference count

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 173 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::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::CostFunction.

template<class TFixedImage , class TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetFixedImage ( const FixedImageType _arg) [virtual]

Connect the FixedImage.

template<class TFixedImage , class TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetInterpolator ( InterpolatorType _arg) [virtual]

Connect the Interpolator.

template<class TFixedImage , class TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetMovingSpatialObject ( const MovingSpatialObjectType _arg) [virtual]

Connect the MovingSpatialObject

template<class TFixedImage , class TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetTransform ( TransformType _arg) [virtual]

Set/Get the Transform.


Member Data Documentation

template<class TFixedImage , class TMovingSpatialObject >
const unsigned int itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ImageDimension = FixedImageType::ImageDimension [static]

Image dimension enumeration.

Definition at line 81 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
FixedImageConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_FixedImage [protected]

Definition at line 182 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
InterpolatorPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_Interpolator [protected]

Definition at line 179 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
ParametersType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_LastTransformParameters [protected]

Definition at line 183 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
MeasureType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_MatchMeasure [protected]

Definition at line 176 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
DerivativeType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_MatchMeasureDerivatives [protected]

Definition at line 177 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
MovingSpatialObjectConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_MovingSpatialObject [protected]

Definition at line 181 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
TransformPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_Transform [mutable, protected]

Definition at line 178 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage , class TMovingSpatialObject >
const unsigned int itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ObjectDimension = MovingSpatialObjectType::ObjectDimension [static]

Object dimension enumeration.

Definition at line 85 of file itkImageToSpatialObjectMetric.h.


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