#include <itkMutualInformationImageToImageMetric.h>

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

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

Classes
class	SpatialSample

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef FixedImageType::IndexType	FixedImageIndexType
typedef FixedImageIndexType::IndexValueType	FixedImageIndexValueType
typedef TransformType::InputPointType	FixedImagePointType
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::InterpolatorType	InterpolatorType
typedef KernelFunctionBase < double >	KernelFunctionType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingImageConstPointer	MovingImageCosntPointer
typedef MovingImageType::IndexType	MovingImageIndexType
typedef TransformType::OutputPointType	MovingImagePointType
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef MutualInformationImageToImageMetric	Self
typedef ImageToImageMetric < TFixedImage, TMovingImage >	Superclass
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformType	TransformType
Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef std::vector < FixedImageIndexType >	FixedImageIndexContainer
typedef FixedImageMaskType::ConstPointer	FixedImageMaskConstPointer
typedef FixedImageMaskType::Pointer	FixedImageMaskPointer
typedef SpatialObject < itkGetStaticConstMacro(FixedImageDimension) >	FixedImageMaskType
typedef TFixedImage::PixelType	FixedImagePixelType
typedef FixedImageType::RegionType	FixedImageRegionType
typedef TransformType::InputPointType	InputPointType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef MovingImageMaskType::ConstPointer	MovingImageMaskConstPointer
typedef MovingImageMaskType::Pointer	MovingImageMaskPointer
typedef SpatialObject < itkGetStaticConstMacro(MovingImageDimension) >	MovingImageMaskType
typedef TMovingImage::PixelType	MovingImagePixelType
typedef MultiThreader	MultiThreaderType
typedef TransformType::OutputPointType	OutputPointType
typedef TransformType::ParametersType	TransformParametersType
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 Types inherited from itk::SingleValuedCostFunction
typedef Superclass::ParametersValueType	ParametersValueType
Public Types inherited from itk::CostFunction
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const
virtual const char *	GetNameOfClass () const
virtual const unsigned int &	GetNumberOfSpatialSamples ()
MeasureType	GetValue (const ParametersType &parameters) const
void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
void	ReinitializeSeed ()
void	ReinitializeSeed (int)
void	SetNumberOfSpatialSamples (unsigned int num)

virtual void	SetMovingImageStandardDeviation (double _arg)
virtual const double &	GetMovingImageStandardDeviation ()

virtual void	SetFixedImageStandardDeviation (double _arg)
virtual double	GetFixedImageStandardDeviation () const

