#include <itkPointSetToPointSetMetricv4.h>

Detailed Description

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
class itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >

Computes similarity between two point sets.

This class is templated over the type of the two point-sets. It expects a Transform to be plugged in for each of fixed and moving point sets. The transforms default to IdentityTransform types. This particular class is the base class for a hierarchy of point-set to point-set metrics.

This class computes a value that measures the similarity between the fixed point-set and the moving point-set in the moving domain. The fixed point set is transformed into the virtual domain by computing the inverse of the fixed transform, then transformed into the moving domain using the moving transform.

Since the PointSet class permits each Point to be associated with a PixelType, there are potential applications which could make use of this additional information. For example, the derived LabeledPointSetToPointSetMetric class uses the PixelType as a LabelEnum for estimating total metric values and gradients from the individual label-wise point subset metric and derivatives

If a virtual domain is not defined by the user, one of two things happens: 1) If the moving transform is a global type, then the virtual domain is left undefined and every point is considered to be within the virtual domain. 2) If the moving transform is a local-support type, then the virtual domain is taken during initialization from the moving transform displacement field, and all fixed points are verified to be within the virtual domain after transformation by the inverse fixed transform. Points outside the virtual domain are not used. See GetNumberOfValidPoints() to verify how many fixed points were used during evaluation.

See ObjectToObjectMetric documentation for more discussion on the virtual domain.

Note: When used with an RegistrationParameterScalesEstimator estimator, a VirtualDomainPointSet must be defined and assigned to the estimator, for use in shift estimation. The virtual domain point set can be retrieved from the metric using the GetVirtualTransformedPointSet() method.

Definition at line 68 of file itkPointSetToPointSetMetricv4.h.

Inheritance diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >:

Collaboration diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	CoordinateType = typename PointType::CoordinateType

using	DerivativeValueType

using	DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType

using	FixedPixelType = typename TFixedPointSet::PixelType

using	FixedPointsContainer = typename TFixedPointSet::PointsContainer

using	FixedPointSetType = TFixedPointSet

using	FixedPointType = typename TFixedPointSet::PointType

using	FixedTransformedPointSetType

using	LocalDerivativeType

using	MovingPixelType = typename TMovingPointSet::PixelType

using	MovingPointsContainer = typename TMovingPointSet::PointsContainer

using	MovingPointSetType = TMovingPointSet

using	MovingPointType = typename TMovingPointSet::PointType

using	MovingTransformedPointSetType

using	NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType

using	PixelType

using	Pointer = SmartPointer<Self>

using	PointIdentifier

using	PointsConstIterator = typename PointsContainer::ConstIterator

using	PointsContainer = FixedPointsContainer

using	PointsLocatorType

using	PointType

using	Self = PointSetToPointSetMetricv4

using	Superclass

using	VirtualImageType = typename Superclass::VirtualImageType

using	VirtualOriginType = typename Superclass::VirtualPointType

using	VirtualRadiusType = typename Superclass::VirtualSizeType

Public Types inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
using	ConstPointer

using	CoordinateType

using	DerivativeValueType

using	DisplacementFieldTransformType

using	FixedPixelType

using	FixedPointsContainer

using	FixedPointSetType

using	FixedPointType

using	FixedTransformedPointSetType

using	LocalDerivativeType

using	MovingPixelType

using	MovingPointsContainer

using	MovingPointSetType

using	MovingPointType

using	MovingTransformedPointSetType

using	NeighborsIdentifierType

typedef unsigned int	NumberOfParametersType

typedef unsigned int	NumberOfParametersType

using	ObjectType

using	PixelType

using	Pointer

using	PointIdentifier

using	PointsConstIterator

using	PointsContainer

using	PointsLocatorType

using	PointType

using	Self

using	Superclass

using	VirtualImageType

using	VirtualOriginType

using	VirtualRadiusType

Public Types inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TFixedPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, 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 LocalDerivativeType	GetLocalNeighborhoodDerivative (const PointType &, const PixelType &pixel) const

virtual MeasureType	GetLocalNeighborhoodValue (const PointType &, const PixelType &pixel) const =0

virtual void	GetLocalNeighborhoodValueAndDerivative (const PointType &, MeasureType &, LocalDerivativeType &, const PixelType &pixel) const =0

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
void	GetDerivative (DerivativeType &) const override

