ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet > Class Template Reference
Data Processing Objects » Filters » Registration Filters » Components of Registration Methods » Similarity Metrics of Registration MethodsGroup Registration » | Module ITKRegistrationCommon

#include <itkPointSetToPointSetMetric.h>

Detailed Description

template<typename TFixedPointSet, typename TMovingPointSet>
class itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >

Computes similarity between two point sets.

This Class is templated over the type of the two point-sets. It expects a Transform to be plugged in. This particular class is the base class for a hierarchy of point-set to point-set metrics.

This class computes a value that measures the similarity between the fixed point-set and the transformed moving point-set.

Definition at line 45 of file itkPointSetToPointSetMetric.h.

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

Public Types

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

virtual TransformType * GetModifiableTransform ()
 
const char * GetNameOfClass () const override
 
unsigned int GetNumberOfParameters () const override
 
virtual void Initialize ()
 
virtual void SetTransform (TransformType *_arg)
 
void SetTransformParameters (const ParametersType &parameters) const
 
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetType * GetFixedPointSet () const
 
virtual void SetMovingPointSet (const MovingPointSetType *_arg)
 
virtual const MovingPointSetType * GetMovingPointSet () const
 
- Public Member Functions inherited from itk::MultipleValuedCostFunction
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
virtual unsigned int GetNumberOfValues () const =0
 
virtual MeasureType GetValue (const ParametersType &parameters) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
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)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int FixedPointSetDimension = TFixedPointSet::PointDimension
 
static constexpr unsigned int MovingPointSetDimension = TMovingPointSet::PointDimension
 

Protected Member Functions

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

Protected Attributes

FixedPointSetConstPointer m_FixedPointSet {}
 
MovingPointSetConstPointer m_MovingPointSet {}
 
