#include <itkVariationalRegistrationFastNCCFunction.h>

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

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

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename 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
using	ConstPointer = SmartPointer< const Self >

using	DisplacementFieldType = typename Superclass::DisplacementFieldType

typedef Superclass::DisplacementFieldTypePointer	DisplacementFieldTypePointer

using	FixedImagePointer = typename Superclass::FixedImagePointer

using	FixedImageType = typename Superclass::FixedImageType

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	GradientCalculatorPointer = typename GradientCalculatorType::Pointer

using	GradientCalculatorType = typename Superclass::GradientCalculatorType

using	IndexType = typename FixedImageType::IndexType

using	MaskImagePointer = typename Superclass::MaskImagePointer

using	MaskImageType = typename Superclass::MaskImageType

using	MovingImagePointer = typename Superclass::MovingImagePointer

using	MovingImageType = typename Superclass::MovingImageType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	PixelType = typename Superclass::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	Self = VariationalRegistrationFastNCCFunction

using	SizeType = typename FixedImageType::SizeType

using	SpacingType = typename FixedImageType::SpacingType

using	Superclass = VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >

Public Types inherited from itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	DisplacementFieldType = typename Superclass::DisplacementFieldType

using	DisplacementFieldTypePointer = typename Superclass::DisplacementFieldTypePointer

using	FixedImagePointer = typename Superclass::FixedImagePointer

using	FixedImageType = typename Superclass::FixedImageType

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	GradientCalculatorPointer = typename GradientCalculatorType::Pointer

using	GradientCalculatorType = CentralDifferenceImageFunction< FixedImageType >

using	IndexType = typename FixedImageType::IndexType

using	MaskImagePointer = typename Superclass::MaskImagePointer

using	MaskImageType = typename Superclass::MaskImageType

using	MovingImagePointer = typename Superclass::MovingImagePointer

using	MovingImageType = typename Superclass::MovingImageType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	PixelType = typename Superclass::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	Self = VariationalRegistrationNCCFunction

using	SizeType = typename FixedImageType::SizeType

using	SpacingType = typename FixedImageType::SpacingType

using	Superclass = VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >

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

using	DisplacementFieldType = TDisplacementField

using	DisplacementFieldTypePointer = typename DisplacementFieldType::ConstPointer

using	FixedImagePointer = typename FixedImageType::ConstPointer

using	FixedImageType = TFixedImage

using	MaskImagePixelType = unsigned char

using	MaskImagePointer = typename MaskImageType::ConstPointer

using	MaskImageType = Image< MaskImagePixelType, ImageDimension >

using	MovingImagePointer = typename MovingImageType::ConstPointer

using	MovingImageType = TMovingImage

using	MovingImageWarperPointer = typename MovingImageWarperType::Pointer

using	MovingImageWarperType = itk::ContinuousBorderWarpImageFilter< FixedImageType, WarpedImageType, DisplacementFieldType >

using	Pointer = SmartPointer< Self >

using	Self = VariationalRegistrationFunction

using	Superclass = FiniteDifferenceFunction< TDisplacementField >

using	TimeStepType = typename Superclass::TimeStepType

using	WarpedImagePointer = typename WarpedImageType::ConstPointer

using	WarpedImageType = TFixedImage

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

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >

using	FloatOffsetType = Vector< float, Self::ImageDimension >

using	ImageType = TDisplacementField

using	NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >

using	NeighborhoodType = ConstNeighborhoodIterator< TDisplacementField, DefaultBoundaryConditionType >

using	PixelRealType = double

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename ConstNeighborhoodIterator< TDisplacementField >::RadiusType

using	Self = FiniteDifferenceFunction

using	Superclass = LightObject

using	TimeStepType = double

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override

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

void *	GetGlobalDataPointer () const override

virtual const char *	GetNameOfClass () const

void	ReleaseGlobalDataPointer (void *GlobalData) const override

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

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

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

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

void *	GetGlobalDataPointer () const override

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

void	ReleaseGlobalDataPointer (void *GlobalData) const override

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

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

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 constexpr unsigned int	ImageDimension = Superclass::ImageDimension

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

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

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

Protected Types
using	GlobalDataStruct = typename Superclass::GlobalDataStruct

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

using	GlobalDataStruct = typename Superclass::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 override

	VariationalRegistrationFastNCCFunction ()

	~VariationalRegistrationFastNCCFunction () override

Protected Member Functions inherited from itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >
void	PrintSelf (std::ostream &os, Indent indent) const override

	VariationalRegistrationNCCFunction ()

	~VariationalRegistrationNCCFunction () override

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

	VariationalRegistrationFunction ()

virtual void	WarpMovingImage (void)

	~VariationalRegistrationFunction () override

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

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

	~FiniteDifferenceFunction () override=default

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

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
std::atomic< int >	m_ReferenceCount