#include <itkANTSNeighborhoodCorrelationImageToImageMetricv4.h>

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>
class itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >

Computes normalized cross correlation using a small neighborhood for each voxel between two images, with speed optimizations for dense registration.

Please cite this reference for more details:

Brian B. Avants, Nicholas J. Tustison, Gang Song, Philip A. Cook, Arno Klein, James C. Gee, A reproducible evaluation of ANTs similarity metric performance in brain image registration, NeuroImage, Volume 54, Issue 3, 1 February 2011, Pages 2033-2044, ISSN 1053-8119, DOI: 10.1016/j.neuroimage.2010.09.025.

Around each voxel, the neighborhood is defined as a N-Dimensional rectangle centered at the voxel. The size of the rectangle is 2*radius+1. The normalized correlation between neighborhoods of fixed image and moving image are averaged over the whole image as the final metric.

Note: A radius less than 2 can be unstable. 2 is the default.

This class uses a specific fast implementation that is described in the above paper. There are two particular speed-ups:

1) It is assumed that the derivative is only affected by changes in the transform at the center of the window. This is obviously not true but speeds the evaluation up considerably and works well in practice. This assumption is the main differentiation of this approach from a more generic one.

2) The evaluation uses on-the-fly queues with multi-threading and a sliding neighborhood window. This is described in the above paper and specifically optimized for dense registration.

Example of usage:

using MetricType = itk::ANTSNeighborhoodCorrelationImageToImageMetricv4 <ImageType, ImageType>; using MetricTypePointer = MetricType::Pointer; MetricTypePointer metric = MetricType::New();

// set all parameters Size<Dimension> neighborhoodRadius; neighborhoodRadius.Fill(2); metric->SetRadius(neighborhood_radius); metric->SetFixedImage(fixedImage); metric->SetMovingImage(movingImage); metric->SetFixedTransform(transformFix); metric->SetMovingTransform(transformMov);

// initialization after parameters are set. metric->Initialize();

// getting derivative and metric value metric->GetValueAndDerivative(valueReturn, derivativeReturn);

This class is templated over the type of the two input objects. This is the base class for a hierarchy of similarity metrics that may, in derived classes, operate on meshes, images, etc. This class computes a value that measures the similarity between the two objects.

Definition at line 95 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

Inheritance diagram for itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >:

Collaboration diagram for itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FixedImageJacobianType = typename FixedTransformType::JacobianType

using	FixedTransformJacobianType = typename Superclass::FixedTransformType::JacobianType

using	ImageRegionType = typename VirtualImageType::RegionType

using	IndexType = typename VirtualImageType::IndexType

using	MovingImageJacobianType = typename MovingTransformType::JacobianType

using	MovingTransformJacobianType = typename Superclass::MovingTransformType::JacobianType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename VirtualImageType::SizeType

using	Self = ANTSNeighborhoodCorrelationImageToImageMetricv4

using	Superclass = ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >

using	VirtualImageType = typename Superclass::VirtualImageType

Public Types inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >
using	ConstPointer = SmartPointer< const Self >

using	DefaultFixedImageGradientCalculator = typename MetricTraits::DefaultFixedImageGradientCalculator

using	DefaultFixedImageGradientFilter = typename MetricTraits::DefaultFixedImageGradientFilter

using	DefaultMovingImageGradientCalculator = typename MetricTraits::DefaultMovingImageGradientCalculator

using	DefaultMovingImageGradientFilter = typename MetricTraits::DefaultMovingImageGradientFilter

using	DerivativeValueType = typename DerivativeType::ValueType

using	FixedGradientPixelType = typename MetricTraits::FixedGradientPixelType

using	FixedImageComponentGradientType = CovariantVector< typename FixedImageGradientType::ValueType, FixedImageDimension >

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImageGradientCalculatorPointer = typename FixedImageGradientCalculatorType::Pointer

using	FixedImageGradientCalculatorType = typename MetricTraits::FixedImageGradientCalculatorType

using	FixedImageGradientFilterPointer = typename FixedImageGradientFilterType::Pointer

using	FixedImageGradientFilterType = typename MetricTraits::FixedImageGradientFilterType

