ITK  4.6.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::MutualInformationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkMutualInformationImageToImageMetric.h>

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

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >

Computes the mutual information between two images to be registered.

MutualInformationImageToImageMetric computes the mutual information between a fixed and moving image to be registered.

This class is templated over the FixedImage type and the MovingImage type.

The fixed and moving images are set via methods SetFixedImage() and SetMovingImage(). This metric makes use of user specified Transform and Interpolator. The Transform is used to map points from the fixed image to the moving image domain. The Interpolator is used to evaluate the image intensity at user specified geometric points in the moving image. The Transform and Interpolator are set via methods SetTransform() and SetInterpolator().

Warning
This metric assumes that the moving image has already been connected to the interpolator outside of this class.

The method GetValue() computes of the mutual information while method GetValueAndDerivative() computes both the mutual information and its derivatives with respect to the transform parameters.

The calculations are based on the method of Viola and Wells where the probability density distributions are estimated using Parzen windows.

By default a Gaussian kernel is used in the density estimation. Other option include Cauchy and spline-based. A user can specify the kernel passing in a pointer a KernelFunctionBase using the SetKernelFunction() method.

Mutual information is estimated using two sample sets: one to calculate the singular and joint pdf's and one to calculate the entropy integral. By default 50 samples points are used in each set. Other values can be set via the SetNumberOfSpatialSamples() method.

Quality of the density estimate depends on the choice of the kernel's standard deviation. Optimal choice will depend on the images. It is can be shown that around the optimal variance, the mutual information estimate is relatively insensitive to small changes of the standard deviation. In our experiments, we have found that a standard deviation of 0.4 works well for images normalized to have a mean of zero and standard deviation of 1.0. The variance can be set via methods SetFixedImageStandardDeviation() and SetMovingImageStandardDeviation().

Implementaton of this class is based on: Viola, P. and Wells III, W. (1997). "Alignment by Maximization of Mutual Information" International Journal of Computer Vision, 24(2):137-154

See Also
KernelFunctionBase
GaussianKernelFunction
Wiki Examples:
Examples:
RegistrationITKv3/ImageRegistration2.cxx, and RegistrationITKv4/ImageRegistration2.cxx.

Definition at line 94 of file itkMutualInformationImageToImageMetric.h.

Classes

class  SpatialSample
 

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
Superclass::FixedImageConstPointer 
FixedImageConstPointer
 
typedef FixedImageType::IndexType FixedImageIndexType
 
typedef
FixedImageIndexType::IndexValueType 
FixedImageIndexValueType
 
typedef
TransformType::InputPointType 
FixedImagePointType
 
typedef Superclass::FixedImageType FixedImageType
 
typedef
Superclass::InterpolatorType 
InterpolatorType
 
typedef KernelFunctionBase
< double > 
KernelFunctionType
 
typedef Superclass::MeasureType MeasureType
 
typedef
Superclass::MovingImageConstPointer 
MovingImageCosntPointer
 
typedef MovingImageType::IndexType MovingImageIndexType
 
typedef
TransformType::OutputPointType 
MovingImagePointType
 
typedef Superclass::MovingImageType MovingImageType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
MutualInformationImageToImageMetric 
Self
 
typedef ImageToImageMetric
< TFixedImage, TMovingImage > 
Superclass
 
typedef
Superclass::TransformJacobianType 
TransformJacobianType
 
typedef
Superclass::TransformPointer 
TransformPointer
 
typedef Superclass::TransformType TransformType
 
- Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef 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 (void) const
 
void GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const
 
virtual const char * GetNameOfClass () const
 
virtual const unsigned int & GetNumberOfSpatialSamples () const
 
MeasureType GetValue (const ParametersType &parameters) const
 
void GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int)
 
void SetNumberOfSpatialSamples (unsigned int num)
 
virtual void SetMovingImageStandardDeviation (double _arg)
 
virtual const double & GetMovingImageStandardDeviation () const
 
virtual void SetFixedImageStandardDeviation (double _arg)
 
virtual double GetFixedImageStandardDeviation () const
 
virtual void SetKernelFunction (KernelFunctionType *_arg)
 
virtual KernelFunctionTypeGetModifiableKernelFunction ()
 
