#include <itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h>

Detailed Description

template<typename TPointSet, class TInternalComputationValueType = double>
class itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >

Implementation of the Jensen Havrda Charvat Tsallis Point Set metric.

Given a specified transform and direction, this class calculates the value and derivative between a "fixed" and "moving" point set pair using the Havrda-Charvat-Tsallis entropy family, a generalization of the well-known Shannon entropy, and the Jensen divergence. Another way to look at the family of information-theoretic measures is that the points are used to construct the corresponding probably density functions.

In addition, we allow the user to invoke a manifold parzen windowing of the data. Instead of an isotropic Gaussian being associated with each point, we can actually calculate the covariance matrix for each point such that it reflects the locate point set structure.

To speed up the metric calculation, we use ITK's K-d tree to query the metric value only for a given neighborhood. Considering that probably only a small subset of points is needed to get a good approximation of the metric value for a single point, this is probably warranted. So what we do is transform each point (with the specified transform) and construct the k-d tree from the transformed points.

Contributed by Nicholas J. Tustison, James C. Gee in [122].

Note: The original work reported in [125] optionally employed a regularization term to prevent the moving point set(s) from coalescing to a single point location. However, within the registration framework, this term is of limited utility as such regularization is dictated by the transform and any explicit regularization terms. Also note that the published work applies to multiple points sets each of which could be considered "moving" but this is also not applicable for this particular implementation.

Definition at line 66 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

Inheritance diagram for itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >:

Collaboration diagram for itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	CoordinateType

using	DensityFunctionPointer = typename DensityFunctionType::Pointer

using	DensityFunctionType = ManifoldParzenWindowsPointSetFunction<PointSetType, RealType>

using	GaussianType = typename DensityFunctionType::GaussianType

using	NeighborsIdentifierType

using	Pointer = SmartPointer<Self>

using	PointsContainer = typename PointSetType::PointsContainer

using	PointsContainerConstIterator = typename PointsContainer::ConstIterator

using	PointSetType = TPointSet

using	RealType = MeasureType

using	Self = JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4

using	Superclass = PointSetToPointSetMetricv4<TPointSet, TPointSet, TInternalComputationValueType>

Public Types inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >
using	ConstPointer

using	CoordinateType

typedef typename DerivativeType::ValueType	DerivativeValueType

using	DerivativeValueType

using	DisplacementFieldTransformType

using	FixedPixelType

using	FixedPointsContainer

using	FixedPointSetType

using	FixedPointType

typedef PointSet< FixedPixelType, Self::PointDimension >	FixedTransformedPointSetType

using	FixedTransformedPointSetType

typedef FixedArray< DerivativeValueType, Self::PointDimension >	LocalDerivativeType

using	LocalDerivativeType

using	MovingPixelType

using	MovingPointsContainer

using	MovingPointSetType

using	MovingPointType

typedef PointSet< MovingPixelType, Self::PointDimension >	MovingTransformedPointSetType

using	MovingTransformedPointSetType

using	NeighborsIdentifierType

typedef FixedPixelType	PixelType

using	PixelType

using	Pointer

typedef typename PointsContainer::ElementIdentifier	PointIdentifier

using	PointIdentifier

using	PointsConstIterator

using	PointsContainer

typedef PointsLocator< PointsContainer >	PointsLocatorType

using	PointsLocatorType

typedef FixedPointType	PointType

using	PointType

using	Self

using	Superclass

using	VirtualImageType

using	VirtualOriginType

using	VirtualRadiusType

Public Types inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, 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< TPointSet::PointDimension, TPointSet::PointDimension, Image< double, TPointSet::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 RealType	GetAlpha () const

virtual unsigned int	GetCovarianceKNeighborhood () const

virtual unsigned int	GetEvaluationKNeighborhood () const

virtual RealType	GetKernelSigma () const

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

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

const char *	GetNameOfClass () const override

virtual RealType	GetPointSetSigma () const

virtual bool	GetUseAnisotropicCovariances () const

void	Initialize () override

LightObject::Pointer	InternalClone () const override

virtual void	SetAlpha (RealType _arg)

virtual void	SetCovarianceKNeighborhood (unsigned int _arg)

virtual void	SetEvaluationKNeighborhood (unsigned int _arg)

virtual void	SetKernelSigma (RealType _arg)

