#include <itkMattesMutualInformationImageToImageMetric.h>

Detailed Description

template<typename TFixedImage, typename 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 [mattes2001], [74] 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 arbitrary magnitude and dynamic range, the image intensity is scaled such that any contribution to the histogram will fall into a valid bin.

Once the PDF's have been constructed, the mutual information is obtained by double summing over the discrete PDF values.

Notes:

This class returns the negative mutual information value.

ITK Sphinx Examples:

All ITK Sphinx Examples

Watch Registration

Examples: Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, and Examples/RegistrationITKv4/MultiResImageRegistration3.cxx.

Definition at line 104 of file itkMattesMutualInformationImageToImageMetric.h.

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

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

Classes
struct	MMIMetricPerThreadStruct

Public Types
using	BSplineTransformIndexArrayType

using	BSplineTransformWeightsType

using	ConstPointer = SmartPointer<const Self>

using	CoordinateRepresentationType

using	DerivativeType

using	FixedImageConstPointer

using	FixedImageSampleContainer

using	FixedImageType

using	ImageDerivativesType

using	IndexValueType

using	InterpolatorType

using	JointPDFDerivativesType = Image<PDFValueType, 3>

using	JointPDFType = Image<PDFValueType, 2>

using	MeasureType

using	MovingImageConstPointer

using	MovingImagePointType

using	MovingImageType

using	OffsetValueType = typename FixedImageType::OffsetValueType

using	ParametersType

using	PDFValueType = double

using	Pointer = SmartPointer<Self>

using	Self = MattesMutualInformationImageToImageMetric

using	Superclass = ImageToImageMetric<TFixedImage, TMovingImage>

using	TransformJacobianType

using	TransformPointer

using	TransformType

using	WeightsValueType

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

using	CoordinateRepresentationType = typename Superclass::ParametersValueType

using	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

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	MultiThreaderType = MultiThreaderBase

using	OutputPointType = typename TransformType::OutputPointType

using	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>

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< double >
using	ConstPointer

using	ParametersType

using	ParametersValueType

using	Pointer

using	Self

using	Superclass

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

const char *	GetNameOfClass () const override

MeasureType	GetValue (const ParametersType &parameters) const override

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

void	Initialize () override


virtual void	SetNumberOfHistogramBins (SizeValueType _arg)

virtual const SizeValueType &	GetNumberOfHistogramBins () const


virtual void	SetUseExplicitPDFDerivatives (bool _arg)

virtual const bool &	GetUseExplicitPDFDerivatives () const

virtual void	UseExplicitPDFDerivativesOn ()

virtual void	UseExplicitPDFDerivativesOff ()


const JointPDFType::Pointer	GetJointPDF () const


const JointPDFDerivativesType::Pointer	GetJointPDFDerivatives () const

Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeGradient ()

virtual const FixedImageRegionType &	GetFixedImageRegion () const

virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold () const

virtual const GradientImageType *	GetGradientImage () const

virtual const InterpolatorType *	GetInterpolator () const

virtual GradientImageType *	GetModifiableGradientImage ()

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual TransformType *	GetModifiableTransform ()

SizeValueType	GetNumberOfMovingImageSamples ()

unsigned int	GetNumberOfParameters () const override

virtual const SizeValueType &	GetNumberOfPixelsCounted () const

SizeValueType	GetNumberOfSpatialSamples ()

virtual const TransformType *	GetTransform () const

virtual const bool &	GetUseAllPixels () const

virtual const bool &	GetUseFixedImageIndexes () const

virtual const bool &	GetUseFixedImageSamplesIntensityThreshold () const

virtual const bool &	GetUseSequentialSampling () const

virtual void	MultiThreadingInitialize ()

void	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)

virtual void	SetFixedImageRegion (const FixedImageRegionType reg)

void	SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)

virtual void	SetInterpolator (InterpolatorType *_arg)

void	SetNumberOfSpatialSamples (SizeValueType num)

virtual void	SetTransform (TransformType *_arg)

void	SetTransformParameters (const ParametersType &parameters) const

void	SetUseAllPixels (bool useAllPixels)

void	SetUseFixedImageIndexes (bool useIndexes)

void	SetUseFixedImageSamplesIntensityThreshold (bool useThresh)