virtual const FixedTransformedPointSetType *	GetFixedTransformedPointSet () const

virtual FixedTransformedPointSetType *	GetModifiableFixedTransformedPointSet ()

virtual MovingTransformedPointSetType *	GetModifiableMovingTransformedPointSet ()

virtual const MovingTransformedPointSetType *	GetMovingTransformedPointSet () const

const char *	GetNameOfClass () const override

SizeValueType	GetNumberOfComponents () const

MeasureType	GetValue () const override

void	GetValueAndDerivative (MeasureType &, DerivativeType &) const override

const VirtualPointSetType *	GetVirtualTransformedPointSet () const

void	Initialize () override

bool	SupportsArbitraryVirtualDomainSamples () const override

void	SetFixedObject (const ObjectType *object) override

void	SetMovingObject (const ObjectType *object) override

virtual void	SetFixedPointSet (const FixedPointSetType *_arg)

virtual const FixedPointSetType *	GetFixedPointSet () const

virtual void	SetMovingPointSet (const MovingPointSetType *_arg)

virtual const MovingPointSetType *	GetMovingPointSet () const

virtual void	SetStoreDerivativeAsSparseFieldForLocalSupportTransforms (bool _arg)

virtual bool	GetStoreDerivativeAsSparseFieldForLocalSupportTransforms () const

virtual void	StoreDerivativeAsSparseFieldForLocalSupportTransformsOn ()

virtual void	StoreDerivativeAsSparseFieldForLocalSupportTransformsOff ()

virtual void	SetCalculateValueAndDerivativeInTangentSpace (bool _arg)

virtual bool	GetCalculateValueAndDerivativeInTangentSpace () const

virtual void	CalculateValueAndDerivativeInTangentSpaceOn ()

virtual void	CalculateValueAndDerivativeInTangentSpaceOff ()

Public Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TFixedPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
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

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

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

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 Attributes
static constexpr DimensionType	FixedPointDimension = Superclass::FixedPointDimension

static constexpr DimensionType	MovingPointDimension = Superclass::MovingPointDimension

static constexpr DimensionType	PointDimension = Superclass::PointDimension

Static Public Attributes inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
static constexpr DimensionType	FixedPointDimension

static constexpr DimensionType	MovingPointDimension

static constexpr DimensionType	PointDimension

Static Public Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TFixedPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
static constexpr DimensionType	FixedDimension

static constexpr DimensionType	MovingDimension

static constexpr DimensionType	VirtualDimension

Protected Member Functions
	PointSetToPointSetMetricv4 ()=default

	~PointSetToPointSetMetricv4 () override=default

Protected Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
virtual SizeValueType	CalculateNumberOfValidFixedPoints () const

void	CalculateValueAndDerivative (MeasureType &calculatedValue, DerivativeType &derivative, bool calculateValue) const

MetricCategoryType	GetMetricCategory () const override

virtual void	InitializeForIteration () const

virtual void	InitializePointSets () const

void	InitializePointsLocators () const

	PointSetToPointSetMetricWithIndexv4 ()

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

virtual bool	RequiresFixedPointsLocator () const

virtual bool	RequiresMovingPointsLocator () const

void	StorePointDerivative (const VirtualPointType &, const DerivativeType &, DerivativeType &) const

void	TransformFixedAndCreateVirtualPointSet () const

void	TransformMovingPointSet () const

	~PointSetToPointSetMetricWithIndexv4 () override=default

Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TFixedPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
const MovingDisplacementFieldTransformType *	GetMovingDisplacementFieldTransform () const

	ObjectToObjectMetric ()

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

	~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 Member Functions
LocalDerivativeType	GetLocalNeighborhoodDerivativeWithIndex (const PointIdentifier &, const PointType &point, const PixelType &pixel) const override

void	GetLocalNeighborhoodValueAndDerivativeWithIndex (const PointIdentifier &, const PointType &point, MeasureType &measure, LocalDerivativeType &derivative, const PixelType &pixel) const override

MeasureType	GetLocalNeighborhoodValueWithIndex (const PointIdentifier &, const PointType &point, const PixelType &pixel) const override

Additional Inherited Members
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 ()

Protected Attributes inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
bool	m_CalculateValueAndDerivativeInTangentSpace

FixedPointSetType::ConstPointer	m_FixedPointSet

FixedTransformedPointSetType::Pointer	m_FixedTransformedPointSet

