ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType > Class Template Reference

#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 the Insight Journal paper: https://www.insight-journal.org/browse/publication/317

Note
The original work reported in Tustison et al. 2011 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.
REFERENCE

N.J. Tustison, S. P. Awate, G. Song, T. S. Cook, and J. C. Gee. "Point set registration using Havrda-Charvat-Tsallis entropy measures" IEEE Transactions on Medical Imaging, 30(2):451-60, 2011.

Examples
SphinxExamples/src/Registration/Metricsv4/RegisterTwoPointSets/Code.cxx.

Definition at line 72 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 DensityFunctionPointer = typename DensityFunctionType::Pointer
 
using DensityFunctionType = ManifoldParzenWindowsPointSetFunction< PointSetType, RealType >
 
using GaussianType = typename DensityFunctionType::GaussianType
 
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, TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename PointType::CoordRepType
 
using DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType
 
using FixedPixelType = typename TPointSet ::PixelType
 
using FixedPointsContainer = typename TPointSet ::PointsContainer
 
using FixedPointSetType = TPointSet
 
using FixedPointType = typename TPointSet ::PointType
 
using MovingPixelType = typename TPointSet ::PixelType
 
using MovingPointsContainer = typename TPointSet ::PointsContainer
 
using MovingPointSetType = TPointSet
 
using MovingPointType = typename TPointSet ::PointType
 
using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType
 
using Pointer = SmartPointer< Self >
 
using PointsConstIterator = typename PointsContainer::ConstIterator
 
using PointsContainer = FixedPointsContainer
 
using Self = PointSetToPointSetMetricv4
 
using Superclass = PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, TInternalComputationValueType >
 
using VirtualImageType = typename Superclass::VirtualImageType
 
using VirtualOriginType = typename Superclass::VirtualPointType
 
using VirtualRadiusType = typename Superclass::VirtualSizeType
 
- Public Types inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename PointType::CoordRepType
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType
 
using FixedPixelType = typename TPointSet ::PixelType
 
using FixedPointsContainer = typename TPointSet ::PointsContainer
 
using FixedPointSetType = TPointSet
 
using FixedPointType = typename TPointSet ::PointType
 
using FixedTransformedPointSetType = PointSet< FixedPixelType, Self::PointDimension >
 
using LocalDerivativeType = FixedArray< DerivativeValueType, Self::PointDimension >
 
using MovingPixelType = typename TPointSet ::PixelType
 
using MovingPointsContainer = typename TPointSet ::PointsContainer
 
using MovingPointSetType = TPointSet
 
using MovingPointType = typename TPointSet ::PointType
 
using MovingTransformedPointSetType = PointSet< MovingPixelType, Self::PointDimension >
 
using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType
 
using ObjectType = typename Superclass::ObjectType
 
using PixelType = FixedPixelType
 
using Pointer = SmartPointer< Self >
 
using PointIdentifier = typename PointsContainer::ElementIdentifier
 
using PointsConstIterator = typename PointsContainer::ConstIterator
 
using PointsContainer = FixedPointsContainer
 
using PointsLocatorType = PointsLocator< PointsContainer >
 
using PointType = FixedPointType
 
using Self = PointSetToPointSetMetricWithIndexv4
 
using Superclass = ObjectToObjectMetric< TPointSet ::PointDimension, TPointSet ::PointDimension, Image< TInternalComputationValueType, TPointSet ::PointDimension >, TInternalComputationValueType >
 
using VirtualImageType = typename Superclass::VirtualImageType
 
using VirtualOriginType = typename Superclass::VirtualPointType
 
using VirtualRadiusType = typename Superclass::VirtualSizeType
 
- Public Types inherited from itk::ObjectToObjectMetric< TPointSet ::PointDimension, TPointSet ::PointDimension, Image< TInternalComputationValueType, TPointSet ::PointDimension >, TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = TInternalComputationValueType
 
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, Image< TInternalComputationValueType, TPointSet ::PointDimension > ::ImageDimension, TFixedDimension >
 
using InternalComputationValueType = TInternalComputationValueType
 
using JacobianType = typename FixedTransformType::JacobianType
 
using MetricCategoryType = typename Superclass::MetricCategoryEnum
 
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, Image< TInternalComputationValueType, TPointSet ::PointDimension > ::ImageDimension, TMovingDimension >
 
using ObjectType = typename Superclass::Object
 
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 = Image< TInternalComputationValueType, TPointSet ::PointDimension >
 
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
 
- Public Types inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = TInternalComputationValueType
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using GradientSourceEnum = itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource
 
