#include <itkANTSNeighborhoodCorrelationImageToImageMetricv4.h>

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

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

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:

typedef itk::ANTSNeighborhoodCorrelationImageToImageMetricv4 <ImageType, ImageType> MetricType; typedef MetricType::Pointer MetricTypePointer; 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.

Note: Sparse sampling is not supported by this metric. An exception will be thrown if m_UseFixedSampledPointSet is set. Support for sparse sampling will require a parallel implementation of the neighborhood scanning, which currently caches information as the neighborhood window moves.

Definition at line 97 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::DerivativeValueType	DerivativeValueType

typedef Superclass::FixedImageGradientType	FixedImageGradientType

typedef FixedTransformType::JacobianType	FixedImageJacobianType

typedef Superclass::FixedImagePixelType	FixedImagePixelType

typedef Superclass::FixedImagePointType	FixedImagePointType

typedef Superclass::FixedImageType	FixedImageType

typedef Superclass::FixedOutputPointType	FixedOutputPointType

typedef Superclass::FixedTransformType::JacobianType	FixedTransformJacobianType

typedef Superclass::FixedTransformType	FixedTransformType

typedef Superclass::ImageDimensionType	ImageDimensionType

typedef VirtualImageType::RegionType	ImageRegionType

typedef VirtualImageType::IndexType	IndexType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MovingImageGradientType	MovingImageGradientType

typedef MovingTransformType::JacobianType	MovingImageJacobianType

typedef Superclass::MovingImagePixelType	MovingImagePixelType

typedef Superclass::MovingImagePointType	MovingImagePointType

typedef Superclass::MovingImageType	MovingImageType

typedef Superclass::MovingOutputPointType	MovingOutputPointType

typedef Superclass::MovingTransformType::JacobianType	MovingTransformJacobianType

typedef Superclass::MovingTransformType	MovingTransformType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef SmartPointer< Self >	Pointer

typedef VirtualImageType::SizeType	RadiusType

typedef ANTSNeighborhoodCorrelationImageToImageMetricv4	Self

typedef ImageToImageMetricv4 < TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >	Superclass

typedef Superclass::VirtualImageGradientType	VirtualImageGradientType

typedef Superclass::VirtualImageType	VirtualImageType

typedef Superclass::VirtualPointType	VirtualPointType

Public Types inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType

typedef MetricTraits::DefaultFixedImageGradientCalculator	DefaultFixedImageGradientCalculator

typedef MetricTraits::DefaultFixedImageGradientFilter	DefaultFixedImageGradientFilter

typedef MetricTraits::DefaultMovingImageGradientCalculator	DefaultMovingImageGradientCalculator

typedef MetricTraits::DefaultMovingImageGradientFilter	DefaultMovingImageGradientFilter

typedef Superclass::DerivativeType	DerivativeType

typedef DerivativeType::ValueType	DerivativeValueType

typedef Superclass::DimensionType	DimensionType

typedef MetricTraits::FixedGradientPixelType	FixedGradientPixelType

typedef CovariantVector < typename FixedImageGradientType::ValueType, FixedImageDimension >	FixedImageComponentGradientType

typedef FixedImageType::ConstPointer	FixedImageConstPointer

typedef FixedImageGradientCalculatorType::Pointer	FixedImageGradientCalculatorPointer

typedef MetricTraits::FixedImageGradientCalculatorType	FixedImageGradientCalculatorType

typedef FixedImageGradientFilterType::Pointer	FixedImageGradientFilterPointer

typedef MetricTraits::FixedImageGradientFilterType	FixedImageGradientFilterType

typedef FixedImageGradientImageType::Pointer	FixedImageGradientImagePointer

typedef MetricTraits::FixedImageGradientImageType	FixedImageGradientImageType

typedef MetricTraits::FixedImageGradientType	FixedImageGradientType

typedef FixedImageType::IndexType	FixedImageIndexType

typedef FixedImageMaskType::ConstPointer	FixedImageMaskConstPointer

typedef FixedImageMaskType::Pointer	FixedImageMaskPointer

typedef SpatialObject < itkGetStaticConstMacro(FixedImageDimension) >	FixedImageMaskType

typedef FixedImageType::PixelType	FixedImagePixelType

typedef FixedImageType::Pointer	FixedImagePointer

typedef FixedImageType::PointType	FixedImagePointType

typedef TFixedImage	FixedImageType

typedef Superclass::FixedInputPointType	FixedInputPointType

typedef FixedInterpolatorType::Pointer	FixedInterpolatorPointer

