#include <itkGradientDifferenceImageToImageMetric.h>

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

Collaboration diagram for itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >:

Detailed Description

template<class TFixedImage, class TMovingImage>
class itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >

Computes similarity between two objects to be registered.

This Class is templated over the type of the Images to be compared and over the type of transformation and Iterpolator to be used.

This metric computes the sum of squared differences between pixels in the derivatives of the moving and fixed images after passing the squared difference through a function of type $\frac{1}{1+x}$ .

Warning: THIS IMAGE METRIC IS CURRENTLY UNDER DEBUGGING. USE AT YOUR OWN RISK.

Spatial correspondance between both images is established through a Transform. Pixel values are taken from the Moving image. Their positions are mapped to the Fixed image and result in general in non-grid position on it. Values at these non-grid position of the Fixed image are interpolated using a user-selected Interpolator.

Implementation of this class is based on: Hipwell, J. H., et. al. (2003), "Intensity-Based 2-D-3D Registration of Cerebral Angiograms,", IEEE Transactions on Medical Imaging, 22(11):1417-1426.

Definition at line 58 of file itkGradientDifferenceImageToImageMetric.h.

Public Types
typedef CastFixedImageFilterType::Pointer	CastFixedImageFilterPointer

typedef itk::CastImageFilter < FixedImageType, FixedGradientImageType >	CastFixedImageFilterType

typedef CastMovedImageFilterType::Pointer	CastMovedImageFilterPointer

typedef itk::CastImageFilter < TransformedMovingImageType, MovedGradientImageType >	CastMovedImageFilterType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef itk::Image< RealType, itkGetStaticConstMacro(FixedImageDimension) >	FixedGradientImageType

typedef FixedGradientImageType::PixelType	FixedGradientPixelType

typedef Superclass::FixedImageConstPointer	FixedImageConstPointer

typedef TFixedImage::PixelType	FixedImagePixelType

typedef Superclass::FixedImageType	FixedImageType

typedef Superclass::MeasureType	MeasureType

typedef itk::Image< RealType, itkGetStaticConstMacro(MovedImageDimension) >	MovedGradientImageType

typedef MovedGradientImageType::PixelType	MovedGradientPixelType

typedef TMovingImage::PixelType	MovedImagePixelType

typedef Superclass::MovingImageConstPointer	MovingImageConstPointer

typedef Superclass::MovingImageType	MovingImageType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RealType	RealType

typedef GradientDifferenceImageToImageMetric	Self

typedef ImageToImageMetric < TFixedImage, TMovingImage >	Superclass

typedef itk::Image < FixedImagePixelType, itkGetStaticConstMacro(FixedImageDimension) >	TransformedMovingImageType

typedef Superclass::TransformJacobianType	TransformJacobianType

typedef itk::ResampleImageFilter < MovingImageType, TransformedMovingImageType >	TransformMovingImageFilterType

typedef Superclass::TransformParametersType	TransformParametersType

typedef Superclass::TransformPointer	TransformPointer

typedef Superclass::TransformType	TransformType

Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ParametersValueType	CoordinateRepresentationType

typedef Superclass::DerivativeType	DerivativeType

typedef FixedImageType::ConstPointer	FixedImageConstPointer

typedef std::vector < FixedImageIndexType >	FixedImageIndexContainer

typedef FixedImageType::IndexType	FixedImageIndexType

typedef FixedImageIndexType::IndexValueType	FixedImageIndexValueType

typedef FixedImageMaskType::ConstPointer	FixedImageMaskConstPointer

typedef FixedImageMaskType::Pointer	FixedImageMaskPointer

typedef SpatialObject < itkGetStaticConstMacro(FixedImageDimension) >	FixedImageMaskType

typedef TFixedImage::PixelType	FixedImagePixelType

typedef TransformType::InputPointType	FixedImagePointType

typedef FixedImageType::RegionType	FixedImageRegionType

typedef TFixedImage	FixedImageType

typedef TransformType::InputPointType	InputPointType

typedef InterpolatorType::Pointer	InterpolatorPointer

typedef InterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	InterpolatorType

typedef Superclass::MeasureType	MeasureType

typedef MovingImageType::ConstPointer	MovingImageConstPointer

typedef MovingImageType::IndexType	MovingImageIndexType

