ITK  5.4.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkMutualInformationImageToImageMetric.h>

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

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

+ 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 FixedImageIndexType = typename FixedImageType::IndexType
 
using FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
 
using FixedImagePointType = typename TransformType::InputPointType
 
using KernelFunctionType = KernelFunctionBase< double >
 
using MovingImageCosntPointer = typename Superclass::MovingImageConstPointer
 
using MovingImageIndexType = typename MovingImageType::IndexType
 
using MovingImagePointType = typename TransformType::OutputPointType
 
using Pointer = SmartPointer< Self >
 
using Self = MutualInformationImageToImageMetric
 
using Superclass = ImageToImageMetric< TFixedImage, TMovingImage >
 
- Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = typename Superclass::ParametersValueType
 
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 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 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< 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

void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override
 
virtual const unsigned int & GetNumberOfSpatialSamples () const
 
MeasureType GetValue (const ParametersType &parameters) const override
 
void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override
 
 itkOverrideGetNameOfClassMacro (MutualInformationImageToImageMetric)
 
void SetNumberOfSpatialSamples (unsigned int num)
 
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 KernelFunctionTypeGetModifiableKernelFunction ()
 
- Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void ComputeGradient ()
 
virtual const FixedImageRegionTypeGetFixedImageRegion () const
 
virtual const FixedImagePixelTypeGetFixedImageSamplesIntensityThreshold () const
 
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual TransformTypeGetModifiableTransform ()
 
SizeValueType GetNumberOfMovingImageSamples ()
 
unsigned int GetNumberOfParameters () const override
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
SizeValueType GetNumberOfSpatialSamples ()
 
virtual const bool & GetUseAllPixels () const
 
virtual const bool & GetUseFixedImageIndexes () const
 
virtual const bool & GetUseFixedImageSamplesIntensityThreshold () const
 
virtual const bool & GetUseSequentialSampling () const
 
virtual void Initialize ()
 
 itkOverrideGetNameOfClassMacro (ImageToImageMetric)
 
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 FixedImageTypeGetFixedImage () const
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetMovingImageMask (const MovingImageMaskType *_arg)
 
virtual const MovingImageMaskTypeGetMovingImageMask () const
 
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
 
virtual const FixedImageMaskTypeGetFixedImageMask () const
 
void SetNumberOfWorkUnits (ThreadIdType numberOfThreads)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
virtual void ComputeGradientOn ()
 
virtual void SetNumberOfFixedImageSamples (SizeValueType numSamples)
 
virtual const SizeValueTypeGetNumberOfFixedImageSamples () const
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int seed)
 
virtual void SetUseCachingOfBSplineWeights (bool _arg)
 
virtual const bool & GetUseCachingOfBSplineWeights () const
 
virtual void UseCachingOfBSplineWeightsOn ()
 
virtual MultiThreaderTypeGetModifiableThreader ()
 
const TransformPointerGetThreaderTransform ()
 
- Public Member Functions inherited from itk::SingleValuedCostFunction
 itkOverrideGetNameOfClassMacro (SingleValuedCostFunction)
 
- Public Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 itkOverrideGetNameOfClassMacro (CostFunctionTemplate)
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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

 MutualInformationImageToImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~MutualInformationImageToImageMetric () 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 void GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const
 
virtual void GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const
 
virtual bool GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) 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 void GetValueThreadPreProcess (ThreadIdType, bool) const
 
virtual bool GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const
 
virtual void GetValueThreadPostProcess (ThreadIdType, bool) 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 ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 DerivativeFunctionType = CentralDifferenceImageFunction< MovingImageType, CoordinateRepresentationType >
 
using SpatialSampleContainer = std::vector< SpatialSample >
 

Private Member Functions

void CalculateDerivatives (const FixedImagePointType &, DerivativeType &, TransformJacobianType &) const
 
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 {}
 
SpatialSampleContainer m_SampleA {}
 
SpatialSampleContainer m_SampleB {}
 

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 = BSplineBaseTransform< CoordinateRepresentationType, FixedImageType::ImageDimension, Self::DeformationSplineOrder >
 
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 {}
 