virtual const KernelFunctionTypeGetKernelFunction () const
 
- Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void ComputeGradient (void)
 
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 ITK_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 Initialize (void) throw ( ExceptionObject )
 
virtual void MultiThreadingInitialize (void) throw ( ExceptionObject )
 
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 (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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 ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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

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

Private Types

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

Private Member Functions

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

Private Attributes

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

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef std::vector< bool > BooleanArrayType
 
typedef
BSplineInterpolateImageFunction
< MovingImageType,
CoordinateRepresentationType
BSplineInterpolatorType
 
typedef FixedArray
< SizeValueType,
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
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- 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
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 
- Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int DeformationSplineOrder = 3
 

Member Typedef Documentation

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

Definition at line 103 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::CoordinateRepresentationType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType
private

Definition at line 254 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 256 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::DerivativeType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Definition at line 117 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageConstPointer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 121 of file itkMutualInformationImageToImageMetric.h.

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

Index and Point typedef support.

Definition at line 125 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 126 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 128 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Definition at line 119 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::InterpolatorType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType

Definition at line 115 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 131 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MeasureType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Definition at line 116 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 122 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 127 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 129 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MovingImageType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Definition at line 120 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::ParametersType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ParametersType

Definition at line 118 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 102 of file itkMutualInformationImageToImageMetric.h.

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

Standard class typedefs.

Definition at line 100 of file itkMutualInformationImageToImageMetric.h.

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

SpatialSampleContainer typedef support.

Definition at line 224 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 101 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformJacobianType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Definition at line 114 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformPointer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Definition at line 113 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformType itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Types inherited from Superclass.

Definition at line 109 of file itkMutualInformationImageToImageMetric.h.

Constructor & Destructor Documentation

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

Definition at line 199 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MutualInformationImageToImageMetric ( const Self )
private

Member Function Documentation

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

Calculate the intensity derivatives at a point

template<typename TFixedImage , typename TMovingImage >
virtual::itk::LightObject::Pointer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::CreateAnother ( void  ) 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::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const ParametersType parameters,
DerivativeType Derivative 
) const
virtual

Get the derivatives of the match measure.

Implements itk::SingleValuedCostFunction.

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

Set/Get the fixed image intensitiy 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.

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

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

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.

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

Set/Get the moving image intensitiy 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.

template<typename TFixedImage , typename TMovingImage >
virtual const char* itk::MutualInformationImageToImageMetric< 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 unsigned int& itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfSpatialSamples ( ) const
virtual

Get the number of spatial samples.

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

Get the value.

Implements itk::SingleValuedCostFunction.

template<typename TFixedImage , typename TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative ( const ParametersType parameters,
MeasureType Value,
DerivativeType Derivative 
) const
virtual

Get the value and derivatives for single valued optimizers.

Reimplemented from itk::SingleValuedCostFunction.

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

Method for creation through the object factory.

template<typename TFixedImage , typename TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::operator= ( const Self )
private
template<typename TFixedImage , typename TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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 >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ReinitializeSeed ( )

Reinitialize the seed of the random number generator that selects the sample of pixels used for estimating the image histograms and the joint histogram. By nature, this metric is not deterministic, since at each run it may select a different set of pixels. By initializing the random number generator seed to the same value you can restore determinism. On the other hand, calling the method ReinitializeSeed() without arguments will use the clock from your machine in order to have a very random initialization of the seed. This will indeed increase the non-deterministic behavior of the metric.

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

Uniformly select samples from the fixed image buffer.

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.
template<typename TFixedImage , typename TMovingImage >
virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageStandardDeviation ( double  _arg)
virtual

Set/Get the fixed image intensitiy 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.

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.

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

Set/Get the moving image intensitiy 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.

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

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

Definition at line 258 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 236 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 239 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 237 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 235 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 234 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
int itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_RandomSeed
private

Definition at line 261 of file itkMutualInformationImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
bool itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::m_ReseedIterator
private

Definition at line 260 of file itkMutualInformationImageToImageMetric.h.

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 228 of file itkMutualInformationImageToImageMetric.h.

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 232 of file itkMutualInformationImageToImageMetric.h.

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

Enum of the moving image dimension.

Definition at line 135 of file itkMutualInformationImageToImageMetric.h.


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