Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference
[Similarity Metrics of Registration Methods]

Computes the mutual information between two images to be registered. More...

#include <itkMutualInformationImageToImageMetric.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >:

Collaboration graph
[legend]

List of all members.

Classes

class  SpatialSample

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Superclass::DerivativeType DerivativeType
typedef
Superclass::FixedImageConstPointer 
FixedImageConstPointer
typedef std::vector
< FixedImageIndexType
FixedImageIndexContainer
typedef FixedImageType::IndexType FixedImageIndexType
typedef
FixedImageIndexType::IndexValueType 
FixedImageIndexValueType
typedef
FixedImageMaskType::ConstPointer 
FixedImageMaskConstPointer
typedef
FixedImageMaskType::ConstPointer 
FixedImageMaskConstPointer
typedef FixedImageMaskType::Pointer FixedImageMaskPointer
typedef FixedImageMaskType::Pointer FixedImageMaskPointer
typedef SpatialObject
< itkGetStaticConstMacro(FixedImageDimension) > 
FixedImageMaskType
typedef SpatialObject
< itkGetStaticConstMacro(FixedImageDimension) > 
FixedImageMaskType
typedef TFixedImage::PixelType FixedImagePixelType
typedef
TransformType::InputPointType 
FixedImagePointType
typedef FixedImageType::RegionType FixedImageRegionType
typedef FixedImageType::RegionType FixedImageRegionType
typedef Superclass::FixedImageType FixedImageType
typedef
TransformType::InputPointType 
InputPointType
typedef
TransformType::InputPointType 
InputPointType
typedef InterpolatorType::Pointer InterpolatorPointer
typedef InterpolatorType::Pointer InterpolatorPointer
typedef
Superclass::InterpolatorType 
InterpolatorType
typedef Superclass::MeasureType MeasureType
typedef
MovingImageType::ConstPointer 
MovingImageConstPointer
typedef
MovingImageType::ConstPointer 
MovingImageConstPointer
typedef
Superclass::MovingImageConstPointer 
MovingImageCosntPointer
typedef MovingImageType::IndexType MovingImageIndexType
typedef
MovingImageMaskType::ConstPointer 
MovingImageMaskConstPointer
typedef
MovingImageMaskType::ConstPointer 
MovingImageMaskConstPointer
typedef
MovingImageMaskType::Pointer 
MovingImageMaskPointer
typedef
MovingImageMaskType::Pointer 
MovingImageMaskPointer
typedef SpatialObject
< itkGetStaticConstMacro(MovingImageDimension) > 
MovingImageMaskType
typedef SpatialObject
< itkGetStaticConstMacro(MovingImageDimension) > 
MovingImageMaskType
typedef TMovingImage::PixelType MovingImagePixelType
typedef TMovingImage::PixelType MovingImagePixelType
typedef
TransformType::OutputPointType 
MovingImagePointType
typedef Superclass::MovingImageType MovingImageType
typedef
TransformType::OutputPointType 
OutputPointType
typedef
TransformType::OutputPointType 
OutputPointType
typedef Superclass::ParametersType ParametersType
typedef double ParametersValueType
typedef SmartPointer< SelfPointer
typedef
MutualInformationImageToImageMetric 
Self
typedef ImageToImageMetric
< TFixedImage, TMovingImage > 
Superclass
typedef
Superclass::TransformJacobianType 
TransformJacobianType
typedef
TransformType::ParametersType 
TransformParametersType
typedef
TransformType::ParametersType 
TransformParametersType
typedef
Superclass::TransformPointer 
TransformPointer
typedef Superclass::TransformType TransformType
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 NumericTraits
< MovingImagePixelType >
::RealType 
RealType
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 NumericTraits
< MovingImagePixelType >
::RealType 
RealType

Public Member Functions

virtual void ComputeGradient (void)
virtual void ComputeGradient ()
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
CommandGetCommand (unsigned long tag)
bool GetDebug () const
void GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const
virtual const FixedImageTypeGetFixedImage ()
virtual const FixedImageTypeGetFixedImage ()
virtual const
FixedImageRegionType
GetFixedImageRegion ()
virtual const
FixedImageRegionType
GetFixedImageRegion ()
virtual const GradientImageTypeGetGradientImage ()
virtual const GradientImageTypeGetGradientImage ()
virtual const InterpolatorTypeGetInterpolator ()
virtual const InterpolatorTypeGetInterpolator ()
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
virtual const MovingImageTypeGetMovingImage ()
virtual const MovingImageTypeGetMovingImage ()
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
unsigned int GetNumberOfParameters (void) const
unsigned int GetNumberOfParameters (void) const
virtual const unsigned long & GetNumberOfPixelsCounted ()
virtual const unsigned int & GetNumberOfSpatialSamples ()
virtual int GetReferenceCount () const
virtual const TransformTypeGetTransform ()
virtual const TransformTypeGetTransform ()
virtual const bool & GetUseFixedImageSamplesIntensityThreshold ()
MeasureType GetValue (const ParametersType &parameters) const
void GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
bool HasObserver (const EventObject &event) const
virtual void Initialize (void) throw ( ExceptionObject )
virtual void Initialize (void) throw ( ExceptionObject )
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
 itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void Modified () const
