#include <itkCorrelationImageToImageMetricv4.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename Superclass::DerivativeType

using	FixedImageGradientType = typename Superclass::FixedImageGradientType

using	FixedImagePixelType = typename Superclass::FixedImagePixelType

using	FixedImagePointType = typename Superclass::FixedImagePointType

using	JacobianType = typename Superclass::JacobianType

using	MeasureType = typename Superclass::MeasureType

using	MovingImageGradientType = typename Superclass::MovingImageGradientType

using	MovingImagePixelType = typename Superclass::MovingImagePixelType

using	MovingImagePointType = typename Superclass::MovingImagePointType

using	MovingTransformType = typename Superclass::MovingTransformType

using	Pointer = SmartPointer< Self >

using	Self = CorrelationImageToImageMetricv4

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

using	VirtualImageType = typename Superclass::VirtualImageType

using	VirtualIndexType = typename Superclass::VirtualIndexType

using	VirtualPointSetType = typename Superclass::VirtualPointSetType

using	VirtualPointType = typename Superclass::VirtualPointType

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

using	CoordinateRepresentationType = typename Superclass::CoordinateRepresentationType

using	DefaultFixedImageGradientCalculator = typename MetricTraits::DefaultFixedImageGradientCalculator

using	DefaultFixedImageGradientFilter = typename MetricTraits::DefaultFixedImageGradientFilter

using	DefaultMovingImageGradientCalculator = typename MetricTraits::DefaultMovingImageGradientCalculator

using	DefaultMovingImageGradientFilter = typename MetricTraits::DefaultMovingImageGradientFilter

using	DerivativeType = typename Superclass::DerivativeType

using	DerivativeValueType = typename DerivativeType::ValueType

using	DimensionType = typename Superclass::DimensionType

using	FixedGradientPixelType = typename MetricTraits::FixedGradientPixelType

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

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImageGradientCalculatorPointer = typename FixedImageGradientCalculatorType::Pointer

using	FixedImageGradientCalculatorType = typename MetricTraits::FixedImageGradientCalculatorType

using	FixedImageGradientFilterPointer = typename FixedImageGradientFilterType::Pointer

using	FixedImageGradientFilterType = typename MetricTraits::FixedImageGradientFilterType

using	FixedImageGradientImagePointer = typename FixedImageGradientImageType::Pointer

using	FixedImageGradientImageType = typename MetricTraits::FixedImageGradientImageType

using	FixedImageGradientType = typename MetricTraits::FixedImageGradientType

using	FixedImageIndexType = typename FixedImageType::IndexType

using	FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer

using	FixedImageMaskPointer = typename FixedImageMaskType::Pointer

using	FixedImageMaskType = SpatialObject< Self::FixedImageDimension >

using	FixedImagePixelType = typename FixedImageType::PixelType

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImagePointType = typename FixedImageType::PointType

using	FixedImageType = TFixedImage

using	FixedInputPointType = typename Superclass::FixedInputPointType

using	FixedInterpolatorPointer = typename FixedInterpolatorType::Pointer

using	FixedInterpolatorType = InterpolateImageFunction< FixedImageType, CoordinateRepresentationType >

using	FixedOutputPointType = typename Superclass::FixedOutputPointType

using	FixedPixelType = FixedImagePixelType

using	FixedRealType = typename MetricTraits::FixedRealType

using	FixedSampledPointSetConstPointer = typename FixedSampledPointSetType::ConstPointer

using	FixedSampledPointSetPointer = typename FixedSampledPointSetType::Pointer

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

using	FixedScalarRealType = typename NumericTraits< FixedRealType >::ScalarRealType

using	FixedTransformJacobianType = typename Superclass::FixedTransformJacobianType

using	FixedTransformParametersType = typename Superclass::FixedTransformParametersType

using	FixedTransformPointer = typename Superclass::FixedTransformPointer

using	FixedTransformType = typename Superclass::FixedTransformType

using	GradientSourceEnum = typename Superclass::GradientSourceEnum

using	ImageDimensionType = typename Superclass::DimensionType

using	InternalComputationValueType = TInternalComputationValueType

using	JacobianType = typename Superclass::JacobianType

using	MeasureType = typename Superclass::MeasureType

using	MetricTraits = TMetricTraits