PointsLocatorType::Pointer	m_FixedTransformedPointsLocator

MovingPointSetType::ConstPointer	m_MovingPointSet

MovingTransformedPointSetType::Pointer	m_MovingTransformedPointSet

PointsLocatorType::Pointer	m_MovingTransformedPointsLocator

bool	m_UsePointSetData

VirtualPointSetPointer	m_VirtualTransformedPointSet

Protected Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TFixedPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, 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

◆ ConstPointer

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 79 of file itkPointSetToPointSetMetricv4.h.

◆ CoordinateType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::CoordinateType = typename PointType::CoordinateType

Definition at line 143 of file itkPointSetToPointSetMetricv4.h.

◆ DerivativeValueType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::DerivativeValueType

Definition at line 170 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ DisplacementFieldTransformType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType

Definition at line 112 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPixelType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPixelType = typename TFixedPointSet::PixelType

Definition at line 120 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPointsContainer

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointsContainer = typename TFixedPointSet::PointsContainer

Definition at line 121 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPointSetType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointSetType = TFixedPointSet

Type of the fixed point set.

Definition at line 118 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPointType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointType = typename TFixedPointSet::PointType

Definition at line 119 of file itkPointSetToPointSetMetricv4.h.

◆ FixedTransformedPointSetType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedTransformedPointSetType

Definition at line 167 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ LocalDerivativeType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::LocalDerivativeType

Definition at line 171 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ MovingPixelType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPixelType = typename TMovingPointSet::PixelType

Definition at line 128 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointsContainer

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointsContainer = typename TMovingPointSet::PointsContainer

Definition at line 129 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointSetType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointSetType = TMovingPointSet

Type of the moving point set.

Definition at line 126 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointType = typename TMovingPointSet::PointType

Definition at line 127 of file itkPointSetToPointSetMetricv4.h.

◆ MovingTransformedPointSetType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingTransformedPointSetType

Definition at line 168 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ NeighborsIdentifierType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType

Definition at line 154 of file itkPointSetToPointSetMetricv4.h.

◆ PixelType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PixelType

Definition at line 153 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ Pointer

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 78 of file itkPointSetToPointSetMetricv4.h.

◆ PointIdentifier

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointIdentifier

Definition at line 161 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ PointsConstIterator

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointsConstIterator = typename PointsContainer::ConstIterator

Definition at line 149 of file itkPointSetToPointSetMetricv4.h.

◆ PointsContainer

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointsContainer = FixedPointsContainer

Definition at line 148 of file itkPointSetToPointSetMetricv4.h.

◆ PointsLocatorType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointsLocatorType

Typedef for points locator class to speed up finding neighboring points

Definition at line 164 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ PointType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointType

Definition at line 152 of file itkPointSetToPointSetMetricWithIndexv4.h.

◆ Self

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Self = PointSetToPointSetMetricv4

Standard class type aliases.

Definition at line 75 of file itkPointSetToPointSetMetricv4.h.

◆ Superclass

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Superclass

Initial value:

PointSetToPointSetMetricWithIndexv4<TFixedPointSet, TMovingPointSet, TInternalComputationValueType>

itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >::PointSetToPointSetMetricWithIndexv4

PointSetToPointSetMetricWithIndexv4()

Definition at line 76 of file itkPointSetToPointSetMetricv4.h.

◆ VirtualImageType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::VirtualImageType = typename Superclass::VirtualImageType

Types for the virtual domain

Definition at line 163 of file itkPointSetToPointSetMetricv4.h.

◆ VirtualOriginType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::VirtualOriginType = typename Superclass::VirtualPointType

Definition at line 169 of file itkPointSetToPointSetMetricv4.h.

◆ VirtualRadiusType

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::VirtualRadiusType = typename Superclass::VirtualSizeType

Definition at line 172 of file itkPointSetToPointSetMetricv4.h.

Constructor & Destructor Documentation

◆ PointSetToPointSetMetricv4()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointSetToPointSetMetricv4 ( )

protecteddefault

◆ ~PointSetToPointSetMetricv4()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::~PointSetToPointSetMetricv4 ( )

overrideprotecteddefault

Member Function Documentation

◆ GetLocalNeighborhoodDerivative()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

virtual LocalDerivativeType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodDerivative	(	const PointType &	,
		const PixelType &	pixel ) const

virtual