virtual void MultiThreadingInitialize (void) throw ( ExceptionObject )
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
virtual void SetFixedImage (const FixedImageType *_arg)
virtual void SetFixedImage (const FixedImageType *_arg)
void SetFixedImageRegion (const FixedImageRegionType reg)
virtual void SetFixedImageRegion (FixedImageRegionType _arg)
virtual void SetInterpolator (InterpolatorType *_arg)
virtual void SetInterpolator (InterpolatorType *_arg)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetMovingImage (const MovingImageType *_arg)
virtual void SetMovingImage (const MovingImageType *_arg)
void SetNumberOfSpatialSamples (unsigned int num)
virtual void SetReferenceCount (int)
virtual void SetTransform (TransformType *_arg)
virtual void SetTransform (TransformType *_arg)
void SetTransformParameters (const ParametersType &parameters) const
void SetTransformParameters (const ParametersType &parameters) const
void SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
virtual void UnRegister () const
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
virtual void ComputeGradientOff ()
virtual void ComputeGradientOn ()
virtual const bool & GetComputeGradient ()
virtual void SetComputeGradient (bool _arg)
virtual void ComputeGradientOff ()
virtual void ComputeGradientOn ()
virtual const bool & GetComputeGradient ()
virtual void SetComputeGradient (bool _arg)
virtual const FixedImageMaskTypeGetFixedImageMask ()
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
virtual const FixedImageMaskTypeGetFixedImageMask ()
virtual void SetFixedImageMask (const FixedImageMaskType *mask)
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
virtual const FixedImagePixelTypeGetFixedImageSamplesIntensityThreshold ()
void SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
virtual double GetFixedImageStandardDeviation () const
virtual void SetFixedImageStandardDeviation (double _arg)
virtual KernelFunctionGetKernelFunction ()
virtual void SetKernelFunction (KernelFunction *_arg)
virtual const MovingImageMaskTypeGetMovingImageMask ()
virtual void SetMovingImageMask (const MovingImageMaskType *_arg)
virtual void SetMovingImageMask (MovingImageMaskType *_arg)
virtual const MovingImageMaskTypeGetMovingImageMask ()
virtual void SetMovingImageMask (const MovingImageMaskType *mask)
virtual void SetMovingImageMask (MovingImageMaskType *_arg)
virtual const double & GetMovingImageStandardDeviation ()
virtual void SetMovingImageStandardDeviation (double _arg)
virtual const unsigned long & GetNumberOfFixedImageSamples ()
virtual void SetNumberOfFixedImageSamples (unsigned long numSamples)
unsigned long GetNumberOfMovingImageSamples (void)
virtual const unsigned long & GetNumberOfPixelsCounted ()
virtual const unsigned int & GetNumberOfThreads ()
void SetNumberOfThreads (unsigned int numberOfThreads)
virtual const bool & GetUseAllPixels ()
void SetUseAllPixels (bool useAllPixels)
void UseAllPixelsOff (void)
void UseAllPixelsOn (void)
virtual const bool & GetUseCachingOfBSplineWeights ()
virtual void SetUseCachingOfBSplineWeights (bool _arg)
virtual void UseCachingOfBSplineWeightsOff ()
virtual void UseCachingOfBSplineWeightsOn ()
virtual const bool & GetUseFixedImageIndexes ()
void SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
void SetUseFixedImageIndexes (bool useIndex)
virtual const bool & GetUseSequentialSampling ()
void SetUseSequentialSampling (bool sequentialSampling)
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
 itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
void ReinitializeSeed (int)
void ReinitializeSeed ()
void SetNumberOfSpatialSamples (unsigned long num)

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef std::vector< bool > BooleanArrayType
typedef
BSplineInterpolateImageFunction
< MovingImageType,
CoordinateRepresentationType > 
BSplineInterpolatorType
typedef FixedArray< unsigned
long,::itk::GetImageDimension
< FixedImageType >
::ImageDimension > 
BSplineParametersOffsetType
typedef
BSplineTransformType::ParameterIndexArrayType 
BSplineTransformIndexArrayType
typedef Array2D< IndexValueTypeBSplineTransformIndicesArrayType
typedef
BSplineDeformableTransform
< CoordinateRepresentationType,::itk::GetImageDimension
< FixedImageType >
::ImageDimension,
itkGetStaticConstMacro(DeformationSplineOrder) > 
BSplineTransformType
typedef Array2D< WeightsValueTypeBSplineTransformWeightsArrayType
typedef
BSplineTransformType::WeightsType 
BSplineTransformWeightsType
typedef std::vector
< FixedImageSamplePoint
FixedImageSampleContainer
typedef CovariantVector
< double,
itkGetStaticConstMacro(MovingImageDimension) > 
ImageDerivativesType
typedef
BSplineTransformIndexArrayType::ValueType 
IndexValueType
typedef std::vector
< MovingImagePointType
MovingImagePointArrayType
typedef MultiThreader MultiThreaderType
typedef
BSplineTransformWeightsType::ValueType 
WeightsValueType
typedef int InternalReferenceCountType

Protected Member Functions

virtual void ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, unsigned int threadID) const
void GetValueAndDerivativeMultiThreadedInitiate (void) const
void GetValueAndDerivativeMultiThreadedPostProcessInitiate (void) const
void GetValueAndDerivativeMultiThreadedPreProcessInitiate (void) const
virtual void GetValueAndDerivativeThread (unsigned int threadID) const
virtual void GetValueAndDerivativeThreadPostProcess (unsigned int, bool) const
virtual void GetValueAndDerivativeThreadPreProcess (unsigned int, bool) const
virtual bool GetValueAndDerivativeThreadProcessSample (unsigned int, unsigned long, const MovingImagePointType &, double, const ImageDerivativesType &) const
void GetValueMultiThreadedInitiate (void) const
void GetValueMultiThreadedPostProcessInitiate (void) const
void GetValueMultiThreadedPreProcessInitiate (void) const
virtual void GetValueThread (unsigned int threadID) const
virtual void GetValueThreadPostProcess (unsigned int, bool) const
virtual void GetValueThreadPreProcess (unsigned int, bool) const
virtual bool GetValueThreadProcessSample (unsigned int, unsigned long, const MovingImagePointType &, double) const
 itkStaticConstMacro (DeformationSplineOrder, unsigned int, 3)
 MutualInformationImageToImageMetric ()
virtual void PreComputeTransformValues (void)
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void SampleFixedImageDomain (FixedImageSampleContainer &samples) const
virtual void SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
virtual void SampleFullFixedImageDomain (FixedImageSampleContainer &samples) const
void SynchronizeTransforms () const
virtual void TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, unsigned int threadID) const
virtual void TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, unsigned int threadID) const
virtual ~MutualInformationImageToImageMetric ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Static Protected Member Functions

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

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
FixedImageConstPointer m_FixedImage
FixedImageIndexContainer m_FixedImageIndexes
FixedImageMaskConstPointer m_FixedImageMask
FixedImageMaskPointer m_FixedImageMask
FixedImageSampleContainer m_FixedImageSamples
FixedImagePixelType m_FixedImageSamplesIntensityThreshold
GradientImagePointer m_GradientImage
InterpolatorPointer m_Interpolator
bool m_InterpolatorIsBSpline
MovingImageConstPointer m_MovingImage
MovingImageMaskConstPointer m_MovingImageMask
MovingImageMaskPointer m_MovingImageMask
unsigned long m_NumberOfFixedImageSamples
unsigned long m_NumberOfParameters
unsigned long m_NumberOfPixelsCounted
unsigned int m_NumberOfThreads
unsigned long m_NumBSplineWeights
ParametersType m_Parameters
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
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