using	FixedImageGradientImagePointer = typename FixedImageGradientImageType::Pointer

using	FixedImageGradientImageType = typename MetricTraits::FixedImageGradientImageType

using	FixedImageGradientType = typename MetricTraits::FixedImageGradientType

using	FixedImageIndexType = typename FixedImageType::IndexType

using	FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer

using	FixedImageMaskPointer = typename FixedImageMaskType::Pointer

using	FixedImageMaskType = SpatialObject< Self::FixedImageDimension >

using	FixedImagePixelType = typename FixedImageType::PixelType

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImagePointType = typename FixedImageType::PointType

using	FixedImageType = TFixedImage

using	FixedInterpolatorPointer = typename FixedInterpolatorType::Pointer

using	FixedInterpolatorType = InterpolateImageFunction< FixedImageType, CoordinateRepresentationType >

using	FixedPixelType = FixedImagePixelType

using	FixedRealType = typename MetricTraits::FixedRealType

using	FixedSampledPointSetConstPointer = typename FixedSampledPointSetType::ConstPointer

using	FixedSampledPointSetPointer = typename FixedSampledPointSetType::Pointer

using	FixedSampledPointSetType = PointSet< typename FixedImageType::PixelType, Self::FixedImageDimension >

using	FixedScalarRealType = typename NumericTraits< FixedRealType >::ScalarRealType

using	ImageDimensionType = typename Superclass::DimensionType

using	InternalComputationValueType = double

using	MetricTraits = DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double >

using	MovingGradientPixelType = typename MetricTraits::MovingGradientPixelType

using	MovingImageComponentGradientType = CovariantVector< typename MovingImageGradientType::ValueType, MovingImageDimension >

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImageGradientCalculatorPointer = typename MovingImageGradientCalculatorType::Pointer

using	MovingImageGradientCalculatorType = typename MetricTraits::MovingImageGradientCalculatorType

using	MovingImageGradientFilterPointer = typename MovingImageGradientFilterType::Pointer

using	MovingImageGradientFilterType = typename MetricTraits::MovingImageGradientFilterType

using	MovingImageGradientImagePointer = typename MovingImageGradientImageType::Pointer

using	MovingImageGradientImageType = typename MetricTraits::MovingImageGradientImageType

using	MovingImageGradientType = typename MetricTraits::MovingImageGradientType

using	MovingImageIndexType = typename MovingImageType::IndexType

using	MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer

using	MovingImageMaskPointer = typename MovingImageMaskType::Pointer

using	MovingImageMaskType = SpatialObject< Self::MovingImageDimension >

using	MovingImagePixelType = typename MovingImageType::PixelType

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImagePointType = typename MovingImageType::PointType

using	MovingImageRegionType = typename MovingImageType::RegionType

using	MovingImageType = TMovingImage

using	MovingInterpolatorPointer = typename MovingInterpolatorType::Pointer

using	MovingInterpolatorType = InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >

using	MovingPixelType = MovingImagePixelType

using	MovingRealType = typename MetricTraits::MovingRealType

using	MovingScalarRealType = typename NumericTraits< MovingRealType >::ScalarRealType

using	ObjectType = typename Superclass::ObjectType

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageMetricv4

using	Superclass = ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >

using	VirtualImageComponentGradientType = CovariantVector< typename VirtualImageGradientType::ValueType, VirtualImageDimension >

using	VirtualImageGradientType = typename MetricTraits::VirtualImageGradientType

using	VirtualImageType = typename Superclass::VirtualImageType

using	VirtualOriginType = typename Superclass::VirtualPointType

using	VirtualRadiusType = typename Superclass::VirtualSizeType

Public Types inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >
using	ConstPointer = SmartPointer< const Self >

using	CoordinateRepresentationType = double

using	DimensionType = SizeValueType

using	FixedInputPointType = typename FixedTransformType::InputPointType

using	FixedOutputPointType = typename FixedTransformType::OutputPointType

using	FixedTransformJacobianType = typename FixedTransformType::JacobianType

using	FixedTransformParametersType = typename FixedTransformType::ParametersType