Calculates the local derivative for a single point. The default implementation calls GetLocalNeighborhoodValueAndDerivative. The PixelType may or may not be used. See class description for further explanation. Default implementation calls GetLocalNeighborhoodValueAndDerivative.

◆ GetLocalNeighborhoodDerivativeWithIndex()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

LocalDerivativeType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodDerivativeWithIndex	(	const PointIdentifier &	,
		const PointType &	,
		const PixelType &	pixel ) const

inlineoverrideprivatevirtual

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point. The PixelType may or may not be used. See class description for further explanation. Default implementation calls GetLocalNeighborhoodValueAndDerivative.

Reimplemented from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >.

Definition at line 220 of file itkPointSetToPointSetMetricv4.h.

◆ GetLocalNeighborhoodValue()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

virtual MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValue	(	const PointType &	,
		const PixelType &	pixel ) const

pure virtual

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point. The PixelType may or may not be used. See class description for further explanation.

Implemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >, and itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

◆ GetLocalNeighborhoodValueAndDerivative()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueAndDerivative	(	const PointType &	,
		MeasureType &	,
		LocalDerivativeType &	,
		const PixelType &	pixel ) const

pure virtual

Calculates the local value/derivative for a single point. The PixelType may or may not be used. See class description for further explanation.

Implemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >, and itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

◆ GetLocalNeighborhoodValueAndDerivativeWithIndex()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueAndDerivativeWithIndex	(	const PointIdentifier &	,
		const PointType &	,
		MeasureType &	,
		LocalDerivativeType &	,
		const PixelType &	pixel ) const

inlineoverrideprivatevirtual

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point. The PixelType may or may not be used. See class description for further explanation.

Implements itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >.

Definition at line 228 of file itkPointSetToPointSetMetricv4.h.

◆ GetLocalNeighborhoodValueWithIndex()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueWithIndex	(	const PointIdentifier &	,
		const PointType &	,
		const PixelType &	pixel ) const

inlineoverrideprivatevirtual

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point. The PixelType may or may not be used. See class description for further explanation.

Implements itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >.

Definition at line 212 of file itkPointSetToPointSetMetricv4.h.

◆ GetNameOfClass()

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

const char * itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TFixedPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >.

Member Data Documentation

◆ FixedPointDimension

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointDimension = Superclass::FixedPointDimension

staticconstexpr

Definition at line 123 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointDimension

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointDimension = Superclass::MovingPointDimension

staticconstexpr

Definition at line 131 of file itkPointSetToPointSetMetricv4.h.

◆ PointDimension

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>

DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointDimension = Superclass::PointDimension

staticconstexpr

typedefs for the data types used in the point set metric calculations. It is assumed that the constants of the fixed point set, such as the point dimension, are the same for the "common space" in which the metric calculation occurs.

Definition at line 139 of file itkPointSetToPointSetMetricv4.h.

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

itkPointSetToPointSetMetricv4.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CoordinateType

◆ DerivativeValueType

◆ DisplacementFieldTransformType

◆ FixedPixelType

◆ FixedPointsContainer

◆ FixedPointSetType

◆ FixedPointType

◆ FixedTransformedPointSetType

◆ LocalDerivativeType

◆ MovingPixelType

◆ MovingPointsContainer

◆ MovingPointSetType

◆ MovingPointType

◆ MovingTransformedPointSetType

◆ NeighborsIdentifierType

◆ PixelType

◆ Pointer

◆ PointIdentifier

◆ PointsConstIterator

◆ PointsContainer

◆ PointsLocatorType

◆ PointType

◆ Self

◆ Superclass

◆ VirtualImageType

◆ VirtualOriginType

◆ VirtualRadiusType

Constructor & Destructor Documentation

◆ PointSetToPointSetMetricv4()

◆ ~PointSetToPointSetMetricv4()

Member Function Documentation

◆ GetLocalNeighborhoodDerivative()

◆ GetLocalNeighborhoodDerivativeWithIndex()

◆ GetLocalNeighborhoodValue()

◆ GetLocalNeighborhoodValueAndDerivative()

◆ GetLocalNeighborhoodValueAndDerivativeWithIndex()

◆ GetLocalNeighborhoodValueWithIndex()

◆ GetNameOfClass()

Member Data Documentation

◆ FixedPointDimension

◆ MovingPointDimension

◆ PointDimension