#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 see [6] for more details.

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 89 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	DerivativeValueType

using	FixedImageGradientType

using	FixedImageJacobianType = typename FixedTransformType::JacobianType

using	FixedImagePixelType

using	FixedImagePointType

using	FixedImageType

using	FixedTransformJacobianType = typename Superclass::FixedTransformType::JacobianType

using	ImageDimensionType

using	ImageRegionType = typename VirtualImageType::RegionType

using	IndexType = typename VirtualImageType::IndexType

using	MovingImageGradientType

using	MovingImageJacobianType = typename MovingTransformType::JacobianType

using	MovingImagePixelType

using	MovingImagePointType

using	MovingImageType

using	MovingTransformJacobianType = typename Superclass::MovingTransformType::JacobianType

using	Pointer = SmartPointer<Self>

using	RadiusType = typename VirtualImageType::SizeType

using	Self = ANTSNeighborhoodCorrelationImageToImageMetricv4

using	Superclass

using	VirtualImageGradientType

using	VirtualImageType = typename Superclass::VirtualImageType

Public Types inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
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

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

typedef itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource	GradientSourceEnum

using	ImageDimensionType = typename Superclass::DimensionType

using	InternalComputationValueType = TInternalComputationValueType

using	MetricTraits = TMetricTraits

using	MovingGradientPixelType = typename MetricTraits::MovingGradientPixelType

using	MovingImageComponentGradientType

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

typedef unsigned int	NumberOfParametersType

using	ObjectType = typename Superclass::ObjectType

using	Pointer = SmartPointer<Self>

using	Self = ImageToImageMetricv4

using	Superclass

using	VirtualImageComponentGradientType

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

using	CoordinateRepresentationType

typedef typename DerivativeType::ValueType	DerivativeValueType

using	DerivativeValueType

using	DimensionType

using	FixedInputPointType

using	FixedOutputPointType

using	FixedTransformJacobianType

using	FixedTransformParametersType

using	FixedTransformPointer

using	FixedTransformType

typedef itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource	GradientSourceEnum

using	GradientSourceEnum

using	InternalComputationValueType

using	JacobianType

using	MetricCategoryType

using	MovingDisplacementFieldTransformType

using	MovingInputPointType

using	MovingOutputPointType

using	MovingTransformJacobianType

using	MovingTransformParametersType

using	MovingTransformPointer

using	MovingTransformType

typedef unsigned int	NumberOfParametersType

using	NumberOfParametersType

using	ObjectType

using	Pointer

using	Self

using	Superclass

using	VirtualDirectionType

using	VirtualImageConstPointer

using	VirtualImagePointer

using	VirtualImageType

using	VirtualIndexType

using	VirtualOriginType

using	VirtualPixelType

using	VirtualPointSetPointer

using	VirtualPointSetType

using	VirtualPointType

using	VirtualRadiusType

using	VirtualRegionType

using	VirtualSizeType

using	VirtualSpacingType

Public Types inherited from itk::ObjectToObjectMetricBaseTemplate< double >
using	ConstPointer

using	CoordinateRepresentationType

typedef Array< double >	DerivativeType

using	DerivativeType

using	DerivativeValueType

using	GradientSourceEnum

typedef double	MeasureType

using	MeasureType

using	MetricCategoryEnum

using	NumberOfParametersType

using	ObjectConstPointer

using	ObjectType

using	ParametersValueType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::SingleValuedCostFunctionv4Template< double >
using	ConstPointer

using	DerivativeType

using	MeasureType

typedef OptimizerParameters< double >	ParametersType

using	ParametersType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::CostFunctionTemplate< double >
using	ConstPointer

using	ParametersType

using	ParametersValueType

using	Pointer

using	Self

using	Superclass

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
virtual::itk::LightObject::Pointer	CreateAnother () const

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, TVirtualImage, TInternalComputationValueType, TMetricTraits >
virtual void	FinalizeThread (const ThreadIdType)