typedef InterpolateImageFunction < FixedImageType, CoordinateRepresentationType >	FixedInterpolatorType

typedef Superclass::FixedOutputPointType	FixedOutputPointType

typedef FixedImagePixelType	FixedPixelType

typedef MetricTraits::FixedRealType	FixedRealType

typedef FixedSampledPointSetType::ConstPointer	FixedSampledPointSetConstPointer

typedef FixedSampledPointSetType::Pointer	FixedSampledPointSetPointer

typedef PointSet< typename FixedImageType::PixelType, itkGetStaticConstMacro(FixedImageDimension)>	FixedSampledPointSetType

typedef NumericTraits < FixedRealType > ::ScalarRealType	FixedScalarRealType

typedef Superclass::FixedTransformJacobianType	FixedTransformJacobianType

typedef Superclass::FixedTransformParametersType	FixedTransformParametersType

typedef Superclass::FixedTransformPointer	FixedTransformPointer

typedef Superclass::FixedTransformType	FixedTransformType

typedef Superclass::GradientSourceType	GradientSourceType

typedef Superclass::DimensionType	ImageDimensionType

typedef TInternalComputationValueType	InternalComputationValueType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MetricCategoryType	MetricCategoryType

typedef TMetricTraits	MetricTraits

typedef MetricTraits::MovingGradientPixelType	MovingGradientPixelType

typedef CovariantVector < typename MovingImageGradientType::ValueType, MovingImageDimension >	MovingImageComponentGradientType

typedef MovingImageType::ConstPointer	MovingImageConstPointer

typedef MovingImageGradientCalculatorType::Pointer	MovingImageGradientCalculatorPointer

typedef MetricTraits::MovingImageGradientCalculatorType	MovingImageGradientCalculatorType

typedef MovingImageGradientFilterType::Pointer	MovingImageGradientFilterPointer

typedef MetricTraits::MovingImageGradientFilterType	MovingImageGradientFilterType

typedef MovingImageGradientImageType::Pointer	MovingImageGradientImagePointer

typedef MetricTraits::MovingImageGradientImageType	MovingImageGradientImageType

typedef MetricTraits::MovingImageGradientType	MovingImageGradientType

typedef MovingImageType::IndexType	MovingImageIndexType

typedef MovingImageMaskType::ConstPointer	MovingImageMaskConstPointer

typedef MovingImageMaskType::Pointer	MovingImageMaskPointer

typedef SpatialObject < itkGetStaticConstMacro(MovingImageDimension) >	MovingImageMaskType

typedef MovingImageType::PixelType	MovingImagePixelType

typedef MovingImageType::Pointer	MovingImagePointer

typedef MovingImageType::PointType	MovingImagePointType

typedef MovingImageType::RegionType	MovingImageRegionType

typedef TMovingImage	MovingImageType

typedef Superclass::MovingInputPointType	MovingInputPointType

typedef MovingInterpolatorType::Pointer	MovingInterpolatorPointer

typedef InterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	MovingInterpolatorType

typedef Superclass::MovingOutputPointType	MovingOutputPointType

typedef MovingImagePixelType	MovingPixelType

typedef MetricTraits::MovingRealType	MovingRealType

typedef NumericTraits < MovingRealType > ::ScalarRealType	MovingScalarRealType

typedef Superclass::MovingTransformJacobianType	MovingTransformJacobianType

typedef Superclass::MovingTransformParametersType	MovingTransformParametersType

typedef Superclass::MovingTransformPointer	MovingTransformPointer

typedef Superclass::MovingTransformType	MovingTransformType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::ObjectType	ObjectType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageMetricv4	Self

typedef ObjectToObjectMetric < TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >	Superclass

typedef Superclass::VirtualDirectionType	VirtualDirectionType

typedef CovariantVector < typename VirtualImageGradientType::ValueType, VirtualImageDimension >	VirtualImageComponentGradientType

typedef MetricTraits::VirtualImageGradientType	VirtualImageGradientType

typedef Superclass::VirtualImagePointer	VirtualImagePointer

typedef Superclass::VirtualImageType	VirtualImageType

typedef Superclass::VirtualIndexType	VirtualIndexType

typedef Superclass::VirtualPointType	VirtualOriginType

typedef Superclass::VirtualPixelType	VirtualPixelType

typedef Superclass::VirtualPointSetPointer	VirtualPointSetPointer

typedef Superclass::VirtualPointSetType	VirtualPointSetType

typedef Superclass::VirtualPointType	VirtualPointType

typedef Superclass::VirtualSizeType	VirtualRadiusType

