#include <itkVariationalRegistrationSSDFunction.h>

Inheritance diagram for itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >:

Collaboration diagram for itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >:

Detailed Description

template<class TFixedImage, class TMovingImage, class TDisplacementField>
class itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >

This class computes SSD forces in the variational registration framework.

This class implements SSD forces given by

$f^{SSD}(x)=\tau\kappa(F(x)-M(x+u(x)))\nabla M(x+u(x))$

$\tau$ is the step size and $\kappa$ is the mean squared spacing. Alternative, the classical gradient $\nabla M(x+u(x))$ can be replaced by $\nabla F(x)$ or $\frac{\nabla F(x) + \nabla M(x+u(x))}{2}$ .

See Also: VariationalRegistrationFilter; VariationalRegistrationFunction

Note: This class was developed with funding from the German Research Foundation (DFG: EH 224/3-1 and HA 235/9-1).

Author: Alexander Schmidt-Richberg; Rene Werner; Jan Ehrhardt

Definition at line 52 of file itkVariationalRegistrationSSDFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DisplacementFieldType	DisplacementFieldType

typedef Superclass::DisplacementFieldTypePointer	DisplacementFieldTypePointer

typedef Superclass::FixedImagePointer	FixedImagePointer

typedef Superclass::FixedImageType	FixedImageType

typedef Superclass::FloatOffsetType	FloatOffsetType

typedef GradientCalculatorType::Pointer	GradientCalculatorPointer

typedef CentralDifferenceImageFunction < FixedImageType >	GradientCalculatorType

typedef FixedImageType::IndexType	IndexType

typedef Superclass::MaskImagePointer	MaskImagePointer

typedef Superclass::MaskImageType	MaskImageType

typedef Superclass::MovingImagePointer	MovingImagePointer

typedef Superclass::MovingImageType	MovingImageType

typedef Superclass::NeighborhoodType	NeighborhoodType

typedef Superclass::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RadiusType	RadiusType

typedef VariationalRegistrationSSDFunction	Self

typedef FixedImageType::SizeType	SizeType

typedef FixedImageType::SpacingType	SpacingType

typedef VariationalRegistrationFunction < TFixedImage, TMovingImage, TDisplacementField >	Superclass

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

typedef TDisplacementField	DisplacementFieldType

typedef DisplacementFieldType::ConstPointer	DisplacementFieldTypePointer

typedef FixedImageType::ConstPointer	FixedImagePointer

typedef TFixedImage	FixedImageType

typedef unsigned char	MaskImagePixelType

typedef MaskImageType::ConstPointer	MaskImagePointer

typedef Image < MaskImagePixelType, ImageDimension >	MaskImageType

typedef MovingImageType::ConstPointer	MovingImagePointer

typedef TMovingImage	MovingImageType

typedef MovingImageWarperType::Pointer	MovingImageWarperPointer

typedef itk::ContinuousBorderWarpImageFilter < FixedImageType, WarpedImageType, DisplacementFieldType >	MovingImageWarperType

typedef SmartPointer< Self >	Pointer

typedef VariationalRegistrationFunction	Self

typedef FiniteDifferenceFunction < TDisplacementField >	Superclass

typedef Superclass::TimeStepType	TimeStepType

typedef WarpedImageType::ConstPointer	WarpedImagePointer

typedef TFixedImage	WarpedImageType

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

typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType

typedef Vector< float, itkGetStaticConstMacro(ImageDimension) >	FloatOffsetType

typedef TDisplacementField	ImageType

typedef Vector< PixelRealType, itkGetStaticConstMacro(ImageDimension) >	NeighborhoodScalesType

typedef ConstNeighborhoodIterator < TDisplacementField, DefaultBoundaryConditionType >	NeighborhoodType

typedef double	PixelRealType

typedef ImageType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef ConstNeighborhoodIterator < TDisplacementField > ::RadiusType	RadiusType

typedef FiniteDifferenceFunction	Self

