ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap > Class Template Reference

#include <itkEuclideanDistancePointMetric.h>

Detailed Description

template<typename TFixedPointSet, typename TMovingPointSet, typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
class itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >

Computes the minimum distance between a moving point-set and a fixed point-set. A vector of minimum closest point distance is created for each point in the moving point-set. No correspondence is needed. For speed consideration, the point-set with the minimum number of points should be used as the moving point-set. If the number of points is high, the possibility of setting a distance map should improve the speed of the closest point computation.

Reference: "A Method for Registration of 3-D Shapes", IEEE PAMI, Vol 14, No. 2, February 1992

Examples
Examples/RegistrationITKv4/IterativeClosestPoint1.cxx, Examples/RegistrationITKv4/IterativeClosestPoint2.cxx, and Examples/RegistrationITKv4/IterativeClosestPoint3.cxx.

Definition at line 47 of file itkEuclideanDistancePointMetric.h.

+ Inheritance diagram for itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >:
+ Collaboration diagram for itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DistanceMapPointer = typename DistanceMapType::ConstPointer
 
using DistanceMapType = TDistanceMap
 
using Pointer = SmartPointer< Self >
 
using Self = EuclideanDistancePointMetric
 
using Superclass = PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >
 
- Public Types inherited from itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = Superclass::ParametersValueType
 
using DerivativeType = Superclass::DerivativeType
 
using FixedPointDataIterator = typename FixedPointSetType::PointDataContainer::ConstIterator
 
using FixedPointIterator = typename FixedPointSetType::PointsContainer::ConstIterator
 
using FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer
 
using FixedPointSetType = TFixedPointSet
 
using InputPointType = typename TransformType::InputPointType
 
using MeasureType = Superclass::MeasureType
 
using MovingPointDataIterator = typename MovingPointSetType::PointDataContainer::ConstIterator
 
using MovingPointIterator = typename MovingPointSetType::PointsContainer::ConstIterator
 
using MovingPointSetConstPointer = typename MovingPointSetType::ConstPointer
 
using MovingPointSetPixelType = typename TMovingPointSet::PixelType
 
using MovingPointSetType = TMovingPointSet
 
using OutputPointType = typename TransformType::OutputPointType
 
using ParametersType = Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = PointSetToPointSetMetric
 
using Superclass = MultipleValuedCostFunction
 
using TransformJacobianType = typename TransformType::JacobianType
 
using TransformParametersType = typename TransformType::ParametersType
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = Transform< CoordinateRepresentationType, Self::MovingPointSetDimension, Self::FixedPointSetDimension >
 
- Public Types inherited from itk::MultipleValuedCostFunction
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array2D< double >
 
using MeasureType = Array< double >
 
using ParametersType = Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = MultipleValuedCostFunction
 
using Superclass = CostFunction
 
- 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

void GetDerivative (const TransformParametersType &parameters, DerivativeType &Derivative) const override
 
unsigned int GetNumberOfValues () const override
 
MeasureType GetValue (const TransformParametersType &parameters) const override
 
void GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
 itkOverrideGetNameOfClassMacro (EuclideanDistancePointMetric)
 
virtual void SetDistanceMap (const DistanceMapType *_arg)
 
virtual const DistanceMapTypeGetDistanceMap () const
 
virtual void SetComputeSquaredDistance (bool _arg)
 
virtual bool GetComputeSquaredDistance () const
 
virtual void ComputeSquaredDistanceOn ()
 
- Public Member Functions inherited from itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >
virtual TransformTypeGetModifiableTransform ()
 
unsigned int GetNumberOfParameters () const override
 
virtual void Initialize ()
 
 itkOverrideGetNameOfClassMacro (PointSetToPointSetMetric)
 
virtual void SetTransform (TransformType *_arg)
 
void SetTransformParameters (const ParametersType &parameters) const
 
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetTypeGetFixedPointSet () const
 
virtual void SetMovingPointSet (const MovingPointSetType *_arg)
 
virtual const MovingPointSetTypeGetMovingPointSet () const
 
- Public Member Functions inherited from itk::MultipleValuedCostFunction
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
virtual MeasureType GetValue (const ParametersType &parameters) const =0
 
 itkOverrideGetNameOfClassMacro (MultipleValuedCostFunction)
 
- 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 ()
 

Protected Member Functions

 EuclideanDistancePointMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~EuclideanDistancePointMetric () override=default
 
- Protected Member Functions inherited from itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >
 PointSetToPointSetMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PointSetToPointSetMetric () override=default
 
