itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference
[Similarity Metrics of Registration Methods, Thread Unsafe classes]

Computes the mutual information between two images to be registered using the method of Mattes et al. More...

#include <itkMattesMutualInformationImageToImageMetric.h>

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

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

[legend]List of all members.

[NOHEADER]
typedef std::vector< FixedImageSpatialSample >	FixedImageSpatialSampleContainer
virtual void	SampleFixedImageDomain (FixedImageSpatialSampleContainer &samples)
virtual void	SampleFullFixedImageDomain (FixedImageSpatialSampleContainer &samples)
virtual void	TransformPoint (unsigned int sampleNumber, const ParametersType &parameters, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue) const
FixedImageSpatialSampleContainer	m_FixedImageSamples
Public Types
typedef MattesMutualInformationImageToImageMetric	Self
typedef ImageToImageMetric< TFixedImage, TMovingImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::TransformType	TransformType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::InterpolatorType	InterpolatorType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef Superclass::MovingImageConstPointer	MovingImageCosntPointer
typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType
typedef FixedImageType::IndexType	FixedImageIndexType
typedef FixedImageIndexType::IndexValueType	FixedImageIndexValueType
typedef MovingImageType::IndexType	MovingImageIndexType
typedef TransformType::InputPointType	FixedImagePointType
typedef TransformType::OutputPointType	MovingImagePointType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void	Initialize (void) throw ( ExceptionObject )
void	GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const
MeasureType	GetValue (const ParametersType &parameters) const
void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
virtual void	SetNumberOfSpatialSamples (unsigned long _arg)
virtual const unsigned long &	GetNumberOfSpatialSamples ()
virtual void	SetNumberOfHistogramBins (unsigned long _arg)
virtual const unsigned long &	GetNumberOfHistogramBins ()
void	ReinitializeSeed ()
void	ReinitializeSeed (int)
virtual void	SetUseAllPixels (bool _arg)
virtual const bool &	GetUseAllPixels ()
virtual void	UseAllPixelsOn ()
virtual void	UseAllPixelsOff ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	MattesMutualInformationImageToImageMetric ()
virtual	~MattesMutualInformationImageToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

Computes the mutual information between two images to be registered using the method of Mattes et al.

MattesMutualInformationImageToImageMetric computes the mutual information between a fixed and moving image to be registered.

This class is templated over the FixedImage type and the MovingImage type.

The fixed and moving images are set via methods SetFixedImage() and SetMovingImage(). This metric makes use of user specified Transform and Interpolator. The Transform is used to map points from the fixed image to the moving image domain. The Interpolator is used to evaluate the image intensity at user specified geometric points in the moving image. The Transform and Interpolator are set via methods SetTransform() and SetInterpolator().

If a BSplineInterpolationFunction is used, this class obtain image derivatives from the BSpline interpolator. Otherwise, image derivatives are computed using central differencing.

Warning:

This metric assumes that the moving image has already been connected to the interpolator outside of this class.

The method GetValue() computes of the mutual information while method GetValueAndDerivative() computes both the mutual information and its derivatives with respect to the transform parameters.

The calculations are based on the method of Mattes et al [1,2] where the probability density distribution are estimated using Parzen histograms. Since the fixed image PDF does not contribute to the derivatives, it does not need to be smooth. Hence, a zero order (box car) BSpline kernel is used for the fixed image intensity PDF. On the other hand, to ensure smoothness a third order BSpline kernel is used for the moving image intensity PDF.

On Initialize(), the FixedImage is uniformly sampled within the FixedImageRegion. The number of samples used can be set via SetNumberOfSpatialSamples(). Typically, the number of spatial samples used should increase with the image size.

The option UseAllPixelOn() disables the random sampling and uses all the pixels of the FixedImageRegion in order to estimate the joint intensity PDF.

During each call of GetValue(), GetDerivatives(), GetValueAndDerivatives(), marginal and joint intensity PDF's values are estimated at discrete position or bins. The number of bins used can be set via SetNumberOfHistogramBins(). To handle data with arbitray magnitude and dynamic range, the image intensity is scale such that any contribution to the histogram will fall into a valid bin.

One the PDF's have been contructed, the mutual information is obtained by doubling summing over the discrete PDF values.

Notes: 1. This class returns the negative mutual information value. 2. This class in not thread safe due the private data structures used to the store the sampled points and the marginal and joint pdfs.

References: [1] "Nonrigid multimodality image registration" D. Mattes, D. R. Haynor, H. Vesselle, T. Lewellen and W. Eubank Medical Imaging 2001: Image Processing, 2001, pp. 1609-1620. [2] "PET-CT Image Registration in the Chest Using Free-form Deformations" D. Mattes, D. R. Haynor, H. Vesselle, T. Lewellen and W. Eubank IEEE Transactions in Medical Imaging. Vol.22, No.1, January 2003. pp.120-128. [3] "Optimization of Mutual Information for MultiResolution Image Registration" P. Thevenaz and M. Unser IEEE Transactions in Image Processing, 9(12) December 2000.

Definition at line 116 of file itkMattesMutualInformationImageToImageMetric.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 125 of file itkMattesMutualInformationImageToImageMetric.h.

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