using	MovingGradientPixelType = typename MetricTraits::MovingGradientPixelType

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

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImageGradientCalculatorPointer = typename MovingImageGradientCalculatorType::Pointer

using	MovingImageGradientCalculatorType = typename MetricTraits::MovingImageGradientCalculatorType

using	MovingImageGradientFilterPointer = typename MovingImageGradientFilterType::Pointer

using	MovingImageGradientFilterType = typename MetricTraits::MovingImageGradientFilterType

using	MovingImageGradientImagePointer = typename MovingImageGradientImageType::Pointer

using	MovingImageGradientImageType = typename MetricTraits::MovingImageGradientImageType

using	MovingImageGradientType = typename MetricTraits::MovingImageGradientType

using	MovingImageIndexType = typename MovingImageType::IndexType

using	MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer

using	MovingImageMaskPointer = typename MovingImageMaskType::Pointer

using	MovingImageMaskType = SpatialObject< Self::MovingImageDimension >

using	MovingImagePixelType = typename MovingImageType::PixelType

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImagePointType = typename MovingImageType::PointType

using	MovingImageRegionType = typename MovingImageType::RegionType

using	MovingImageType = TMovingImage

using	MovingInputPointType = typename Superclass::MovingInputPointType

using	MovingInterpolatorPointer = typename MovingInterpolatorType::Pointer

using	MovingInterpolatorType = InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >

using	MovingOutputPointType = typename Superclass::MovingOutputPointType

using	MovingPixelType = MovingImagePixelType

using	MovingRealType = typename MetricTraits::MovingRealType

using	MovingScalarRealType = typename NumericTraits< MovingRealType >::ScalarRealType

using	MovingTransformJacobianType = typename Superclass::MovingTransformJacobianType

using	MovingTransformParametersType = typename Superclass::MovingTransformParametersType

using	MovingTransformPointer = typename Superclass::MovingTransformPointer

using	MovingTransformType = typename Superclass::MovingTransformType

using	NumberOfParametersType = typename Superclass::NumberOfParametersType

using	ObjectType = typename Superclass::ObjectType

using	ParametersType = typename Superclass::ParametersType

using	ParametersValueType = typename Superclass::ParametersValueType

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageMetricv4

using	Superclass = ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >

using	VirtualDirectionType = typename Superclass::VirtualDirectionType

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

using	VirtualImageGradientType = typename MetricTraits::VirtualImageGradientType

using	VirtualImagePointer = typename Superclass::VirtualImagePointer

using	VirtualImageType = typename Superclass::VirtualImageType

using	VirtualIndexType = typename Superclass::VirtualIndexType

using	VirtualOriginType = typename Superclass::VirtualPointType

using	VirtualPixelType = typename Superclass::VirtualPixelType

using	VirtualPointSetPointer = typename Superclass::VirtualPointSetPointer

using	VirtualPointSetType = typename Superclass::VirtualPointSetType

using	VirtualPointType = typename Superclass::VirtualPointType

using	VirtualRadiusType = typename Superclass::VirtualSizeType

using	VirtualRegionType = typename Superclass::VirtualRegionType

using	VirtualSizeType = typename Superclass::VirtualSizeType

using	VirtualSpacingType = typename Superclass::VirtualSpacingType

using	MetricCategoryType = typename Superclass::MetricCategoryType

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

using	CoordinateRepresentationType = TInternalComputationValueType

using	DerivativeType = typename Superclass::DerivativeType

using	DerivativeValueType = typename Superclass::DerivativeValueType

using	DimensionType = SizeValueType

using	FixedInputPointType = typename FixedTransformType::InputPointType

using	FixedOutputPointType = typename FixedTransformType::OutputPointType

using	FixedTransformJacobianType = typename FixedTransformType::JacobianType

using	FixedTransformParametersType = typename FixedTransformType::ParametersType

using	FixedTransformPointer = typename FixedTransformType::Pointer

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

using	GradientSourceEnum = typename Superclass::GradientSourceEnum

using	InternalComputationValueType = TInternalComputationValueType

using	JacobianType = typename FixedTransformType::JacobianType

using	MeasureType = typename Superclass::MeasureType

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

using	MovingInputPointType = typename MovingTransformType::InputPointType

using	MovingOutputPointType = typename MovingTransformType::OutputPointType

using	MovingTransformJacobianType = typename MovingTransformType::JacobianType

