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

#include <itkMutualInformationImageToImageMetric.h>

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

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

[legend]List of all members.

---

Detailed Description

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

Computes the mutual information between two images to be registered.

MutualInformationImageToImageMetric 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().

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 Viola and Wells where the probability density distributions are estimated using Parzen windows.

By default a Gaussian kernel is used in the density estimation. Other option include Cauchy and spline-based. A user can specify the kernel passing in a pointer a KernelFunction using the SetKernelFunction() method.

Mutual information is estimated using two sample sets: one to calculate the singular and joint pdf's and one to calculate the entropy integral. By default 50 samples points are used in each set. Other values can be set via the SetNumberOfSpatialSamples() method.

Quality of the density estimate depends on the choice of the kernel's standard deviation. Optimal choice will depend on the images. It is can be shown that around the optimal variance, the mutual information estimate is relatively insensitive to small changes of the standard deviation. In our experiments, we have found that a standard deviation of 0.4 works well for images normalized to have a mean of zero and standard deviation of 1.0. The variance can be set via methods SetFixedImageStandardDeviation() and SetMovingImageStandardDeviation().

Implementaton of this class is based on: Viola, P. and Wells III, W. (1997). "Alignment by Maximization of Mutual Information" International Journal of Computer Vision, 24(2):137-154

See also:

KernelFunction

GaussianKernelFunction

