ITK  4.13.0
Insight Segmentation and Registration 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::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkMattesMutualInformationImageToImageMetric.h>

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

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 [1,2] 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 arbitray magnitude and dynamic range, the image intensity is scale such that any contribution to the histogram will fall into a valid bin.

One the PDF's have been contructed, the mutual information is obtained by doubling summing over the discrete PDF values.

Notes:

  1. This class returns the negative mutual information value.

References: [1] "Nonrigid multimodality image registration" D. Mattes, D. R. Haynor, H. Vesselle, T. Lewellen and W. Eubank Medical Imaging 2001: Image Processing, 2001, pp. 1609-1620. [2] "PET-CT Image Registration in the Chest Using Free-form Deformations" D. Mattes, D. R. Haynor, H. Vesselle, T. Lewellen and W. Eubank IEEE Transactions in Medical Imaging. Vol.22, No.1, January 2003. pp.120-128. [3] "Optimization of Mutual Information for MultiResolution Image Registration" P. Thevenaz and M. Unser IEEE Transactions in Image Processing, 9(12) December 2000.

Examples:
Examples/RegistrationITKv3/DeformableRegistration12.cxx, Examples/RegistrationITKv3/DeformableRegistration13.cxx, Examples/RegistrationITKv3/DeformableRegistration14.cxx, Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/DeformableRegistration8.cxx, Examples/RegistrationITKv3/ImageRegistration11.cxx, Examples/RegistrationITKv3/ImageRegistration13.cxx, Examples/RegistrationITKv3/ImageRegistration16.cxx, Examples/RegistrationITKv3/ImageRegistration4.cxx, Examples/RegistrationITKv3/MultiResImageRegistration1.cxx, Examples/RegistrationITKv3/MultiResImageRegistration2.cxx, Examples/RegistrationITKv3/MultiResImageRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, and WikiExamples/Registration/WatchRegistration.cxx.

Definition at line 112 of file itkMattesMutualInformationImageToImageMetric.h.

Classes

struct  MMIMetricPerThreadStruct
 

Public Types

typedef
Superclass::BSplineTransformIndexArrayType 
BSplineTransformIndexArrayType
 
typedef
Superclass::BSplineTransformWeightsType 
BSplineTransformWeightsType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::CoordinateRepresentationType 
CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
Superclass::FixedImageConstPointer 
FixedImageConstPointer
 
typedef
Superclass::FixedImageSampleContainer 
FixedImageSampleContainer
 
typedef Superclass::FixedImageType FixedImageType
 
typedef
Superclass::ImageDerivativesType 
ImageDerivativesType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef
Superclass::InterpolatorType 
InterpolatorType
 
typedef Image< PDFValueType, 3 > JointPDFDerivativesType
 
typedef Image< PDFValueType, 2 > JointPDFType
 
typedef Superclass::MeasureType MeasureType
 
typedef
Superclass::MovingImageConstPointer 
MovingImageConstPointer
 
typedef
Superclass::MovingImagePointType 
MovingImagePointType
 
typedef Superclass::MovingImageType MovingImageType
 
typedef
FixedImageType::OffsetValueType 
OffsetValueType
 
typedef Superclass::ParametersType ParametersType
 
typedef double PDFValueType
 
typedef SmartPointer< SelfPointer
 
typedef
MattesMutualInformationImageToImageMetric 
Self
 
typedef ImageToImageMetric
< TFixedImage, TMovingImage > 
Superclass
 
typedef
Superclass::TransformJacobianType 
TransformJacobianType
 
typedef
Superclass::TransformPointer 
TransformPointer
 
typedef Superclass::TransformType TransformType
 
typedef
Superclass::WeightsValueType 
WeightsValueType
 
- Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ParametersValueType 
CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
FixedImageType::ConstPointer 
FixedImageConstPointer
 
typedef std::vector
< FixedImageIndexType
FixedImageIndexContainer
 
typedef FixedImageType::IndexType FixedImageIndexType
 
typedef
FixedImageIndexType::IndexValueType 
FixedImageIndexValueType
 