typedef MovingImageMaskType::ConstPointer	MovingImageMaskConstPointer

typedef MovingImageMaskType::Pointer	MovingImageMaskPointer

typedef SpatialObject < itkGetStaticConstMacro(MovingImageDimension) >	MovingImageMaskType

typedef TMovingImage::PixelType	MovingImagePixelType

typedef TransformType::OutputPointType	MovingImagePointType

typedef TMovingImage	MovingImageType

typedef MultiThreader	MultiThreaderType

typedef TransformType::OutputPointType	OutputPointType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageMetric	Self

typedef SingleValuedCostFunction	Superclass

typedef TransformType::JacobianType	TransformJacobianType

typedef TransformType::ParametersType	TransformParametersType

typedef TransformType::Pointer	TransformPointer

typedef Transform < CoordinateRepresentationType, itkGetStaticConstMacro(MovingImageDimension), itkGetStaticConstMacro(FixedImageDimension) >	TransformType

typedef NumericTraits < MovingImagePixelType > ::RealType	RealType

typedef CovariantVector < RealType, itkGetStaticConstMacro(MovingImageDimension) >	GradientPixelType

typedef Image < GradientPixelType, itkGetStaticConstMacro(MovingImageDimension) >	GradientImageType

typedef SmartPointer < GradientImageType >	GradientImagePointer

typedef GradientRecursiveGaussianImageFilter < MovingImageType, GradientImageType >	GradientImageFilterType

typedef GradientImageFilterType::Pointer	GradientImageFilterPointer

Public Types inherited from itk::SingleValuedCostFunction
typedef SmartPointer< const Self >	ConstPointer

typedef Array < ParametersValueType >	DerivativeType

typedef double	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef SingleValuedCostFunction	Self

typedef CostFunction	Superclass

Public Types inherited from itk::CostFunction
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < ParametersValueType >	ParametersType

typedef double	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef CostFunction	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

void	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const

virtual const char *	GetNameOfClass () const

MeasureType	GetValue (const TransformParametersType &parameters) const

void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &derivative) const

virtual void	Initialize (void) throw ( ExceptionObject )

void	WriteGradientImagesToFiles (void) const


virtual void	SetDerivativeDelta (double _arg)

virtual const double &	GetDerivativeDelta ()

Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeGradient (void)

virtual const FixedImageRegionType &	GetFixedImageRegion ()

virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold ()

virtual const GradientImageType *	GetGradientImage () const

virtual const InterpolatorType *	GetInterpolator () const

virtual GradientImageType *	GetModifiableGradientImage ()

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual TransformType *	GetModifiableTransform ()

SizeValueType	GetNumberOfMovingImageSamples (void)

unsigned int	GetNumberOfParameters (void) const

virtual const SizeValueType &	GetNumberOfPixelsCounted ()

SizeValueType	GetNumberOfSpatialSamples (void)

virtual const TransformType *	GetTransform () const

virtual const bool &	GetUseAllPixels ()

virtual const bool &	GetUseFixedImageIndexes ()

virtual const bool &	GetUseFixedImageSamplesIntensityThreshold ()

virtual const bool &	GetUseSequentialSampling ()

virtual void	MultiThreadingInitialize (void) throw ( ExceptionObject )

void	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)

void	SetFixedImageRegion (const FixedImageRegionType reg)

void	SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)

virtual void	SetInterpolator (InterpolatorType *_arg)

void	SetNumberOfSpatialSamples (SizeValueType num)

virtual void	SetTransform (TransformType *_arg)

void	SetTransformParameters (const ParametersType &parameters) const

void	SetUseAllPixels (bool useAllPixels)

void	SetUseFixedImageIndexes (bool useIndex)

void	SetUseFixedImageSamplesIntensityThreshold (bool useThresh)

void	SetUseSequentialSampling (bool sequentialSampling)

void	UseAllPixelsOff (void)

void	UseAllPixelsOn (void)

virtual void	SetFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetFixedImage () const

virtual void	SetMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetMovingImage () const

virtual void	SetMovingImageMask (MovingImageMaskType *_arg)

virtual void	SetMovingImageMask (const MovingImageMaskType *_arg)

virtual const MovingImageMaskType *	GetMovingImageMask () const

virtual void	SetFixedImageMask (FixedImageMaskType *_arg)

virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)