typedef Superclass::VirtualRegionType	VirtualRegionType

typedef Superclass::VirtualSizeType	VirtualSizeType

typedef Superclass::VirtualSpacingType	VirtualSpacingType

Public Types inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >
typedef SmartPointer< const Self >	ConstPointer

typedef TInternalComputationValueType	CoordinateRepresentationType

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::DerivativeValueType	DerivativeValueType

typedef SizeValueType	DimensionType

typedef FixedTransformType::InputPointType	FixedInputPointType

typedef FixedTransformType::OutputPointType	FixedOutputPointType

typedef FixedTransformType::JacobianType	FixedTransformJacobianType

typedef FixedTransformType::ParametersType	FixedTransformParametersType

typedef FixedTransformType::Pointer	FixedTransformPointer

typedef Transform < TInternalComputationValueType, TVirtualImage::ImageDimension, TFixedDimension >	FixedTransformType

typedef Superclass::GradientSourceType	GradientSourceType

typedef TInternalComputationValueType	InternalComputationValueType

typedef FixedTransformType::JacobianType	JacobianType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MetricCategoryType	MetricCategoryType

typedef DisplacementFieldTransform < CoordinateRepresentationType, itkGetStaticConstMacro(MovingDimension) >	MovingDisplacementFieldTransformType

typedef MovingTransformType::InputPointType	MovingInputPointType

typedef MovingTransformType::OutputPointType	MovingOutputPointType

typedef MovingTransformType::JacobianType	MovingTransformJacobianType

typedef MovingTransformType::ParametersType	MovingTransformParametersType

typedef MovingTransformType::Pointer	MovingTransformPointer

typedef Transform < TInternalComputationValueType, TVirtualImage::ImageDimension, TMovingDimension >	MovingTransformType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::Object	ObjectType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef ObjectToObjectMetric	Self

typedef ObjectToObjectMetricBaseTemplate < TInternalComputationValueType >	Superclass

typedef VirtualImageType::DirectionType	VirtualDirectionType

typedef VirtualImageType::ConstPointer	VirtualImageConstPointer

typedef VirtualImageType::Pointer	VirtualImagePointer

typedef TVirtualImage	VirtualImageType

typedef VirtualImageType::IndexType	VirtualIndexType

typedef VirtualImageType::PointType	VirtualOriginType

typedef VirtualImageType::PixelType	VirtualPixelType

typedef VirtualPointSetType::Pointer	VirtualPointSetPointer

typedef PointSet < VirtualPixelType, itkGetStaticConstMacro(VirtualDimension)>	VirtualPointSetType

typedef VirtualImageType::PointType	VirtualPointType

typedef VirtualImageType::SizeType	VirtualRadiusType

typedef VirtualImageType::RegionType	VirtualRegionType

typedef VirtualRegionType::SizeType	VirtualSizeType

typedef VirtualImageType::SpacingType	VirtualSpacingType

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

typedef TInternalComputationValueType	CoordinateRepresentationType

typedef Superclass::DerivativeType	DerivativeType

typedef DerivativeType::ValueType	DerivativeValueType

enum	GradientSourceType { GRADIENT_SOURCE_FIXED =0, GRADIENT_SOURCE_MOVING, GRADIENT_SOURCE_BOTH }

typedef Superclass::MeasureType	MeasureType

enum	MetricCategoryType { UNKNOWN_METRIC = 0, OBJECT_METRIC = 1, IMAGE_METRIC = 2, POINT_SET_METRIC = 3, MULTI_METRIC = 4 }

typedef unsigned int	NumberOfParametersType

typedef ObjectType::ConstPointer	ObjectConstPointer

typedef Object	ObjectType

typedef Superclass::ParametersType	ParametersType

typedef TInternalComputationValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef ObjectToObjectMetricBaseTemplate	Self

typedef SingleValuedCostFunctionv4Template < TInternalComputationValueType >	Superclass

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

typedef Array < TInternalComputationValueType >	DerivativeType

typedef TInternalComputationValueType	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef SingleValuedCostFunctionv4Template	Self

typedef CostFunctionTemplate < TInternalComputationValueType >	Superclass

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

typedef OptimizerParameters < TInternalComputationValueType >	ParametersType

typedef TInternalComputationValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef CostFunctionTemplate	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 () const

virtual const char *	GetNameOfClass () const

virtual RadiusType	GetRadius ()

virtual RadiusType	GetRadius () const

void	Initialize (void) override throw ( itk::ExceptionObject )

virtual void	SetRadius (RadiusType _arg)

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