void	SetUseSequentialSampling (bool useSequential)

void	UseAllPixelsOff ()

void	UseAllPixelsOn ()

virtual void	SetFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetFixedImage () const

virtual void	SetMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetMovingImage () const

virtual void	SetMovingImageMask (const MovingImageMaskType *_arg)

virtual const MovingImageMaskType *	GetMovingImageMask () const

virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)

virtual const FixedImageMaskType *	GetFixedImageMask () const

void	SetNumberOfWorkUnits (ThreadIdType numberOfWorkUnits)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

virtual void	SetComputeGradient (bool _arg)

virtual const bool &	GetComputeGradient () const

virtual void	ComputeGradientOn ()

virtual void	ComputeGradientOff ()

virtual void	SetNumberOfFixedImageSamples (SizeValueType numSamples)

virtual const SizeValueType &	GetNumberOfFixedImageSamples () 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::SingleValuedCostFunction
const char *	GetNameOfClass () const override

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

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

LightObject::Pointer	CreateAnother () const override

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

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

Protected Member Functions
	MattesMutualInformationImageToImageMetric ()

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

	~MattesMutualInformationImageToImageMetric () override=default

Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const

void	GetValueAndDerivativeMultiThreadedInitiate () const

void	GetValueAndDerivativeMultiThreadedPostProcessInitiate () const

virtual void	GetValueAndDerivativeThread (ThreadIdType threadId) const

virtual bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue, const ImageDerivativesType &movingImageGradientValue) const

	ImageToImageMetric ()

virtual void	PreComputeTransformValues ()

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 &sampleOk, double &movingImageValue, ThreadIdType threadId) const

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

	~ImageToImageMetric () override=default

void	GetValueMultiThreadedInitiate () const

void	GetValueMultiThreadedPostProcessInitiate () const

virtual void	GetValueThread (ThreadIdType threadId) const

virtual bool	GetValueThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue) const

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

	~SingleValuedCostFunction () override

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

	CostFunctionTemplate ()=default

	~CostFunctionTemplate () override=default

	~CostFunctionTemplate () override=default

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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
using	CubicBSplineDerivativeFunctionType = BSplineDerivativeKernelFunction<3, PDFValueType>

using	CubicBSplineFunctionType = BSplineKernelFunction<3, PDFValueType>

using	JointPDFDerivativesIndexType = JointPDFDerivativesType::IndexType

using	JointPDFDerivativesRegionType = JointPDFDerivativesType::RegionType

using	JointPDFDerivativesSizeType = JointPDFDerivativesType::SizeType

using	JointPDFDerivativesValueType = JointPDFDerivativesType::PixelType

using	JointPDFIndexType = JointPDFType::IndexType

using	JointPDFRegionType = JointPDFType::RegionType

using	JointPDFSizeType = JointPDFType::SizeType

using	JointPDFValueType = JointPDFType::PixelType

using	MarginalPDFType = std::vector<PDFValueType>

using	PRatioArrayType = Array2D<PRatioType>

using	PRatioType = PDFValueType

Private Member Functions
void	CommonGetValueProcessing () const

void	ComputeFixedImageParzenWindowIndices (FixedImageSampleContainer &samples)

void	ComputePDFDerivatives (ThreadIdType threadId, unsigned int sampleNumber, int pdfMovingIndex, const ImageDerivativesType &movingImageGradientValue, PDFValueType cubicBSplineDerivativeValue) const

void	GetValueAndDerivativeThreadPostProcess (ThreadIdType threadId, bool withinSampleThread) const override

void	GetValueAndDerivativeThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const override

bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue, const ImageDerivativesType &movingImageGradientValue) const override

void	GetValueThreadPostProcess (ThreadIdType threadId, bool withinSampleThread) const override

void	GetValueThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const override

bool	GetValueThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue) const override

	itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedMMIMetricPerThreadStruct, AlignedMMIMetricPerThreadStruct)

	itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, MMIMetricPerThreadStruct, PaddedMMIMetricPerThreadStruct)

Private Attributes
PDFValueType	m_FixedImageBinSize { 0.0 }

PDFValueType	m_FixedImageNormalizedMin { 0.0 }

PDFValueType	m_FixedImageTrueMax { 0.0 }