using	MovingTransformParametersType = typename MovingTransformType::ParametersType

using	MovingTransformPointer = typename MovingTransformType::Pointer

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

using	NumberOfParametersType = typename Superclass::NumberOfParametersType

using	ObjectType = typename Superclass::Object

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = ObjectToObjectMetric

using	Superclass = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >

using	VirtualDirectionType = typename VirtualImageType::DirectionType

using	VirtualImageConstPointer = typename VirtualImageType::ConstPointer

using	VirtualImagePointer = typename VirtualImageType::Pointer

using	VirtualImageType = TVirtualImage

using	VirtualIndexType = typename VirtualImageType::IndexType

using	VirtualOriginType = typename VirtualImageType::PointType

using	VirtualPixelType = typename VirtualImageType::PixelType

using	VirtualPointSetPointer = typename VirtualPointSetType::Pointer

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

using	VirtualPointType = typename VirtualImageType::PointType

using	VirtualRadiusType = typename VirtualImageType::SizeType

using	VirtualRegionType = typename VirtualImageType::RegionType

using	VirtualSizeType = typename VirtualRegionType::SizeType

using	VirtualSpacingType = typename VirtualImageType::SpacingType

using	MetricCategoryType = typename Superclass::MetricCategoryEnum

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

using	CoordinateRepresentationType = TInternalComputationValueType

using	DerivativeType = typename Superclass::DerivativeType

using	DerivativeValueType = typename DerivativeType::ValueType

using	MeasureType = typename Superclass::MeasureType

using	ObjectConstPointer = typename ObjectType::ConstPointer

using	ObjectType = Object

using	ParametersType = typename Superclass::ParametersType

using	ParametersValueType = TInternalComputationValueType

using	Pointer = SmartPointer< Self >

using	Self = ObjectToObjectMetricBaseTemplate

using	Superclass = SingleValuedCostFunctionv4Template< TInternalComputationValueType >

using	GradientSourceEnum = itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource

using	NumberOfParametersType = unsigned int

using	MetricCategoryEnum = itk::ObjectToObjectMetricBaseTemplateEnums::MetricCategory

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

using	DerivativeType = Array< TInternalComputationValueType >

using	MeasureType = TInternalComputationValueType

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = SingleValuedCostFunctionv4Template

using	Superclass = CostFunctionTemplate< TInternalComputationValueType >

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

using	ParametersType = OptimizerParameters< TInternalComputationValueType >

using	ParametersValueType = TInternalComputationValueType

using	Pointer = SmartPointer< Self >

using	Self = CostFunctionTemplate

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
void	SetFixedObject (const ObjectType *object) override

void	SetMovingObject (const ObjectType *object) override

virtual void	SetFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetFixedImage () const

virtual void	SetMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetMovingImage () const

virtual void	SetFixedInterpolator (FixedInterpolatorType *_arg)

virtual FixedInterpolatorType *	GetModifiableFixedInterpolator ()

virtual const FixedInterpolatorType *	GetFixedInterpolator () const

virtual void	SetMovingInterpolator (MovingInterpolatorType *_arg)

virtual MovingInterpolatorType *	GetModifiableMovingInterpolator ()

virtual const MovingInterpolatorType *	GetMovingInterpolator () 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	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 ThreadIdType	GetNumberOfWorkUnitsUsed () const

virtual void	SetMaximumNumberOfWorkUnits (const ThreadIdType number)

virtual ThreadIdType	GetMaximumNumberOfWorkUnits () const

virtual void	FinalizeThread (const ThreadIdType)

virtual FixedImageGradientImageType *	GetModifiableFixedImageGradientImage ()

virtual const FixedImageGradientImageType *	GetFixedImageGradientImage () const

virtual MovingImageGradientImageType *	GetModifiableMovingImageGradientImage ()

virtual const MovingImageGradientImageType *	GetMovingImageGradientImage () const

SizeValueType	GetNumberOfValidPoints () const override

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

void	Initialize () override

MeasureType	GetValue () const override

void	GetDerivative (DerivativeType &) const override

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

virtual const SizeValueType &	GetNumberOfSkippedFixedSampledPoints () const

bool	SupportsArbitraryVirtualDomainSamples () const override

MetricCategoryType	GetMetricCategory () const override

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

NumberOfParametersType	GetNumberOfLocalParameters () const override