typedef LightObject	Superclass

typedef double	TimeStepType

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual Superclass::TimeStepType	ComputeGlobalTimeStep (void *gd) const

virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual double	GetIntensityDifferenceThreshold () const

virtual const char *	GetNameOfClass () const

virtual void	InitializeIteration ()

virtual void	SetGradientTypeToFixedImage ()

virtual void	SetGradientTypeToSymmetric ()

virtual void	SetGradientTypeToWarpedMovingImage ()

virtual void	SetIntensityDifferenceThreshold (const double threshold)

Public Member Functions inherited from itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
virtual const DisplacementFieldType *	GetDisplacementField (void) const

virtual const FixedImageType *	GetFixedImage (void) const

virtual void *	GetGlobalDataPointer () const

virtual MaskImagePixelType	GetMaskBackgroundThreshold (void) const

virtual const MaskImageType *	GetMaskImage (void) const

virtual double	GetMetric () const

virtual const MovingImageType *	GetMovingImage (void) const

virtual const MovingImageWarperType *	GetMovingImageWarper (void) const

virtual double	GetRMSChange () const

virtual const TimeStepType	GetTimeStep (void) const

virtual void	ReleaseGlobalDataPointer (void *GlobalData) const

virtual void	SetDisplacementField (DisplacementFieldType *ptr)

virtual void	SetFixedImage (const FixedImageType *ptr)

virtual void	SetMaskBackgroundThreshold (MaskImagePixelType threshold)

virtual void	SetMaskImage (const MaskImageType *ptr)

virtual void	SetMovingImage (const MovingImageType *ptr)

virtual void	SetMovingImageWarper (MovingImageWarperType *ptr)

virtual void	SetTimeStep (TimeStepType timeStep)

Public Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
const NeighborhoodScalesType	ComputeNeighborhoodScales () const

const RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

void	SetRadius (const RadiusType &r)

void	SetScaleCoefficients (PixelRealType vals[ImageDimension])

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
static const unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
static const unsigned int	ImageDimension

Protected Types
typedef Superclass::GlobalDataStruct	GlobalDataStruct

enum	GradientType { GRADIENT_TYPE_WARPED = 0, GRADIENT_TYPE_FIXED = 1, GRADIENT_TYPE_SYMMETRIC = 2 }

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

	VariationalRegistrationSSDFunction ()

	~VariationalRegistrationSSDFunction ()

Protected Member Functions inherited from itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
virtual const WarpedImagePointer	GetWarpedImage (void) const

	VariationalRegistrationFunction ()

virtual void	WarpMovingImage (void)

	~VariationalRegistrationFunction ()

Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
	FiniteDifferenceFunction ()

	~FiniteDifferenceFunction ()

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
void	operator= (const Self &)

	VariationalRegistrationSSDFunction (const Self &)

Private Attributes
GradientCalculatorPointer	m_FixedImageGradientCalculator

GradientType	m_GradientType

double	m_IntensityDifferenceThreshold

double	m_Normalizer

GradientCalculatorPointer	m_WarpedImageGradientCalculator

PixelType	m_ZeroUpdateReturn

Additional Inherited Members
Protected Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
RadiusType	m_Radius

PixelRealType	m_ScaleCoefficients [ImageDimension]

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef SmartPointer< const Self > itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer

Definition at line 61 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::DisplacementFieldType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType

Deformation field type.

Definition at line 90 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::DisplacementFieldTypePointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldTypePointer

Definition at line 92 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::FixedImagePointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer

Definition at line 78 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::FixedImageType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType

FixedImage image type.

Definition at line 77 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::FloatOffsetType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::FloatOffsetType

Definition at line 98 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::GlobalDataStruct itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::GlobalDataStruct

protected

Definition at line 151 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef GradientCalculatorType::Pointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorPointer

Definition at line 103 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef CentralDifferenceImageFunction<FixedImageType> itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorType

Image gradient calculator type.