virtual void	GetDerivative (DerivativeType &) const override

virtual const FixedImageType *	GetFixedImage () const

virtual const FixedImageGradientImageType *	GetFixedImageGradientImage () const

virtual const FixedInterpolatorType *	GetFixedInterpolator () const

virtual MetricCategoryType	GetMetricCategory () const override

virtual FixedImageGradientImageType *	GetModifiableFixedImageGradientImage ()

virtual FixedInterpolatorType *	GetModifiableFixedInterpolator ()

virtual MovingImageGradientImageType *	GetModifiableMovingImageGradientImage ()

virtual MovingInterpolatorType *	GetModifiableMovingInterpolator ()

virtual VirtualPointSetType *	GetModifiableVirtualSampledPointSet ()

virtual const MovingImageGradientImageType *	GetMovingImageGradientImage () const

virtual const MovingInterpolatorType *	GetMovingInterpolator () const

SizeValueType	GetNumberOfDomainPoints () const

virtual const SizeValueType &	GetNumberOfSkippedFixedSampledPoints () const

virtual ThreadIdType	GetNumberOfThreadsUsed () const

virtual SizeValueType	GetNumberOfValidPoints () const override

virtual MeasureType	GetValue () const override

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

virtual const VirtualPointSetType *	GetVirtualSampledPointSet () const

virtual void	InitializeThread (const ThreadIdType)

virtual void	SetFixedImage (const FixedImageType *_arg)

virtual void	SetFixedInterpolator (FixedInterpolatorType *_arg)

virtual void	SetMovingInterpolator (MovingInterpolatorType *_arg)

virtual bool	SupportsArbitraryVirtualDomainSamples (void) const override

virtual void	SetFixedObject (const ObjectType *object) override

virtual void	SetMovingObject (const ObjectType *object) override

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

virtual void	SetFixedSampledPointSet (FixedSampledPointSetType *_arg)

virtual void	SetFixedSampledPointSet (const FixedSampledPointSetType *_arg)

virtual const FixedSampledPointSetType *	GetFixedSampledPointSet () const

virtual void	SetUseFixedSampledPointSet (bool _arg)

virtual const bool &	GetUseFixedSampledPointSet () const

virtual void	UseFixedSampledPointSetOn ()

virtual void	UseFixedSampledPointSetOff ()

virtual void	SetFixedImageGradientFilter (FixedImageGradientFilterType *_arg)

virtual FixedImageGradientFilterType *	GetModifiableFixedImageGradientFilter ()

virtual const FixedImageGradientFilterType *	GetFixedImageGradientFilter () const

virtual void	SetMovingImageGradientFilter (MovingImageGradientFilterType *_arg)

virtual MovingImageGradientFilterType *	GetModifiableMovingImageGradientFilter ()

virtual const MovingImageGradientFilterType *	GetMovingImageGradientFilter () const

virtual void	SetFixedImageGradientCalculator (FixedImageGradientCalculatorType *_arg)

virtual FixedImageGradientCalculatorType *	GetModifiableFixedImageGradientCalculator ()

virtual const FixedImageGradientCalculatorType *	GetFixedImageGradientCalculator () const

virtual void	SetMovingImageGradientCalculator (MovingImageGradientCalculatorType *_arg)

virtual MovingImageGradientCalculatorType *	GetModifiableMovingImageGradientCalculator ()

virtual const MovingImageGradientCalculatorType *	GetMovingImageGradientCalculator () const

virtual void	SetUseFixedImageGradientFilter (bool _arg)

virtual const bool &	GetUseFixedImageGradientFilter () const

virtual void	UseFixedImageGradientFilterOn ()

virtual void	UseFixedImageGradientFilterOff ()

virtual void	SetUseMovingImageGradientFilter (bool _arg)

virtual const bool &	GetUseMovingImageGradientFilter () const

virtual void	UseMovingImageGradientFilterOn ()

virtual void	UseMovingImageGradientFilterOff ()

virtual void	SetMaximumNumberOfThreads (const ThreadIdType threads)

virtual ThreadIdType	GetMaximumNumberOfThreads () const

virtual void	SetUseFloatingPointCorrection (bool _arg)

virtual const bool &	GetUseFloatingPointCorrection () const

virtual void	UseFloatingPointCorrectionOn ()

virtual void	UseFloatingPointCorrectionOff ()

virtual void	SetFloatingPointCorrectionResolution (DerivativeValueType _arg)

virtual DerivativeValueType	GetFloatingPointCorrectionResolution () const

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

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

virtual const FixedTransformType *	GetFixedTransform () const