NumberOfParametersType	GetNumberOfParameters () const override

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, TInternalComputationValueType factor) override

bool	IsInsideVirtualDomain (const VirtualPointType &point) const

bool	IsInsideVirtualDomain (const VirtualIndexType &index) const

MetricCategoryType	GetMetricCategory () const override

Public Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
virtual const ObjectType *	GetFixedObject () const

virtual const ObjectType *	GetMovingObject () const

virtual void	SetGradientSource (GradientSourceEnum _arg)

virtual GradientSourceEnum	GetGradientSource () const

bool	GetGradientSourceIncludesFixed () const

bool	GetGradientSourceIncludesMoving () const

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

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 TFixedImage::ImageDimensionType	FixedImageDimension = TFixedImage::ImageDimension

static constexpr TMovingImage::ImageDimensionType	MovingImageDimension = TMovingImage::ImageDimension

static constexpr TVirtualImage::ImageDimensionType	VirtualImageDimension = TVirtualImage::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, TVirtualImage, TInternalComputationValueType >
static constexpr DimensionType	FixedDimension

static constexpr DimensionType	MovingDimension

static constexpr DimensionType	VirtualDimension

Protected Types
using	CorrelationDenseGetValueAndDerivativeThreaderType = CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

using	CorrelationHelperDenseThreaderType = CorrelationImageToImageMetricv4HelperThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

using	CorrelationHelperSparseThreaderType = CorrelationImageToImageMetricv4HelperThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

using	CorrelationSparseGetValueAndDerivativeThreaderType = CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

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

using	MovingImageGradientInterpolatorType = LinearInterpolateImageFunction< MovingImageGradientImageType, CoordinateRepresentationType >

Protected Member Functions
	CorrelationImageToImageMetricv4 ()

void	InitializeForIteration () const override

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

	~CorrelationImageToImageMetricv4 () override=default

Protected Member Functions inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
bool	TransformAndEvaluateFixedPoint (const VirtualPointType &virtualPoint, FixedImagePointType &mappedFixedPoint, FixedImagePixelType &mappedFixedPixelValue) const

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

virtual void	ComputeFixedImageGradientAtPoint (const FixedImagePointType &mappedPoint, FixedImageGradientType &gradient) const

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

virtual void	ComputeFixedImageGradientFilterImage ()

virtual void	ComputeMovingImageGradientFilterImage () const

virtual void	GetValueAndDerivativeExecute () const

virtual void	InitializeDefaultFixedImageGradientFilter ()

virtual void	InitializeDefaultMovingImageGradientFilter ()

virtual bool	GetComputeDerivative () const

	ImageToImageMetricv4 ()

	~ImageToImageMetricv4 () override=default

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

Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >
	ObjectToObjectMetric ()

	~ObjectToObjectMetric () override=default

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

virtual void	VerifyDisplacementFieldSizeAndPhysicalSpace ()

bool	TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const

void	TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const

const MovingDisplacementFieldTransformType *	GetMovingDisplacementFieldTransform () const

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

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

	~ObjectToObjectMetricBaseTemplate () override=default

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

	~SingleValuedCostFunctionv4Template () override=default

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

	~CostFunctionTemplate () override=default

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Protected Attributes
MeasureType	m_AverageFix

MeasureType	m_AverageMov

CorrelationHelperDenseThreaderType::Pointer	m_HelperDenseThreader

CorrelationHelperSparseThreaderType::Pointer	m_HelperSparseThreader

Protected Attributes inherited from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >
ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< VirtualImageDimension >, Self >::Pointer	m_DenseGetValueAndDerivativeThreader

ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Self >::Pointer	m_SparseGetValueAndDerivativeThreader

FixedImageConstPointer	m_FixedImage

MovingImageConstPointer	m_MovingImage

FixedInterpolatorPointer	m_FixedInterpolator

MovingInterpolatorPointer	m_MovingInterpolator

FixedImageGradientInterpolatorType::Pointer	m_FixedImageGradientInterpolator

MovingImageGradientInterpolatorType::Pointer	m_MovingImageGradientInterpolator

bool	m_UseFixedImageGradientFilter

bool	m_UseMovingImageGradientFilter

FixedImageGradientFilterPointer	m_FixedImageGradientFilter

MovingImageGradientFilterPointer	m_MovingImageGradientFilter