- Protected Member Functions inherited from itk::MultipleValuedCostFunction
 MultipleValuedCostFunction ()=default
 
 ~MultipleValuedCostFunction () override
 
- 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
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

bool m_ComputeSquaredDistance { false }
 
DistanceMapPointer m_DistanceMap {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >
static constexpr unsigned int FixedPointSetDimension = TFixedPointSet::PointDimension
 
static constexpr unsigned int MovingPointSetDimension = TMovingPointSet::PointDimension
 
- Protected Attributes inherited from itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >
FixedPointSetConstPointer m_FixedPointSet {}
 
MovingPointSetConstPointer m_MovingPointSet {}
 
TransformPointer m_Transform {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
using itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkEuclideanDistancePointMetric.h.

◆ DistanceMapPointer

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
using itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::DistanceMapPointer = typename DistanceMapType::ConstPointer

Definition at line 86 of file itkEuclideanDistancePointMetric.h.

◆ DistanceMapType

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
using itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::DistanceMapType = TDistanceMap

Definition at line 85 of file itkEuclideanDistancePointMetric.h.

◆ Pointer

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
using itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkEuclideanDistancePointMetric.h.

◆ Self

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
using itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::Self = EuclideanDistancePointMetric

Standard class type aliases.

Definition at line 54 of file itkEuclideanDistancePointMetric.h.

◆ Superclass

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
using itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::Superclass = PointSetToPointSetMetric<TFixedPointSet, TMovingPointSet>

Definition at line 55 of file itkEuclideanDistancePointMetric.h.

Constructor & Destructor Documentation

◆ EuclideanDistancePointMetric()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::EuclideanDistancePointMetric ( )
protected

◆ ~EuclideanDistancePointMetric()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::~EuclideanDistancePointMetric ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeSquaredDistanceOn()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
virtual void itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::ComputeSquaredDistanceOn ( )
virtual

Set/Get if the distance should be squared. When set to true, the filter's computational speed is substantially improved (by avoiding numerous sqrt() calls), but it will result in minimizing the sum of distances^4 instead of the sum of distances^2. Default is false.

◆ GetComputeSquaredDistance()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
virtual bool itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::GetComputeSquaredDistance ( ) const
virtual

Set/Get if the distance should be squared. When set to true, the filter's computational speed is substantially improved (by avoiding numerous sqrt() calls), but it will result in minimizing the sum of distances^4 instead of the sum of distances^2. Default is false.

◆ GetDerivative()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
void itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::GetDerivative ( const TransformParametersType parameters,
DerivativeType Derivative 
) const
override

Get the derivatives of the match measure.

◆ GetDistanceMap()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
virtual const DistanceMapType* itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::GetDistanceMap ( ) const
virtual

Set/Get the distance map.

◆ GetNumberOfValues()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
unsigned int itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::GetNumberOfValues ( ) const
overridevirtual

Get the number of values, i.e. the number of points in the moving set.

Implements itk::MultipleValuedCostFunction.

◆ GetValue()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
MeasureType itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::GetValue ( const TransformParametersType parameters) const
override

Get the match measure, i.e. the value for single valued optimizers.

◆ GetValueAndDerivative()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
void itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::GetValueAndDerivative ( const TransformParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const

Get value and derivatives for multiple valued optimizers.

◆ itkOverrideGetNameOfClassMacro()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::itkOverrideGetNameOfClassMacro ( EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >  )

Run-time type information (and related methods).

◆ New()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
static Pointer itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
void itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::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< TInternalComputationValueType >.

◆ SetComputeSquaredDistance()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
virtual void itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::SetComputeSquaredDistance ( bool  _arg)
virtual

Set/Get if the distance should be squared. When set to true, the filter's computational speed is substantially improved (by avoiding numerous sqrt() calls), but it will result in minimizing the sum of distances^4 instead of the sum of distances^2. Default is false.

◆ SetDistanceMap()

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
virtual void itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::SetDistanceMap ( const DistanceMapType _arg)
virtual

Set/Get the distance map.

Member Data Documentation

◆ m_ComputeSquaredDistance

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
bool itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::m_ComputeSquaredDistance { false }
private

Definition at line 129 of file itkEuclideanDistancePointMetric.h.

◆ m_DistanceMap

template<typename TFixedPointSet , typename TMovingPointSet , typename TDistanceMap = itk::Image<unsigned short, TMovingPointSet::PointDimension>>
DistanceMapPointer itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >::m_DistanceMap {}
private

Definition at line 128 of file itkEuclideanDistancePointMetric.h.


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