#include <itkMutualInformationImageToImageMetric.h>

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

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

Classes
class	SpatialSample

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename Superclass::DerivativeType

using	FixedImageConstPointer = typename Superclass::FixedImageConstPointer

using	FixedImageIndexType = typename FixedImageType::IndexType

using	FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType

using	FixedImagePointType = typename TransformType::InputPointType

using	FixedImageType = typename Superclass::FixedImageType

using	InterpolatorType = typename Superclass::InterpolatorType

using	KernelFunctionType = KernelFunctionBase< double >

using	MeasureType = typename Superclass::MeasureType

using	MovingImageCosntPointer = typename Superclass::MovingImageConstPointer

using	MovingImageIndexType = typename MovingImageType::IndexType

using	MovingImagePointType = typename TransformType::OutputPointType

using	MovingImageType = typename Superclass::MovingImageType

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = MutualInformationImageToImageMetric

using	Superclass = ImageToImageMetric< TFixedImage, TMovingImage >

using	TransformJacobianType = typename Superclass::TransformJacobianType

using	TransformPointer = typename Superclass::TransformPointer

using	TransformType = typename Superclass::TransformType

Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using	ConstPointer = SmartPointer< const Self >

using	CoordinateRepresentationType = typename Superclass::ParametersValueType

using	DerivativeType = typename Superclass::DerivativeType

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImageIndexContainer = std::vector< FixedImageIndexType >

using	FixedImageIndexType = typename FixedImageType::IndexType

using	FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType

using	FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer

using	FixedImageMaskPointer = typename FixedImageMaskType::Pointer

using	FixedImageMaskType = SpatialObject< Self::FixedImageDimension >

using	FixedImagePixelType = typename TFixedImage::PixelType

using	FixedImagePointType = typename TransformType::InputPointType

using	FixedImageRegionType = typename FixedImageType::RegionType

using	FixedImageType = TFixedImage

using	GradientImageFilterPointer = typename GradientImageFilterType::Pointer

using	GradientImageFilterType = GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >

using	GradientImagePointer = SmartPointer< GradientImageType >

using	GradientImageType = Image< GradientPixelType, Self::MovingImageDimension >

using	GradientPixelType = CovariantVector< RealType, Self::MovingImageDimension >

using	InputPointType = typename TransformType::InputPointType

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorType = InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >

using	MeasureType = typename Superclass::MeasureType

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImageIndexType = typename MovingImageType::IndexType

using	MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer

using	MovingImageMaskPointer = typename MovingImageMaskType::Pointer

using	MovingImageMaskType = SpatialObject< Self::MovingImageDimension >

using	MovingImagePixelType = typename TMovingImage::PixelType

using	MovingImagePointType = typename TransformType::OutputPointType

using	MovingImageType = TMovingImage

using	OutputPointType = typename TransformType::OutputPointType

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< MovingImagePixelType >::RealType

using	Self = ImageToImageMetric

using	Superclass = SingleValuedCostFunction

using	TransformJacobianType = typename TransformType::JacobianType

using	TransformParametersType = typename TransformType::ParametersType

using	TransformPointer = typename TransformType::Pointer

using	TransformType = Transform< CoordinateRepresentationType, Self::MovingImageDimension, Self::FixedImageDimension >

using	MultiThreaderType = MultiThreaderBase

Public Types inherited from itk::SingleValuedCostFunction
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = Array< ParametersValueType >

using	MeasureType = double

using	ParametersType = Superclass::ParametersType

using	ParametersValueType = Superclass::ParametersValueType

using	Pointer = SmartPointer< Self >

using	Self = SingleValuedCostFunction

using	Superclass = CostFunction

Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = OptimizerParameters< TInternalComputationValueType >

using	ParametersValueType = TInternalComputationValueType

using	Pointer = SmartPointer< Self >

using	Self = CostFunctionTemplate

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override

virtual const char *	GetNameOfClass () const

virtual const unsigned int &	GetNumberOfSpatialSamples () const

MeasureType	GetValue (const ParametersType &parameters) const override

void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override

void	SetNumberOfSpatialSamples (unsigned int num)

Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	SetFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetFixedImage () const

virtual void	SetMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetMovingImage () const

virtual void	SetTransform (TransformType *_arg)

virtual TransformType *	GetModifiableTransform ()

virtual const TransformType *	GetTransform () const

virtual void	SetInterpolator (InterpolatorType *_arg)

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual const InterpolatorType *	GetInterpolator () const

SizeValueType	GetNumberOfMovingImageSamples ()

virtual const SizeValueType &	GetNumberOfPixelsCounted () const

virtual void	SetFixedImageRegion (const FixedImageRegionType reg)

virtual const FixedImageRegionType &	GetFixedImageRegion () const