Detailed Description

template<class TFixedImage, class 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 KernelFunction 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:
KernelFunction

GaussianKernelFunction

Definition at line 90 of file itkMutualInformationImageToImageMetric.h.


Member Typedef Documentation

typedef std::vector<bool> itk::ImageToImageMetric< TFixedImage , TMovingImage >::BooleanArrayType [protected, inherited]

Definition at line 453 of file itkOptImageToImageMetric.h.

typedef BSplineInterpolateImageFunction<MovingImageType, CoordinateRepresentationType> itk::ImageToImageMetric< TFixedImage , TMovingImage >::BSplineInterpolatorType [protected, inherited]

If a BSplineInterpolationFunction is used, this class obtain image derivatives from the BSpline interpolator. Otherwise, image derivatives are computed using central differencing.

Definition at line 464 of file itkOptImageToImageMetric.h.

typedef FixedArray< unsigned long, ::itk::GetImageDimension<FixedImageType>::ImageDimension > itk::ImageToImageMetric< TFixedImage , TMovingImage >::BSplineParametersOffsetType [protected, inherited]

Definition at line 456 of file itkOptImageToImageMetric.h.

typedef BSplineTransformType::ParameterIndexArrayType itk::ImageToImageMetric< TFixedImage , TMovingImage >::BSplineTransformIndexArrayType [protected, inherited]

typedef Array2D<IndexValueType> itk::ImageToImageMetric< TFixedImage , TMovingImage >::BSplineTransformIndicesArrayType [protected, inherited]

Definition at line 450 of file itkOptImageToImageMetric.h.

typedef BSplineDeformableTransform< CoordinateRepresentationType, ::itk::GetImageDimension<FixedImageType>::ImageDimension, itkGetStaticConstMacro(DeformationSplineOrder) > itk::ImageToImageMetric< TFixedImage , TMovingImage >::BSplineTransformType [protected, inherited]

Definition at line 441 of file itkOptImageToImageMetric.h.

typedef Array2D<WeightsValueType> itk::ImageToImageMetric< TFixedImage , TMovingImage >::BSplineTransformWeightsArrayType [protected, inherited]

Definition at line 445 of file itkOptImageToImageMetric.h.

typedef BSplineTransformType::WeightsType itk::ImageToImageMetric< TFixedImage , TMovingImage >::BSplineTransformWeightsType [protected, inherited]

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

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

Type of the derivative.

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

Definition at line 113 of file itkMutualInformationImageToImageMetric.h.

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

typedef std::vector<FixedImageIndexType> itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageIndexContainer [inherited]

Definition at line 113 of file itkOptImageToImageMetric.h.

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

Index and Point typedef support.

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

Definition at line 121 of file itkMutualInformationImageToImageMetric.h.

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

typedef FixedImageMaskType::ConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageMaskConstPointer [inherited]

Definition at line 145 of file itkOptImageToImageMetric.h.

typedef FixedImageMaskType::ConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageMaskConstPointer [inherited]

Definition at line 137 of file itkImageToImageMetric.h.

typedef FixedImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageMaskPointer [inherited]

Definition at line 144 of file itkOptImageToImageMetric.h.

typedef FixedImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageMaskPointer [inherited]

Definition at line 136 of file itkImageToImageMetric.h.

typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension) > itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageMaskType [inherited]

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 143 of file itkOptImageToImageMetric.h.

typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension) > itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageMaskType [inherited]

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 135 of file itkImageToImageMetric.h.

typedef TFixedImage ::PixelType itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImagePixelType [inherited]

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

typedef FixedImageType::RegionType itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageRegionType [inherited]

typedef FixedImageType::RegionType itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageRegionType [inherited]

typedef std::vector<FixedImageSamplePoint> itk::ImageToImageMetric< TFixedImage , TMovingImage >::FixedImageSampleContainer [protected, inherited]

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

Type of the fixed Image.

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

Definition at line 115 of file itkMutualInformationImageToImageMetric.h.

typedef GradientImageFilterType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientImageFilterPointer [inherited]

Gaussian filter to compute the gradient of the Moving Image

Definition at line 133 of file itkOptImageToImageMetric.h.

typedef GradientImageFilterType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientImageFilterPointer [inherited]

Gaussian filter to compute the gradient of the Moving Image

Definition at line 125 of file itkImageToImageMetric.h.

Gaussian filter to compute the gradient of the Moving Image

Definition at line 132 of file itkOptImageToImageMetric.h.

Gaussian filter to compute the gradient of the Moving Image

Definition at line 124 of file itkImageToImageMetric.h.

typedef SmartPointer<GradientImageType> itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientImagePointer [inherited]

Gaussian filter to compute the gradient of the Moving Image

Definition at line 129 of file itkOptImageToImageMetric.h.

typedef SmartPointer<GradientImageType> itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientImagePointer [inherited]

Gaussian filter to compute the gradient of the Moving Image

Definition at line 121 of file itkImageToImageMetric.h.

typedef Image<GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)> itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientImageType [inherited]

Gaussian filter to compute the gradient of the Moving Image

Reimplemented in itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 128 of file itkOptImageToImageMetric.h.

typedef Image<GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)> itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientImageType [inherited]

Gaussian filter to compute the gradient of the Moving Image

Reimplemented in itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 120 of file itkImageToImageMetric.h.

typedef CovariantVector<RealType, itkGetStaticConstMacro(MovingImageDimension)> itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientPixelType [inherited]

typedef CovariantVector<RealType, itkGetStaticConstMacro(MovingImageDimension)> itk::ImageToImageMetric< TFixedImage , TMovingImage >::GradientPixelType [inherited]