using MetricCategoryEnum = itk::ObjectToObjectMetricBaseTemplateEnums::MetricCategory
 
using NumberOfParametersType = unsigned int
 
using ObjectConstPointer = typename ObjectType::ConstPointer
 
using ObjectType = Object
 
using ParametersValueType = TInternalComputationValueType
 
using Pointer = SmartPointer< Self >
 
using Self = ObjectToObjectMetricBaseTemplate
 
using Superclass = SingleValuedCostFunctionv4Template< TInternalComputationValueType >
 
- Public Types inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< TInternalComputationValueType >
 
using MeasureType = TInternalComputationValueType
 
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 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
 
virtual RealType GetPointSetSigma () const
 
virtual bool GetUseAnisotropicCovariances () const
 
void Initialize () override
 
LightObject::Pointer InternalClone () const override
 
 itkOverrideGetNameOfClassMacro (JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4)
 
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 UseAnisotropicCovariancesOn ()
 
- Public Member Functions inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >
virtual LocalDerivativeType GetLocalNeighborhoodDerivative (const PointType &, const PixelType &pixel) const
 
 itkOverrideGetNameOfClassMacro (PointSetToPointSetMetricv4)
 
- Public Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, TInternalComputationValueType >
void GetDerivative (DerivativeType &) const override
 
virtual FixedTransformedPointSetTypeGetModifiableFixedTransformedPointSet ()
 
virtual MovingTransformedPointSetTypeGetModifiableMovingTransformedPointSet ()
 
SizeValueType GetNumberOfComponents () const
 
MeasureType GetValue () const override
 
void GetValueAndDerivative (MeasureType &, DerivativeType &) const override
 
const VirtualPointSetTypeGetVirtualTransformedPointSet () const
 
void Initialize () override
 
 itkOverrideGetNameOfClassMacro (PointSetToPointSetMetricWithIndexv4)
 
bool SupportsArbitraryVirtualDomainSamples () const override
 
void SetFixedObject (const ObjectType *object) override
 
void SetMovingObject (const ObjectType *object) override
 
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetTypeGetFixedPointSet () const
 
virtual void SetMovingPointSet (const MovingPointSetType *_arg)
 
virtual const MovingPointSetTypeGetMovingPointSet () const
 
virtual void SetStoreDerivativeAsSparseFieldForLocalSupportTransforms (bool _arg)
 
virtual bool GetStoreDerivativeAsSparseFieldForLocalSupportTransforms () const
 
virtual void StoreDerivativeAsSparseFieldForLocalSupportTransformsOn ()
 
virtual void SetCalculateValueAndDerivativeInTangentSpace (bool _arg)
 
virtual bool GetCalculateValueAndDerivativeInTangentSpace () const
 
virtual void CalculateValueAndDerivativeInTangentSpaceOn ()
 
- Public Member Functions inherited from itk::ObjectToObjectMetric< TPointSet ::PointDimension, TPointSet ::PointDimension, Image< TInternalComputationValueType, TPointSet ::PointDimension >, TInternalComputationValueType >
OffsetValueType ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const
 
OffsetValueType ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const
 
virtual FixedTransformTypeGetModifiableFixedTransform ()
 
virtual MovingTransformTypeGetModifiableMovingTransform ()
 
virtual VirtualImageTypeGetModifiableVirtualImage ()
 
NumberOfParametersType GetNumberOfLocalParameters () const override
 
NumberOfParametersType GetNumberOfParameters () const override
 
virtual SizeValueType GetNumberOfValidPoints () const
 
const ParametersTypeGetParameters () const override
 
const MovingTransformTypeGetTransform ()
 
VirtualDirectionType GetVirtualDirection () const
 
virtual const TimeStampGetVirtualDomainTimeStamp () const
 
VirtualOriginType GetVirtualOrigin () const
 
const VirtualRegionTypeGetVirtualRegion () const
 
VirtualSpacingType GetVirtualSpacing () const
 
bool HasLocalSupport () const override
 
 itkOverrideGetNameOfClassMacro (ObjectToObjectMetric)
 
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
 
- Public Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
MeasureType GetCurrentValue () const
 
virtual GradientSourceEnum GetGradientSource () const
 
bool GetGradientSourceIncludesFixed () const
 
bool GetGradientSourceIncludesMoving () const
 
 itkOverrideGetNameOfClassMacro (ObjectToObjectMetricBaseTemplate)
 
virtual void SetGradientSource (GradientSourceEnum _arg)
 
virtual const ObjectTypeGetFixedObject () const
 