virtual const FixedImageMaskType *	GetFixedImageMask () const

void	SetNumberOfThreads (ThreadIdType numberOfThreads)

virtual const ThreadIdType &	GetNumberOfThreads ()

virtual void	SetComputeGradient (bool _arg)

virtual const bool &	GetComputeGradient ()

virtual void	ComputeGradientOn ()

virtual void	ComputeGradientOff ()

virtual void	SetNumberOfFixedImageSamples (SizeValueType numSamples)

virtual const SizeValueType &	GetNumberOfFixedImageSamples ()

void	ReinitializeSeed ()

void	ReinitializeSeed (int seed)

virtual void	SetUseCachingOfBSplineWeights (bool _arg)

virtual const bool &	GetUseCachingOfBSplineWeights ()

virtual void	UseCachingOfBSplineWeightsOn ()

virtual void	UseCachingOfBSplineWeightsOff ()

virtual MultiThreaderType *	GetModifiableThreader ()

virtual const MultiThreaderType *	GetThreader () const

const TransformPointer *	GetThreaderTransform ()

Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0

virtual MeasureType	GetValue (const ParametersType &parameters) const =0

virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	FixedImageDimension = TFixedImage::ImageDimension

static const unsigned int	MovedImageDimension = MovingImageType::ImageDimension

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

static const unsigned int	FixedImageDimension = TFixedImage::ImageDimension

Protected Types
typedef NeighborhoodOperatorImageFilter < FixedGradientImageType, FixedGradientImageType >	FixedSobelFilter

typedef NeighborhoodOperatorImageFilter < MovedGradientImageType, MovedGradientImageType >	MovedSobelFilter

Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef std::vector< bool >	BooleanArrayType

typedef BSplineInterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	BSplineInterpolatorType

typedef FixedArray < SizeValueType, FixedImageType::ImageDimension >	BSplineParametersOffsetType

typedef BSplineTransformType::ParameterIndexArrayType	BSplineTransformIndexArrayType

typedef Array2D< IndexValueType >	BSplineTransformIndicesArrayType

typedef BSplineBaseTransform < CoordinateRepresentationType, FixedImageType::ImageDimension, itkGetStaticConstMacro(DeformationSplineOrder) >	BSplineTransformType

typedef Array2D< WeightsValueType >	BSplineTransformWeightsArrayType

typedef BSplineTransformType::WeightsType	BSplineTransformWeightsType

typedef CentralDifferenceImageFunction < MovingImageType, CoordinateRepresentationType >	DerivativeFunctionType

typedef std::vector < FixedImageSamplePoint >	FixedImageSampleContainer

typedef CovariantVector < double, itkGetStaticConstMacro(MovingImageDimension) >	ImageDerivativesType

typedef BSplineTransformIndexArrayType::ValueType	IndexValueType

typedef std::vector < MovingImagePointType >	MovingImagePointArrayType

typedef BSplineTransformWeightsType::ValueType	WeightsValueType

Protected Member Functions
MeasureType	ComputeMeasure (const TransformParametersType &parameters, const double *subtractionFactor) const

void	ComputeMovedGradientRange (void) const

void	ComputeVariance (void) const

	GradientDifferenceImageToImageMetric ()

void	PrintSelf (std::ostream &os, Indent indent) const

virtual	~GradientDifferenceImageToImageMetric ()

Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadID) const

void	GetValueAndDerivativeMultiThreadedInitiate (void) const

void	GetValueAndDerivativeMultiThreadedPostProcessInitiate (void) const

void	GetValueAndDerivativeMultiThreadedPreProcessInitiate (void) const

virtual void	GetValueAndDerivativeThread (ThreadIdType threadID) const

virtual void	GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const

virtual void	GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const

virtual bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const

void	GetValueMultiThreadedInitiate (void) const

void	GetValueMultiThreadedPostProcessInitiate (void) const

void	GetValueMultiThreadedPreProcessInitiate (void) const

virtual void	GetValueThread (ThreadIdType threadID) const

virtual void	GetValueThreadPostProcess (ThreadIdType, bool) const

virtual void	GetValueThreadPreProcess (ThreadIdType, bool) const

virtual bool	GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const

	ImageToImageMetric ()

virtual void	PreComputeTransformValues (void)

void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	SampleFixedImageIndexes (FixedImageSampleContainer &samples) const