void	GetDerivative (DerivativeType &) const override

virtual const FixedImageType *	GetFixedImage () const

virtual const FixedImageGradientImageType *	GetFixedImageGradientImage () const

virtual const FixedInterpolatorType *	GetFixedInterpolator () const

MetricCategoryType	GetMetricCategory () const override

virtual FixedImageGradientImageType *	GetModifiableFixedImageGradientImage ()

virtual FixedInterpolatorType *	GetModifiableFixedInterpolator ()

virtual MovingImageGradientImageType *	GetModifiableMovingImageGradientImage ()

virtual MovingInterpolatorType *	GetModifiableMovingInterpolator ()

virtual const MovingImageGradientImageType *	GetMovingImageGradientImage () const

virtual const MovingInterpolatorType *	GetMovingInterpolator () const

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

virtual void	SetUseVirtualSampledPointSet (bool _arg)

virtual const bool &	GetUseVirtualSampledPointSet () const

virtual void	UseVirtualSampledPointSetOn ()

virtual void	UseVirtualSampledPointSetOff ()

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	SetMaximumNumberOfWorkUnits (const ThreadIdType number)

virtual ThreadIdType	GetMaximumNumberOfWorkUnits () 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, TFixedImage, double >
OffsetValueType	ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const

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

virtual const FixedTransformType *	GetFixedTransform () const

MetricCategoryType	GetMetricCategory () const override

virtual FixedTransformType *	GetModifiableFixedTransform ()

virtual MovingTransformType *	GetModifiableMovingTransform ()

virtual VirtualImageType *	GetModifiableVirtualImage ()

virtual const MovingTransformType *	GetMovingTransform () const

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

virtual const VirtualImageType *	GetVirtualImage () 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)

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

MeasureType	GetCurrentValue () const

virtual GradientSourceEnum	GetGradientSource () const

virtual GradientSourceEnum	GetGradientSource () const

bool	GetGradientSourceIncludesFixed () const

bool	GetGradientSourceIncludesFixed () const

bool	GetGradientSourceIncludesMoving () const

bool	GetGradientSourceIncludesMoving () const

const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

virtual void	SetGradientSource (GradientSourceEnum _arg)

virtual void	SetGradientSource (GradientSourceEnum _arg)

virtual void	SetFixedObject (const ObjectType *_arg)

virtual const ObjectType *	GetFixedObject () const

virtual void	SetFixedObject (const ObjectType *_arg)

virtual const ObjectType *	GetFixedObject () const

virtual void	SetMovingObject (const ObjectType *_arg)

virtual const ObjectType *	GetMovingObject () const

virtual void	SetMovingObject (const ObjectType *_arg)

virtual const ObjectType *	GetMovingObject () const

Public Member Functions inherited from itk::SingleValuedCostFunctionv4Template< double >
const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

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

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

virtual int	GetReferenceCount () const

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 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, TVirtualImage, TInternalComputationValueType, TMetricTraits >
static constexpr DimensionType	FixedImageDimension = Superclass::FixedDimension

static constexpr DimensionType	MovingImageDimension = Superclass::MovingDimension

static constexpr DimensionType	VirtualImageDimension = Superclass::VirtualDimension

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

using	ANTSNeighborhoodCorrelationImageToImageMetricv4SparseGetValueAndDerivativeThreaderType

Protected Types inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
using	FixedImageGradientInterpolatorType

using	MovingImageGradientInterpolatorType

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, 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

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

	ObjectToObjectMetricBaseTemplate ()

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

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

	~ObjectToObjectMetricBaseTemplate () override=default

	~ObjectToObjectMetricBaseTemplate () override=default

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

	SingleValuedCostFunctionv4Template ()=default

	~SingleValuedCostFunctionv4Template () override=default

	~SingleValuedCostFunctionv4Template () override=default

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

	CostFunctionTemplate ()=default

	~CostFunctionTemplate () override=default

	~CostFunctionTemplate () override=default

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

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

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	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, 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_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

