itk::ImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference
[Similarity Metrics of Registration Methods]

Computes similarity between regions of two images. More...

#include <itkImageToImageMetric.h>

Inheritance diagram for itk::ImageToImageMetric:

[legend]Collaboration diagram for itk::ImageToImageMetric< TFixedImage, TMovingImage >:

[legend]List of all members.

Public Types
typedef ImageToImageMetric	Self
typedef SingleValuedCostFunction	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersValueType	CoordinateRepresentationType
typedef TMovingImage	MovingImageType
typedef TMovingImage::PixelType	MovingImagePixelType
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef TFixedImage	FixedImageType
typedef FixedImageType::ConstPointer	FixedImageConstPointer
typedef FixedImageType::RegionType	FixedImageRegionType
typedef Transform< CoordinateRepresentationType, itkGetStaticConstMacro(MovingImageDimension), itkGetStaticConstMacro(FixedImageDimension)	TransformType )
typedef TransformType::Pointer	TransformPointer
typedef TransformType::InputPointType	InputPointType
typedef TransformType::OutputPointType	OutputPointType
typedef TransformType::ParametersType	TransformParametersType
typedef TransformType::JacobianType	TransformJacobianType
typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >	InterpolatorType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef Superclass::MeasureType	MeasureType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::ParametersType	ParametersType
typedef NumericTraits< MovingImagePixelType >::RealType	RealType
typedef CovariantVector< RealType, itkGetStaticConstMacro(MovingImageDimension)	GradientPixelType )
typedef Image< GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)	GradientImageType )
typedef SmartPointer< GradientImageType >	GradientImagePointer
typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >	GradientImageFilterType
typedef GradientImageFilterType::Pointer	GradientImageFilterPointer
Public Methods
virtual const char *	GetClassName () const
	itkSetConstObjectMacro (FixedImage, FixedImageType)
	itkGetConstObjectMacro (FixedImage, FixedImageType)
	itkSetConstObjectMacro (MovingImage, MovingImageType)
	itkGetConstObjectMacro (MovingImage, MovingImageType)
virtual void	SetTransform (TransformType *_arg)
virtual TransformType *	GetTransform ()
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetInterpolator ()
virtual unsigned long	GetNumberOfPixelsCounted () const
virtual void	SetFixedImageRegion (FixedImageRegionType _arg)
virtual FixedImageRegionType	GetFixedImageRegion () const
void	SetTransformParameters (const ParametersType &parameters) const
unsigned int	GetNumberOfParameters (void) const
virtual void	Initialize (void) throw ( ExceptionObject )
	itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
	itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
virtual void	SetScaleGradient (RealType _arg)
virtual RealType	GetScaleGradient ()
Protected Methods
	ImageToImageMetric ()
virtual	~ImageToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
unsigned long	m_NumberOfPixelsCounted
FixedImageConstPointer	m_FixedImage
MovingImageConstPointer	m_MovingImage
TransformPointer	m_Transform
InterpolatorPointer	m_Interpolator
bool	m_ComputeGradient
GradientImagePointer	m_GradientImage

---

Detailed Description

template<class TFixedImage, class TMovingImage>
class itk::ImageToImageMetric< TFixedImage, TMovingImage >

Computes similarity between regions of two images.

This Class is templated over the type of the two input images. It expects a Transform and an Interpolator to be plugged in. This particular class is the base class for a hierarchy of similarity metrics.

This class computes a value that measures the similarity between the Fixed image and the transformed Moving image. The Interpolator is used to compute intensity values on non-grid positions resulting from mapping points through the Transform.

Definition at line 50 of file itkImageToImageMetric.h.

---

Member Typedef Documentation

template<class TFixedImage, class TMovingImage> typedef SmartPointer<const Self> itk::ImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer

Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 57 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::ParametersValueType itk::ImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType

Type used for representing point components Definition at line 60 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::DerivativeType itk::ImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Type of the derivative. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 119 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef FixedImageType::ConstPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 72 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef FixedImageType::RegionType itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageRegionType

Definition at line 73 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TFixedImage itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 71 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef GradientImageFilterType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterPointer

Gaussian filter to compute the gradient of the Moving Image Definition at line 109 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType > itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterType

Gaussian filter to compute the gradient of the Moving Image Definition at line 108 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SmartPointer<GradientImageType> itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImagePointer

Gaussian filter to compute the gradient of the Moving Image Definition at line 105 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Image<GradientPixelType, itkGetStaticConstMacro(MovingImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImageType)

Gaussian filter to compute the gradient of the Moving Image Definition at line 104 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef CovariantVector<RealType, itkGetStaticConstMacro(MovingImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType)