Definition at line 90 of file itkMutualInformationImageToImageMetric.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef FixedImageType::IndexType	FixedImageIndexType
typedef FixedImageIndexType::IndexValueType	FixedImageIndexValueType
typedef FixedImageMaskType::Pointer	FixedImageMaskPointer
typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension)	FixedImageMaskType )
typedef TransformType::InputPointType	FixedImagePointType
typedef FixedImageType::RegionType	FixedImageRegionType
typedef Superclass::FixedImageType	FixedImageType
typedef GradientImageFilterType::Pointer	GradientImageFilterPointer
typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >	GradientImageFilterType
typedef SmartPointer< GradientImageType >	GradientImagePointer
typedef Image< GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)	GradientImageType )
typedef CovariantVector< RealType, itkGetStaticConstMacro(MovingImageDimension)	GradientPixelType )
typedef TransformType::InputPointType	InputPointType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef Superclass::InterpolatorType	InterpolatorType
typedef Superclass::MeasureType	MeasureType
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef Superclass::MovingImageConstPointer	MovingImageCosntPointer
typedef MovingImageType::IndexType	MovingImageIndexType
typedef MovingImageMaskType::Pointer	MovingImageMaskPointer
typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension)	MovingImageMaskType )
typedef TMovingImage::PixelType	MovingImagePixelType
typedef TransformType::OutputPointType	MovingImagePointType
typedef Superclass::MovingImageType	MovingImageType
typedef TransformType::OutputPointType	OutputPointType
typedef Superclass::ParametersType	ParametersType
typedef double	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef MutualInformationImageToImageMetric	Self
typedef ImageToImageMetric< TFixedImage, TMovingImage >	Superclass
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef TransformType::ParametersType	TransformParametersType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformType	TransformType
Public Member Functions
virtual void	ComputeGradientOff ()
virtual void	ComputeGradientOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
virtual const bool &	GetComputeGradient ()
bool	GetDebug () const
void	GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const
virtual const FixedImageType *	GetFixedImage ()
virtual const FixedImageMaskType *	GetFixedImageMask ()
virtual const FixedImageRegionType &	GetFixedImageRegion ()
virtual double	GetFixedImageStandardDeviation ()
virtual const GradientImageType *	GetGradientImage ()
virtual const InterpolatorType *	GetInterpolator ()
virtual KernelFunction *	GetKernelFunction ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual const MovingImageType *	GetMovingImage ()
virtual const MovingImageMaskType *	GetMovingImageMask ()
virtual const double &	GetMovingImageStandardDeviation ()
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfParameters (void) const
virtual const unsigned long &	GetNumberOfPixelsCounted ()
virtual const unsigned int &	GetNumberOfSpatialSamples ()
virtual int	GetReferenceCount () const
virtual const TransformType *	GetTransform ()
MeasureType	GetValue (const ParametersType &parameters) const
void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
bool	HasObserver (const EventObject &event) const
virtual void	Initialize (void) throw ( ExceptionObject )
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
Constants for the image dimensions *	itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	ReinitializeSeed (int)
void	ReinitializeSeed ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
Set Get gradient computation *virtual void	SetComputeGradient (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetFixedImage (const FixedImageType *_arg)
Set Get the fixed image mask *virtual void	SetFixedImageMask (FixedImageMaskType *_arg)
virtual void	SetFixedImageRegion (FixedImageRegionType _arg)
Set Get the fixed image intensitiy standard deviation This defines *the kernel bandwidth used in the joint probability distribution *calculation Default value is which works well for image intensities *normalized to a mean of and standard deviation of *Value is clamped to be always greater than zero *virtual void	SetFixedImageStandardDeviation (double _arg)
virtual void	SetInterpolator (InterpolatorType *_arg)
Set Get the kernel function This is used to calculate the joint *probability distribution Default is the GaussianKernelFunction *virtual void	SetKernelFunction (KernelFunction *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetMovingImage (const MovingImageType *_arg)
Set Get the moving image mask *virtual void	SetMovingImageMask (MovingImageMaskType *_arg)
Set Get the moving image intensitiy standard deviation This defines *the kernel bandwidth used in the joint probability distribution *calculation Default value is which works well for image intensities *normalized to a mean of and standard deviation of *Value is clamped to be always greater than zero *virtual void	SetMovingImageStandardDeviation (double _arg)
void	SetNumberOfSpatialSamples (unsigned int num)
virtual void	SetReferenceCount (int)
virtual void	SetTransform (TransformType *_arg)
void	SetTransformParameters (const ParametersType &parameters) const
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Gaussian filter to compute the gradient of the Moving Image *typedef NumericTraits< MovingImagePixelType >::RealType	RealType
Protected Member Functions
	MutualInformationImageToImageMetric ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~MutualInformationImageToImageMetric ()
Protected Attributes
bool	m_ComputeGradient
FixedImageConstPointer	m_FixedImage
FixedImageMaskPointer	m_FixedImageMask
GradientImagePointer	m_GradientImage
InterpolatorPointer	m_Interpolator
MovingImageConstPointer	m_MovingImage
MovingImageMaskPointer	m_MovingImageMask
unsigned long	m_NumberOfPixelsCounted
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
TransformPointer	m_Transform
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Classes
class	SpatialSample

---

Member Typedef Documentation

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

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

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

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

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

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

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

Index and Point typedef support. Definition at line 121 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 122 of file itkMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef FixedImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskPointer [inherited]

Definition at line 122 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskType) [inherited]

Type for the mask of the fixed image. Only pixels that are "inside" this mask will be considered for the computation of the metric Definition at line 121 of file itkImageToImageMetric.h.

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

Definition at line 124 of file itkMutualInformationImageToImageMetric.h.

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

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, and itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 74 of file itkImageToImageMetric.h.

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

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

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

Definition at line 110 of file itkImageToImageMetric.h.

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

Definition at line 109 of file itkImageToImageMetric.h.

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

Definition at line 106 of file itkImageToImageMetric.h.

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

Definition at line 105 of file itkImageToImageMetric.h.

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

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 103 of file itkImageToImageMetric.h.

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

Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 89 of file itkImageToImageMetric.h.

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

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 114 of file itkImageToImageMetric.h.

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

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

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

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

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

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 69 of file itkImageToImageMetric.h.

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

Definition at line 118 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 123 of file itkMutualInformationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef MovingImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskPointer [inherited]

Definition at line 128 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskType) [inherited]

Type for the mask of the moving image. Only pixels that are "inside" this mask will be considered for the computation of the metric Definition at line 127 of file itkImageToImageMetric.h.

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

Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 68 of file itkImageToImageMetric.h.

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

Definition at line 125 of file itkMutualInformationImageToImageMetric.h.

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

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

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

Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 90 of file itkImageToImageMetric.h.

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

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

typedef double itk::CostFunction::ParametersValueType [inherited]

ParametersType typedef. It defines a position in the optimization search space. Definition at line 46 of file itkCostFunction.h.

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

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

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

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

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

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

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

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

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

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 91 of file itkImageToImageMetric.h.

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

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

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

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

---

Constructor & Destructor Documentation

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

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

Definition at line 183 of file itkMutualInformationImageToImageMetric.h.

---

Member Function Documentation

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

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

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::ComputeGradientOff (   )  [virtual, inherited]

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::ComputeGradientOn (   )  [virtual, inherited]

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.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

template<class TFixedImage, class TMovingImage> virtual const bool& itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetComputeGradient (   )  [virtual, inherited]

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

template<class TFixedImage, class TMovingImage> void itk::MutualInformationImageToImageMetric< 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 FixedImageType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImage (   )  [virtual, inherited]

Get the Fixed Image.

template<class TFixedImage, class TMovingImage> virtual const FixedImageMaskType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageMask (   )  [virtual, inherited]

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