PDFValueType	m_FixedImageTrueMin { 0.0 }

bool	m_ImplicitDerivativesSecondPass { false }

std::unique_ptr< AlignedMMIMetricPerThreadStruct[]>	m_MMIMetricPerThreadVariables

PDFValueType	m_MovingImageBinSize { 0.0 }

MarginalPDFType	m_MovingImageMarginalPDF {}

PDFValueType	m_MovingImageNormalizedMin { 0.0 }

PDFValueType	m_MovingImageTrueMax { 0.0 }

PDFValueType	m_MovingImageTrueMin { 0.0 }

SizeValueType	m_NumberOfHistogramBins { 50 }

PRatioArrayType	m_PRatioArray {}

bool	m_UseExplicitPDFDerivatives { true }

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

using	BSplineInterpolatorType = BSplineInterpolateImageFunction<MovingImageType, CoordinateRepresentationType>

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

using	BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType

using	BSplineTransformIndicesArrayType = Array2D<IndexValueType>

using	BSplineTransformType

using	BSplineTransformWeightsArrayType = Array2D<WeightsValueType>

using	BSplineTransformWeightsType = typename BSplineTransformType::WeightsType

using	DerivativeFunctionType = CentralDifferenceImageFunction<MovingImageType, CoordinateRepresentationType>

using	FixedImageSampleContainer = std::vector<FixedImageSamplePoint>

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

using	IndexValueType = typename BSplineTransformIndexArrayType::ValueType

using	MovingImagePointArrayType = std::vector<MovingImagePointType>