using	FixedTransformPointer = typename FixedTransformType::Pointer

using	FixedTransformType = Transform< double, TVirtualImage::ImageDimension, TFixedDimension >

using	InternalComputationValueType = double

using	JacobianType = typename FixedTransformType::JacobianType

using	MetricCategoryType = typename Superclass::MetricCategoryEnum

using	MovingDisplacementFieldTransformType = DisplacementFieldTransform< CoordinateRepresentationType, Self::MovingDimension >

using	MovingInputPointType = typename MovingTransformType::InputPointType

using	MovingOutputPointType = typename MovingTransformType::OutputPointType

using	MovingTransformJacobianType = typename MovingTransformType::JacobianType

using	MovingTransformParametersType = typename MovingTransformType::ParametersType

using	MovingTransformPointer = typename MovingTransformType::Pointer

using	MovingTransformType = Transform< double, TVirtualImage::ImageDimension, TMovingDimension >

using	ObjectType = typename Superclass::Object

using	Pointer = SmartPointer< Self >

using	Self = ObjectToObjectMetric

using	Superclass = ObjectToObjectMetricBaseTemplate< double >

using	VirtualDirectionType = typename VirtualImageType::DirectionType

using	VirtualImageConstPointer = typename VirtualImageType::ConstPointer

using	VirtualImagePointer = typename VirtualImageType::Pointer

using	VirtualImageType = TFixedImage

using	VirtualIndexType = typename VirtualImageType::IndexType

using	VirtualOriginType = typename VirtualImageType::PointType

using	VirtualPixelType = typename VirtualImageType::PixelType

using	VirtualPointSetPointer = typename VirtualPointSetType::Pointer

using	VirtualPointSetType = PointSet< VirtualPixelType, Self::VirtualDimension >

using	VirtualPointType = typename VirtualImageType::PointType

using	VirtualRadiusType = typename VirtualImageType::SizeType

using	VirtualRegionType = typename VirtualImageType::RegionType

using	VirtualSizeType = typename VirtualRegionType::SizeType

using	VirtualSpacingType = typename VirtualImageType::SpacingType

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

using	CoordinateRepresentationType = double

using	DerivativeValueType = typename DerivativeType::ValueType

using	GradientSourceEnum = itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource

using	MetricCategoryEnum = itk::ObjectToObjectMetricBaseTemplateEnums::MetricCategory

using	NumberOfParametersType = unsigned int

using	ObjectConstPointer = typename ObjectType::ConstPointer

using	ObjectType = Object

using	ParametersValueType = double

using	Pointer = SmartPointer< Self >

using	Self = ObjectToObjectMetricBaseTemplate

using	Superclass = SingleValuedCostFunctionv4Template< double >

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

using	DerivativeType = Array< double >

using	MeasureType = double

using	Pointer = SmartPointer< Self >

using	Self = SingleValuedCostFunctionv4Template

using	Superclass = CostFunctionTemplate< double >

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

using	ParametersType = OptimizerParameters< double >

using	ParametersValueType = double

using	Pointer = SmartPointer< Self >

using	Self = CostFunctionTemplate

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

virtual RadiusType	GetRadius ()

virtual RadiusType	GetRadius () const

void	Initialize () override

virtual void	SetRadius (RadiusType _arg)

Public Member Functions inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >
virtual void	FinalizeThread (const ThreadIdType)

void	GetDerivative (DerivativeType &) const override

virtual const FixedImageType *	GetFixedImage () const

MetricCategoryType	GetMetricCategory () const override

virtual FixedImageGradientImageType *	GetModifiableFixedImageGradientImage ()

virtual FixedInterpolatorType *	GetModifiableFixedInterpolator ()

virtual MovingImageGradientImageType *	GetModifiableMovingImageGradientImage ()

virtual MovingInterpolatorType *	GetModifiableMovingInterpolator ()

const char *	GetNameOfClass () const override

SizeValueType	GetNumberOfDomainPoints () const

virtual const SizeValueType &	GetNumberOfSkippedFixedSampledPoints () const

virtual ThreadIdType	GetNumberOfWorkUnitsUsed () const

MeasureType	GetValue () const override