bool m_InterpolatorIsBSpline { false }
 
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_TransformIsBSpline { false }
 
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< ConstantPointerWrapperm_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

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 103 of file itkMutualInformationImageToImageMetric.h.

◆ DerivativeFunctionType

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeFunctionType = CentralDifferenceImageFunction<MovingImageType, CoordinateRepresentationType>
private

Definition at line 259 of file itkMutualInformationImageToImageMetric.h.

◆ FixedImageIndexType

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexType = typename FixedImageType::IndexType

Index and Point type alias support

Definition at line 125 of file itkMutualInformationImageToImageMetric.h.

◆ FixedImageIndexValueType

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType

Definition at line 126 of file itkMutualInformationImageToImageMetric.h.

◆ FixedImagePointType

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePointType = typename TransformType::InputPointType

Definition at line 128 of file itkMutualInformationImageToImageMetric.h.

◆ KernelFunctionType

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::KernelFunctionType = KernelFunctionBase<double>

Definition at line 131 of file itkMutualInformationImageToImageMetric.h.

◆ MovingImageCosntPointer

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageCosntPointer = typename Superclass::MovingImageConstPointer

Definition at line 122 of file itkMutualInformationImageToImageMetric.h.

◆ MovingImageIndexType

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageIndexType = typename MovingImageType::IndexType

Definition at line 127 of file itkMutualInformationImageToImageMetric.h.

◆ MovingImagePointType

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType = typename TransformType::OutputPointType

Definition at line 129 of file itkMutualInformationImageToImageMetric.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 102 of file itkMutualInformationImageToImageMetric.h.

◆ Self

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Self = MutualInformationImageToImageMetric

Standard class type aliases.

Definition at line 100 of file itkMutualInformationImageToImageMetric.h.

◆ SpatialSampleContainer

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SpatialSampleContainer = std::vector<SpatialSample>
private

SpatialSampleContainer type alias support

Definition at line 215 of file itkMutualInformationImageToImageMetric.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage >
using itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Superclass = ImageToImageMetric<TFixedImage, TMovingImage>

Definition at line 101 of file itkMutualInformationImageToImageMetric.h.

Constructor & Destructor Documentation

◆ MutualInformationImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >
itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MutualInformationImageToImageMetric ( )
protected

◆ ~MutualInformationImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >
itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::~MutualInformationImageToImageMetric ( )
overrideprotecteddefault

Member Function Documentation

◆ CalculateDerivatives()

template<typename TFixedImage , typename TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CalculateDerivatives ( const FixedImagePointType ,
DerivativeType ,
TransformJacobianType  
) const
private

◆ GetDerivative()

template<typename TFixedImage , typename TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const ParametersType parameters,
DerivativeType derivative 
) const
overridevirtual

Get the derivatives of the match measure.

Implements itk::SingleValuedCostFunction.

◆ GetFixedImageStandardDeviation()

template<typename TFixedImage , typename TMovingImage >
virtual double itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageStandardDeviation ( ) const
virtual

Set/Get the fixed image intensity standard deviation. This defines the kernel bandwidth used in the joint probability distribution calculation. Default value is 0.4 which works well for image intensities normalized to a mean of 0 and standard deviation of 1.0. Value is clamped to be always greater than zero.

◆ GetModifiableKernelFunction()

template<typename TFixedImage , typename TMovingImage >
virtual KernelFunctionType* itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetModifiableKernelFunction ( )
virtual

Set/Get the kernel function. This is used to calculate the joint probability distribution. Default is the GaussianKernelFunction.

◆ GetMovingImageStandardDeviation()

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

Set/Get the moving image intensity standard deviation. This defines the kernel bandwidth used in the joint probability distribution calculation. Default value is 0.4 which works well for image intensities normalized to a mean of 0 and standard deviation of 1.0. Value is clamped to be always greater than zero.

◆ GetNumberOfSpatialSamples()

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

Get the number of spatial samples.

◆ GetValue()

template<typename TFixedImage , typename TMovingImage >
MeasureType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const ParametersType parameters) const
overridevirtual