virtual void	SampleFixedImageRegion (FixedImageSampleContainer &samples) const

virtual void	SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const

virtual void	SynchronizeTransforms () const

virtual void	TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ThreadIdType threadID) const

virtual void	TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, ThreadIdType threadID) const

virtual	~ImageToImageMetric ()

Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()

virtual	~SingleValuedCostFunction ()

Protected Member Functions inherited from itk::CostFunction
	CostFunction ()

virtual	~CostFunction ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	GradientDifferenceImageToImageMetric (const Self &)

void	operator= (const Self &)

Private Attributes
CastFixedImageFilterPointer	m_CastFixedImageFilter

CastMovedImageFilterPointer	m_CastMovedImageFilter

double	m_DerivativeDelta

ZeroFluxNeumannBoundaryCondition < FixedGradientImageType >	m_FixedBoundCond

FixedSobelFilter::Pointer	m_FixedSobelFilters [itkGetStaticConstMacro(FixedImageDimension)]

SobelOperator < FixedGradientPixelType, itkGetStaticConstMacro(FixedImageDimension) >	m_FixedSobelOperators [FixedImageDimension]

FixedGradientPixelType	m_MaxFixedGradient [FixedImageDimension]

MovedGradientPixelType	m_MaxMovedGradient [MovedImageDimension]

FixedGradientPixelType	m_MinFixedGradient [FixedImageDimension]

MovedGradientPixelType	m_MinMovedGradient [MovedImageDimension]

ZeroFluxNeumannBoundaryCondition < MovedGradientImageType >	m_MovedBoundCond

MovedSobelFilter::Pointer	m_MovedSobelFilters [itkGetStaticConstMacro(MovedImageDimension)]

SobelOperator < MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >	m_MovedSobelOperators [MovedImageDimension]

TransformMovingImageFilterType::Pointer	m_TransformMovingImageFilter

MovedGradientPixelType	m_Variance [FixedImageDimension]

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreaded (void *arg)

static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreadedPostProcess (void *arg)

static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreadedPreProcess (void *arg)

static ITK_THREAD_RETURN_TYPE	GetValueMultiThreaded (void *arg)

static ITK_THREAD_RETURN_TYPE	GetValueMultiThreadedPostProcess (void *arg)

static ITK_THREAD_RETURN_TYPE	GetValueMultiThreadedPreProcess (void *arg)

Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
BSplineInterpolatorType::Pointer	m_BSplineInterpolator

BSplineParametersOffsetType	m_BSplineParametersOffset

MovingImagePointArrayType	m_BSplinePreTransformPointsArray

BSplineTransformType::Pointer	m_BSplineTransform

BSplineTransformIndexArrayType	m_BSplineTransformIndices

BSplineTransformIndicesArrayType	m_BSplineTransformIndicesArray

BSplineTransformWeightsType	m_BSplineTransformWeights

BSplineTransformWeightsArrayType	m_BSplineTransformWeightsArray

bool	m_ComputeGradient

DerivativeFunctionType::Pointer	m_DerivativeCalculator

FixedImageConstPointer	m_FixedImage

FixedImageIndexContainer	m_FixedImageIndexes

FixedImageMaskConstPointer	m_FixedImageMask

FixedImageSampleContainer	m_FixedImageSamples

FixedImagePixelType	m_FixedImageSamplesIntensityThreshold

GradientImagePointer	m_GradientImage

InterpolatorPointer	m_Interpolator

bool	m_InterpolatorIsBSpline

MovingImageConstPointer	m_MovingImage

MovingImageMaskConstPointer	m_MovingImageMask

SizeValueType	m_NumberOfFixedImageSamples

SizeValueType	m_NumberOfParameters

SizeValueType	m_NumberOfPixelsCounted

ThreadIdType	m_NumberOfThreads

SizeValueType	m_NumBSplineWeights

int	m_RandomSeed

bool	m_ReseedIterator

MultiThreaderType::Pointer	m_Threader

BSplineTransformIndexArrayType *	m_ThreaderBSplineTransformIndices

BSplineTransformWeightsType *	m_ThreaderBSplineTransformWeights

unsigned int *	m_ThreaderNumberOfMovingImageSamples

MultiThreaderParameterType	m_ThreaderParameter

TransformPointer *	m_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

Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int	DeformationSplineOrder = 3