void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override

void	Initialize () override

virtual void	SetFixedImage (const FixedImageType *_arg)

virtual void	SetFixedInterpolator (FixedInterpolatorType *_arg)

virtual void	SetMovingInterpolator (MovingInterpolatorType *_arg)

bool	SupportsArbitraryVirtualDomainSamples () const override

void	SetFixedObject (const ObjectType *object) override

void	SetMovingObject (const ObjectType *object) override

virtual void	SetMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetMovingImage () const

virtual void	SetMovingImageMask (const MovingImageMaskType *_arg)

virtual const MovingImageMaskType *	GetMovingImageMask () const

virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)

virtual const FixedImageMaskType *	GetFixedImageMask () const

virtual void	SetFixedSampledPointSet (const FixedSampledPointSetType *_arg)

virtual const FixedSampledPointSetType *	GetFixedSampledPointSet () const

virtual void	SetVirtualSampledPointSet (VirtualPointSetType *_arg)

virtual const VirtualPointSetType *	GetVirtualSampledPointSet () const

virtual void	SetUseSampledPointSet (bool _arg)

virtual const bool &	GetUseSampledPointSet () const

virtual void	UseSampledPointSetOn ()

virtual void	SetUseVirtualSampledPointSet (bool _arg)

virtual const bool &	GetUseVirtualSampledPointSet () const

virtual void	UseVirtualSampledPointSetOn ()

virtual void	SetFixedImageGradientFilter (FixedImageGradientFilterType *_arg)

virtual FixedImageGradientFilterType *	GetModifiableFixedImageGradientFilter ()

virtual void	SetMovingImageGradientFilter (MovingImageGradientFilterType *_arg)

virtual MovingImageGradientFilterType *	GetModifiableMovingImageGradientFilter ()

virtual void	SetFixedImageGradientCalculator (FixedImageGradientCalculatorType *_arg)

virtual FixedImageGradientCalculatorType *	GetModifiableFixedImageGradientCalculator ()

virtual void	SetMovingImageGradientCalculator (MovingImageGradientCalculatorType *_arg)

virtual MovingImageGradientCalculatorType *	GetModifiableMovingImageGradientCalculator ()

virtual void	SetUseFixedImageGradientFilter (bool _arg)

virtual const bool &	GetUseFixedImageGradientFilter () const

virtual void	UseFixedImageGradientFilterOn ()

virtual void	SetUseMovingImageGradientFilter (bool _arg)

virtual const bool &	GetUseMovingImageGradientFilter () const

virtual void	UseMovingImageGradientFilterOn ()

virtual void	SetMaximumNumberOfWorkUnits (const ThreadIdType number)

virtual ThreadIdType	GetMaximumNumberOfWorkUnits () const

virtual void	SetUseFloatingPointCorrection (bool _arg)

virtual const bool &	GetUseFloatingPointCorrection () const

virtual void	UseFloatingPointCorrectionOn ()

virtual void	SetFloatingPointCorrectionResolution (DerivativeValueType _arg)

virtual DerivativeValueType	GetFloatingPointCorrectionResolution () const

Public Member Functions inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >
OffsetValueType	ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const

OffsetValueType	ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const

MetricCategoryType	GetMetricCategory () const override

virtual FixedTransformType *	GetModifiableFixedTransform ()

virtual MovingTransformType *	GetModifiableMovingTransform ()

virtual VirtualImageType *	GetModifiableVirtualImage ()

const char *	GetNameOfClass () const override

NumberOfParametersType	GetNumberOfLocalParameters () const override

NumberOfParametersType	GetNumberOfParameters () const override

virtual SizeValueType	GetNumberOfValidPoints () const

const ParametersType &	GetParameters () const override

const MovingTransformType *	GetTransform ()

VirtualDirectionType	GetVirtualDirection () const

virtual const TimeStamp &	GetVirtualDomainTimeStamp () const

VirtualOriginType	GetVirtualOrigin () const

const VirtualRegionType &	GetVirtualRegion () const

VirtualSpacingType	GetVirtualSpacing () const

bool	HasLocalSupport () const override

void	Initialize () override