Get the region over which the metric will be computed

template<class TFixedImage, class TMovingImage> virtual double itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageStandardDeviation (   )  [virtual]

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class TFixedImage, class TMovingImage> virtual const GradientImageType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetGradientImage (   )  [virtual, inherited]

Get Gradient Image.

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

Get a pointer to the Interpolator.

template<class TFixedImage, class TMovingImage> virtual KernelFunction* itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetKernelFunction (   )  [virtual]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

template<class TFixedImage, class TMovingImage> virtual const MovingImageType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImage (   )  [virtual, inherited]

Get the Moving Image.

template<class TFixedImage, class TMovingImage> virtual const MovingImageMaskType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageMask (   )  [virtual, inherited]

template<class TFixedImage, class TMovingImage> virtual const double& itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageStandardDeviation (   )  [virtual]

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

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

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

Return the number of parameters required by the Transform Implements itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 197 of file itkImageToImageMetric.h.

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

Get the number of pixels considered in the computation.

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

Get the number of spatial samples.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

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

Get a pointer to the Transform.

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

Get the value. Implements itk::SingleValuedCostFunction.

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

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

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

Initialize the Metric by making sure that all the components are present and plugged together correctly Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

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

Reimplemented in itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> Constants for the image dimensions* itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro (  MovingImageDimension  , unsigned  int, TMovingImage::ImageDimension  )  [inherited]

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

Enum of the moving image dimension.

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

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

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

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

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

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

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

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

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

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

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

template<class TFixedImage, class TMovingImage> Set Get gradient computation* virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetComputeGradient (  bool  _arg  )  [virtual, inherited]

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImage (  const FixedImageType *  _arg  )  [virtual, inherited]

Connect the Fixed Image.

template<class TFixedImage, class TMovingImage> Set Get the fixed image mask* virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageMask (  FixedImageMaskType *  _arg  )  [virtual, inherited]

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

Set the region over which the metric will be computed

template<class TFixedImage, class TMovingImage> Set Get the fixed image intensitiy standard deviation This defines* the kernel bandwidth used in the joint probability distribution* calculation Default value is which works well for image intensities* normalized to a mean of and standard deviation of* Value is clamped to be always greater than zero* virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageStandardDeviation (  double  _arg  )  [virtual]

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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

Connect the Interpolator.

template<class TFixedImage, class TMovingImage> Set Get the kernel function This is used to calculate the joint* probability distribution Default is the GaussianKernelFunction* virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetKernelFunction (  KernelFunction *  _arg  )  [virtual]

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImage (  const MovingImageType *  _arg  )  [virtual, inherited]

Connect the Moving Image.

template<class TFixedImage, class TMovingImage> Set Get the moving image mask* virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageMask (  MovingImageMaskType *  _arg  )  [virtual, inherited]

template<class TFixedImage, class TMovingImage> Set Get the moving image intensitiy standard deviation This defines* the kernel bandwidth used in the joint probability distribution* calculation Default value is which works well for image intensities* normalized to a mean of and standard deviation of* Value is clamped to be always greater than zero* virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageStandardDeviation (  double  _arg  )  [virtual]

template<class TFixedImage, class TMovingImage> void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetNumberOfSpatialSamples (  unsigned int  num  )

Set the number of spatial samples. This is the number of image samples used to calculate the joint probability distribution. The number of spatial samples is clamped to be a minimum of 1. Default value is 50.

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

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

Connect the Transform.

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

Set the parameters defining the Transform.

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

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

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 unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

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

Definition at line 217 of file itkImageToImageMetric.h.

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

Definition at line 211 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> FixedImageMaskPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageMask [mutable, protected, inherited]

Definition at line 220 of file itkImageToImageMetric.h.

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

Definition at line 218 of file itkImageToImageMetric.h.

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

Definition at line 215 of file itkImageToImageMetric.h.

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

Definition at line 212 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> MovingImageMaskPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageMask [mutable, protected, inherited]

Definition at line 221 of file itkImageToImageMetric.h.

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

Definition at line 209 of file itkImageToImageMetric.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

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

Definition at line 214 of file itkImageToImageMetric.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

template<class TFixedImage, class TMovingImage> Gaussian filter to compute the gradient of the Moving Image* typedef NumericTraits<MovingImagePixelType>::RealType itk::ImageToImageMetric< TFixedImage, TMovingImage >::RealType [inherited]

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, and itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 101 of file itkImageToImageMetric.h.

---

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

• itkMutualInformationImageToImageMetric.h

---