using	WeightsValueType = typename BSplineTransformWeightsType::ValueType

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreadedPostProcess (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreaded (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreadedPostProcess (void *workunitInfoAsVoid)

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 { true }

DerivativeFunctionType::Pointer	m_DerivativeCalculator {}

FixedImageConstPointer	m_FixedImage {}

FixedImageIndexContainer	m_FixedImageIndexes {}

FixedImageMaskConstPointer	m_FixedImageMask {}

FixedImageSampleContainer	m_FixedImageSamples {}

FixedImagePixelType	m_FixedImageSamplesIntensityThreshold {}

GradientImagePointer	m_GradientImage {}

InterpolatorPointer	m_Interpolator {}

MovingImageConstPointer	m_MovingImage {}

MovingImageMaskConstPointer	m_MovingImageMask {}

SizeValueType	m_NumberOfFixedImageSamples { 50000 }

SizeValueType	m_NumberOfParameters { 0 }

SizeValueType	m_NumberOfPixelsCounted { 0 }

ThreadIdType	m_NumberOfWorkUnits { 1 }

SizeValueType	m_NumBSplineWeights { 0 }

int	m_RandomSeed {}

bool	m_ReseedIterator { false }

std::unique_ptr< BSplineTransformIndexArrayType[]>	m_ThreaderBSplineTransformIndices

std::unique_ptr< BSplineTransformWeightsType[]>	m_ThreaderBSplineTransformWeights

std::unique_ptr< TransformPointer[]>	m_ThreaderTransform

TransformPointer	m_Transform {}

bool	m_UseAllPixels { false }

bool	m_UseCachingOfBSplineWeights { true }

bool	m_UseFixedImageIndexes { false }

bool	m_UseFixedImageSamplesIntensityThreshold { false }

bool	m_UseSequentialSampling { false }

BooleanArrayType	m_WithinBSplineSupportRegionArray {}

MultiThreaderType::Pointer	m_Threader {}

std::unique_ptr< ConstantPointerWrapper >	m_ConstSelfWrapper

std::unique_ptr< unsigned int[]>	m_ThreaderNumberOfMovingImageSamples

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

Member Typedef Documentation

◆ BSplineTransformIndexArrayType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::BSplineTransformIndexArrayType

Definition at line 493 of file itkImageToImageMetric.h.

◆ BSplineTransformWeightsType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::BSplineTransformWeightsType

Definition at line 489 of file itkImageToImageMetric.h.

◆ ConstPointer

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 114 of file itkMattesMutualInformationImageToImageMetric.h.

◆ CoordinateRepresentationType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType

Type used for representing point components

Definition at line 66 of file itkImageToImageMetric.h.

◆ CubicBSplineDerivativeFunctionType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CubicBSplineDerivativeFunctionType = BSplineDerivativeKernelFunction<3, PDFValueType>

private

Definition at line 270 of file itkMattesMutualInformationImageToImageMetric.h.

◆ CubicBSplineFunctionType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CubicBSplineFunctionType = BSplineKernelFunction<3, PDFValueType>

private

Typedefs for BSpline kernel and derivative functions.

Definition at line 269 of file itkMattesMutualInformationImageToImageMetric.h.

◆ DerivativeType

template<typename TFixedImage, typename TMovingImage>

using itk::SingleValuedCostFunction::DerivativeType

DerivativeType type alias. It defines a type used to return the cost function derivative.

Definition at line 133 of file itkSingleValuedCostFunction.h.

◆ FixedImageConstPointer

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 79 of file itkImageToImageMetric.h.

◆ FixedImageSampleContainer

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageSampleContainer

FixedImageSamplePoint type alias support

Definition at line 409 of file itkImageToImageMetric.h.

◆ FixedImageType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image.

Definition at line 77 of file itkImageToImageMetric.h.

◆ ImageDerivativesType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::ImageDerivativesType

Definition at line 509 of file itkImageToImageMetric.h.

◆ IndexValueType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::IndexValueType

Definition at line 494 of file itkImageToImageMetric.h.

◆ InterpolatorType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType

Type of the Interpolator Base class

Definition at line 105 of file itkImageToImageMetric.h.

◆ JointPDFDerivativesIndexType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesIndexType = JointPDFDerivativesType::IndexType

private

Definition at line 263 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFDerivativesRegionType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesRegionType = JointPDFDerivativesType::RegionType

private

Definition at line 265 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFDerivativesSizeType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesSizeType = JointPDFDerivativesType::SizeType

private

Definition at line 266 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFDerivativesType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesType = Image<PDFValueType, 3>

Definition at line 218 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFDerivativesValueType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesValueType = JointPDFDerivativesType::PixelType

private

Definition at line 264 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFIndexType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFIndexType = JointPDFType::IndexType

private

Definition at line 259 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFRegionType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFRegionType = JointPDFType::RegionType

private

Definition at line 261 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFSizeType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFSizeType = JointPDFType::SizeType

private

Definition at line 262 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFType = Image<PDFValueType, 2>

Typedef for the joint PDF and PDF derivatives are stored as ITK Images.

Definition at line 217 of file itkMattesMutualInformationImageToImageMetric.h.

◆ JointPDFValueType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFValueType = JointPDFType::PixelType

private

Definition at line 260 of file itkMattesMutualInformationImageToImageMetric.h.

◆ MarginalPDFType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MarginalPDFType = std::vector<PDFValueType>

private

The moving image marginal PDF.

Definition at line 329 of file itkMattesMutualInformationImageToImageMetric.h.

◆ MeasureType

template<typename TFixedImage, typename TMovingImage>

using itk::SingleValuedCostFunction::MeasureType

MeasureType type alias. It defines a type used to return the cost function value.

Definition at line 130 of file itkSingleValuedCostFunction.h.

◆ MovingImageConstPointer

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Definition at line 74 of file itkImageToImageMetric.h.

◆ MovingImagePointType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType

Definition at line 100 of file itkImageToImageMetric.h.

◆ MovingImageType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image.

Definition at line 72 of file itkImageToImageMetric.h.

◆ OffsetValueType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::OffsetValueType = typename FixedImageType::OffsetValueType

Definition at line 144 of file itkMattesMutualInformationImageToImageMetric.h.

◆ ParametersType

template<typename TFixedImage, typename TMovingImage>

using itk::SingleValuedCostFunction::ParametersType

ParametersType type alias. It defines a position in the optimization search space.

Definition at line 136 of file itkSingleValuedCostFunction.h.

◆ PDFValueType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PDFValueType = double

The marginal PDFs are stored as std::vector.

Definition at line 213 of file itkMattesMutualInformationImageToImageMetric.h.

◆ Pointer

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 113 of file itkMattesMutualInformationImageToImageMetric.h.

◆ PRatioArrayType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PRatioArrayType = Array2D<PRatioType>

private

Definition at line 324 of file itkMattesMutualInformationImageToImageMetric.h.

◆ PRatioType

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PRatioType = PDFValueType

private

Helper array for storing the values of the JointPDF ratios.

Definition at line 323 of file itkMattesMutualInformationImageToImageMetric.h.

◆ Self

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Self = MattesMutualInformationImageToImageMetric

Standard class type aliases.

Definition at line 111 of file itkMattesMutualInformationImageToImageMetric.h.

◆ Superclass

template<typename TFixedImage, typename TMovingImage>

using itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Superclass = ImageToImageMetric<TFixedImage, TMovingImage>

Definition at line 112 of file itkMattesMutualInformationImageToImageMetric.h.

◆ TransformJacobianType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Definition at line 93 of file itkImageToImageMetric.h.

◆ TransformPointer

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Definition at line 89 of file itkImageToImageMetric.h.

◆ TransformType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Type of the Transform Base class

Definition at line 87 of file itkImageToImageMetric.h.

◆ WeightsValueType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::WeightsValueType

Definition at line 490 of file itkImageToImageMetric.h.

Constructor & Destructor Documentation

◆ MattesMutualInformationImageToImageMetric()

template<typename TFixedImage, typename TMovingImage>

itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MattesMutualInformationImageToImageMetric ( )

protected

Referenced by GetNameOfClass().

◆ ~MattesMutualInformationImageToImageMetric()

template<typename TFixedImage, typename TMovingImage>

itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::~MattesMutualInformationImageToImageMetric ( )

overrideprotecteddefault

Member Function Documentation

◆ CommonGetValueProcessing()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CommonGetValueProcessing ( ) const

private

Extract common processing for both GetValueAndDerivative and GetValue functions

◆ ComputeFixedImageParzenWindowIndices()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ComputeFixedImageParzenWindowIndices ( FixedImageSampleContainer & samples )

private

Compute the Parzen window index locations from the pre-computed samples.

◆ ComputePDFDerivatives()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ComputePDFDerivatives	(	ThreadIdType	threadId,
		unsigned int	sampleNumber,
		int	pdfMovingIndex,
		const ImageDerivativesType &	movingImageGradientValue,
		PDFValueType	cubicBSplineDerivativeValue ) const

private

Compute PDF derivative contribution for each parameter.

◆ CreateAnother()

template<typename TFixedImage, typename TMovingImage>

virtual::itk::LightObject::Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CreateAnother ( ) const

virtual

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.

◆ GetDerivative()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative	(	const ParametersType &	parameters,
		DerivativeType &	derivative ) const

overridevirtual

Get the derivatives of the match measure.

Implements itk::SingleValuedCostFunction.

◆ GetJointPDF()

template<typename TFixedImage, typename TMovingImage>

const JointPDFType::Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetJointPDF ( ) const

inline

Get the internal JointPDF image that was used in creating the metric value.

Definition at line 225 of file itkMattesMutualInformationImageToImageMetric.h.

References m_MMIMetricPerThreadVariables.

◆ GetJointPDFDerivatives()

template<typename TFixedImage, typename TMovingImage>

const JointPDFDerivativesType::Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetJointPDFDerivatives ( ) const

inline

Get the internal JointPDFDeriviative image that was used in creating the metric derivative value. This is only created when UseExplicitPDFDerivatives is ON, and derivatives are requested.

Definition at line 242 of file itkMattesMutualInformationImageToImageMetric.h.

References m_MMIMetricPerThreadVariables.

◆ GetNameOfClass()

template<typename TFixedImage, typename TMovingImage>

const char * itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

References MattesMutualInformationImageToImageMetric().

◆ GetNumberOfHistogramBins()

template<typename TFixedImage, typename TMovingImage>

virtual const SizeValueType & itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfHistogramBins ( ) const

virtual

Number of bins to used in the histogram. According to Mattes et al the optimum value is 50. The minimum value is 5 due to the padding required by the Parzen windowing with a cubic-BSpline kernel. Note that even if the metric is used on binary images, the number of bins should at least be equal to five.

◆ GetUseExplicitPDFDerivatives()

template<typename TFixedImage, typename TMovingImage>

virtual const bool & itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetUseExplicitPDFDerivatives ( ) const

virtual

This variable selects the method to be used for computing the Metric derivatives with respect to the Transform parameters. Two modes of computation are available. The choice between one and the other is a trade-off between computation speed and memory allocations. The two modes are described in detail below:

UseExplicitPDFDerivatives = True will compute the Metric derivative by first calculating the derivatives of each one of the Joint PDF bins with respect to each one of the Transform parameters and then accumulating these contributions in the final metric derivative array by using a bin-specific weight. The memory required for storing the intermediate derivatives is a 3D array of floating point values with size equals to the product of (number of histogram bins)^2 times number of transform parameters. This method is well suited for Transform with a small number of parameters.

UseExplicitPDFDerivatives = False will compute the Metric derivative by first computing the weights for each one of the Joint PDF bins and caching them into an array. Then it will revisit each one of the PDF bins for computing its weighted contribution to the full derivative array. In this method an extra 2D array is used for storing the weights of each one of the PDF bins. This is an array of floating point values with size equals to (number of histogram bins)^2. This method is well suited for Transforms with a large number of parameters, such as, BSplineTransforms.

◆ GetValue()

template<typename TFixedImage, typename TMovingImage>

MeasureType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const ParametersType & parameters ) const

overridevirtual

Get the value.

Implements itk::SingleValuedCostFunction.

◆ GetValueAndDerivative()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative	(	const ParametersType &	parameters,
		MeasureType &	value,
		DerivativeType &	derivative ) const

overridevirtual

Get the value and derivatives for single valued optimizers.

Reimplemented from itk::SingleValuedCostFunction.

◆ GetValueAndDerivativeThreadPostProcess()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadPostProcess	(	ThreadIdType	threadId,
		bool	withinSampleThread ) const

overrideprivatevirtual

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

◆ GetValueAndDerivativeThreadPreProcess()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadPreProcess	(	ThreadIdType	threadId,
		bool	withinSampleThread ) const

overrideprivatevirtual

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

◆ GetValueAndDerivativeThreadProcessSample()

template<typename TFixedImage, typename TMovingImage>

bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadProcessSample	(	ThreadIdType	threadId,
		SizeValueType	fixedImageSample,
		const MovingImagePointType &	mappedPoint,
		double	movingImageValue,
		const ImageDerivativesType &	movingImageGradientValue ) const

overrideprivate

◆ GetValueThreadPostProcess()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreadPostProcess	(	ThreadIdType	threadId,
		bool	withinSampleThread ) const

overrideprivatevirtual

Get the match Measure.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

◆ GetValueThreadPreProcess()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreadPreProcess	(	ThreadIdType	threadId,
		bool	withinSampleThread ) const

overrideprivatevirtual

Get the match Measure.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

◆ GetValueThreadProcessSample()

template<typename TFixedImage, typename TMovingImage>

bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreadProcessSample	(	ThreadIdType	threadId,
		SizeValueType	fixedImageSample,
		const MovingImagePointType &	mappedPoint,
		double	movingImageValue ) const

overrideprivate

◆ Initialize()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Initialize ( )

overridevirtual

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 >.

◆ itkAlignedTypedef()

template<typename TFixedImage, typename TMovingImage>

itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::itkAlignedTypedef	(	ITK_CACHE_LINE_ALIGNMENT	,
		PaddedMMIMetricPerThreadStruct	,
		AlignedMMIMetricPerThreadStruct	)

private

◆ itkPadStruct()

template<typename TFixedImage, typename TMovingImage>

itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::itkPadStruct	(	ITK_CACHE_LINE_ALIGNMENT	,
		MMIMetricPerThreadStruct	,
		PaddedMMIMetricPerThreadStruct	)

private

◆ New()

template<typename TFixedImage, typename TMovingImage>

static Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage, typename TMovingImage>

void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotectedvirtual

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 >.

◆ SetNumberOfHistogramBins()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetNumberOfHistogramBins ( SizeValueType _arg )

virtual

Number of bins to used in the histogram. According to Mattes et al the optimum value is 50. The minimum value is 5 due to the padding required by the Parzen windowing with a cubic-BSpline kernel. Note that even if the metric is used on binary images, the number of bins should at least be equal to five.

References itk::NumericTraits< T >::max().

◆ SetUseExplicitPDFDerivatives()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetUseExplicitPDFDerivatives ( bool _arg )

virtual

This variable selects the method to be used for computing the Metric derivatives with respect to the Transform parameters. Two modes of computation are available. The choice between one and the other is a trade-off between computation speed and memory allocations. The two modes are described in detail below:

UseExplicitPDFDerivatives = True will compute the Metric derivative by first calculating the derivatives of each one of the Joint PDF bins with respect to each one of the Transform parameters and then accumulating these contributions in the final metric derivative array by using a bin-specific weight. The memory required for storing the intermediate derivatives is a 3D array of floating point values with size equals to the product of (number of histogram bins)^2 times number of transform parameters. This method is well suited for Transform with a small number of parameters.

UseExplicitPDFDerivatives = False will compute the Metric derivative by first computing the weights for each one of the Joint PDF bins and caching them into an array. Then it will revisit each one of the PDF bins for computing its weighted contribution to the full derivative array. In this method an extra 2D array is used for storing the weights of each one of the PDF bins. This is an array of floating point values with size equals to (number of histogram bins)^2. This method is well suited for Transforms with a large number of parameters, such as, BSplineTransforms.

◆ UseExplicitPDFDerivativesOff()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::UseExplicitPDFDerivativesOff ( )

virtual

This variable selects the method to be used for computing the Metric derivatives with respect to the Transform parameters. Two modes of computation are available. The choice between one and the other is a trade-off between computation speed and memory allocations. The two modes are described in detail below:

UseExplicitPDFDerivatives = True will compute the Metric derivative by first calculating the derivatives of each one of the Joint PDF bins with respect to each one of the Transform parameters and then accumulating these contributions in the final metric derivative array by using a bin-specific weight. The memory required for storing the intermediate derivatives is a 3D array of floating point values with size equals to the product of (number of histogram bins)^2 times number of transform parameters. This method is well suited for Transform with a small number of parameters.

UseExplicitPDFDerivatives = False will compute the Metric derivative by first computing the weights for each one of the Joint PDF bins and caching them into an array. Then it will revisit each one of the PDF bins for computing its weighted contribution to the full derivative array. In this method an extra 2D array is used for storing the weights of each one of the PDF bins. This is an array of floating point values with size equals to (number of histogram bins)^2. This method is well suited for Transforms with a large number of parameters, such as, BSplineTransforms.

◆ UseExplicitPDFDerivativesOn()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::UseExplicitPDFDerivativesOn ( )

virtual

This variable selects the method to be used for computing the Metric derivatives with respect to the Transform parameters. Two modes of computation are available. The choice between one and the other is a trade-off between computation speed and memory allocations. The two modes are described in detail below:

UseExplicitPDFDerivatives = True will compute the Metric derivative by first calculating the derivatives of each one of the Joint PDF bins with respect to each one of the Transform parameters and then accumulating these contributions in the final metric derivative array by using a bin-specific weight. The memory required for storing the intermediate derivatives is a 3D array of floating point values with size equals to the product of (number of histogram bins)^2 times number of transform parameters. This method is well suited for Transform with a small number of parameters.

UseExplicitPDFDerivatives = False will compute the Metric derivative by first computing the weights for each one of the Joint PDF bins and caching them into an array. Then it will revisit each one of the PDF bins for computing its weighted contribution to the full derivative array. In this method an extra 2D array is used for storing the weights of each one of the PDF bins. This is an array of floating point values with size equals to (number of histogram bins)^2. This method is well suited for Transforms with a large number of parameters, such as, BSplineTransforms.

Member Data Documentation

◆ m_FixedImageBinSize

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageBinSize { 0.0 }

private

Definition at line 319 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_FixedImageNormalizedMin

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageNormalizedMin { 0.0 }

private

Definition at line 314 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_FixedImageTrueMax

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageTrueMax { 0.0 }

private

Definition at line 316 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_FixedImageTrueMin

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageTrueMin { 0.0 }

private

Definition at line 315 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_ImplicitDerivativesSecondPass

template<typename TFixedImage, typename TMovingImage>

bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_ImplicitDerivativesSecondPass { false }

mutableprivate

Definition at line 363 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_MMIMetricPerThreadVariables

template<typename TFixedImage, typename TMovingImage>

std::unique_ptr<AlignedMMIMetricPerThreadStruct[]> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MMIMetricPerThreadVariables

private

Definition at line 359 of file itkMattesMutualInformationImageToImageMetric.h.

Referenced by GetJointPDF(), and GetJointPDFDerivatives().

◆ m_MovingImageBinSize

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageBinSize { 0.0 }

private

Definition at line 320 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_MovingImageMarginalPDF

template<typename TFixedImage, typename TMovingImage>

MarginalPDFType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageMarginalPDF {}

mutableprivate

Definition at line 330 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_MovingImageNormalizedMin

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageNormalizedMin { 0.0 }

private

Definition at line 313 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_MovingImageTrueMax

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageTrueMax { 0.0 }

private

Definition at line 318 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_MovingImageTrueMin

template<typename TFixedImage, typename TMovingImage>

PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageTrueMin { 0.0 }

private

Definition at line 317 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_NumberOfHistogramBins

template<typename TFixedImage, typename TMovingImage>

SizeValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_NumberOfHistogramBins { 50 }

private

Variables to define the marginal and joint histograms.

Definition at line 312 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_PRatioArray

template<typename TFixedImage, typename TMovingImage>

PRatioArrayType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_PRatioArray {}

mutableprivate

Definition at line 326 of file itkMattesMutualInformationImageToImageMetric.h.

◆ m_UseExplicitPDFDerivatives

template<typename TFixedImage, typename TMovingImage>

bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_UseExplicitPDFDerivatives { true }

private

Definition at line 362 of file itkMattesMutualInformationImageToImageMetric.h.

◆ MovingImageDimension

template<typename TFixedImage, typename TMovingImage>

unsigned int itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDimension = MovingImageType::ImageDimension

staticconstexpr

The moving image dimension.

Definition at line 147 of file itkMattesMutualInformationImageToImageMetric.h.

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

itkMattesMutualInformationImageToImageMetric.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ BSplineTransformIndexArrayType

◆ BSplineTransformWeightsType

◆ ConstPointer

◆ CoordinateRepresentationType

◆ CubicBSplineDerivativeFunctionType

◆ CubicBSplineFunctionType

◆ DerivativeType

◆ FixedImageConstPointer

◆ FixedImageSampleContainer

◆ FixedImageType

◆ ImageDerivativesType

◆ IndexValueType

◆ InterpolatorType

◆ JointPDFDerivativesIndexType

◆ JointPDFDerivativesRegionType

◆ JointPDFDerivativesSizeType

◆ JointPDFDerivativesType

◆ JointPDFDerivativesValueType

◆ JointPDFIndexType

◆ JointPDFRegionType

◆ JointPDFSizeType

◆ JointPDFType

◆ JointPDFValueType

◆ MarginalPDFType

◆ MeasureType

◆ MovingImageConstPointer

◆ MovingImagePointType

◆ MovingImageType

◆ OffsetValueType

◆ ParametersType

◆ PDFValueType

◆ Pointer

◆ PRatioArrayType

◆ PRatioType

◆ Self

◆ Superclass

◆ TransformJacobianType

◆ TransformPointer

◆ TransformType

◆ WeightsValueType

Constructor & Destructor Documentation

◆ MattesMutualInformationImageToImageMetric()

◆ ~MattesMutualInformationImageToImageMetric()

Member Function Documentation

◆ CommonGetValueProcessing()

◆ ComputeFixedImageParzenWindowIndices()

◆ ComputePDFDerivatives()

◆ CreateAnother()

◆ GetDerivative()

◆ GetJointPDF()

◆ GetJointPDFDerivatives()

◆ GetNameOfClass()

◆ GetNumberOfHistogramBins()

◆ GetUseExplicitPDFDerivatives()

◆ GetValue()

◆ GetValueAndDerivative()

◆ GetValueAndDerivativeThreadPostProcess()

◆ GetValueAndDerivativeThreadPreProcess()

◆ GetValueAndDerivativeThreadProcessSample()

◆ GetValueThreadPostProcess()

◆ GetValueThreadPreProcess()

◆ GetValueThreadProcessSample()

◆ Initialize()

◆ itkAlignedTypedef()

◆ itkPadStruct()

◆ New()

◆ PrintSelf()

◆ SetNumberOfHistogramBins()