#include <itkVariationalRegistrationFastNCCFunction.h>

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

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

Detailed Description

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

This class computes NCC forces in the variational registration framework.

This class implements NCC forces as given in Hermosillo, Chefd'Hotel, and Faugeras. "Variational methods for multimodal image matching." IJCV 50(3), 2002: 329-343 and Avants et al. "Symmetric diffeomorphic image registration with cross-correlation: evaluating automated labeling of elderly and neurodegenerative brain." Medical image analysis 12(1), 2008: 26-41 (except Jacobian term). We define the derivative of NCC between two images as:

$f^{NCC}(x)=\tau\kappa\frac{2\sum_w (F-\bar{F})(M-\bar{M})}{\sum_w (F-\bar{F})^2\ \sum_w (M-\bar{M})^2}\left((M-\bar{M}) - \frac{\sum_w (F-\bar{F})(M-\bar{M})}{\sum_w (F-\bar{F})^2}(F-\bar{F})\right) \nabla M(x+u(x))$

$\tau$ is the step size and $\kappa$ is the mean squared spacing. Use SetRadius() (see FiniteDifferenceFunction) to set the size of the neighbourhood to compute local mean values $\bar{F}$ and $\bar{M}$ and the local sums. 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 64 of file itkVariationalRegistrationFastNCCFunction.h.

Classes
struct	NCCGlobalDataStruct

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 Superclass::GradientCalculatorType	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 VariationalRegistrationFastNCCFunction	Self

typedef FixedImageType::SizeType	SizeType

typedef FixedImageType::SpacingType	SpacingType

typedef VariationalRegistrationNCCFunction < TFixedImage, TMovingImage, TDisplacementField >	Superclass

Public Types inherited from itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
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 VariationalRegistrationNCCFunction	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 PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override

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

virtual void *	GetGlobalDataPointer () const override

virtual const char *	GetNameOfClass () const

virtual void	ReleaseGlobalDataPointer (void *GlobalData) const override

Public Member Functions inherited from itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
virtual Superclass::TimeStepType	ComputeGlobalTimeStep (void *) const override

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

virtual void	InitializeIteration () override

virtual void	SetGradientTypeToFixedImage ()

virtual void	SetGradientTypeToSymmetric ()

virtual void	SetGradientTypeToWarpedMovingImage ()

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

virtual const FixedImageType *	GetFixedImage (void) 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	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::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
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::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
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

Protected Types inherited from itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
typedef ConstNeighborhoodIterator < FixedImageType >	FixedImageNeighborhoodIteratorType

typedef Superclass::GlobalDataStruct	GlobalDataStruct

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

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

	VariationalRegistrationFastNCCFunction ()

	~VariationalRegistrationFastNCCFunction ()

Protected Member Functions inherited from itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
	VariationalRegistrationNCCFunction ()

	~VariationalRegistrationNCCFunction ()

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 () override

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 &)

	VariationalRegistrationFastNCCFunction (const Self &)

Additional Inherited Members
Protected Attributes inherited from itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
GradientCalculatorPointer	m_FixedImageGradientCalculator

GradientType	m_GradientType

double	m_Normalizer

GradientCalculatorPointer	m_WarpedImageGradientCalculator

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

PixelRealType	m_ScaleCoefficients [ImageDimension]

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