DefaultFixedImageGradientFilter::Pointer	m_DefaultFixedImageGradientFilter

DefaultMovingImageGradientFilter::Pointer	m_DefaultMovingImageGradientFilter

DefaultFixedImageGradientCalculator::Pointer	m_DefaultFixedImageGradientCalculator

DefaultMovingImageGradientCalculator::Pointer	m_DefaultMovingImageGradientCalculator

FixedImageGradientImagePointer	m_FixedImageGradientImage

MovingImageGradientImagePointer	m_MovingImageGradientImage

FixedImageGradientCalculatorPointer	m_FixedImageGradientCalculator

MovingImageGradientCalculatorPointer	m_MovingImageGradientCalculator

DerivativeType *	m_DerivativeResult

FixedImageMaskConstPointer	m_FixedImageMask

MovingImageMaskConstPointer	m_MovingImageMask

FixedSampledPointSetConstPointer	m_FixedSampledPointSet

VirtualPointSetPointer	m_VirtualSampledPointSet

bool	m_UseSampledPointSet

bool	m_UseVirtualSampledPointSet

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

MovingTransformPointer	m_MovingTransform

VirtualImagePointer	m_VirtualImage

bool	m_UserHasSetVirtualDomain

SizeValueType	m_NumberOfValidPoints

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

ObjectConstPointer	m_MovingObject

GradientSourceEnum	m_GradientSource

MeasureType	m_Value

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

Friends
class	CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

class	CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

class	CorrelationImageToImageMetricv4HelperThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

class	CorrelationImageToImageMetricv4HelperThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

class	ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

class	ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Self >

class	ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

class	ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedIndexedContainerPartitioner, Self >

Detailed Description

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

Class implementing normalized cross correlation image metric.

Definition of the normalized cross correlation metric used here:

negative square of normalized cross correlation

$C(f, m) = -\frac{<f-\bar{f}, m-\bar{m} >^2}{|f-\bar{f}|^2 |m-\bar{m}|^2}$

in which, f, m are the vectors of image pixel intensities, $\bar{f}$ and $\bar{m}$ are the mean values of f and m. <,> denotes inner product, $|\cdot|$ denotes the 2-norm of the vector. The minus sign makes the metric to optimize towards its minimal value. Note that this uses the square of the mathematical notion of normalized cross correlation to avoid the square root computation in practice.

Moving image (m) is a function of the parameters (p) of the moving transforms. So $ C(f, m) = C(f, m(p)) $ GetValueAndDerivative will return the value as $ C(f,m) $ and the derivative as

$\frac{d}{dp} C = 2 \frac{<f1, m1>}{|f1|^2 |m1|^2} * ( <f1, \frac{dm}{dp}> - \frac{<f1, m1>}{|m1|^2} < m1, \frac{dm}{dp} > )$