virtual void	SetMovingImageMask (MovingImageMaskType *_arg)

virtual void	SetMovingImageMask (const MovingImageMaskType *_arg)

virtual const MovingImageMaskType *	GetMovingImageMask () const

virtual void	SetFixedImageMask (FixedImageMaskType *_arg)

virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)

virtual const FixedImageMaskType *	GetFixedImageMask () const

void	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)

void	SetUseFixedImageIndexes (bool useIndexes)

virtual const bool &	GetUseFixedImageIndexes () const

void	SetNumberOfWorkUnits (ThreadIdType numberOfThreads)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

virtual void	SetComputeGradient (bool _arg)

virtual const bool &	GetComputeGradient () const

virtual void	ComputeGradientOn ()

virtual void	ComputeGradientOff ()

virtual void	ComputeGradient ()

virtual GradientImageType *	GetModifiableGradientImage ()

virtual const GradientImageType *	GetGradientImage () const

void	SetTransformParameters (const ParametersType &parameters) const

unsigned int	GetNumberOfParameters () const override

virtual void	Initialize ()

virtual void	MultiThreadingInitialize ()

virtual void	SetNumberOfFixedImageSamples (SizeValueType numSamples)

virtual const SizeValueType &	GetNumberOfFixedImageSamples () const

void	SetNumberOfSpatialSamples (SizeValueType num)

SizeValueType	GetNumberOfSpatialSamples ()

void	SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)

virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold () const

void	SetUseFixedImageSamplesIntensityThreshold (bool useThresh)

virtual const bool &	GetUseFixedImageSamplesIntensityThreshold () const

void	SetUseAllPixels (bool useAllPixels)

void	UseAllPixelsOn ()

void	UseAllPixelsOff ()

virtual const bool &	GetUseAllPixels () const

void	SetUseSequentialSampling (bool useSequential)

virtual const bool &	GetUseSequentialSampling () const

void	ReinitializeSeed ()

void	ReinitializeSeed (int seed)

virtual void	SetUseCachingOfBSplineWeights (bool _arg)

virtual const bool &	GetUseCachingOfBSplineWeights () const

virtual void	UseCachingOfBSplineWeightsOn ()

virtual void	UseCachingOfBSplineWeightsOff ()

virtual MultiThreaderType *	GetModifiableThreader ()

virtual const MultiThreaderType *	GetThreader () const

const TransformPointer *	GetThreaderTransform ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	MovingImageDimension = MovingImageType::ImageDimension

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

static constexpr unsigned int	MovingImageDimension = TMovingImage::ImageDimension

using	SpatialSampleContainer = std::vector< SpatialSample >

using	CoordinateRepresentationType = typename Superclass::CoordinateRepresentationType

using	DerivativeFunctionType = CentralDifferenceImageFunction< MovingImageType, CoordinateRepresentationType >

SpatialSampleContainer	m_SampleA

SpatialSampleContainer	m_SampleB

unsigned int	m_NumberOfSpatialSamples

double	m_MovingImageStandardDeviation

double	m_FixedImageStandardDeviation

double	m_MinProbability

KernelFunctionType::Pointer	m_KernelFunction

DerivativeFunctionType::Pointer	m_DerivativeCalculator

virtual void	SetMovingImageStandardDeviation (double _arg)

virtual const double &	GetMovingImageStandardDeviation () const

virtual void	SetFixedImageStandardDeviation (double _arg)

virtual double	GetFixedImageStandardDeviation () const

virtual void	SetKernelFunction (KernelFunctionType *_arg)

virtual KernelFunctionType *	GetModifiableKernelFunction ()

virtual const KernelFunctionType *	GetKernelFunction () const

	MutualInformationImageToImageMetric ()

	~MutualInformationImageToImageMetric () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SampleFixedImageDomain (SpatialSampleContainer &samples) const

void	CalculateDerivatives (const FixedImagePointType &, DerivativeType &, TransformJacobianType &) const

Additional Inherited Members
Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using	FixedImageSampleContainer = std::vector< FixedImageSamplePoint >

using	BSplineTransformType = BSplineBaseTransform< CoordinateRepresentationType, FixedImageType::ImageDimension, Self::DeformationSplineOrder >

using	BSplineTransformWeightsType = typename BSplineTransformType::WeightsType

using	WeightsValueType = typename BSplineTransformWeightsType::ValueType

using	BSplineTransformWeightsArrayType = Array2D< WeightsValueType >

using	BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType

using	IndexValueType = typename BSplineTransformIndexArrayType::ValueType

using	BSplineTransformIndicesArrayType = Array2D< IndexValueType >

using	MovingImagePointArrayType = std::vector< MovingImagePointType >

using	BooleanArrayType = std::vector< bool >

using	BSplineParametersOffsetType = FixedArray< SizeValueType, FixedImageType::ImageDimension >