ObjectConstPointer	m_FixedObject

GradientSourceEnum	m_GradientSource

GradientSourceEnum	m_GradientSource

ObjectConstPointer	m_MovingObject

ObjectConstPointer	m_MovingObject

MeasureType	m_Value

MeasureType	m_Value

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

Member Typedef Documentation

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4DenseGetValueAndDerivativeThreaderType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::ANTSNeighborhoodCorrelationImageToImageMetricv4DenseGetValueAndDerivativeThreaderType

protected

Initial value:

 
    ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader<
      ThreadedImageRegionPartitioner<VirtualImageDimension>,
      Superclass,
      Self>

Definition at line 170 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4SparseGetValueAndDerivativeThreaderType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::ANTSNeighborhoodCorrelationImageToImageMetricv4SparseGetValueAndDerivativeThreaderType

protected

Initial value:

 
    ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader<ThreadedIndexedContainerPartitioner,
                                                                                 Superclass,
                                                                                 Self>

Definition at line 180 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ ConstPointer

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::ConstPointer = SmartPointer<const Self>

Definition at line 100 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ DerivativeValueType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeValueType

Definition at line 356 of file itkImageToImageMetricv4.h.

◆ FixedImageGradientType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImageGradientType

Image derivatives types

Definition at line 297 of file itkImageToImageMetricv4.h.

◆ FixedImageJacobianType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImageJacobianType = typename FixedTransformType::JacobianType

Definition at line 117 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ FixedImagePixelType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImagePixelType

Definition at line 235 of file itkImageToImageMetricv4.h.

◆ FixedImagePointType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImagePointType

Definition at line 239 of file itkImageToImageMetricv4.h.

◆ FixedImageType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImageType

Image-accessor type alias

Definition at line 234 of file itkImageToImageMetricv4.h.

◆ FixedTransformJacobianType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedTransformJacobianType = typename Superclass::FixedTransformType::JacobianType

Definition at line 134 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ ImageDimensionType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::ImageDimensionType

Definition at line 212 of file itkImageToImageMetricv4.h.

◆ ImageRegionType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::ImageRegionType = typename VirtualImageType::RegionType

Definition at line 140 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ IndexType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::IndexType = typename VirtualImageType::IndexType

Definition at line 142 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ MovingImageGradientType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImageGradientType

Definition at line 298 of file itkImageToImageMetricv4.h.

◆ MovingImageJacobianType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImageJacobianType = typename MovingTransformType::JacobianType

Definition at line 123 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ MovingImagePixelType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImagePixelType

Definition at line 242 of file itkImageToImageMetricv4.h.

◆ MovingImagePointType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImagePointType

Definition at line 246 of file itkImageToImageMetricv4.h.

◆ MovingImageType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImageType

Definition at line 241 of file itkImageToImageMetricv4.h.

◆ MovingTransformJacobianType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingTransformJacobianType = typename Superclass::MovingTransformType::JacobianType

Definition at line 135 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ Pointer

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::Pointer = SmartPointer<Self>

Definition at line 99 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ RadiusType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::RadiusType = typename VirtualImageType::SizeType

Definition at line 141 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ Self

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::Self = ANTSNeighborhoodCorrelationImageToImageMetricv4

Standard class type aliases.

Definition at line 96 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ Superclass

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::Superclass

Initial value:

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

itk::ImageToImageMetricv4::ImageToImageMetricv4

ImageToImageMetricv4()

Definition at line 97 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ VirtualImageGradientType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::VirtualImageGradientType

Definition at line 299 of file itkImageToImageMetricv4.h.

◆ VirtualImageType

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

using itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::VirtualImageType = typename Superclass::VirtualImageType

Definition at line 130 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