virtual const ObjectTypeGetMovingObject () const
 
- Public Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
 itkOverrideGetNameOfClassMacro (SingleValuedCostFunctionv4Template)
 
- Public Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 itkOverrideGetNameOfClassMacro (CostFunctionTemplate)
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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, TInternalComputationValueType >
static constexpr DimensionType FixedPointDimension
 
static constexpr DimensionType MovingPointDimension
 
static constexpr DimensionType PointDimension
 
- Static Public Attributes inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, TInternalComputationValueType >
static constexpr DimensionType FixedPointDimension
 
static constexpr DimensionType MovingPointDimension
 
static constexpr DimensionType PointDimension
 
- Static Public Attributes inherited from itk::ObjectToObjectMetric< TPointSet ::PointDimension, TPointSet ::PointDimension, Image< TInternalComputationValueType, TPointSet ::PointDimension >, TInternalComputationValueType >
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, TInternalComputationValueType >
 PointSetToPointSetMetricv4 ()=default
 
 ~PointSetToPointSetMetricv4 () override=default
 
- Protected Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, TInternalComputationValueType >
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< TInternalComputationValueType, TPointSet ::PointDimension >, TInternalComputationValueType >
const MovingDisplacementFieldTransformTypeGetMovingDisplacementFieldTransform () 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< 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 ()
 
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, TInternalComputationValueType >
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< TInternalComputationValueType, TPointSet ::PointDimension >, TInternalComputationValueType >
FixedTransformPointer m_FixedTransform
 
MovingTransformPointer m_MovingTransform
 
SizeValueType m_NumberOfValidPoints
 
bool m_UserHasSetVirtualDomain
 
VirtualImagePointer m_VirtualImage
 
- Protected Attributes inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
ObjectConstPointer m_FixedObject {}
 
GradientSourceEnum m_GradientSource {}
 
ObjectConstPointer m_MovingObject {}
 
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>

◆ DensityFunctionPointer

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

◆ DensityFunctionType

template<typename TPointSet , class TInternalComputationValueType = double>
using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::DensityFunctionType = ManifoldParzenWindowsPointSetFunction<PointSetType, RealType>

Other typedefs

Definition at line 117 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ GaussianType

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

◆ Pointer

template<typename TPointSet , class TInternalComputationValueType = double>
using itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Pointer = SmartPointer<Self>

◆ PointsContainer

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

◆ PointsContainerConstIterator

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

◆ PointSetType

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

◆ RealType

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

◆ Self

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

Standard class type aliases.

Definition at line 79 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ Superclass

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

Constructor & Destructor Documentation

◆ JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4()

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

◆ ~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, TInternalComputationValueType >.

◆ 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, TInternalComputationValueType >.

◆ 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< TInternalComputationValueType >.

◆ 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.

◆ itkOverrideGetNameOfClassMacro()

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

Run-time type information (and related methods)

◆ 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::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

◆ RequiresFixedPointsLocator()

template<typename TPointSet , class TInternalComputationValueType = double>
bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::RequiresFixedPointsLocator ( ) const
inlineoverrideprotectedvirtual

◆ RequiresMovingPointsLocator()

template<typename TPointSet , class TInternalComputationValueType = double>
bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::RequiresMovingPointsLocator ( ) const
inlineoverrideprotectedvirtual

◆ 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.

◆ 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

◆ m_CovarianceKNeighborhood

template<typename TPointSet , class TInternalComputationValueType = double>
unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_CovarianceKNeighborhood {}
private

◆ m_EvaluationKNeighborhood

template<typename TPointSet , class TInternalComputationValueType = double>
unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_EvaluationKNeighborhood {}
private

◆ m_KernelSigma

template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_KernelSigma {}
private

◆ m_MovingDensityFunction

template<typename TPointSet , class TInternalComputationValueType = double>
DensityFunctionPointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_MovingDensityFunction {}
private

◆ m_PointSetSigma

template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_PointSetSigma {}
private

◆ m_Prefactor0

template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Prefactor0 {}
mutableprivate

◆ m_Prefactor1

template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Prefactor1 {}
mutableprivate

◆ m_TotalNumberOfPoints

template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_TotalNumberOfPoints {}
mutableprivate

Precomputed cached values

Definition at line 261 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

◆ m_UseAnisotropicCovariances

template<typename TPointSet , class TInternalComputationValueType = double>
bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_UseAnisotropicCovariances { false }
private

◆ PointDimension

template<typename TPointSet , class TInternalComputationValueType = double>
constexpr unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointDimension = TPointSet::PointDimension
staticconstexpr

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