using	BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >

using	DerivativeFunctionType = CentralDifferenceImageFunction< MovingImageType, CoordinateRepresentationType >

using	ImageDerivativesType = CovariantVector< double, Self::MovingImageDimension >

Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
	ImageToImageMetric ()

	~ImageToImageMetric () override

virtual void	SampleFixedImageRegion (FixedImageSampleContainer &samples) const

virtual void	SampleFixedImageIndexes (FixedImageSampleContainer &samples) const

virtual void	SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const

virtual void	PreComputeTransformValues ()

virtual void	TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ThreadIdType threadId) const

virtual void	TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ImageDerivativesType &movingImageGradient, ThreadIdType threadId) const

virtual void	ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const

void	GetValueMultiThreadedInitiate () const

void	GetValueMultiThreadedPostProcessInitiate () const

virtual void	GetValueThread (ThreadIdType threadId) const

virtual void	GetValueThreadPreProcess (ThreadIdType, bool) const

virtual bool	GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const

virtual void	GetValueThreadPostProcess (ThreadIdType, bool) const

void	GetValueAndDerivativeMultiThreadedInitiate () const

void	GetValueAndDerivativeMultiThreadedPostProcessInitiate () const

virtual void	GetValueAndDerivativeThread (ThreadIdType threadId) const

virtual void	GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const

virtual bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const

virtual void	GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const

virtual void	SynchronizeTransforms () const

Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()=default

	~SingleValuedCostFunction () override

Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
	CostFunctionTemplate ()=default

	~CostFunctionTemplate () override=default

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreaded (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreadedPostProcess (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreaded (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreadedPostProcess (void *workunitInfoAsVoid)

Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
bool	m_UseFixedImageIndexes { false }

FixedImageIndexContainer	m_FixedImageIndexes

bool	m_UseFixedImageSamplesIntensityThreshold { false }

FixedImagePixelType	m_FixedImageSamplesIntensityThreshold

FixedImageSampleContainer	m_FixedImageSamples

SizeValueType	m_NumberOfParameters { 0 }

SizeValueType	m_NumberOfFixedImageSamples { 50000 }

SizeValueType	m_NumberOfPixelsCounted { 0 }

FixedImageConstPointer	m_FixedImage

MovingImageConstPointer	m_MovingImage

TransformPointer	m_Transform

TransformPointer *	m_ThreaderTransform

InterpolatorPointer	m_Interpolator

bool	m_ComputeGradient { true }

GradientImagePointer	m_GradientImage

FixedImageMaskConstPointer	m_FixedImageMask

MovingImageMaskConstPointer	m_MovingImageMask

ThreadIdType	m_NumberOfWorkUnits { 1 }

bool	m_UseAllPixels { false }

bool	m_UseSequentialSampling { false }

bool	m_ReseedIterator { false }

int	m_RandomSeed

bool	m_TransformIsBSpline { false }

SizeValueType	m_NumBSplineWeights { 0 }

BSplineTransformType::Pointer	m_BSplineTransform

BSplineTransformWeightsArrayType	m_BSplineTransformWeightsArray

BSplineTransformIndicesArrayType	m_BSplineTransformIndicesArray

MovingImagePointArrayType	m_BSplinePreTransformPointsArray

BooleanArrayType	m_WithinBSplineSupportRegionArray

BSplineParametersOffsetType	m_BSplineParametersOffset

bool	m_UseCachingOfBSplineWeights { true }

BSplineTransformWeightsType	m_BSplineTransformWeights

BSplineTransformIndexArrayType	m_BSplineTransformIndices

BSplineTransformWeightsType *	m_ThreaderBSplineTransformWeights

BSplineTransformIndexArrayType *	m_ThreaderBSplineTransformIndices

bool	m_InterpolatorIsBSpline { false }

BSplineInterpolatorType::Pointer	m_BSplineInterpolator

DerivativeFunctionType::Pointer	m_DerivativeCalculator

MultiThreaderType::Pointer	m_Threader

ConstantPointerWrapper *	m_ConstSelfWrapper

unsigned int *	m_ThreaderNumberOfMovingImageSamples { nullptr }

bool	m_WithinThreadPreProcess { false }

bool	m_WithinThreadPostProcess { false }

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int	DeformationSplineOrder = 3

Detailed Description

template<typename TFixedImage, typename 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

ITK Sphinx Examples:

All ITK Sphinx Examples

Mutual Information

Mutual Information Affine

Examples: Examples/RegistrationITKv4/ImageRegistration2.cxx, SphinxExamples/src/Core/Transform/MutualInformationAffine/Code.cxx, SphinxExamples/src/Registration/Common/MutualInformation/Code.cxx, and SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx.

Definition at line 94 of file itkMutualInformationImageToImageMetric.h.