typedef CovariantVector< double, itkGetStaticConstMacro(MovingImageDimension) > itk::ImageToImageMetric< TFixedImage , TMovingImage >::ImageDerivativesType [protected, inherited]

typedef BSplineTransformIndexArrayType::ValueType itk::ImageToImageMetric< TFixedImage , TMovingImage >::IndexValueType [protected, inherited]

typedef TransformType::InputPointType itk::ImageToImageMetric< TFixedImage , TMovingImage >::InputPointType [inherited]

typedef TransformType::InputPointType itk::ImageToImageMetric< TFixedImage , TMovingImage >::InputPointType [inherited]

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef InterpolatorType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::InterpolatorPointer [inherited]

typedef InterpolatorType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::InterpolatorPointer [inherited]

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

Type of the Interpolator Base class

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

Definition at line 111 of file itkMutualInformationImageToImageMetric.h.

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

Type of the measure.

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

Definition at line 112 of file itkMutualInformationImageToImageMetric.h.

typedef MovingImageType::ConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImageConstPointer [inherited]

typedef MovingImageType::ConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImageConstPointer [inherited]

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

Definition at line 118 of file itkMutualInformationImageToImageMetric.h.

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

Definition at line 152 of file itkOptImageToImageMetric.h.

Definition at line 145 of file itkImageToImageMetric.h.

typedef MovingImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImageMaskPointer [inherited]

Definition at line 151 of file itkOptImageToImageMetric.h.

typedef MovingImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImageMaskPointer [inherited]

Definition at line 144 of file itkImageToImageMetric.h.

typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension) > itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImageMaskType [inherited]

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 150 of file itkOptImageToImageMetric.h.

typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension) > itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImageMaskType [inherited]

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 143 of file itkImageToImageMetric.h.

typedef TMovingImage ::PixelType itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImagePixelType [inherited]

typedef TMovingImage ::PixelType itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImagePixelType [inherited]

typedef std::vector<MovingImagePointType> itk::ImageToImageMetric< TFixedImage , TMovingImage >::MovingImagePointArrayType [protected, inherited]

Definition at line 452 of file itkOptImageToImageMetric.h.

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

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

Type of the moving Image.

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

Definition at line 116 of file itkMutualInformationImageToImageMetric.h.

typedef MultiThreader itk::ImageToImageMetric< TFixedImage , TMovingImage >::MultiThreaderType [protected, inherited]

Types and variables related to multi-threading

Definition at line 528 of file itkOptImageToImageMetric.h.

typedef TransformType::OutputPointType itk::ImageToImageMetric< TFixedImage , TMovingImage >::OutputPointType [inherited]

typedef TransformType::OutputPointType itk::ImageToImageMetric< TFixedImage , TMovingImage >::OutputPointType [inherited]

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

Type of the parameters.

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

Definition at line 114 of file itkMutualInformationImageToImageMetric.h.

typedef double itk::CostFunction::ParametersValueType [inherited]

ParametersType typedef. It defines a position in the optimization search space.

Definition at line 46 of file itkCostFunction.h.

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

typedef NumericTraits<MovingImagePixelType>::RealType itk::ImageToImageMetric< TFixedImage , TMovingImage >::RealType [inherited]

typedef NumericTraits<MovingImagePixelType>::RealType itk::ImageToImageMetric< TFixedImage , TMovingImage >::RealType [inherited]

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

Standard class typedefs.

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

Definition at line 96 of file itkMutualInformationImageToImageMetric.h.

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

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

typedef TransformType::ParametersType itk::ImageToImageMetric< TFixedImage , TMovingImage >::TransformParametersType [inherited]

typedef TransformType::ParametersType itk::ImageToImageMetric< TFixedImage , TMovingImage >::TransformParametersType [inherited]

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

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

Types inherited from Superclass.

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

Definition at line 105 of file itkMutualInformationImageToImageMetric.h.

typedef BSplineTransformWeightsType::ValueType itk::ImageToImageMetric< TFixedImage , TMovingImage >::WeightsValueType [protected, inherited]


Constructor & Destructor Documentation

template<class TFixedImage , class TMovingImage >
itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::MutualInformationImageToImageMetric (  )  [protected]

template<class TFixedImage , class TMovingImage >
virtual itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::~MutualInformationImageToImageMetric (  )  [inline, protected, virtual]

Definition at line 193 of file itkMutualInformationImageToImageMetric.h.


Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [inherited]

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) [inherited]

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError (  )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::ComputeGradient ( void   )  [virtual, inherited]

Computes the gradient image and assigns it to m_GradientImage

Reimplemented in itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::ComputeGradient ( void   )  [virtual, inherited]

Computes the gradient image and assigns it to m_GradientImage

Reimplemented in itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::ComputeGradientOff (  )  [virtual, inherited]

Set/Get gradient computation.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::ComputeGradientOff (  )  [virtual, inherited]

Set/Get gradient computation.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::ComputeGradientOn (  )  [virtual, inherited]

Set/Get gradient computation.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::ComputeGradientOn (  )  [virtual, inherited]

Set/Get gradient computation.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::ComputeImageDerivatives ( const MovingImagePointType mappedPoint,
ImageDerivativesType gradient,
unsigned int  threadID 
) const [protected, virtual, inherited]

Compute image derivatives at a point.

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]

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.

virtual void itk::Object::DebugOff (  )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (  )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (  )  [virtual, inherited]

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.

Command* itk::Object::GetCommand ( unsigned long  tag  )  [inherited]

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.

virtual const bool& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetComputeGradient (  )  [virtual, inherited]

Set/Get gradient computation.

virtual const bool& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetComputeGradient (  )  [virtual, inherited]

Set/Get gradient computation.

bool itk::Object::GetDebug (  )  const [inherited]

Get the value of the debug flag.

template<class TFixedImage , class TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const ParametersType parameters,
DerivativeType Derivative 
) const [virtual]

Get the derivatives of the match measure.

Implements itk::SingleValuedCostFunction.

virtual const FixedImageType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetFixedImage (  )  [virtual, inherited]

Get the Fixed Image.

virtual const FixedImageType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetFixedImage (  )  [virtual, inherited]

Get the Fixed Image.

virtual const FixedImageMaskType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetFixedImageMask (  )  [virtual, inherited]