Constructor & Destructor Documentation

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::ANTSNeighborhoodCorrelationImageToImageMetricv4 ( )

protected

Referenced by ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Superclass, Self >, and GetNameOfClass().

◆ ~ANTSNeighborhoodCorrelationImageToImageMetricv4()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::~ANTSNeighborhoodCorrelationImageToImageMetricv4 ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

virtual::itk::LightObject::Pointer itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::CreateAnother ( ) const

virtual

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

Reimplemented from itk::LightObject.

◆ GetNameOfClass()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

const char * itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References ANTSNeighborhoodCorrelationImageToImageMetricv4().

◆ GetRadius() [1/2]

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

virtual RadiusType itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::GetRadius ( )

virtual

◆ GetRadius() [2/2]

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

virtual RadiusType itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::GetRadius ( ) const

virtual

◆ Initialize()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

void itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::Initialize ( )

overridevirtual

Initialize the Metric by making sure that all the components are present and plugged together correctly, and initializing internal variables as required. This is for one-time initialization, e.g. before starting an optimization process.

Implements itk::ObjectToObjectMetricBaseTemplate< double >.

◆ New()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

static Pointer itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

void itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightObject.

◆ SetRadius()

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

virtual void itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::SetRadius ( RadiusType _arg )

virtual

Friends And Related Symbol Documentation

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Superclass, Self >

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

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

friend

Definition at line 164 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

References ANTSNeighborhoodCorrelationImageToImageMetricv4(), and VirtualImageDimension.

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

friend class ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

friend

Definition at line 164 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

Member Data Documentation

◆ FixedImageDimension

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

ImageDimensionType itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImageDimension = FixedImageType::ImageDimension

staticconstexpr

Definition at line 145 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ m_Radius

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

RadiusType itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::m_Radius {}

private

Definition at line 190 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ MovingImageDimension

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

ImageDimensionType itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImageDimension = MovingImageType::ImageDimension

staticconstexpr

Definition at line 147 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

◆ VirtualImageDimension

template<typename TFixedImage, typename TMovingImage, typename TVirtualImage = TFixedImage, typename TInternalComputationValueType = double, typename TMetricTraits = DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>

ImageDimensionType itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::VirtualImageDimension = VirtualImageType::ImageDimension

staticconstexpr

Definition at line 149 of file itkANTSNeighborhoodCorrelationImageToImageMetricv4.h.

Referenced by ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Superclass, Self >.

The documentation for this class was generated from the following file:

itkANTSNeighborhoodCorrelationImageToImageMetricv4.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4DenseGetValueAndDerivativeThreaderType

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4SparseGetValueAndDerivativeThreaderType

◆ ConstPointer

◆ DerivativeValueType

◆ FixedImageGradientType

◆ FixedImageJacobianType

◆ FixedImagePixelType

◆ FixedImagePointType

◆ FixedImageType

◆ FixedTransformJacobianType

◆ ImageDimensionType

◆ ImageRegionType

◆ IndexType

◆ MovingImageGradientType

◆ MovingImageJacobianType

◆ MovingImagePixelType

◆ MovingImagePointType

◆ MovingImageType

◆ MovingTransformJacobianType

◆ Pointer

◆ RadiusType

◆ Self

◆ Superclass

◆ VirtualImageGradientType

◆ VirtualImageType

Constructor & Destructor Documentation

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4()

◆ ~ANTSNeighborhoodCorrelationImageToImageMetricv4()

Member Function Documentation

◆ CreateAnother()

◆ GetNameOfClass()

◆ GetRadius() [1/2]

◆ GetRadius() [2/2]

◆ Initialize()

◆ New()

◆ PrintSelf()

◆ SetRadius()

Friends And Related Symbol Documentation

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Superclass, Self >

◆ ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

Member Data Documentation

◆ FixedImageDimension

◆ m_Radius

◆ MovingImageDimension

◆ VirtualImageDimension