Get the value.

Implements itk::SingleValuedCostFunction.

◆ GetValueAndDerivative()

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

◆ itkOverrideGetNameOfClassMacro()

template<typename TFixedImage , typename TMovingImage >
itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::itkOverrideGetNameOfClassMacro ( MutualInformationImageToImageMetric< TFixedImage, TMovingImage >  )

Run-time type information (and related methods).

◆ New()

template<typename TFixedImage , typename TMovingImage >
static Pointer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SampleFixedImageDomain()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SampleFixedImageDomain ( SpatialSampleContainer samples) const
privatevirtual

Uniformly select samples from the fixed image buffer.

Each sample consists of:

  • the fixed image value
  • the corresponding moving image value
Warning
Note that this method has a different signature than the one in the base OptImageToImageMetric and therefore they are not intended to provide polymorphism. That is, this function is not overriding the one in the base class.

◆ SetFixedImageStandardDeviation()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageStandardDeviation ( double  _arg)
virtual

Set/Get the fixed image intensity standard deviation. This defines the kernel bandwidth used in the joint probability distribution calculation. Default value is 0.4 which works well for image intensities normalized to a mean of 0 and standard deviation of 1.0. Value is clamped to be always greater than zero.

◆ SetKernelFunction()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetKernelFunction ( KernelFunctionType _arg)
virtual

Set/Get the kernel function. This is used to calculate the joint probability distribution. Default is the GaussianKernelFunction.

◆ SetMovingImageStandardDeviation()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageStandardDeviation ( double  _arg)
virtual

Set/Get the moving image intensity standard deviation. This defines the kernel bandwidth used in the joint probability distribution calculation. Default value is 0.4 which works well for image intensities normalized to a mean of 0 and standard deviation of 1.0. Value is clamped to be always greater than zero.

◆ SetNumberOfSpatialSamples()

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

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

Member Data Documentation

◆ m_DerivativeCalculator

template<typename TFixedImage , typename TMovingImage >
DerivativeFunctionType::Pointer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_DerivativeCalculator {}
private

Definition at line 261 of file itkMutualInformationImageToImageMetric.h.

◆ m_FixedImageStandardDeviation

template<typename TFixedImage , typename TMovingImage >
double itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageStandardDeviation {}
private

Definition at line 227 of file itkMutualInformationImageToImageMetric.h.

◆ m_KernelFunction

template<typename TFixedImage , typename TMovingImage >
KernelFunctionType::Pointer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_KernelFunction {}
private

Definition at line 230 of file itkMutualInformationImageToImageMetric.h.

◆ m_MinProbability

template<typename TFixedImage , typename TMovingImage >
double itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MinProbability {}
private

Definition at line 228 of file itkMutualInformationImageToImageMetric.h.

◆ m_MovingImageStandardDeviation

template<typename TFixedImage , typename TMovingImage >
double itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageStandardDeviation {}
private

Definition at line 226 of file itkMutualInformationImageToImageMetric.h.

◆ m_NumberOfSpatialSamples

template<typename TFixedImage , typename TMovingImage >
unsigned int itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_NumberOfSpatialSamples {}
private

Definition at line 225 of file itkMutualInformationImageToImageMetric.h.

◆ m_SampleA

template<typename TFixedImage , typename TMovingImage >
SpatialSampleContainer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_SampleA {}
mutableprivate

Container to store sample set A - used to approximate the probability density function (pdf).

Definition at line 219 of file itkMutualInformationImageToImageMetric.h.

◆ m_SampleB

template<typename TFixedImage , typename TMovingImage >
SpatialSampleContainer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_SampleB {}
mutableprivate

Container to store sample set B - used to approximate the mutual information value.

Definition at line 223 of file itkMutualInformationImageToImageMetric.h.

◆ MovingImageDimension

template<typename TFixedImage , typename TMovingImage >
constexpr unsigned int itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDimension = MovingImageType::ImageDimension
staticconstexpr

Enum of the moving image dimension.

Definition at line 134 of file itkMutualInformationImageToImageMetric.h.


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