virtual void	SetKernelFunction (KernelFunctionType *_arg)
virtual KernelFunctionType *	GetKernelFunction ()
Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeGradient (void)
virtual const FixedImageType *	GetFixedImage ()
virtual const FixedImageRegionType &	GetFixedImageRegion ()
virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold ()
virtual const GradientImageType *	GetGradientImage ()
virtual const InterpolatorType *	GetInterpolator ()
virtual const MovingImageType *	GetMovingImage ()
SizeValueType	GetNumberOfMovingImageSamples (void)
unsigned int	GetNumberOfParameters (void) const
virtual const SizeValueType &	GetNumberOfPixelsCounted ()
virtual const TransformType *	GetTransform ()
virtual const bool &	GetUseAllPixels ()
virtual const bool &	GetUseFixedImageIndexes ()
virtual const bool &	GetUseFixedImageSamplesIntensityThreshold ()
virtual const bool &	GetUseSequentialSampling ()
virtual void	Initialize (void) throw ( ExceptionObject )
virtual void	MultiThreadingInitialize (void) throw ( ExceptionObject )
virtual void	SetFixedImage (const FixedImageType *_arg)
void	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
void	SetFixedImageRegion (const FixedImageRegionType reg)
void	SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual void	SetMovingImage (const MovingImageType *_arg)
void	SetNumberOfSpatialSamples (SizeValueType num)
virtual void	SetTransform (TransformType *_arg)
void	SetTransformParameters (const ParametersType &parameters) const
void	SetUseAllPixels (bool useAllPixels)
void	SetUseFixedImageIndexes (bool useIndex)
void	SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
void	SetUseSequentialSampling (bool sequentialSampling)
void	UseAllPixelsOff (void)
void	UseAllPixelsOn (void)
virtual void	SetMovingImageMask (MovingImageMaskType *_arg)
virtual void	SetMovingImageMask (const MovingImageMaskType *_arg)
virtual const MovingImageMaskType *	GetMovingImageMask ()
virtual void	SetFixedImageMask (FixedImageMaskType *_arg)
virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)
virtual const FixedImageMaskType *	GetFixedImageMask ()
void	SetNumberOfThreads (ThreadIdType numberOfThreads)
virtual const ThreadIdType &	GetNumberOfThreads ()
virtual void	SetComputeGradient (bool _arg)
virtual const bool &	GetComputeGradient ()
virtual void	ComputeGradientOn ()
virtual void	ComputeGradientOff ()
virtual void	SetNumberOfFixedImageSamples (SizeValueType numSamples)
virtual const SizeValueType &	GetNumberOfFixedImageSamples ()
virtual void	SetUseCachingOfBSplineWeights (bool _arg)
virtual const bool &	GetUseCachingOfBSplineWeights ()
virtual void	UseCachingOfBSplineWeightsOn ()
virtual void	UseCachingOfBSplineWeightsOff ()
virtual const MultiThreaderType *	GetThreader ()
const TransformPointer *	GetThreaderTransform ()

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	MovingImageDimension = MovingImageType::ImageDimension
Static Public Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int	FixedImageDimension = TFixedImage::ImageDimension

Protected Member Functions
	MutualInformationImageToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MutualInformationImageToImageMetric ()
Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadID) const
void	GetValueAndDerivativeMultiThreadedInitiate (void) const
void	GetValueAndDerivativeMultiThreadedPostProcessInitiate (void) const
void	GetValueAndDerivativeMultiThreadedPreProcessInitiate (void) const
virtual void	GetValueAndDerivativeThread (ThreadIdType threadID) const
virtual void	GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const
virtual void	GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const
virtual bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const
void	GetValueMultiThreadedInitiate (void) const
void	GetValueMultiThreadedPostProcessInitiate (void) const
void	GetValueMultiThreadedPreProcessInitiate (void) const
virtual void	GetValueThread (ThreadIdType threadID) const
virtual void	GetValueThreadPostProcess (ThreadIdType, bool) const
virtual void	GetValueThreadPreProcess (ThreadIdType, bool) const
virtual bool	GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const
	ImageToImageMetric ()
virtual void	PreComputeTransformValues (void)
virtual void	SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
virtual void	SampleFixedImageRegion (FixedImageSampleContainer &samples) const
virtual void	SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const
virtual void	SynchronizeTransforms () const
virtual void	TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ThreadIdType threadID) const
virtual void	TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, ThreadIdType threadID) const
virtual	~ImageToImageMetric ()
Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()
virtual	~SingleValuedCostFunction ()
Protected Member Functions inherited from itk::CostFunction
	CostFunction ()
virtual	~CostFunction ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Types
typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType
typedef CentralDifferenceImageFunction < MovingImageType, CoordinateRepresentationType >	DerivativeFunctionType
typedef std::vector < SpatialSample >	SpatialSampleContainer

Private Member Functions
void	CalculateDerivatives (const FixedImagePointType &, DerivativeType &) const
	MutualInformationImageToImageMetric (const Self &)
void	operator= (const Self &)
virtual void	SampleFixedImageDomain (SpatialSampleContainer &samples) const

Private Attributes
DerivativeFunctionType::Pointer	m_DerivativeCalculator
double	m_FixedImageStandardDeviation
KernelFunctionType::Pointer	m_KernelFunction
double	m_MinProbability
double	m_MovingImageStandardDeviation
unsigned int	m_NumberOfSpatialSamples
int	m_RandomSeed
bool	m_ReseedIterator
SpatialSampleContainer	m_SampleA
SpatialSampleContainer	m_SampleB