virtual FixedTransformType *	GetModifiableFixedTransform ()

virtual MovingTransformType *	GetModifiableMovingTransform ()

virtual VirtualImageType *	GetModifiableVirtualImage ()

virtual const MovingTransformType *	GetMovingTransform () const

virtual NumberOfParametersType	GetNumberOfLocalParameters () const override

virtual NumberOfParametersType	GetNumberOfParameters () const override

virtual const ParametersType &	GetParameters () const override

const MovingTransformType *	GetTransform ()

VirtualDirectionType	GetVirtualDirection () const

virtual const TimeStamp &	GetVirtualDomainTimeStamp () const

virtual const VirtualImageType *	GetVirtualImage () const

VirtualOriginType	GetVirtualOrigin () const

const VirtualRegionType &	GetVirtualRegion () const

VirtualSpacingType	GetVirtualSpacing () const

virtual bool	HasLocalSupport () const override

virtual void	SetFixedTransform (FixedTransformType *_arg)

virtual void	SetMovingTransform (MovingTransformType *_arg)

virtual 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 void	UpdateTransformParameters (const DerivativeType &derivative, TInternalComputationValueTypefactor) override

bool	IsInsideVirtualDomain (const VirtualPointType &point) const

bool	IsInsideVirtualDomain (const VirtualIndexType &index) const

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

virtual GradientSourceType	GetGradientSource () const

bool	GetGradientSourceIncludesFixed () const

bool	GetGradientSourceIncludesMoving () const

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

virtual void	SetGradientSource (GradientSourceType _arg)

virtual const ObjectType *	GetFixedObject () const

virtual const ObjectType *	GetMovingObject () const

Public Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0

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

unsigned long	AddObserver (const EventObject &event, Command *) const

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

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

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

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

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

static Pointer	New ()

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

static const ImageDimensionType	MovingImageDimension = MovingImageType::ImageDimension

static const ImageDimensionType	VirtualImageDimension = VirtualImageType::ImageDimension

Static Public Attributes inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
static const DimensionType	FixedImageDimension = Superclass::FixedDimension

static const DimensionType	MovingImageDimension = Superclass::MovingDimension

static const DimensionType	VirtualImageDimension = Superclass::VirtualDimension

Static Public Attributes inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >
static const DimensionType	FixedDimension

static const DimensionType	MovingDimension

static const DimensionType	VirtualDimension

Protected Types
typedef ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader < ThreadedImageRegionPartitioner < VirtualImageDimension > , Superclass, Self >	ANTSNeighborhoodCorrelationImageToImageMetricv4DenseGetValueAndDerivativeThreaderType

typedef ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader < ThreadedIndexedContainerPartitioner, Superclass, Self >	ANTSNeighborhoodCorrelationImageToImageMetricv4SparseGetValueAndDerivativeThreaderType

Protected Types inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
typedef LinearInterpolateImageFunction < FixedImageGradientImageType, CoordinateRepresentationType >	FixedImageGradientInterpolatorType

typedef LinearInterpolateImageFunction < MovingImageGradientImageType, CoordinateRepresentationType >	MovingImageGradientInterpolatorType

Protected Member Functions
	ANTSNeighborhoodCorrelationImageToImageMetricv4 ()

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

virtual	~ANTSNeighborhoodCorrelationImageToImageMetricv4 ()

Protected Member Functions inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
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

virtual	~ImageToImageMetricv4 ()

virtual void	InitializeDefaultFixedImageGradientFilter ()

virtual void	InitializeDefaultMovingImageGradientFilter ()

Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >
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

virtual	~ObjectToObjectMetric ()

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

virtual	~ObjectToObjectMetricBaseTemplate ()

Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
	SingleValuedCostFunctionv4Template ()

virtual	~SingleValuedCostFunctionv4Template ()

Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
	CostFunctionTemplate ()

virtual	~CostFunctionTemplate ()

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
	ANTSNeighborhoodCorrelationImageToImageMetricv4 (const Self &)

void	operator= (const Self &)

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, TVirtualImage, TInternalComputationValueType, TMetricTraits >
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_UseFixedSampledPointSet

bool	m_UseMovingImageGradientFilter

VirtualPointSetPointer	m_VirtualSampledPointSet

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

MovingTransformPointer	m_MovingTransform

SizeValueType	m_NumberOfValidPoints

bool	m_UserHasSetVirtualDomain

VirtualImagePointer	m_VirtualImage

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

GradientSourceType	m_GradientSource

ObjectConstPointer	m_MovingObject

MeasureType	m_Value

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