virtual void	SetFixedTransform (FixedTransformType *_arg)

virtual void	SetMovingTransform (MovingTransformType *_arg)

void	SetParameters (ParametersType &params) override

void	SetTransform (MovingTransformType *transform)

void	SetVirtualDomain (const VirtualSpacingType &spacing, const VirtualOriginType &origin, const VirtualDirectionType &direction, const VirtualRegionType &region)

void	SetVirtualDomainFromImage (const VirtualImageType *virtualImage)

virtual bool	SupportsArbitraryVirtualDomainSamples () const=0

void	UpdateTransformParameters (const DerivativeType &derivative, double factor) override

bool	IsInsideVirtualDomain (const VirtualPointType &point) const

bool	IsInsideVirtualDomain (const VirtualIndexType &index) const

Public Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< double >
MeasureType	GetCurrentValue () const

virtual void	GetDerivative (DerivativeType &) const=0

virtual GradientSourceEnum	GetGradientSource () const

bool	GetGradientSourceIncludesFixed () const

bool	GetGradientSourceIncludesMoving () const

virtual MetricCategoryEnum	GetMetricCategory () const

const char *	GetNameOfClass () const override

virtual const ParametersType &	GetParameters () const=0

MeasureType	GetValue () const override=0

void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override=0

virtual bool	HasLocalSupport () const=0

virtual void	Initialize ()=0

virtual void	SetGradientSource (GradientSourceEnum _arg)

virtual void	SetParameters (ParametersType &params)=0

virtual void	UpdateTransformParameters (const DerivativeType &derivative, ParametersValueType factor=NumericTraits< ParametersValueType >::OneValue())=0

virtual void	SetFixedObject (const ObjectType *_arg)

virtual const ObjectType *	GetFixedObject () const

virtual void	SetMovingObject (const ObjectType *_arg)

virtual const ObjectType *	GetMovingObject () const

const char *	GetNameOfClass () const override

virtual MeasureType	GetValue () const=0

virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const=0

const char *	GetNameOfClass () const override

virtual unsigned int	GetNumberOfParameters () const=0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

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

static Pointer	New ()

Static Public Attributes
static constexpr ImageDimensionType	FixedImageDimension = FixedImageType::ImageDimension

static constexpr ImageDimensionType	MovingImageDimension = MovingImageType::ImageDimension

static constexpr ImageDimensionType	VirtualImageDimension = VirtualImageType::ImageDimension

Static Public Attributes inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >
static constexpr DimensionType	FixedImageDimension

static constexpr DimensionType	MovingImageDimension

static constexpr DimensionType	VirtualImageDimension

Static Public Attributes inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >
static constexpr DimensionType	FixedDimension

static constexpr DimensionType	MovingDimension

static constexpr DimensionType	VirtualDimension

Protected Types
using	ANTSNeighborhoodCorrelationImageToImageMetricv4DenseGetValueAndDerivativeThreaderType = ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Superclass, Self >

using	ANTSNeighborhoodCorrelationImageToImageMetricv4SparseGetValueAndDerivativeThreaderType = ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

Protected Types inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >
using	FixedImageGradientInterpolatorType = LinearInterpolateImageFunction< FixedImageGradientImageType, CoordinateRepresentationType >

using	MovingImageGradientInterpolatorType = LinearInterpolateImageFunction< MovingImageGradientImageType, CoordinateRepresentationType >

Protected Member Functions
	ANTSNeighborhoodCorrelationImageToImageMetricv4 ()

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

	~ANTSNeighborhoodCorrelationImageToImageMetricv4 () override=default

Protected Member Functions inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >
virtual void	ComputeFixedImageGradientAtPoint (const FixedImagePointType &mappedPoint, FixedImageGradientType &gradient) const

virtual void	ComputeFixedImageGradientFilterImage ()

virtual void	ComputeMovingImageGradientAtPoint (const MovingImagePointType &mappedPoint, MovingImageGradientType &gradient) const

virtual void	ComputeMovingImageGradientFilterImage () const

virtual bool	GetComputeDerivative () const

virtual void	GetValueAndDerivativeExecute () const

	ImageToImageMetricv4 ()