in which, $f1 = f - \bar{f}$ , $m1 = m - \bar{m}$ (Note: there should be a minus sign of $\frac{d}{dp}$ mathematically, which is not in the implementation to match the requirement of the metricv4 optimization framework.

See CorrelationImageToImageMetricv4GetValueAndDerivativeThreader::ProcessPoint for algorithm implementation.

This metric only works with the global transform. It throws an exception if the transform has local support.

Examples: Examples/RegistrationITKv4/DeformableRegistration4.cxx.

Definition at line 78 of file itkCorrelationImageToImageMetricv4.h.

Member Typedef Documentation

◆ ConstPointer

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

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

Definition at line 89 of file itkCorrelationImageToImageMetricv4.h.

◆ CorrelationDenseGetValueAndDerivativeThreaderType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::CorrelationDenseGetValueAndDerivativeThreaderType = CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner<Superclass::VirtualImageDimension>, Superclass, Self>

protected

Definition at line 152 of file itkCorrelationImageToImageMetricv4.h.

◆ CorrelationHelperDenseThreaderType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::CorrelationHelperDenseThreaderType = CorrelationImageToImageMetricv4HelperThreader<ThreadedImageRegionPartitioner<Superclass::VirtualImageDimension>, Superclass, Self>

protected

Definition at line 165 of file itkCorrelationImageToImageMetricv4.h.

◆ CorrelationHelperSparseThreaderType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::CorrelationHelperSparseThreaderType = CorrelationImageToImageMetricv4HelperThreader<ThreadedIndexedContainerPartitioner, Superclass, Self>

protected

Definition at line 167 of file itkCorrelationImageToImageMetricv4.h.

◆ CorrelationSparseGetValueAndDerivativeThreaderType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::CorrelationSparseGetValueAndDerivativeThreaderType = CorrelationImageToImageMetricv4GetValueAndDerivativeThreader<ThreadedIndexedContainerPartitioner, Superclass, Self>

protected

Definition at line 154 of file itkCorrelationImageToImageMetricv4.h.

◆ DerivativeType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::DerivativeType = typename Superclass::DerivativeType

Definition at line 99 of file itkCorrelationImageToImageMetricv4.h.

◆ FixedImageGradientType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImageGradientType = typename Superclass::FixedImageGradientType

Definition at line 103 of file itkCorrelationImageToImageMetricv4.h.

◆ FixedImagePixelType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImagePixelType = typename Superclass::FixedImagePixelType

Definition at line 102 of file itkCorrelationImageToImageMetricv4.h.

◆ FixedImagePointType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImagePointType = typename Superclass::FixedImagePointType

Definition at line 101 of file itkCorrelationImageToImageMetricv4.h.

◆ JacobianType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::JacobianType = typename Superclass::JacobianType

Definition at line 110 of file itkCorrelationImageToImageMetricv4.h.

◆ MeasureType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MeasureType = typename Superclass::MeasureType

Superclass types

Definition at line 98 of file itkCorrelationImageToImageMetricv4.h.

◆ MovingImageGradientType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImageGradientType = typename Superclass::MovingImageGradientType

Definition at line 107 of file itkCorrelationImageToImageMetricv4.h.

◆ MovingImagePixelType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImagePixelType = typename Superclass::MovingImagePixelType

Definition at line 106 of file itkCorrelationImageToImageMetricv4.h.

◆ MovingImagePointType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImagePointType = typename Superclass::MovingImagePointType

Definition at line 105 of file itkCorrelationImageToImageMetricv4.h.

◆ MovingTransformType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingTransformType = typename Superclass::MovingTransformType

Definition at line 109 of file itkCorrelationImageToImageMetricv4.h.

◆ Pointer

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

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

Definition at line 88 of file itkCorrelationImageToImageMetricv4.h.

◆ Self

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

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

Standard class type aliases.

Definition at line 85 of file itkCorrelationImageToImageMetricv4.h.

◆ Superclass

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

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

Definition at line 87 of file itkCorrelationImageToImageMetricv4.h.

◆ VirtualImageType

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

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

Definition at line 111 of file itkCorrelationImageToImageMetricv4.h.

◆ VirtualIndexType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::VirtualIndexType = typename Superclass::VirtualIndexType

Definition at line 112 of file itkCorrelationImageToImageMetricv4.h.

◆ VirtualPointSetType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::VirtualPointSetType = typename Superclass::VirtualPointSetType

Definition at line 114 of file itkCorrelationImageToImageMetricv4.h.

◆ VirtualPointType

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

using itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::VirtualPointType = typename Superclass::VirtualPointType

Definition at line 113 of file itkCorrelationImageToImageMetricv4.h.

Constructor & Destructor Documentation

◆ CorrelationImageToImageMetricv4()

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

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

protected

◆ ~CorrelationImageToImageMetricv4()

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

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

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::CorrelationImageToImageMetricv4< 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::Object.

◆ GetNameOfClass()

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

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >.

◆ InitializeForIteration()

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

void itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::InitializeForIteration ( ) const

overrideprotectedvirtual

Perform any initialization required before each evaluation of GetValueAndDerivative. This is distinct from Initialize, which is called only once before a number of iterations, e.g. before a registration loop.

Reimplemented from itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >.

◆ New()

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

static Pointer itk::CorrelationImageToImageMetricv4< 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::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Type to represent the number of parameters that are being optimized at any given iteration of the optimizer.

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

Friends And Related Function Documentation

◆ CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

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

friend class CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

friend

Definition at line 144 of file itkCorrelationImageToImageMetricv4.h.

◆ CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

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

friend class CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

friend

Definition at line 147 of file itkCorrelationImageToImageMetricv4.h.

◆ CorrelationImageToImageMetricv4HelperThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

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

friend class CorrelationImageToImageMetricv4HelperThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

friend

Definition at line 159 of file itkCorrelationImageToImageMetricv4.h.

◆ CorrelationImageToImageMetricv4HelperThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

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

friend class CorrelationImageToImageMetricv4HelperThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

friend

Definition at line 160 of file itkCorrelationImageToImageMetricv4.h.

◆ ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

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

friend class ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

friend

Definition at line 138 of file itkCorrelationImageToImageMetricv4.h.

◆ ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Self >

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

friend class ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Self >

friend

Definition at line 139 of file itkCorrelationImageToImageMetricv4.h.

◆ ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

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

friend class ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

friend

Definition at line 134 of file itkCorrelationImageToImageMetricv4.h.

◆ ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedIndexedContainerPartitioner, Self >

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

friend class ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedIndexedContainerPartitioner, Self >

friend

Definition at line 135 of file itkCorrelationImageToImageMetricv4.h.

Member Data Documentation

◆ FixedImageDimension

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

constexpr TFixedImage::ImageDimensionType itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::FixedImageDimension = TFixedImage::ImageDimension

staticconstexpr

Definition at line 118 of file itkCorrelationImageToImageMetricv4.h.

◆ m_AverageFix

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

MeasureType itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::m_AverageFix

mutableprotected

Definition at line 175 of file itkCorrelationImageToImageMetricv4.h.

◆ m_AverageMov

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

MeasureType itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::m_AverageMov

mutableprotected

Definition at line 176 of file itkCorrelationImageToImageMetricv4.h.

◆ m_HelperDenseThreader

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

CorrelationHelperDenseThreaderType::Pointer itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::m_HelperDenseThreader

protected

Definition at line 169 of file itkCorrelationImageToImageMetricv4.h.

◆ m_HelperSparseThreader

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

CorrelationHelperSparseThreaderType::Pointer itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::m_HelperSparseThreader

protected

Definition at line 170 of file itkCorrelationImageToImageMetricv4.h.

◆ MovingImageDimension

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

constexpr TMovingImage::ImageDimensionType itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::MovingImageDimension = TMovingImage::ImageDimension

staticconstexpr

Definition at line 119 of file itkCorrelationImageToImageMetricv4.h.

◆ VirtualImageDimension

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

constexpr TVirtualImage::ImageDimensionType itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >::VirtualImageDimension = TVirtualImage::ImageDimension

staticconstexpr

Definition at line 117 of file itkCorrelationImageToImageMetricv4.h.

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

itkCorrelationImageToImageMetricv4.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ CorrelationDenseGetValueAndDerivativeThreaderType

◆ CorrelationHelperDenseThreaderType

◆ CorrelationHelperSparseThreaderType

◆ CorrelationSparseGetValueAndDerivativeThreaderType

◆ DerivativeType

◆ FixedImageGradientType

◆ FixedImagePixelType

◆ FixedImagePointType

◆ JacobianType

◆ MeasureType

◆ MovingImageGradientType

◆ MovingImagePixelType

◆ MovingImagePointType

◆ MovingTransformType

◆ Pointer

◆ Self

◆ Superclass

◆ VirtualImageType

◆ VirtualIndexType

◆ VirtualPointSetType

◆ VirtualPointType

Constructor & Destructor Documentation

◆ CorrelationImageToImageMetricv4()

◆ ~CorrelationImageToImageMetricv4()

Member Function Documentation

◆ CreateAnother()

◆ GetNameOfClass()

◆ InitializeForIteration()

◆ New()

◆ PrintSelf()

Friends And Related Function Documentation

◆ CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

◆ CorrelationImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

◆ CorrelationImageToImageMetricv4HelperThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Superclass, Self >

◆ CorrelationImageToImageMetricv4HelperThreader< ThreadedIndexedContainerPartitioner, Superclass, Self >

◆ ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

◆ ImageToImageMetricv4GetValueAndDerivativeThreader< ThreadedIndexedContainerPartitioner, Self >

◆ ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedImageRegionPartitioner< Superclass::VirtualImageDimension >, Self >

◆ ImageToImageMetricv4GetValueAndDerivativeThreaderBase< ThreadedIndexedContainerPartitioner, Self >

Member Data Documentation

◆ FixedImageDimension

◆ m_AverageFix

◆ m_AverageMov

◆ m_HelperDenseThreader

◆ m_HelperSparseThreader

◆ MovingImageDimension

◆ VirtualImageDimension