Gaussian filter to compute the gradient of the Moving Image Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, and itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 102 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TransformType::InputPointType itk::ImageToImageMetric< TFixedImage, TMovingImage >::InputPointType

Definition at line 88 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef InterpolatorType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorPointer

Definition at line 113 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType > itk::ImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType

Type of the Interpolator Base class Reimplemented in itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 96 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::MeasureType itk::ImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Type of the measure. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 116 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef MovingImageType::ConstPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 68 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TMovingImage::PixelType itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType

Definition at line 67 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TMovingImage itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 66 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TransformType::OutputPointType itk::ImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType

Definition at line 89 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::ParametersType itk::ImageToImageMetric< TFixedImage, TMovingImage >::ParametersType

Type of the parameters. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 122 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SmartPointer<Self> itk::ImageToImageMetric< TFixedImage, TMovingImage >::Pointer

Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 56 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef NumericTraits<MovingImagePixelType>::RealType itk::ImageToImageMetric< TFixedImage, TMovingImage >::RealType

Gaussian filter to compute the gradient of the Moving Image Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, and itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 100 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef ImageToImageMetric itk::ImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 54 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SingleValuedCostFunction itk::ImageToImageMetric< TFixedImage, TMovingImage >::Superclass

Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 55 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TransformType::JacobianType itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 91 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TransformType::ParametersType itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 90 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TransformType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 87 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Transform<CoordinateRepresentationType, itkGetStaticConstMacro(MovingImageDimension), itkGetStaticConstMacro(FixedImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformType)

Type of the Transform Base class Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 85 of file itkImageToImageMetric.h.

---

Constructor & Destructor Documentation

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::ImageToImageMetric (    )  [protected]

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

Definition at line 176 of file itkImageToImageMetric.h.

---

Member Function Documentation

template<class TFixedImage, class TMovingImage> virtual const char* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> virtual FixedImageRegionType itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageRegion (    )  const [virtual]

Get the region over which the metric will be computed

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

Get a pointer to the Interpolator.

template<class TFixedImage, class TMovingImage> unsigned int itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfParameters (  void    )  const [inline, virtual]

Return the number of parameters required by the Transform Implements itk::CostFunction. Definition at line 161 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> virtual unsigned long itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfPixelsCounted (    )  const [virtual]

Get the number of pixels considered in the computation.

template<class TFixedImage, class TMovingImage> virtual RealType itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetScaleGradient (    )  [virtual]

Set/Get the sigma value used for computing the gradient image with a derivative of a Gaussian filter

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

Get a pointer to the Transform.

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

Initialize the Metric by making sure that all the components are present and plugged together correctly

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkGetConstObjectMacro (  MovingImage   , MovingImageType    )

Get the Moving Image.

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkGetConstObjectMacro (  FixedImage   , FixedImageType    )

Get the Fixed Image.

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkSetConstObjectMacro (  MovingImage   , MovingImageType    )

Connect the Moving Image.

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkSetConstObjectMacro (  FixedImage   , FixedImageType    )

Connect the Fixed Image.

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro (  FixedImageDimension   , unsigned    int, TFixedImage::ImageDimension    )

Constants for the image dimensions

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro (  MovingImageDimension   , unsigned    int, TMovingImage::ImageDimension    )

Constants for the image dimensions

template<class TFixedImage, class TMovingImage> void itk::ImageToImageMetric< 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::CostFunction. Reimplemented in itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::PatternIntensityImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageRegion (  FixedImageRegionType    _arg )  [virtual]

Set the region over which the metric will be computed

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetInterpolator (  InterpolatorType *    _arg )  [virtual]

Connect the Interpolator.

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetScaleGradient (  RealType    _arg )  [virtual]

Set/Get the sigma value used for computing the gradient image with a derivative of a Gaussian filter

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetTransform (  TransformType *    _arg )  [virtual]

Connect the Transform.

template<class TFixedImage, class TMovingImage> void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetTransformParameters (  const ParametersType &    parameters )  const

Set the parameters defining the Transform.

---

Member Data Documentation

template<class TFixedImage, class TMovingImage> bool itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_ComputeGradient [protected]

Definition at line 187 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> FixedImageConstPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImage [protected]

Definition at line 181 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> GradientImagePointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_GradientImage [protected]

Definition at line 188 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> InterpolatorPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_Interpolator [protected]

Definition at line 185 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> MovingImageConstPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImage [protected]

Definition at line 182 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> unsigned long itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_NumberOfPixelsCounted [protected]

Definition at line 179 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> TransformPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_Transform [protected]

Definition at line 184 of file itkImageToImageMetric.h.

---

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

• itkImageToImageMetric.h

---