typedef
FixedImageMaskType::ConstPointer 
FixedImageMaskConstPointer
 
typedef FixedImageMaskType::Pointer FixedImageMaskPointer
 
typedef SpatialObject
< itkGetStaticConstMacro(FixedImageDimension) > 
FixedImageMaskType
 
typedef TFixedImage::PixelType FixedImagePixelType
 
typedef
TransformType::InputPointType 
FixedImagePointType
 
typedef FixedImageType::RegionType FixedImageRegionType
 
typedef TFixedImage FixedImageType
 
typedef
TransformType::InputPointType 
InputPointType
 
typedef InterpolatorType::Pointer InterpolatorPointer
 
typedef
InterpolateImageFunction
< MovingImageType,
CoordinateRepresentationType
InterpolatorType
 
typedef Superclass::MeasureType MeasureType
 
typedef
MovingImageType::ConstPointer 
MovingImageConstPointer
 
typedef MovingImageType::IndexType MovingImageIndexType
 
typedef
MovingImageMaskType::ConstPointer 
MovingImageMaskConstPointer
 
typedef
MovingImageMaskType::Pointer 
MovingImageMaskPointer
 
typedef SpatialObject
< itkGetStaticConstMacro(MovingImageDimension) > 
MovingImageMaskType
 
typedef TMovingImage::PixelType MovingImagePixelType
 
typedef
TransformType::OutputPointType 
MovingImagePointType
 
typedef TMovingImage MovingImageType
 
typedef MultiThreader MultiThreaderType
 
typedef
TransformType::OutputPointType 
OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageMetric Self
 
typedef SingleValuedCostFunction Superclass
 
typedef TransformType::JacobianType TransformJacobianType
 
typedef
TransformType::ParametersType 
TransformParametersType
 
typedef TransformType::Pointer TransformPointer
 
typedef Transform
< CoordinateRepresentationType,
itkGetStaticConstMacro(MovingImageDimension),
itkGetStaticConstMacro(FixedImageDimension) > 
TransformType
 
typedef NumericTraits
< MovingImagePixelType >
::RealType 
RealType
 
typedef CovariantVector
< RealType,
itkGetStaticConstMacro(MovingImageDimension) > 
GradientPixelType
 
typedef Image
< GradientPixelType,
itkGetStaticConstMacro(MovingImageDimension) > 
GradientImageType
 
typedef SmartPointer
< GradientImageType
GradientImagePointer
 
typedef
GradientRecursiveGaussianImageFilter
< MovingImageType,
GradientImageType
GradientImageFilterType
 
typedef
GradientImageFilterType::Pointer 
GradientImageFilterPointer
 
- Public Types inherited from itk::SingleValuedCostFunction
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< ParametersValueType
DerivativeType
 
typedef double MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef SingleValuedCostFunction Self
 
typedef CostFunction Superclass
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ParametersType
 
typedef
TInternalComputationValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef CostFunctionTemplate Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const override
 
virtual const char * GetNameOfClass () const
 
MeasureType GetValue (const ParametersType &parameters) const override
 
void GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override
 
virtual void Initialize (void) override
 
virtual void SetNumberOfHistogramBins (SizeValueType _arg)
 
virtual const SizeValueTypeGetNumberOfHistogramBins () 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 FixedImagePixelTypeGetFixedImageSamplesIntensityThreshold () const
 
virtual const GradientImageTypeGetGradientImage () const
 
virtual const InterpolatorTypeGetInterpolator () const
 
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual TransformTypeGetModifiableTransform ()
 
SizeValueType GetNumberOfMovingImageSamples (void)
 
virtual unsigned int GetNumberOfParameters (void) const override
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
SizeValueType GetNumberOfSpatialSamples (void)
 
virtual const TransformTypeGetTransform () 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)
 
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 useIndex)
 
void SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
 
void SetUseSequentialSampling (bool sequentialSampling)
 
void UseAllPixelsOff (void)
 
void UseAllPixelsOn (void)
 
virtual void SetFixedImage (const FixedImageType *_arg)
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetMovingImageMask (MovingImageMaskType *_arg)
 