Type used for representing point components Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 146 of file itkMattesMutualInformationImageToImageMetric.h.

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

Type of the derivative. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 139 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::FixedImageConstPointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 143 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef FixedImageType::IndexType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexType

Index and Point typedef support. Definition at line 149 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef FixedImageIndexType::IndexValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexValueType

Definition at line 150 of file itkMattesMutualInformationImageToImageMetric.h.

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

Definition at line 152 of file itkMattesMutualInformationImageToImageMetric.h. Referenced by itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageSpatialSample::FixedImageSpatialSample().

template<class TFixedImage, class TMovingImage> typedef std::vector<FixedImageSpatialSample> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageSpatialSampleContainer [protected]

FixedImageSpatialSample typedef support. Definition at line 231 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::FixedImageType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 141 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::InterpolatorType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType

Type of the Interpolator Base class Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 137 of file itkMattesMutualInformationImageToImageMetric.h.

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

Type of the measure. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 138 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::MovingImageConstPointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageCosntPointer

Definition at line 144 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef MovingImageType::IndexType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageIndexType

Definition at line 151 of file itkMattesMutualInformationImageToImageMetric.h.

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

Definition at line 153 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::MovingImageType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 142 of file itkMattesMutualInformationImageToImageMetric.h.

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

Type of the parameters. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 140 of file itkMattesMutualInformationImageToImageMetric.h.

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

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 124 of file itkMattesMutualInformationImageToImageMetric.h.

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

Standard class typedefs. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 122 of file itkMattesMutualInformationImageToImageMetric.h.

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

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 123 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::TransformJacobianType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 136 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::TransformPointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 135 of file itkMattesMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::TransformType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Types inherited from Superclass. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 134 of file itkMattesMutualInformationImageToImageMetric.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 208 of file itkMattesMutualInformationImageToImageMetric.h.

---

Member Function Documentation

template<class TFixedImage, class TMovingImage> void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative (  const ParametersType &  parameters, DerivativeType &  Derivative )  const [virtual]

Get the derivatives of the match measure. Implements itk::SingleValuedCostFunction.

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

Run-time type information (and related methods). Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> virtual const unsigned long& itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfHistogramBins (   )  [virtual]

Number of bins to used in the histogram. Typical value is 50.

template<class TFixedImage, class TMovingImage> virtual const unsigned long& itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfSpatialSamples (   )  [virtual]

Number of spatial samples to used to compute metric

template<class TFixedImage, class TMovingImage> virtual const bool& itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetUseAllPixels (   )  [virtual]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels.

template<class TFixedImage, class TMovingImage> MeasureType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValue (  const ParametersType &  parameters  )  const [virtual]

Get the value. Implements itk::SingleValuedCostFunction.

template<class TFixedImage, class TMovingImage> void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative (  const ParametersType &  parameters, MeasureType &  Value, DerivativeType &  Derivative )  const [virtual]

Get the value and derivatives for single valued optimizers. Reimplemented from itk::SingleValuedCostFunction.

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

Initialize the Metric by (1) making sure that all the components are present and plugged together correctly, (2) uniformly select NumberOfSpatialSamples within the FixedImageRegion, and (3) allocate memory for pdf data structures. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

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

The moving image dimension.

template<class TFixedImage, class TMovingImage> Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TFixedImage, class TMovingImage> void itk::MattesMutualInformationImageToImageMetric< 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::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ReinitializeSeed (  int   )

Provide API to reinitialize the seed of the random number generator

template<class TFixedImage, class TMovingImage> void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ReinitializeSeed (   )

Provide API to reinitialize the seed of the random number generator

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SampleFixedImageDomain (  FixedImageSpatialSampleContainer &  samples  )  [protected, virtual]

Uniformly select a sample set from the fixed image domain.

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SampleFullFixedImageDomain (  FixedImageSpatialSampleContainer &  samples  )  [protected, virtual]

Gather all the pixels from the fixed image domain.

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetNumberOfHistogramBins (  unsigned long  _arg  )  [virtual]

Number of bins to used in the histogram. Typical value is 50.

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetNumberOfSpatialSamples (  unsigned long  _arg  )  [virtual]

Number of spatial samples to used to compute metric

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetUseAllPixels (  bool  _arg  )  [virtual]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels.

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformPoint (  unsigned int  sampleNumber, const ParametersType &  parameters, MovingImagePointType &  mappedPoint, bool &  sampleWithinSupportRegion, double &  movingImageValue )  const [protected, virtual]

Transform a point from FixedImage domain to MovingImage domain. This function also checks if mapped point is within support region.

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::UseAllPixelsOff (   )  [virtual]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels.

template<class TFixedImage, class TMovingImage> virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::UseAllPixelsOn (   )  [virtual]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels.

---

Member Data Documentation

template<class TFixedImage, class TMovingImage> FixedImageSpatialSampleContainer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageSamples [protected]

Container to store a set of points and fixed image values. Definition at line 234 of file itkMattesMutualInformationImageToImageMetric.h.

---

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

• itkMattesMutualInformationImageToImageMetric.h

---