virtual void	SetPointSetSigma (RealType _arg)

virtual void	SetUseAnisotropicCovariances (bool _arg)

virtual void	UseAnisotropicCovariancesOff ()

virtual void	UseAnisotropicCovariancesOn ()

Public Member Functions inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >
virtual LocalDerivativeType	GetLocalNeighborhoodDerivative (const PointType &, const PixelType &pixel) const

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, 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< TPointSet::PointDimension, TPointSet::PointDimension, Image< double, TPointSet::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 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 unsigned int	PointDimension = TPointSet::PointDimension

Static Public Attributes inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >
static constexpr DimensionType	FixedPointDimension

static constexpr DimensionType	MovingPointDimension

static constexpr DimensionType	PointDimension

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

static constexpr DimensionType	MovingPointDimension

static constexpr DimensionType	PointDimension

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

static constexpr DimensionType	MovingDimension

static constexpr DimensionType	VirtualDimension

Protected Member Functions
void	ComputeValueAndDerivative (const PointType &samplePoint, MeasureType &value, LocalDerivativeType &derivativeReturn, bool calcValue, bool calcDerivative) const

	JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ()

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

bool	RequiresFixedPointsLocator () const override

bool	RequiresMovingPointsLocator () const override

	~JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 () override=default

Protected Member Functions inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >
	PointSetToPointSetMetricv4 ()=default

	~PointSetToPointSetMetricv4 () override=default

Protected Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, 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

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

void	TransformFixedAndCreateVirtualPointSet () const

void	TransformMovingPointSet () const

	~PointSetToPointSetMetricWithIndexv4 () override=default

Protected Member Functions inherited from itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension, Image< double, TPointSet::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
	LightObject ()

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

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

virtual	~LightObject ()

Private Attributes
RealType	m_Alpha {}

unsigned int	m_CovarianceKNeighborhood {}

unsigned int	m_EvaluationKNeighborhood {}

RealType	m_KernelSigma {}

DensityFunctionPointer	m_MovingDensityFunction {}

RealType	m_PointSetSigma {}

RealType	m_Prefactor0 {}

RealType	m_Prefactor1 {}

RealType	m_TotalNumberOfPoints {}

bool	m_UseAnisotropicCovariances { false }

Additional Inherited Members
Protected Attributes inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, 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< TPointSet::PointDimension, TPointSet::PointDimension, Image< double, TPointSet::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 TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 76 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ CoordinateType

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >::CoordinateType

Definition at line 143 of file itkPointSetToPointSetMetricv4.h.

◆ DensityFunctionPointer

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::DensityFunctionPointer = typename DensityFunctionType::Pointer

Definition at line 113 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ DensityFunctionType

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::DensityFunctionType = ManifoldParzenWindowsPointSetFunction<PointSetType, RealType>

Other typedefs

Definition at line 111 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ GaussianType

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GaussianType = typename DensityFunctionType::GaussianType

Definition at line 112 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ NeighborsIdentifierType

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >::NeighborsIdentifierType

Definition at line 154 of file itkPointSetToPointSetMetricv4.h.

◆ Pointer

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 75 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ PointsContainer

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointsContainer = typename PointSetType::PointsContainer

Definition at line 85 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ PointsContainerConstIterator

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointsContainerConstIterator = typename PointsContainer::ConstIterator

Definition at line 86 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ PointSetType

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointSetType = TPointSet

Definition at line 84 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ RealType

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::RealType = MeasureType

Definition at line 106 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ Self

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Self = JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4

Standard class type aliases.

Definition at line 73 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ Superclass

template<typename TPointSet, class TInternalComputationValueType = double>

using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Superclass = PointSetToPointSetMetricv4<TPointSet, TPointSet, TInternalComputationValueType>

Definition at line 74 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

Constructor & Destructor Documentation

◆ JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4()

template<typename TPointSet, class TInternalComputationValueType = double>

itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ( )

protected

Referenced by GetNameOfClass().

◆ ~JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4()

template<typename TPointSet, class TInternalComputationValueType = double>

itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::~JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeValueAndDerivative()

template<typename TPointSet, class TInternalComputationValueType = double>

void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::ComputeValueAndDerivative	(	const PointType &	samplePoint,
		MeasureType &	value,
		LocalDerivativeType &	derivativeReturn,
		bool	calcValue,
		bool	calcDerivative ) const