TransformPointer m_Transform {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkPointSetToPointSetMetric.h.

◆ CoordinateRepresentationType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::CoordinateRepresentationType = Superclass::ParametersValueType

Type used for representing point components

Definition at line 57 of file itkPointSetToPointSetMetric.h.

◆ DerivativeType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::DerivativeType = Superclass::DerivativeType

Type of the derivative.

Definition at line 95 of file itkPointSetToPointSetMetric.h.

◆ FixedPointDataIterator

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::FixedPointDataIterator = typename FixedPointSetType::PointDataContainer::ConstIterator

Definition at line 76 of file itkPointSetToPointSetMetric.h.

◆ FixedPointIterator

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::FixedPointIterator = typename FixedPointSetType::PointsContainer::ConstIterator

Definition at line 75 of file itkPointSetToPointSetMetric.h.

◆ FixedPointSetConstPointer

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer

Definition at line 69 of file itkPointSetToPointSetMetric.h.

◆ FixedPointSetType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::FixedPointSetType = TFixedPointSet

Type of the fixed Pointset.

Definition at line 68 of file itkPointSetToPointSetMetric.h.

◆ InputPointType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::InputPointType = typename TransformType::InputPointType

Definition at line 86 of file itkPointSetToPointSetMetric.h.

◆ MeasureType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MeasureType = Superclass::MeasureType

Type of the measure.

Definition at line 92 of file itkPointSetToPointSetMetric.h.

◆ MovingPointDataIterator

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointDataIterator = typename MovingPointSetType::PointDataContainer::ConstIterator

Definition at line 79 of file itkPointSetToPointSetMetric.h.

◆ MovingPointIterator

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointIterator = typename MovingPointSetType::PointsContainer::ConstIterator

Definition at line 78 of file itkPointSetToPointSetMetric.h.

◆ MovingPointSetConstPointer

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointSetConstPointer = typename MovingPointSetType::ConstPointer

Definition at line 65 of file itkPointSetToPointSetMetric.h.

◆ MovingPointSetPixelType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointSetPixelType = typename TMovingPointSet::PixelType

Definition at line 64 of file itkPointSetToPointSetMetric.h.

◆ MovingPointSetType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointSetType = TMovingPointSet

Type of the moving Pointset.

Definition at line 63 of file itkPointSetToPointSetMetric.h.

◆ OutputPointType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::OutputPointType = typename TransformType::OutputPointType

Definition at line 87 of file itkPointSetToPointSetMetric.h.

◆ ParametersType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::ParametersType = Superclass::ParametersType

Type of the parameters.

Definition at line 98 of file itkPointSetToPointSetMetric.h.

◆ Pointer

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkPointSetToPointSetMetric.h.

◆ Self

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::Self = PointSetToPointSetMetric

Standard class type aliases.

Definition at line 51 of file itkPointSetToPointSetMetric.h.

◆ Superclass

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::Superclass = MultipleValuedCostFunction

Definition at line 52 of file itkPointSetToPointSetMetric.h.

◆ TransformJacobianType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::TransformJacobianType = typename TransformType::JacobianType

Definition at line 89 of file itkPointSetToPointSetMetric.h.

◆ TransformParametersType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::TransformParametersType = typename TransformType::ParametersType

Definition at line 88 of file itkPointSetToPointSetMetric.h.

◆ TransformPointer

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::TransformPointer = typename TransformType::Pointer

Definition at line 85 of file itkPointSetToPointSetMetric.h.

◆ TransformType

template<typename TFixedPointSet , typename TMovingPointSet >
using itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::TransformType = Transform<CoordinateRepresentationType, Self::MovingPointSetDimension, Self::FixedPointSetDimension>

Type of the Transform Base class

Definition at line 83 of file itkPointSetToPointSetMetric.h.

Constructor & Destructor Documentation

◆ PointSetToPointSetMetric()

template<typename TFixedPointSet , typename TMovingPointSet >
itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::PointSetToPointSetMetric ( )
protected

◆ ~PointSetToPointSetMetric()

template<typename TFixedPointSet , typename TMovingPointSet >
itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::~PointSetToPointSetMetric ( )
overrideprotecteddefault

Member Function Documentation

◆ GetFixedPointSet()

template<typename TFixedPointSet , typename TMovingPointSet >
virtual const FixedPointSetType* itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetFixedPointSet ( ) const
virtual

Get/Set the Fixed Pointset.

◆ GetModifiableTransform()

template<typename TFixedPointSet , typename TMovingPointSet >
virtual TransformType* itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetModifiableTransform ( )
virtual

Get a pointer to the Transform.

◆ GetMovingPointSet()

template<typename TFixedPointSet , typename TMovingPointSet >
virtual const MovingPointSetType* itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetMovingPointSet ( ) const
virtual

Get/Set the Moving Pointset.

◆ GetNameOfClass()

template<typename TFixedPointSet , typename TMovingPointSet >
const char* itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::MultipleValuedCostFunction.

◆ GetNumberOfParameters()

template<typename TFixedPointSet , typename TMovingPointSet >
unsigned int itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetNumberOfParameters ( ) const
inlineoverridevirtual

Return the number of parameters required by the Transform

Implements itk::CostFunctionTemplate< TInternalComputationValueType >.

Definition at line 122 of file itkPointSetToPointSetMetric.h.

◆ Initialize()

template<typename TFixedPointSet , typename TMovingPointSet >
virtual void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::Initialize ( )
virtual

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

◆ PrintSelf()

template<typename TFixedPointSet , typename TMovingPointSet >
void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::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 >.

◆ SetFixedPointSet()

template<typename TFixedPointSet , typename TMovingPointSet >
virtual void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::SetFixedPointSet ( const FixedPointSetType *  _arg)
virtual

Get/Set the Fixed Pointset.

◆ SetMovingPointSet()

template<typename TFixedPointSet , typename TMovingPointSet >
virtual void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::SetMovingPointSet ( const MovingPointSetType *  _arg)
virtual

Get/Set the Moving Pointset.

◆ SetTransform()

template<typename TFixedPointSet , typename TMovingPointSet >
virtual void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::SetTransform ( TransformType *  _arg)
virtual

Connect the Transform.

◆ SetTransformParameters()

template<typename TFixedPointSet , typename TMovingPointSet >
void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::SetTransformParameters ( const ParametersType &  parameters) const

Set the parameters defining the Transform.

Member Data Documentation

◆ FixedPointSetDimension

template<typename TFixedPointSet , typename TMovingPointSet >
constexpr unsigned int itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::FixedPointSetDimension = TFixedPointSet::PointDimension
staticconstexpr

Definition at line 73 of file itkPointSetToPointSetMetric.h.

◆ m_FixedPointSet

template<typename TFixedPointSet , typename TMovingPointSet >
FixedPointSetConstPointer itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::m_FixedPointSet {}
protected

Definition at line 137 of file itkPointSetToPointSetMetric.h.

◆ m_MovingPointSet

template<typename TFixedPointSet , typename TMovingPointSet >
MovingPointSetConstPointer itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::m_MovingPointSet {}
protected

Definition at line 139 of file itkPointSetToPointSetMetric.h.

◆ m_Transform

template<typename TFixedPointSet , typename TMovingPointSet >
TransformPointer itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::m_Transform {}
mutableprotected

Definition at line 141 of file itkPointSetToPointSetMetric.h.

◆ MovingPointSetDimension

template<typename TFixedPointSet , typename TMovingPointSet >
constexpr unsigned int itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointSetDimension = TMovingPointSet::PointDimension
staticconstexpr

Constants for the pointset dimensions

Definition at line 72 of file itkPointSetToPointSetMetric.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16