#include <itkMattesMutualInformationImageToImageMetric.h>
Inheritance diagram for itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >:


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.
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. 2. This class in not thread safe due the private data structures used to the store the sampled points and the marginal and joint pdfs.
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.
Definition at line 116 of file itkMattesMutualInformationImageToImageMetric.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef Superclass::CoordinateRepresentationType | CoordinateRepresentationType |
| typedef Superclass::DerivativeType | DerivativeType |
| typedef Superclass::FixedImageConstPointer | FixedImageConstPointer |
| typedef FixedImageType::IndexType | FixedImageIndexType |
| typedef FixedImageIndexType::IndexValueType | FixedImageIndexValueType |
| typedef FixedImageMaskType::Pointer | FixedImageMaskPointer |
| typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension) | FixedImageMaskType ) |
| typedef TransformType::InputPointType | FixedImagePointType |
| typedef FixedImageType::RegionType | FixedImageRegionType |
| typedef Superclass::FixedImageType | FixedImageType |
| typedef GradientImageFilterType::Pointer | GradientImageFilterPointer |
| typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType > | GradientImageFilterType |
| typedef SmartPointer< GradientImageType > | GradientImagePointer |
| typedef Image< GradientPixelType, itkGetStaticConstMacro(MovingImageDimension) | GradientImageType ) |
| typedef CovariantVector< RealType, itkGetStaticConstMacro(MovingImageDimension) | GradientPixelType ) |
| typedef TransformType::InputPointType | InputPointType |
| typedef InterpolatorType::Pointer | InterpolatorPointer |
| typedef Superclass::InterpolatorType | InterpolatorType |
| typedef Superclass::MeasureType | MeasureType |
| typedef MovingImageType::ConstPointer | MovingImageConstPointer |
| typedef Superclass::MovingImageConstPointer | MovingImageCosntPointer |
| typedef MovingImageType::IndexType | MovingImageIndexType |
| typedef MovingImageMaskType::Pointer | MovingImageMaskPointer |
| typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension) | MovingImageMaskType ) |
| typedef TMovingImage::PixelType | MovingImagePixelType |
| typedef TransformType::OutputPointType | MovingImagePointType |
| typedef Superclass::MovingImageType | MovingImageType |
| typedef TransformType::OutputPointType | OutputPointType |
| typedef Superclass::ParametersType | ParametersType |
| typedef double | ParametersValueType |
| typedef SmartPointer< Self > | Pointer |
| typedef MattesMutualInformationImageToImageMetric | Self |
| typedef ImageToImageMetric< TFixedImage, TMovingImage > | Superclass |
| typedef Superclass::TransformJacobianType | TransformJacobianType |
| typedef TransformType::ParametersType | TransformParametersType |
| typedef Superclass::TransformPointer | TransformPointer |
| typedef Superclass::TransformType | TransformType |
Public Member Functions | |
| virtual void | ComputeGradientOff () |
| virtual void | ComputeGradientOn () |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| virtual void | Delete () |
| Command * | GetCommand (unsigned long tag) |
| virtual const bool & | GetComputeGradient () |
| bool | GetDebug () const |
| void | GetDerivative (const ParametersType ¶meters, DerivativeType &Derivative) const |
| virtual const FixedImageType * | GetFixedImage () |
| virtual const FixedImageMaskType * | GetFixedImageMask () |
| virtual const FixedImageRegionType & | GetFixedImageRegion () |
| virtual const GradientImageType * | GetGradientImage () |
| virtual const InterpolatorType * | GetInterpolator () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual const MovingImageType * | GetMovingImage () |
| virtual const MovingImageMaskType * | GetMovingImageMask () |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| virtual const unsigned long & | GetNumberOfHistogramBins () |
| unsigned int | GetNumberOfParameters (void) const |
| virtual const unsigned long & | GetNumberOfPixelsCounted () |
| virtual const unsigned long & | GetNumberOfSpatialSamples () |
| virtual int | GetReferenceCount () const |
| virtual const TransformType * | GetTransform () |
| virtual const bool & | GetUseAllPixels () |
| MeasureType | GetValue (const ParametersType ¶meters) const |
| void | GetValueAndDerivative (const ParametersType ¶meters, MeasureType &Value, DerivativeType &Derivative) const |
| bool | HasObserver (const EventObject &event) const |
| virtual void | Initialize (void) throw ( ExceptionObject ) |
| void | InvokeEvent (const EventObject &) const |
| void | InvokeEvent (const EventObject &) |
| itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension) | |
| Constants for the image dimensions * | itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension) |
| itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension) | |
| virtual void | Modified () const |
| void | Print (std::ostream &os, Indent indent=0) const |
| virtual void | Register () const |
| void | ReinitializeSeed (int) |
| Provide API to reinitialize the seed of the random number generator *void | ReinitializeSeed () |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| Set Get gradient computation *virtual void | SetComputeGradient (bool _arg) |
| void | SetDebug (bool debugFlag) const |
| virtual void | SetFixedImage (const FixedImageType *_arg) |
| Set Get the fixed image mask *virtual void | SetFixedImageMask (FixedImageMaskType *_arg) |
| virtual void | SetFixedImageRegion (FixedImageRegionType _arg) |
| virtual void | SetInterpolator (InterpolatorType *_arg) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetMovingImage (const MovingImageType *_arg) |
| Set Get the moving image mask *virtual void | SetMovingImageMask (MovingImageMaskType *_arg) |
| Number of bins to used in the histogram Typical value is *virtual void | SetNumberOfHistogramBins (unsigned long _arg) |
| Number of spatial samples to used to compute metric *virtual void | SetNumberOfSpatialSamples (unsigned long _arg) |
| virtual void | SetReferenceCount (int) |
| virtual void | SetTransform (TransformType *_arg) |
| void | SetTransformParameters (const ParametersType ¶meters) const |
| virtual void | UnRegister () const |
| virtual void | UseAllPixelsOff () |
| virtual void | UseAllPixelsOn () |
Static Public Member Functions | |
| static void | BreakOnError () |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| This is a global flag that controls whether any warning *or error messages are displayed *static void | SetGlobalWarningDisplay (bool flag) |
Public Attributes | |
| Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon | AddObserver )(const EventObject &event, Command *) const |
| This is a global flag that controls whether any | debug |
| Gaussian filter to compute the gradient of the Moving Image *typedef NumericTraits< MovingImagePixelType >::RealType | RealType |
Protected Member Functions | |
| MattesMutualInformationImageToImageMetric () | |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
| virtual void | SampleFixedImageDomain (FixedImageSpatialSampleContainer &samples) |
| virtual void | SampleFullFixedImageDomain (FixedImageSpatialSampleContainer &samples) |
| virtual void | TransformPoint (unsigned int sampleNumber, const ParametersType ¶meters, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue) const |
| virtual | ~MattesMutualInformationImageToImageMetric () |
Protected Attributes | |
| *A fixed image spatial sample consists of the fixed domain point *and the fixed image value at that point *typedef std::vector< FixedImageSpatialSample > | FixedImageSpatialSampleContainer |
| bool | m_ComputeGradient |
| FixedImageConstPointer | m_FixedImage |
| FixedImageMaskPointer | m_FixedImageMask |
| FixedImageSpatialSampleContainer | m_FixedImageSamples |
| GradientImagePointer | m_GradientImage |
| InterpolatorPointer | m_Interpolator |
| MovingImageConstPointer | m_MovingImage |
| MovingImageMaskPointer | m_MovingImageMask |
| unsigned long | m_NumberOfPixelsCounted |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| TransformPointer | m_Transform |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
|
|||||
|
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 125 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Type used for representing point components Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 146 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Type of the derivative. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 139 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 143 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Index and Point typedef support. Definition at line 149 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Definition at line 150 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Definition at line 122 of file itkImageToImageMetric.h. |
|
|||||
|
Type for the mask of the fixed image. Only pixels that are "inside" this mask will be considered for the computation of the metric Definition at line 121 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 152 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
|||||
|
Type of the fixed Image. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 141 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Definition at line 110 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 109 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 106 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 105 of file itkImageToImageMetric.h. |
|
|||||
|
|||||
|
Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 89 of file itkImageToImageMetric.h. |
|
|||||
|
Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 114 of file itkImageToImageMetric.h. |
|
|||||
|
Type of the Interpolator Base class Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 137 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Type of the measure. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 138 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
|||||
|
Definition at line 144 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Definition at line 151 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Definition at line 128 of file itkImageToImageMetric.h. |
|
|||||
|
Type for the mask of the moving image. Only pixels that are "inside" this mask will be considered for the computation of the metric Definition at line 127 of file itkImageToImageMetric.h. |
|
|||||
|
Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 68 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 153 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Type of the moving Image. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 142 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 90 of file itkImageToImageMetric.h. |
|
|||||
|
Type of the parameters. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 140 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|
ParametersType typedef. It defines a position in the optimization search space. Definition at line 46 of file itkCostFunction.h. |
|
|||||
|
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 124 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Standard class typedefs. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 122 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 123 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 136 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
|||||
|
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 135 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Types inherited from Superclass. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 131 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||||||
|
|
|
|||||||||
|
Definition at line 208 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
|||||||||
|
|
|
|||||||||
|
|
|
|
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class. Reimplemented from itk::LightObject. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting. |
|
|
Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used. |
|
|||||||||
|
|
|
|
Get the value of the debug flag. |
|
||||||||||||||||
|
Get the derivatives of the match measure. Implements itk::SingleValuedCostFunction. |
|
|||||||||
|
Get the Fixed Image. |
|
|||||||||
|
|
|
|||||||||
|
Get the region over which the metric will be computed |
|
|
|
|
|||||||||
|
Get Gradient Image. |
|
|||||||||
|
Get a pointer to the Interpolator. |
|
|
|
|
|
|
|
|||||||||
|
Get the Moving Image. |
|
|||||||||
|
|
|
|
|||||||||
|
Run-time type information (and related methods). Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. |
|
|||||||||
|
|
|
||||||||||
|
Return the number of parameters required by the Transform Implements itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 197 of file itkImageToImageMetric.h. |
|
|||||||||
|
Get the number of pixels considered in the computation. |
|
|||||||||
|
|
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
|||||||||
|
Get a pointer to the Transform. |
|
|||||||||
|
|
|
||||||||||
|
Get the value. Implements itk::SingleValuedCostFunction. |
|
||||||||||||||||||||
|
Get the value and derivatives for single valued optimizers. Reimplemented from itk::SingleValuedCostFunction. |
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Return true if an observer is registered for this event. |
|
||||||||||
|
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 >. |
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
||||||||||||||||||||
|
Reimplemented in itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >. |
|
||||||||||||||||||||
|
|
|
||||||||||||||||||||
|
The moving image dimension. |
|
|
|||||||||
|
Method for creation through the object factory. Reimplemented from itk::Object. |
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
||||||||||||||||
|
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 >. |
|
||||||||||||
|
|
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
||||||||||
|
|
|
|||||||||
|
|
|
|
Remove all observers . |
|
|
Remove the observer with this tag value. |
|
||||||||||
|
Uniformly select a sample set from the fixed image domain. |
|
||||||||||
|
Gather all the pixels from the fixed image domain. |
|
||||||||||
|
|
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
||||||||||
|
Connect the Fixed Image. |
|
||||||||||
|
|
|
||||||||||
|
Set the region over which the metric will be computed |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
||||||||||
|
Connect the Interpolator. |
|
|
|
|
||||||||||
|
Connect the Moving Image. |
|
||||||||||
|
|
|
||||||||||
|
|
|
||||||||||
|
|
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
||||||||||
|
Connect the Transform. |
|
||||||||||
|
Set the parameters defining the Transform. |
|
||||||||||||||||||||||||||||
|
Transform a point from FixedImage domain to MovingImage domain. This function also checks if mapped point is within support region. |
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|||||||||
|
|
|
|||||||||
|
|
|
|
|
|
|
Definition at line 94 of file itkObject.h. |
|
|||||
|
FixedImageSpatialSample typedef support. Definition at line 230 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Definition at line 217 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 211 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 220 of file itkImageToImageMetric.h. |
|
|||||
|
Container to store a set of points and fixed image values. Definition at line 233 of file itkMattesMutualInformationImageToImageMetric.h. |
|
|||||
|
Definition at line 218 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 215 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 212 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 221 of file itkImageToImageMetric.h. |
|
|||||
|
Definition at line 209 of file itkImageToImageMetric.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|||||
|
Definition at line 214 of file itkImageToImageMetric.h. |
|
|
|
|
|||||
1.4.2 written by Dimitri van Heesch,
© 1997-2000