Additional Inherited Members
Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef std::vector< bool >	BooleanArrayType
typedef BSplineInterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	BSplineInterpolatorType
typedef FixedArray < SizeValueType,::itk::GetImageDimension < FixedImageType > ::ImageDimension >	BSplineParametersOffsetType
typedef BSplineTransformType::ParameterIndexArrayType	BSplineTransformIndexArrayType
typedef Array2D< IndexValueType >	BSplineTransformIndicesArrayType
typedef BSplineBaseTransform < CoordinateRepresentationType,::itk::GetImageDimension < FixedImageType > ::ImageDimension, itkGetStaticConstMacro(DeformationSplineOrder) >	BSplineTransformType
typedef Array2D< WeightsValueType >	BSplineTransformWeightsArrayType
typedef BSplineTransformType::WeightsType	BSplineTransformWeightsType
typedef std::vector < FixedImageSamplePoint >	FixedImageSampleContainer
typedef CovariantVector < double, itkGetStaticConstMacro(MovingImageDimension) >	ImageDerivativesType
typedef BSplineTransformIndexArrayType::ValueType	IndexValueType
typedef std::vector < MovingImagePointType >	MovingImagePointArrayType
typedef BSplineTransformWeightsType::ValueType	WeightsValueType
Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreaded (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreadedPostProcess (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreadedPreProcess (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueMultiThreaded (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueMultiThreadedPostProcess (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueMultiThreadedPreProcess (void *arg)
Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
BSplineInterpolatorType::Pointer	m_BSplineInterpolator
BSplineParametersOffsetType	m_BSplineParametersOffset
MovingImagePointArrayType	m_BSplinePreTransformPointsArray
BSplineTransformType::Pointer	m_BSplineTransform
BSplineTransformIndexArrayType	m_BSplineTransformIndices
BSplineTransformIndicesArrayType	m_BSplineTransformIndicesArray
BSplineTransformWeightsType	m_BSplineTransformWeights
BSplineTransformWeightsArrayType	m_BSplineTransformWeightsArray
bool	m_ComputeGradient
FixedImageConstPointer	m_FixedImage
FixedImageIndexContainer	m_FixedImageIndexes
FixedImageMaskConstPointer	m_FixedImageMask
FixedImageSampleContainer	m_FixedImageSamples
FixedImagePixelType	m_FixedImageSamplesIntensityThreshold
GradientImagePointer	m_GradientImage
InterpolatorPointer	m_Interpolator
bool	m_InterpolatorIsBSpline
MovingImageConstPointer	m_MovingImage
MovingImageMaskConstPointer	m_MovingImageMask
SizeValueType	m_NumberOfFixedImageSamples
SizeValueType	m_NumberOfParameters
SizeValueType	m_NumberOfPixelsCounted
ThreadIdType	m_NumberOfThreads
SizeValueType	m_NumBSplineWeights
MultiThreaderType::Pointer	m_Threader
BSplineTransformIndexArrayType *	m_ThreaderBSplineTransformIndices
BSplineTransformWeightsType *	m_ThreaderBSplineTransformWeights
unsigned int *	m_ThreaderNumberOfMovingImageSamples
MultiThreaderParameterType	m_ThreaderParameter
TransformPointer *	m_ThreaderTransform
TransformPointer	m_Transform
bool	m_TransformIsBSpline
bool	m_UseAllPixels
bool	m_UseCachingOfBSplineWeights
bool	m_UseFixedImageIndexes
bool	m_UseFixedImageSamplesIntensityThreshold
bool	m_UseSequentialSampling
BooleanArrayType	m_WithinBSplineSupportRegionArray
bool	m_WithinThreadPostProcess
bool	m_WithinThreadPreProcess
Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int	DeformationSplineOrder = 3

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 KernelFunctionBase 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:: KernelFunctionBase; GaussianKernelFunction

Wiki Examples:

All Examples

Mutual Information

Mutual Information Affine

Definition at line 94 of file itkMutualInformationImageToImageMetric.h.