Set/Get the fixed image mask.

virtual const FixedImageMaskType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetFixedImageMask (  )  [virtual, inherited]

Set/Get the fixed image mask.

virtual const FixedImageRegionType& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetFixedImageRegion (  )  [virtual, inherited]

Get the region over which the metric will be computed

virtual const FixedImageRegionType& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetFixedImageRegion (  )  [virtual, inherited]

Get the region over which the metric will be computed

virtual const FixedImagePixelType& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetFixedImageSamplesIntensityThreshold (  )  [virtual, inherited]

Minimum fixed-image intensity needed for a sample to be used in the metric computation

template<class TFixedImage , class 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.

static bool itk::Object::GetGlobalWarningDisplay (  )  [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

virtual const GradientImageType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetGradientImage (  )  [virtual, inherited]

Get Gradient Image.

virtual const GradientImageType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetGradientImage (  )  [virtual, inherited]

Get Gradient Image.

virtual const InterpolatorType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetInterpolator (  )  [virtual, inherited]

Get a pointer to the Interpolator.

virtual const InterpolatorType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetInterpolator (  )  [virtual, inherited]

Get a pointer to the Interpolator.

template<class TFixedImage , class TMovingImage >
virtual KernelFunction* itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetKernelFunction (  )  [virtual]

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

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

virtual const MovingImageType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetMovingImage ( void   )  [virtual, inherited]

Get the Moving Image.

virtual const MovingImageType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetMovingImage ( void   )  [virtual, inherited]

Get the Moving Image.

virtual const MovingImageMaskType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetMovingImageMask (  )  [virtual, inherited]

Set/Get the moving image mask.

virtual const MovingImageMaskType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetMovingImageMask (  )  [virtual, inherited]

Set/Get the moving image mask.

template<class TFixedImage , class TMovingImage >
virtual const double& itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageStandardDeviation (  )  [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.

virtual unsigned long itk::Object::GetMTime (  )  const [virtual, inherited]

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TFixedImage , class TMovingImage >
virtual const char* itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods).

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

virtual const unsigned long& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetNumberOfFixedImageSamples (  )  [virtual, inherited]

Number of spatial samples to used to compute metric This sets the number of samples.

unsigned long itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetNumberOfMovingImageSamples ( void   )  [inline, inherited]

Get the number of pixels considered in the computation.

Definition at line 189 of file itkOptImageToImageMetric.h.

unsigned int itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetNumberOfParameters ( void   )  const [inline, virtual, inherited]

unsigned int itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetNumberOfParameters ( void   )  const [inline, virtual, inherited]

virtual const unsigned long& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetNumberOfPixelsCounted (  )  [virtual, inherited]

Get the number of pixels considered in the computation.

virtual const unsigned long& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetNumberOfPixelsCounted (  )  [virtual, inherited]

Get the number of pixels considered in the computation.

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

Get the number of spatial samples.

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

virtual const unsigned int& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetNumberOfThreads (  )  [virtual, inherited]

Set/Get number of threads to use for computations.

Reimplemented in itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >.

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const TransformType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetTransform (  )  [virtual, inherited]

Get a pointer to the Transform.

virtual const TransformType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetTransform (  )  [virtual, inherited]

Get a pointer to the Transform.

virtual const bool& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetUseAllPixels (  )  [virtual, inherited]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels. This value override IntensityThreshold, Masks, and SequentialSampling.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

virtual const bool& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetUseCachingOfBSplineWeights (  )  [virtual, inherited]

This boolean flag is only relevant when this metric is used along with a BSplineDeformableTransform. The flag enables/disables the caching of values computed when a physical point is mapped through the BSplineDeformableTransform. In particular it will cache the values of the BSpline weights for that points, and the indexes indicating what BSpline-grid nodes are relevant for that specific point. This caching is made optional due to the fact that the memory arrays used for the caching can reach large sizes even for moderate image size problems. For example, for a 3D image of 256^3, using 20% of pixels, these arrays will take about 1 Gigabyte of RAM for storage. The ratio of computing time between using the cache or not using the cache can reach 1:5, meaning that using the caching can provide a five times speed up. It is therefore, interesting to enable the caching, if enough memory is available for it. The caching is enabled by default, in order to preserve backward compatibility with previous versions of ITK.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

virtual const bool& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetUseFixedImageIndexes (  )  [virtual, inherited]

Set the fixed image indexes to be used as the samples when computing the match metric

virtual const bool& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetUseFixedImageSamplesIntensityThreshold (  )  [virtual, inherited]

virtual const bool& itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetUseSequentialSampling (  )  [virtual, inherited]

If set to true, then every pixel in the fixed image will be scanned to determine if it should be used in registration metric computation. A pixel will be chosen if it meets any mask or threshold limits set. If set to false, then UseAllPixels will be set to false.

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

Get the value.

Implements itk::SingleValuedCostFunction.

virtual void itk::SingleValuedCostFunction::GetValueAndDerivative ( const ParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const [inline, virtual, inherited]

This method returns the value and derivative of the cost function corresponding to the specified parameters

Definition at line 71 of file itkSingleValuedCostFunction.h.

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

Get the value and derivatives for single valued optimizers.

static ITK_THREAD_RETURN_TYPE itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeMultiThreaded ( void *  arg  )  [static, protected, inherited]

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeMultiThreadedInitiate ( void   )  const [protected, inherited]

static ITK_THREAD_RETURN_TYPE itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeMultiThreadedPostProcess ( void *  arg  )  [static, protected, inherited]

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeMultiThreadedPostProcessInitiate ( void   )  const [protected, inherited]

static ITK_THREAD_RETURN_TYPE itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeMultiThreadedPreProcess ( void *  arg  )  [static, protected, inherited]

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeMultiThreadedPreProcessInitiate ( void   )  const [protected, inherited]

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeThread ( unsigned int  threadID  )  const [inline, protected, virtual, inherited]

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeThreadPostProcess ( unsigned int  ,
bool   
) const [inline, protected, virtual, inherited]

Definition at line 583 of file itkOptImageToImageMetric.h.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeThreadPreProcess ( unsigned int  ,
bool   
) const [inline, protected, virtual, inherited]

Definition at line 572 of file itkOptImageToImageMetric.h.

virtual bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueAndDerivativeThreadProcessSample ( unsigned int  ,
unsigned long  ,
const MovingImagePointType ,
double  ,
const ImageDerivativesType  
) const [inline, protected, virtual, inherited]

Definition at line 576 of file itkOptImageToImageMetric.h.

static ITK_THREAD_RETURN_TYPE itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueMultiThreaded ( void *  arg  )  [static, protected, inherited]

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueMultiThreadedInitiate ( void   )  const [protected, inherited]

static ITK_THREAD_RETURN_TYPE itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueMultiThreadedPostProcess ( void *  arg  )  [static, protected, inherited]

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueMultiThreadedPostProcessInitiate ( void   )  const [protected, inherited]

static ITK_THREAD_RETURN_TYPE itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueMultiThreadedPreProcess ( void *  arg  )  [static, protected, inherited]

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueMultiThreadedPreProcessInitiate ( void   )  const [protected, inherited]

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueThread ( unsigned int  threadID  )  const [inline, protected, virtual, inherited]

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueThreadPostProcess ( unsigned int  ,
bool   
) const [inline, protected, virtual, inherited]

Definition at line 559 of file itkOptImageToImageMetric.h.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueThreadPreProcess ( unsigned int  ,
bool   
) const [inline, protected, virtual, inherited]

Definition at line 549 of file itkOptImageToImageMetric.h.

virtual bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::GetValueThreadProcessSample ( unsigned int  ,
unsigned long  ,
const MovingImagePointType ,
double   
) const [inline, protected, virtual, inherited]

Definition at line 553 of file itkOptImageToImageMetric.h.

static void itk::Object::GlobalWarningDisplayOff (  )  [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (  )  [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject event  )  const [inherited]

Return true if an observer is registered for this event.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::Initialize ( void   )  throw ( ExceptionObject ) [virtual, inherited]

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::Initialize ( void   )  throw ( ExceptionObject ) [virtual, inherited]

void itk::Object::InvokeEvent ( const EventObject  )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject  )  [inherited]

Call Execute on all the Commands observing this event id.

itk::ImageToImageMetric< TFixedImage , TMovingImage >::itkStaticConstMacro ( DeformationSplineOrder  ,
unsigned  int,
 
) [protected, inherited]

itk::ImageToImageMetric< TFixedImage , TMovingImage >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned  int,
TFixedImage ::ImageDimension   
) [inherited]

Constants for the image dimensions

Reimplemented in itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >.

itk::ImageToImageMetric< TFixedImage , TMovingImage >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned  int,
TMovingImage ::ImageDimension   
) [inherited]