virtual void SetMovingImageMask (const MovingImageMaskType *_arg)
 
virtual const MovingImageMaskTypeGetMovingImageMask () const
 
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
 
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
 
virtual const FixedImageMaskTypeGetFixedImageMask () const
 
void SetNumberOfThreads (ThreadIdType numberOfThreads)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
virtual void ComputeGradientOn ()
 
virtual void ComputeGradientOff ()
 
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 void UseCachingOfBSplineWeightsOff ()
 
virtual MultiThreaderTypeGetModifiableThreader ()
 
virtual const MultiThreaderTypeGetThreader () const
 
const TransformPointerGetThreaderTransform ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

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

Protected Member Functions

 MattesMutualInformationImageToImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~MattesMutualInformationImageToImageMetric () override
 
- 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
 
void GetValueAndDerivativeMultiThreadedPreProcessInitiate () const
 
virtual void GetValueAndDerivativeThread (ThreadIdType threadId) const
 
void GetValueMultiThreadedInitiate () const
 
void GetValueMultiThreadedPostProcessInitiate () const
 
void GetValueMultiThreadedPreProcessInitiate () const
 
virtual void GetValueThread (ThreadIdType threadId) 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 &sampleWithinSupportRegion, double &movingImageValue, ThreadIdType threadId) const
 
virtual void TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, ThreadIdType threadId) const
 
virtual ~ImageToImageMetric () override
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()
 
virtual ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
 
virtual ~CostFunctionTemplate () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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

typedef
BSplineDerivativeKernelFunction
< 3, PDFValueType
CubicBSplineDerivativeFunctionType
 
typedef BSplineKernelFunction
< 3, PDFValueType
CubicBSplineFunctionType
 
typedef
JointPDFDerivativesType::IndexType 
JointPDFDerivativesIndexType
 
typedef
JointPDFDerivativesType::RegionType 
JointPDFDerivativesRegionType
 
typedef
JointPDFDerivativesType::SizeType 
JointPDFDerivativesSizeType
 
typedef
JointPDFDerivativesType::PixelType 
JointPDFDerivativesValueType
 
typedef JointPDFType::IndexType JointPDFIndexType
 
typedef JointPDFType::RegionType JointPDFRegionType
 
typedef JointPDFType::SizeType JointPDFSizeType
 
typedef JointPDFType::PixelType JointPDFValueType
 
typedef std::vector< PDFValueTypeMarginalPDFType
 
typedef Array2D< PRatioTypePRatioArrayType
 
typedef PDFValueType PRatioType
 

Private Member Functions

void ComputeFixedImageParzenWindowIndices (FixedImageSampleContainer &samples)
 
void ComputePDFDerivatives (ThreadIdType threadId, unsigned int sampleNumber, int movingImageParzenWindowIndex, const ImageDerivativesType &movingImageGradientValue, PDFValueType cubicBSplineDerivativeValue) const
 
virtual void GetValueAndDerivativeThreadPostProcess (ThreadIdType threadId, bool withinSampleThread) const override
 
virtual void GetValueAndDerivativeThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const override
 
virtual bool GetValueAndDerivativeThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue, const ImageDerivativesType &movingImageGradientValue) const override
 
virtual void GetValueThreadPostProcess (ThreadIdType threadId, bool withinSampleThread) const override
 
virtual void GetValueThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const override
 
virtual 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

CubicBSplineDerivativeFunctionType::Pointer m_CubicBSplineDerivativeKernel
 
CubicBSplineFunctionType::Pointer m_CubicBSplineKernel
 
PDFValueType m_FixedImageBinSize
 
PDFValueType m_FixedImageNormalizedMin
 
PDFValueType m_FixedImageTrueMax
 
PDFValueType m_FixedImageTrueMin
 
bool m_ImplicitDerivativesSecondPass
 
AlignedMMIMetricPerThreadStruct * m_MMIMetricPerThreadVariables
 
PDFValueType m_MovingImageBinSize
 
MarginalPDFType m_MovingImageMarginalPDF
 