virtual void	InitializeForIteration () const

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

bool	TransformAndEvaluateFixedPoint (const VirtualPointType &virtualPoint, FixedImagePointType &mappedFixedPoint, FixedImagePixelType &mappedFixedPixelValue) const

bool	TransformAndEvaluateMovingPoint (const VirtualPointType &virtualPoint, MovingImagePointType &mappedMovingPoint, MovingImagePixelType &mappedMovingPixelValue) const

	~ImageToImageMetricv4 () override=default

virtual void	InitializeDefaultFixedImageGradientFilter ()

virtual void	InitializeDefaultMovingImageGradientFilter ()

Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >
const MovingDisplacementFieldTransformType *	GetMovingDisplacementFieldTransform () const

	ObjectToObjectMetric ()

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

bool	TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const

void	TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const

virtual void	VerifyDisplacementFieldSizeAndPhysicalSpace ()

bool	VerifyNumberOfValidPoints (MeasureType &value, DerivativeType &derivative) const

	~ObjectToObjectMetric () override=default

Protected Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< double >
	ObjectToObjectMetricBaseTemplate ()

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

	~ObjectToObjectMetricBaseTemplate () override=default

Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< double >
	SingleValuedCostFunctionv4Template ()=default

	~SingleValuedCostFunctionv4Template () override=default

Protected Member Functions inherited from itk::CostFunctionTemplate< double >
	CostFunctionTemplate ()=default

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

	~CostFunctionTemplate () override=default

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () 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	PrintSelf (std::ostream &os, Indent indent) const

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

virtual	~LightObject ()

Private Attributes
RadiusType	m_Radius {}

Friends
class	ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Superclass, Self >

class	ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

Additional Inherited Members
Protected Attributes inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >
DefaultFixedImageGradientCalculator::Pointer	m_DefaultFixedImageGradientCalculator

DefaultFixedImageGradientFilter::Pointer	m_DefaultFixedImageGradientFilter

DefaultMovingImageGradientCalculator::Pointer	m_DefaultMovingImageGradientCalculator

DefaultMovingImageGradientFilter::Pointer	m_DefaultMovingImageGradientFilter

ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Self >::Pointer	m_DenseGetValueAndDerivativeThreader

DerivativeType *	m_DerivativeResult

FixedImageConstPointer	m_FixedImage

FixedImageGradientCalculatorPointer	m_FixedImageGradientCalculator

FixedImageGradientFilterPointer	m_FixedImageGradientFilter

FixedImageGradientImagePointer	m_FixedImageGradientImage

FixedImageGradientInterpolatorType::Pointer	m_FixedImageGradientInterpolator

FixedImageMaskConstPointer	m_FixedImageMask

FixedInterpolatorPointer	m_FixedInterpolator

FixedSampledPointSetConstPointer	m_FixedSampledPointSet

MovingImageConstPointer	m_MovingImage

MovingImageGradientCalculatorPointer	m_MovingImageGradientCalculator

MovingImageGradientFilterPointer	m_MovingImageGradientFilter

MovingImageGradientImagePointer	m_MovingImageGradientImage

MovingImageGradientInterpolatorType::Pointer	m_MovingImageGradientInterpolator

MovingImageMaskConstPointer	m_MovingImageMask

MovingInterpolatorPointer	m_MovingInterpolator

ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Self >::Pointer	m_SparseGetValueAndDerivativeThreader

bool	m_UseFixedImageGradientFilter

bool	m_UseMovingImageGradientFilter

bool	m_UseSampledPointSet

bool	m_UseVirtualSampledPointSet

VirtualPointSetPointer	m_VirtualSampledPointSet

Protected Attributes inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >
FixedTransformPointer	m_FixedTransform

MovingTransformPointer	m_MovingTransform

SizeValueType	m_NumberOfValidPoints

bool	m_UserHasSetVirtualDomain

VirtualImagePointer	m_VirtualImage

Protected Attributes inherited from itk::ObjectToObjectMetricBaseTemplate< double >
ObjectConstPointer	m_FixedObject

GradientSourceEnum	m_GradientSource

ObjectConstPointer	m_MovingObject

MeasureType	m_Value

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}