Constants for the image dimensions

template<class TFixedImage , class TMovingImage >
itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned  int,
MovingImageType::ImageDimension   
)

Enum of the moving image dimension.

virtual void itk::Object::Modified (  )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::MultiThreadingInitialize ( void   )  throw ( ExceptionObject ) [virtual, inherited]

Initialize the components related to supporting multiple threads

template<class TFixedImage , class TMovingImage >
static Pointer itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::PreComputeTransformValues ( void   )  [protected, virtual, inherited]

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const [inherited]

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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.

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]

template<class TFixedImage , class TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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.

virtual void itk::Object::Register (  )  const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

template<class TFixedImage , class TMovingImage >
void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ReinitializeSeed ( int   ) 

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.

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

template<class TFixedImage , class 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.

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

void itk::Object::RemoveAllObservers (  )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SampleFixedImageDomain ( FixedImageSampleContainer &  samples  )  const [protected, virtual, inherited]

Uniformly select a sample set from the fixed image domain.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SampleFixedImageIndexes ( FixedImageSampleContainer &  samples  )  const [protected, virtual, inherited]

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SampleFullFixedImageDomain ( FixedImageSampleContainer &  samples  )  const [protected, virtual, inherited]

Gather all the pixels from the fixed image domain.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetComputeGradient ( bool  _arg  )  [virtual, inherited]

Set/Get gradient computation.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetComputeGradient ( bool  _arg  )  [virtual, inherited]

Set/Get gradient computation.