Definition at line 102 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef FixedImageType::IndexType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::IndexType

Image parameter types.

Definition at line 85 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::MaskImagePointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::MaskImagePointer

Definition at line 82 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::MaskImageType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::MaskImageType

MaskImage image type.

Definition at line 81 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::MovingImagePointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer

Definition at line 74 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::MovingImageType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType

MovingImage image type.

Definition at line 73 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::NeighborhoodType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::NeighborhoodType

Definition at line 97 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::PixelType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::PixelType

Various type definitions.

Definition at line 95 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef SmartPointer< Self > itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::Pointer

Definition at line 60 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef Superclass::RadiusType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::RadiusType

Definition at line 96 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef VariationalRegistrationSSDFunction itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::Self

Standard class typedefs.

Definition at line 57 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef FixedImageType::SizeType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::SizeType

Definition at line 86 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef FixedImageType::SpacingType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::SpacingType

Definition at line 87 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

typedef VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass

Definition at line 59 of file itkVariationalRegistrationSSDFunction.h.

Member Enumeration Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >

enum itk::VariationalRegistrationSSDFunction::GradientType

protected

Type of available image forces

Enumerator
GRADIENT_TYPE_WARPED
GRADIENT_TYPE_FIXED
GRADIENT_TYPE_SYMMETRIC

Definition at line 157 of file itkVariationalRegistrationSSDFunction.h.

Constructor & Destructor Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >

itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::VariationalRegistrationSSDFunction ( )

protected

template<class TFixedImage , class TMovingImage , class TDisplacementField >

itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::~VariationalRegistrationSSDFunction ( )

inlineprotected

Definition at line 149 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::VariationalRegistrationSSDFunction ( const Self & )

private

Member Function Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual Superclass::TimeStepType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep ( void * gd ) const

virtual

Computes the time step for an update. Returns the constant time step scaled with the mean squared spacing.

See Also: SetTimeStep()

Reimplemented from itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual PixelType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeUpdate	(	const NeighborhoodType &	neighborhood,
		void *	globalData,
		const FloatOffsetType &	offset = `FloatOffsetType(0.0)`
	)

virtual

This method is called by a finite difference solver image filter at each pixel that does not lie on a data set boundary

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual::itk::LightObject::Pointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual double itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::GetIntensityDifferenceThreshold ( ) const

inlinevirtual

Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector.

Definition at line 139 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual const char* itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual void itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::InitializeIteration ( )

virtual

Set the object's state before each iteration.

Reimplemented from itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

static Pointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::New ( )

static

Method for creation through the object factory.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

void itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::operator= ( const Self & )

private

template<class TFixedImage , class TMovingImage , class TDisplacementField >

void itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

Print information about the filter.

Reimplemented from itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual void itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientTypeToFixedImage ( )

inlinevirtual

Select that the fixed image gradient is used for computing the forces.

Definition at line 116 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual void itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientTypeToSymmetric ( )

inlinevirtual

Select that fixed and warped image gradients are used for computing the forces.

Definition at line 125 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual void itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientTypeToWarpedMovingImage ( )

inlinevirtual

Select that the warped image gradient is used for computing the forces.

Definition at line 120 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

virtual void itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::SetIntensityDifferenceThreshold ( const double threshold )

inlinevirtual

Set the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.

Definition at line 132 of file itkVariationalRegistrationSSDFunction.h.

Member Data Documentation

template<class TFixedImage , class TMovingImage , class TDisplacementField >

const unsigned int itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::ImageDimension = Superclass::ImageDimension

static

Get image dimension.

Definition at line 70 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

GradientCalculatorPointer itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageGradientCalculator

private

Function to compute derivatives of the fixed image.

Definition at line 168 of file itkVariationalRegistrationSSDFunction.h.

template<class TFixedImage , class TMovingImage , class TDisplacementField >

GradientType itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientType

private

Set if warped or fixed image gradient is used for force computation.