protected

◆ GetAlpha()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetAlpha ( ) const

virtual

Get the alpha parameter used to tune the point-set metric.

◆ GetCovarianceKNeighborhood()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetCovarianceKNeighborhood ( ) const

virtual

Get the size of the covariance neighborhood used to construct the anisotropic covariances. Only relevant if m_UseAnisotropicCovariances = true. Default = 5.

◆ GetEvaluationKNeighborhood()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetEvaluationKNeighborhood ( ) const

virtual

Get the neighborhood size used to evaluate the measurement at each point. Default = 50.

◆ GetKernelSigma()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetKernelSigma ( ) const

virtual

Get the noise kernel sigma for the anisotropic covariances.

◆ GetLocalNeighborhoodValue()

template<typename TPointSet, class TInternalComputationValueType = double>

MeasureType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValue	(	const PointType &	,
		const PixelType &	pixel = 0 ) const

overridevirtual

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::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >.

References itk::point().

◆ GetLocalNeighborhoodValueAndDerivative()

template<typename TPointSet, class TInternalComputationValueType = double>

void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueAndDerivative	(	const PointType &	,
		MeasureType &	,
		LocalDerivativeType &	,
		const PixelType &	pixel = 0 ) const

overridevirtual

Get the local measure and the derivative values.

Implements itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >.

◆ GetNameOfClass()

template<typename TPointSet, class TInternalComputationValueType = double>

const char * itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::CostFunctionTemplate< double >.

References JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4().

◆ GetPointSetSigma()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetPointSetSigma ( ) const

virtual

Get the point set sigma function

◆ GetUseAnisotropicCovariances()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetUseAnisotropicCovariances ( ) const

virtual

Get whether or not anisotropic covariances are determined for each Gaussian. Default = false.

◆ Initialize()

template<typename TPointSet, class TInternalComputationValueType = double>

void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Initialize ( )

overridevirtual

Initialize the Metric by making sure that all the components are present and plugged together correctly.

Implements itk::ObjectToObjectMetricBaseTemplate< double >.

◆ InternalClone()

template<typename TPointSet, class TInternalComputationValueType = double>

LightObject::Pointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::InternalClone ( ) const

overridevirtual

Clone method will clone the existing instance of this type, including its internal member variables.

Reimplemented from itk::LightObject.

◆ New()

template<typename TPointSet, class TInternalComputationValueType = double>

static Pointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TPointSet, class TInternalComputationValueType = double>

void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotectedvirtual

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

Reimplemented from itk::CostFunctionTemplate< double >.

◆ RequiresFixedPointsLocator()

template<typename TPointSet, class TInternalComputationValueType = double>

bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::RequiresFixedPointsLocator ( ) const

inlineoverrideprotectedvirtual

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

Definition at line 231 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ RequiresMovingPointsLocator()

template<typename TPointSet, class TInternalComputationValueType = double>

bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::RequiresMovingPointsLocator ( ) const

inlineoverrideprotectedvirtual

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

Definition at line 237 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ SetAlpha()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetAlpha ( RealType _arg )

virtual

Set the alpha parameter used to tune the point-set metric from a maximum-likelihood measure (alpha = 1) to the more robust L2 solution (alpha = 2). Typically, "robustness" is associated with performance in the presence of uniform noise but in most applications the noise will be highly correlated with the point sets, therefore an alpha value close to 1, in general, provides better performance. Only values between 1 and 2 are convex.

◆ SetCovarianceKNeighborhood()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetCovarianceKNeighborhood ( unsigned int _arg )

virtual

Set the size of the covariance neighborhood used to construct the anisotropic covariances. Only relevant if m_UseAnisotropicCovariances = true. Default = 5.

◆ SetEvaluationKNeighborhood()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetEvaluationKNeighborhood ( unsigned int _arg )

virtual

Set the neighborhood size used to evaluate the measurement at each point. Default = 50.

◆ SetKernelSigma()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetKernelSigma ( RealType _arg )

virtual

Set the size of the noise kernel used to construct each covariance image. To avoid the case where the local point set structure would result in a degenerate covariance matrix, a small amount of noise is added along the diagonal represented by this variable. Only relevant if m_UseAnisotropicCovariances = true. Default = 10.0.