void itk::Object::SetDebug ( bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImage ( const FixedImageType *  _arg  )  [virtual, inherited]

Connect the Fixed Image.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImage ( const FixedImageType *  _arg  )  [virtual, inherited]

Connect the Fixed Image.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageIndexes ( const FixedImageIndexContainer &  indexes  )  [inherited]

Set the fixed image indexes to be used as the samples when computing the match metric

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageMask ( const FixedImageMaskType _arg  )  [virtual, inherited]

Set/Get the fixed image mask.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageMask ( FixedImageMaskType _arg  )  [virtual, inherited]

Set/Get the fixed image mask.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageMask ( const FixedImageMaskType mask  )  [inline, virtual, inherited]

Set/Get the fixed image mask.

Definition at line 206 of file itkImageToImageMetric.h.

References itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageMask().

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageMask ( FixedImageMaskType _arg  )  [virtual, inherited]

Set/Get the fixed image mask.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageRegion ( const FixedImageRegionType  reg  )  [inherited]

Set the region over which the metric will be computed

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageRegion ( FixedImageRegionType  _arg  )  [virtual, inherited]

Set the region over which the metric will be computed

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetFixedImageSamplesIntensityThreshold ( const FixedImagePixelType &  thresh  )  [inherited]

Minimum fixed-image intensity needed for a sample to be used in the metric computation

template<class TFixedImage , class 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.

static void itk::Object::SetGlobalWarningDisplay ( bool  flag  )  [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetInterpolator ( InterpolatorType _arg  )  [virtual, inherited]

Connect the Interpolator.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetInterpolator ( InterpolatorType _arg  )  [virtual, inherited]

Connect the Interpolator.

template<class TFixedImage , class TMovingImage >
virtual void itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >::SetKernelFunction ( KernelFunction _arg  )  [virtual]

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs  )  [inherited]

Returns:
Set the MetaDataDictionary

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetMovingImage ( const MovingImageType *  _arg  )  [virtual, inherited]

Connect the Moving Image.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetMovingImage ( const MovingImageType *  _arg  )  [virtual, inherited]

Connect the Moving Image.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetMovingImageMask ( const MovingImageMaskType _arg  )  [virtual, inherited]

Set/Get the moving image mask.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetMovingImageMask ( MovingImageMaskType _arg  )  [virtual, inherited]

Set/Get the moving image mask.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetMovingImageMask ( const MovingImageMaskType mask  )  [inline, virtual, inherited]

Set/Get the moving image mask.

Definition at line 195 of file itkImageToImageMetric.h.

References itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageMask().

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetMovingImageMask ( MovingImageMaskType _arg  )  [virtual, inherited]

Set/Get the moving image mask.

template<class TFixedImage , class 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.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetNumberOfFixedImageSamples ( unsigned long  numSamples  )  [virtual, inherited]

Number of spatial samples to used to compute metric This sets the number of samples.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetNumberOfSpatialSamples ( unsigned long  num  )  [inline, inherited]

Number of spatial samples to used to compute metric This sets the number of samples.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 262 of file itkOptImageToImageMetric.h.

template<class TFixedImage , class 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.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetNumberOfThreads ( unsigned int  numberOfThreads  )  [inherited]

Set/Get number of threads to use for computations.

virtual void itk::Object::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetTransform ( TransformType _arg  )  [virtual, inherited]

Connect the Transform.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetTransform ( TransformType _arg  )  [virtual, inherited]

Connect the Transform.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetTransformParameters ( const ParametersType parameters  )  const [inherited]

Set the parameters defining the Transform.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetTransformParameters ( const ParametersType parameters  )  const [inherited]

Set the parameters defining the Transform.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetUseAllPixels ( bool  useAllPixels  )  [inherited]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels. This value override IntensityThreshold, Masks, and SequentialSampling.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetUseCachingOfBSplineWeights ( bool  _arg  )  [virtual, inherited]

This boolean flag is only relevant when this metric is used along with a BSplineDeformableTransform. The flag enables/disables the caching of values computed when a physical point is mapped through the BSplineDeformableTransform. In particular it will cache the values of the BSpline weights for that points, and the indexes indicating what BSpline-grid nodes are relevant for that specific point. This caching is made optional due to the fact that the memory arrays used for the caching can reach large sizes even for moderate image size problems. For example, for a 3D image of 256^3, using 20% of pixels, these arrays will take about 1 Gigabyte of RAM for storage. The ratio of computing time between using the cache or not using the cache can reach 1:5, meaning that using the caching can provide a five times speed up. It is therefore, interesting to enable the caching, if enough memory is available for it. The caching is enabled by default, in order to preserve backward compatibility with previous versions of ITK.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetUseFixedImageIndexes ( bool  useIndex  )  [inherited]

Set the fixed image indexes to be used as the samples when computing the match metric

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetUseFixedImageSamplesIntensityThreshold ( bool  useThresh  )  [inherited]

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SetUseSequentialSampling ( bool  sequentialSampling  )  [inherited]

If set to true, then every pixel in the fixed image will be scanned to determine if it should be used in registration metric computation. A pixel will be chosen if it meets any mask or threshold limits set. If set to false, then UseAllPixels will be set to false.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::SynchronizeTransforms (  )  const [protected, inherited]

Synchronizes the threader transforms with the transform member variable.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::TransformPoint ( unsigned int  sampleNumber,
MovingImagePointType mappedPoint,
bool &  sampleWithinSupportRegion,
double &  movingImageValue,
unsigned int  threadID 
) const [protected, virtual, inherited]

Transform a point from FixedImage domain to MovingImage domain. This function also checks if mapped point is within support region.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::TransformPointWithDerivatives ( unsigned int  sampleNumber,
MovingImagePointType mappedPoint,
bool &  sampleWithinSupportRegion,
double &  movingImageValue,
ImageDerivativesType gradient,
unsigned int  threadID 
) const [protected, virtual, inherited]

virtual void itk::Object::UnRegister (  )  const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::UseAllPixelsOff ( void   )  [inline, inherited]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels. This value override IntensityThreshold, Masks, and SequentialSampling.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 289 of file itkOptImageToImageMetric.h.

void itk::ImageToImageMetric< TFixedImage , TMovingImage >::UseAllPixelsOn ( void   )  [inline, inherited]

Select whether the metric will be computed using all the pixels on the fixed image region, or only using a set of randomly selected pixels. This value override IntensityThreshold, Masks, and SequentialSampling.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 285 of file itkOptImageToImageMetric.h.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::UseCachingOfBSplineWeightsOff (  )  [virtual, inherited]

This boolean flag is only relevant when this metric is used along with a BSplineDeformableTransform. The flag enables/disables the caching of values computed when a physical point is mapped through the BSplineDeformableTransform. In particular it will cache the values of the BSpline weights for that points, and the indexes indicating what BSpline-grid nodes are relevant for that specific point. This caching is made optional due to the fact that the memory arrays used for the caching can reach large sizes even for moderate image size problems. For example, for a 3D image of 256^3, using 20% of pixels, these arrays will take about 1 Gigabyte of RAM for storage. The ratio of computing time between using the cache or not using the cache can reach 1:5, meaning that using the caching can provide a five times speed up. It is therefore, interesting to enable the caching, if enough memory is available for it. The caching is enabled by default, in order to preserve backward compatibility with previous versions of ITK.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

virtual void itk::ImageToImageMetric< TFixedImage , TMovingImage >::UseCachingOfBSplineWeightsOn (  )  [virtual, inherited]

This boolean flag is only relevant when this metric is used along with a BSplineDeformableTransform. The flag enables/disables the caching of values computed when a physical point is mapped through the BSplineDeformableTransform. In particular it will cache the values of the BSpline weights for that points, and the indexes indicating what BSpline-grid nodes are relevant for that specific point. This caching is made optional due to the fact that the memory arrays used for the caching can reach large sizes even for moderate image size problems. For example, for a 3D image of 256^3, using 20% of pixels, these arrays will take about 1 Gigabyte of RAM for storage. The ratio of computing time between using the cache or not using the cache can reach 1:5, meaning that using the caching can provide a five times speed up. It is therefore, interesting to enable the caching, if enough memory is available for it. The caching is enabled by default, in order to preserve backward compatibility with previous versions of ITK.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.


Member Data Documentation

BSplineInterpolatorType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplineInterpolator [protected, inherited]

Pointer to BSplineInterpolator.

Definition at line 513 of file itkOptImageToImageMetric.h.

BSplineParametersOffsetType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplineParametersOffset [protected, inherited]

Definition at line 482 of file itkOptImageToImageMetric.h.

MovingImagePointArrayType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplinePreTransformPointsArray [protected, inherited]

Definition at line 479 of file itkOptImageToImageMetric.h.

BSplineTransformType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplineTransform [protected, inherited]

Definition at line 475 of file itkOptImageToImageMetric.h.

BSplineTransformIndexArrayType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplineTransformIndices [mutable, protected, inherited]

Definition at line 487 of file itkOptImageToImageMetric.h.

BSplineTransformIndicesArrayType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplineTransformIndicesArray [protected, inherited]

Definition at line 478 of file itkOptImageToImageMetric.h.

BSplineTransformWeightsType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplineTransformWeights [mutable, protected, inherited]

Definition at line 486 of file itkOptImageToImageMetric.h.

BSplineTransformWeightsArrayType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_BSplineTransformWeightsArray [protected, inherited]

Definition at line 477 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_ComputeGradient [protected, inherited]

Definition at line 248 of file itkImageToImageMetric.h.

FixedImageConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_FixedImage [protected, inherited]

Definition at line 242 of file itkImageToImageMetric.h.

FixedImageIndexContainer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_FixedImageIndexes [protected, inherited]

Definition at line 367 of file itkOptImageToImageMetric.h.

FixedImageMaskConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_FixedImageMask [protected, inherited]

Definition at line 412 of file itkOptImageToImageMetric.h.

FixedImageMaskPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_FixedImageMask [mutable, protected, inherited]

Definition at line 255 of file itkImageToImageMetric.h.

FixedImageSampleContainer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_FixedImageSamples [protected, inherited]

Container to store a set of points and fixed image values.

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 386 of file itkOptImageToImageMetric.h.

FixedImagePixelType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_FixedImageSamplesIntensityThreshold [protected, inherited]

Definition at line 370 of file itkOptImageToImageMetric.h.

GradientImagePointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_GradientImage [protected, inherited]

Definition at line 249 of file itkImageToImageMetric.h.

InterpolatorPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_Interpolator [protected, inherited]

Definition at line 246 of file itkImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_InterpolatorIsBSpline [protected, inherited]

Boolean to indicate if the interpolator BSpline.

Definition at line 510 of file itkOptImageToImageMetric.h.

MovingImageConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_MovingImage [protected, inherited]

Definition at line 243 of file itkImageToImageMetric.h.

MovingImageMaskConstPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_MovingImageMask [protected, inherited]

Definition at line 413 of file itkOptImageToImageMetric.h.

MovingImageMaskPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_MovingImageMask [mutable, protected, inherited]

Definition at line 256 of file itkImageToImageMetric.h.

unsigned long itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_NumberOfFixedImageSamples [protected, inherited]

Definition at line 391 of file itkOptImageToImageMetric.h.

unsigned long itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_NumberOfParameters [protected, inherited]

Definition at line 388 of file itkOptImageToImageMetric.h.

unsigned long itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_NumberOfPixelsCounted [mutable, protected, inherited]

Definition at line 240 of file itkImageToImageMetric.h.

unsigned int itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_NumberOfThreads [protected, inherited]

Definition at line 415 of file itkOptImageToImageMetric.h.

unsigned long itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_NumBSplineWeights [protected, inherited]

The number of BSpline transform weights is the number of of parameter in the support region (per dimension ).

Definition at line 435 of file itkOptImageToImageMetric.h.

ParametersType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_Parameters [mutable, protected, inherited]

Definition at line 389 of file itkOptImageToImageMetric.h.

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

MultiThreaderType::Pointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_Threader [protected, inherited]

Definition at line 535 of file itkOptImageToImageMetric.h.

BSplineTransformIndexArrayType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_ThreaderBSplineTransformIndices [mutable, protected, inherited]

Definition at line 490 of file itkOptImageToImageMetric.h.

BSplineTransformWeightsType* itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_ThreaderBSplineTransformWeights [mutable, protected, inherited]

Definition at line 489 of file itkOptImageToImageMetric.h.

unsigned int* itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_ThreaderNumberOfMovingImageSamples [mutable, protected, inherited]

Definition at line 537 of file itkOptImageToImageMetric.h.

MultiThreaderParameterType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_ThreaderParameter [protected, inherited]

Definition at line 536 of file itkOptImageToImageMetric.h.

TransformPointer* itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_ThreaderTransform [protected, inherited]

Copies of Transform helpers per thread (N-1 of them, since m_Transform will do the work for thread=0.

Definition at line 405 of file itkOptImageToImageMetric.h.

TransformPointer itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_Transform [mutable, protected, inherited]

Main transform to be used in thread = 0

Definition at line 245 of file itkImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_TransformIsBSpline [protected, inherited]

Types and variables related to BSpline deformable transforms. If the transform is of type third order BSplineDeformableTransform, then we can speed up the metric derivative calculation by only inspecting the parameters within the support region of a mapped point. Boolean to indicate if the transform is BSpline deformable.

Definition at line 431 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_UseAllPixels [protected, inherited]

Definition at line 417 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_UseCachingOfBSplineWeights [protected, inherited]

Definition at line 485 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_UseFixedImageIndexes [protected, inherited]

Definition at line 366 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_UseFixedImageSamplesIntensityThreshold [protected, inherited]

Definition at line 369 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_UseSequentialSampling [protected, inherited]

Definition at line 418 of file itkOptImageToImageMetric.h.

BooleanArrayType itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_WithinBSplineSupportRegionArray [protected, inherited]

Definition at line 480 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_WithinThreadPostProcess [protected, inherited]

Definition at line 539 of file itkOptImageToImageMetric.h.

bool itk::ImageToImageMetric< TFixedImage , TMovingImage >::m_WithinThreadPreProcess [protected, inherited]

Definition at line 538 of file itkOptImageToImageMetric.h.


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

Generated at Tue Sep 15 11:08:29 2009 for ITK by doxygen 1.5.8 written by Dimitri van Heesch, © 1997-2000