PDFValueType m_MovingImageNormalizedMin
 
PDFValueType m_MovingImageTrueMax
 
PDFValueType m_MovingImageTrueMin
 
SizeValueType m_NumberOfHistogramBins
 
PRatioArrayType m_PRatioArray
 
bool m_UseExplicitPDFDerivatives
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef std::vector< bool > BooleanArrayType
 
typedef
BSplineInterpolateImageFunction
< MovingImageType,
CoordinateRepresentationType
BSplineInterpolatorType
 
typedef FixedArray
< SizeValueType,
FixedImageType::ImageDimension > 
BSplineParametersOffsetType
 
typedef
BSplineTransformType::ParameterIndexArrayType 
BSplineTransformIndexArrayType
 
typedef Array2D< IndexValueTypeBSplineTransformIndicesArrayType
 
typedef BSplineBaseTransform
< CoordinateRepresentationType,
FixedImageType::ImageDimension,
itkGetStaticConstMacro(DeformationSplineOrder) > 
BSplineTransformType
 
typedef Array2D< WeightsValueTypeBSplineTransformWeightsArrayType
 
typedef
BSplineTransformType::WeightsType 
BSplineTransformWeightsType
 
typedef
CentralDifferenceImageFunction
< MovingImageType,
CoordinateRepresentationType
DerivativeFunctionType
 
typedef std::vector
< FixedImageSamplePoint
FixedImageSampleContainer
 
typedef CovariantVector
< double,
itkGetStaticConstMacro(MovingImageDimension) > 
ImageDerivativesType
 
typedef
BSplineTransformIndexArrayType::ValueType 
IndexValueType
 
typedef std::vector
< MovingImagePointType
MovingImagePointArrayType
 
typedef
BSplineTransformWeightsType::ValueType 
WeightsValueType
 
- Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_TYPE GetValueAndDerivativeMultiThreaded (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueAndDerivativeMultiThreadedPostProcess (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueAndDerivativeMultiThreadedPreProcess (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueMultiThreaded (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueMultiThreadedPostProcess (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueMultiThreadedPreProcess (void *arg)
 
- Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
BSplineInterpolatorType::Pointer m_BSplineInterpolator
 
BSplineParametersOffsetType m_BSplineParametersOffset
 
MovingImagePointArrayType m_BSplinePreTransformPointsArray
 
BSplineTransformType::Pointer m_BSplineTransform
 
BSplineTransformIndexArrayType m_BSplineTransformIndices
 
BSplineTransformIndicesArrayType m_BSplineTransformIndicesArray
 
BSplineTransformWeightsType m_BSplineTransformWeights
 
BSplineTransformWeightsArrayType m_BSplineTransformWeightsArray
 
bool m_ComputeGradient
 
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
 
MovingImageConstPointer m_MovingImage
 
MovingImageMaskConstPointer m_MovingImageMask
 
SizeValueType m_NumberOfFixedImageSamples
 
SizeValueType m_NumberOfParameters
 
SizeValueType m_NumberOfPixelsCounted
 
ThreadIdType m_NumberOfThreads
 
SizeValueType m_NumBSplineWeights
 
int m_RandomSeed
 
bool m_ReseedIterator
 
MultiThreaderType::Pointer m_Threader
 
BSplineTransformIndexArrayTypem_ThreaderBSplineTransformIndices
 
BSplineTransformWeightsTypem_ThreaderBSplineTransformWeights
 
unsigned int * m_ThreaderNumberOfMovingImageSamples
 
MultiThreaderParameterType m_ThreaderParameter
 
TransformPointerm_ThreaderTransform
 
TransformPointer m_Transform
 
bool m_TransformIsBSpline
 
bool m_UseAllPixels
 
bool m_UseCachingOfBSplineWeights
 
bool m_UseFixedImageIndexes
 
bool m_UseFixedImageSamplesIntensityThreshold
 
bool m_UseSequentialSampling
 
BooleanArrayType m_WithinBSplineSupportRegionArray
 
bool m_WithinThreadPostProcess
 
bool m_WithinThreadPreProcess
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 
- Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int DeformationSplineOrder = 3
 

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::BSplineTransformIndexArrayType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::BSplineTransformIndexArrayType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::BSplineTransformWeightsType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::BSplineTransformWeightsType
template<typename TFixedImage , typename TMovingImage >
typedef SmartPointer<const Self> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::CoordinateRepresentationType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType
template<typename TFixedImage , typename TMovingImage >
typedef BSplineDerivativeKernelFunction<3,PDFValueType> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CubicBSplineDerivativeFunctionType
private
template<typename TFixedImage , typename TMovingImage >
typedef BSplineKernelFunction<3,PDFValueType> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CubicBSplineFunctionType
private

Typedefs for BSpline kernel and derivative functions.

Definition at line 272 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::DerivativeType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageConstPointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageSampleContainer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageSampleContainer
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::ImageDerivativesType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ImageDerivativesType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::IndexValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::IndexValueType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::InterpolatorType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType
template<typename TFixedImage , typename TMovingImage >
typedef JointPDFDerivativesType::IndexType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesIndexType
private
template<typename TFixedImage , typename TMovingImage >
typedef JointPDFDerivativesType::RegionType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesRegionType
private
template<typename TFixedImage , typename TMovingImage >
typedef JointPDFDerivativesType::SizeType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesSizeType
private
template<typename TFixedImage , typename TMovingImage >
typedef Image<PDFValueType, 3> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesType
template<typename TFixedImage , typename TMovingImage >
typedef JointPDFDerivativesType::PixelType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFDerivativesValueType
private
template<typename TFixedImage , typename TMovingImage >
typedef JointPDFType::IndexType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFIndexType
private
template<typename TFixedImage , typename TMovingImage >
typedef JointPDFType::RegionType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFRegionType
private
template<typename TFixedImage , typename TMovingImage >
typedef JointPDFType::SizeType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFSizeType
private
template<typename TFixedImage , typename TMovingImage >
typedef Image<PDFValueType, 2> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFType

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

Definition at line 220 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef JointPDFType::PixelType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::JointPDFValueType
private
template<typename TFixedImage , typename TMovingImage >
typedef std::vector< PDFValueType > itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MarginalPDFType
private

The moving image marginal PDF.

Definition at line 321 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MeasureType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MeasureType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MovingImageConstPointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MovingImagePointType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MovingImageType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType
template<typename TFixedImage , typename TMovingImage >
typedef FixedImageType::OffsetValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::OffsetValueType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::ParametersType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ParametersType
template<typename TFixedImage , typename TMovingImage >
typedef double itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PDFValueType

The marginal PDFs are stored as std::vector.

Definition at line 213 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef SmartPointer<Self> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Pointer
template<typename TFixedImage , typename TMovingImage >
typedef Array2D<PRatioType> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PRatioArrayType
private
template<typename TFixedImage , typename TMovingImage >
typedef PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PRatioType
private

Helper array for storing the values of the JointPDF ratios.

Definition at line 315 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef MattesMutualInformationImageToImageMetric itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Definition at line 118 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef ImageToImageMetric<TFixedImage, TMovingImage> itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Superclass
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformJacobianType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformPointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer
template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Types inherited from Superclass.

Definition at line 128 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::WeightsValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::WeightsValueType

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage >
itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MattesMutualInformationImageToImageMetric ( )
protected
template<typename TFixedImage , typename TMovingImage >
virtual itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::~MattesMutualInformationImageToImageMetric ( )
overrideprotectedvirtual

Member Function Documentation

template<typename TFixedImage , typename TMovingImage >
void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ComputeFixedImageParzenWindowIndices ( FixedImageSampleContainer samples)
private

Precompute fixed image parzen window indices.

template<typename TFixedImage , typename TMovingImage >
void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ComputePDFDerivatives ( ThreadIdType  threadId,
unsigned int  sampleNumber,
int  movingImageParzenWindowIndex,
const ImageDerivativesType movingImageGradientValue,
PDFValueType  cubicBSplineDerivativeValue 
) const
private

Compute PDF derivative contribution for each parameter.

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

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.

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 227 of file itkMattesMutualInformationImageToImageMetric.h.

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 243 of file itkMattesMutualInformationImageToImageMetric.h.

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

Run-time type information (and related methods).

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

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.

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.

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

Get the value.

Implements itk::SingleValuedCostFunction.

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.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadPostProcess ( ThreadIdType  threadId,
bool  withinSampleThread 
) const
overrideprivatevirtual
template<typename TFixedImage , typename TMovingImage >
virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadPreProcess ( ThreadIdType  threadId,
bool  withinSampleThread 
) const
overrideprivatevirtual
template<typename TFixedImage , typename TMovingImage >
virtual bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadProcessSample ( ThreadIdType  threadId,
SizeValueType  fixedImageSample,
const MovingImagePointType mappedPoint,
double  movingImageValue,
const ImageDerivativesType movingImageGradientValue 
) const
overrideprivatevirtual
template<typename TFixedImage , typename TMovingImage >
virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreadPostProcess ( ThreadIdType  threadId,
bool  withinSampleThread 
) const
overrideprivatevirtual
template<typename TFixedImage , typename TMovingImage >
virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreadPreProcess ( ThreadIdType  threadId,
bool  withinSampleThread 
) const
overrideprivatevirtual
template<typename TFixedImage , typename TMovingImage >
virtual bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreadProcessSample ( ThreadIdType  threadId,
SizeValueType  fixedImageSample,
const MovingImagePointType mappedPoint,
double  movingImageValue 
) const
overrideprivatevirtual
template<typename TFixedImage , typename TMovingImage >
virtual void itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Initialize ( void  )
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 >.

template<typename TFixedImage , typename TMovingImage >
itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::itkAlignedTypedef ( ITK_CACHE_LINE_ALIGNMENT  ,
PaddedMMIMetricPerThreadStruct  ,
AlignedMMIMetricPerThreadStruct   
)
private
template<typename TFixedImage , typename TMovingImage >
itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::itkPadStruct ( ITK_CACHE_LINE_ALIGNMENT  ,
MMIMetricPerThreadStruct  ,
PaddedMMIMetricPerThreadStruct   
)
private
template<typename TFixedImage , typename TMovingImage >
static Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::New ( )
static

Method for creation through the object factory.

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

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.

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.

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.

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

template<typename TFixedImage , typename TMovingImage >
CubicBSplineDerivativeFunctionType::Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_CubicBSplineDerivativeKernel
private
template<typename TFixedImage , typename TMovingImage >
CubicBSplineFunctionType::Pointer itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_CubicBSplineKernel
private

Cubic BSpline kernel for computing Parzen histograms.

Definition at line 311 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageBinSize
private
template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageNormalizedMin
private
template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageTrueMax
private
template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageTrueMin
private
template<typename TFixedImage , typename TMovingImage >
bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_ImplicitDerivativesSecondPass
mutableprivate
template<typename TFixedImage , typename TMovingImage >
AlignedMMIMetricPerThreadStruct* itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MMIMetricPerThreadVariables
mutableprivate
template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageBinSize
private
template<typename TFixedImage , typename TMovingImage >
MarginalPDFType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageMarginalPDF
mutableprivate
template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageNormalizedMin
private
template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageTrueMax
private
template<typename TFixedImage , typename TMovingImage >
PDFValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageTrueMin
private
template<typename TFixedImage , typename TMovingImage >
SizeValueType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_NumberOfHistogramBins
private

Variables to define the marginal and joint histograms.

Definition at line 300 of file itkMattesMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
PRatioArrayType itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_PRatioArray
mutableprivate
template<typename TFixedImage , typename TMovingImage >
bool itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_UseExplicitPDFDerivatives
private
template<typename TFixedImage , typename TMovingImage >
const unsigned int itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDimension = MovingImageType::ImageDimension
static

The moving image dimension.

Definition at line 156 of file itkMattesMutualInformationImageToImageMetric.h.


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