◆ SetPointSetSigma()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetPointSetSigma ( RealType _arg )

virtual

Each point is associated with a Gaussian characterized by m_PointSetSigma which provides a sense of scale for determining the similarity between two point sets. Default = 1.0.

◆ SetUseAnisotropicCovariances()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetUseAnisotropicCovariances ( bool _arg )

virtual

Set whether or not anisotropic covariances are determined for each Gaussian. Default = false.

◆ UseAnisotropicCovariancesOff()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::UseAnisotropicCovariancesOff ( )

virtual

◆ UseAnisotropicCovariancesOn()

template<typename TPointSet, class TInternalComputationValueType = double>

virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::UseAnisotropicCovariancesOn ( )

virtual

Get/set whether or not anisotropic covariances are determined for each Gaussian. Default = false.

Member Data Documentation

◆ m_Alpha

template<typename TPointSet, class TInternalComputationValueType = double>

RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Alpha {}

private

Definition at line 252 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_CovarianceKNeighborhood

template<typename TPointSet, class TInternalComputationValueType = double>

unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_CovarianceKNeighborhood {}

private

Definition at line 249 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_EvaluationKNeighborhood

template<typename TPointSet, class TInternalComputationValueType = double>

unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_EvaluationKNeighborhood {}

private

Definition at line 250 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_KernelSigma

template<typename TPointSet, class TInternalComputationValueType = double>

RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_KernelSigma {}

private

Definition at line 248 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_MovingDensityFunction

template<typename TPointSet, class TInternalComputationValueType = double>

DensityFunctionPointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_MovingDensityFunction {}

private

Definition at line 243 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_PointSetSigma

template<typename TPointSet, class TInternalComputationValueType = double>

RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_PointSetSigma {}

private

Definition at line 247 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_Prefactor0

template<typename TPointSet, class TInternalComputationValueType = double>

RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Prefactor0 {}

mutableprivate

Definition at line 256 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_Prefactor1

template<typename TPointSet, class TInternalComputationValueType = double>

RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Prefactor1 {}

mutableprivate

Definition at line 257 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_TotalNumberOfPoints

template<typename TPointSet, class TInternalComputationValueType = double>

RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_TotalNumberOfPoints {}

mutableprivate

Precomputed cached values

Definition at line 255 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_UseAnisotropicCovariances

template<typename TPointSet, class TInternalComputationValueType = double>

bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_UseAnisotropicCovariances { false }

private

Definition at line 245 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ PointDimension

template<typename TPointSet, class TInternalComputationValueType = double>

unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointDimension = TPointSet::PointDimension

staticconstexpr

Definition at line 88 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

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

itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CoordinateType

◆ DensityFunctionPointer

◆ DensityFunctionType

◆ GaussianType

◆ NeighborsIdentifierType

◆ Pointer

◆ PointsContainer

◆ PointsContainerConstIterator

◆ PointSetType

◆ RealType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4()

◆ ~JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4()

Member Function Documentation

◆ ComputeValueAndDerivative()

◆ GetAlpha()

◆ GetCovarianceKNeighborhood()

◆ GetEvaluationKNeighborhood()

◆ GetKernelSigma()

◆ GetLocalNeighborhoodValue()

◆ GetLocalNeighborhoodValueAndDerivative()

◆ GetNameOfClass()

◆ GetPointSetSigma()

◆ GetUseAnisotropicCovariances()

◆ Initialize()

◆ InternalClone()

◆ New()

◆ PrintSelf()

◆ RequiresFixedPointsLocator()

◆ RequiresMovingPointsLocator()

◆ SetAlpha()

◆ SetCovarianceKNeighborhood()

◆ SetEvaluationKNeighborhood()

◆ SetKernelSigma()

◆ SetPointSetSigma()

◆ SetUseAnisotropicCovariances()

◆ UseAnisotropicCovariancesOff()

◆ UseAnisotropicCovariancesOn()

Member Data Documentation

◆ m_Alpha

◆ m_CovarianceKNeighborhood

◆ m_EvaluationKNeighborhood

◆ m_KernelSigma

◆ m_MovingDensityFunction

◆ m_PointSetSigma

◆ m_Prefactor0

◆ m_Prefactor1

◆ m_TotalNumberOfPoints

◆ m_UseAnisotropicCovariances

◆ PointDimension