ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet > Class Template Reference
Similarity Metrics of Registration Methods | Module ITKRegistrationCommon

#include <itkPointSetToPointSetMetric.h>

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

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.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef
Superclass::ParametersValueType 		CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
FixedPointSetType::PointDataContainer::ConstIterator 		FixedPointDataIterator
 
typedef
FixedPointSetType::PointsContainer::ConstIterator 		FixedPointIterator
 
typedef
FixedPointSetType::ConstPointer 		FixedPointSetConstPointer
 
typedef TFixedPointSet FixedPointSetType
 
typedef
TransformType::InputPointType 		InputPointType
 
typedef Superclass::MeasureType MeasureType
 
typedef
MovingPointSetType::PointDataContainer::ConstIterator 		MovingPointDataIterator
 
typedef
MovingPointSetType::PointsContainer::ConstIterator 		MovingPointIterator
 
typedef
MovingPointSetType::ConstPointer 		MovingPointSetConstPointer
 
typedef TMovingPointSet::PixelType MovingPointSetPixelType
 
typedef TMovingPointSet MovingPointSetType
 
typedef
TransformType::OutputPointType 		OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< Self > Pointer
 
typedef PointSetToPointSetMetric Self
 
typedef MultipleValuedCostFunction Superclass
 
typedef TransformType::JacobianType TransformJacobianType
 
typedef
TransformType::ParametersType 		TransformParametersType
 
typedef TransformType::Pointer TransformPointer
 
typedef Transform
< CoordinateRepresentationType,
itkGetStaticConstMacro(MovingPointSetDimension),
itkGetStaticConstMacro(FixedPointSetDimension) > 		TransformType
 
- Public Types inherited from itk::MultipleValuedCostFunction
typedef SmartPointer< const Self > ConstPointer
 
typedef Array2D< double > DerivativeType
 
typedef Array< double > MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< Self > Pointer
 
typedef MultipleValuedCostFunction Self
 
typedef CostFunction Superclass
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const Self > ConstPointer
 
typedef OptimizerParameters
< TInternalComputationValueType > 		ParametersType
 
typedef
TInternalComputationValueType 		ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
typedef CostFunctionTemplate Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

virtual TransformType * GetModifiableTransform ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfParameters (void) const override
 
virtual const TransformType * GetTransform () const
 
virtual void Initialize (void) throw ( ExceptionObject )
 
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 (void) 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
 
virtual 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

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

Protected Member Functions

 PointSetToPointSetMetric ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~PointSetToPointSetMetric ()
 
- Protected Member Functions inherited from itk::MultipleValuedCostFunction
 MultipleValuedCostFunction ()
 
virtual ~MultipleValuedCostFunction ()
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
 
virtual ~CostFunctionTemplate ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 PointSetToPointSetMetric (const Self &) ITK_DELETE_FUNCTION
 

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Member Typedef Documentation

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

Definition at line 53 of file itkPointSetToPointSetMetric.h.

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

Type used for representing point components

Definition at line 56 of file itkPointSetToPointSetMetric.h.

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

Type of the derivative.

Definition at line 98 of file itkPointSetToPointSetMetric.h.

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

Definition at line 78 of file itkPointSetToPointSetMetric.h.

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

Definition at line 77 of file itkPointSetToPointSetMetric.h.

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

Definition at line 68 of file itkPointSetToPointSetMetric.h.

template<typename TFixedPointSet , typename TMovingPointSet >
typedef TFixedPointSet itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::FixedPointSetType

Type of the fixed Pointset.

Definition at line 67 of file itkPointSetToPointSetMetric.h.

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

Definition at line 89 of file itkPointSetToPointSetMetric.h.

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

Type of the measure.

Definition at line 95 of file itkPointSetToPointSetMetric.h.

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

Definition at line 81 of file itkPointSetToPointSetMetric.h.

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

Definition at line 80 of file itkPointSetToPointSetMetric.h.

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

Definition at line 64 of file itkPointSetToPointSetMetric.h.

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

Definition at line 63 of file itkPointSetToPointSetMetric.h.

template<typename TFixedPointSet , typename TMovingPointSet >
typedef TMovingPointSet itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointSetType

Type of the moving Pointset.

Definition at line 59 of file itkPointSetToPointSetMetric.h.

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

Definition at line 90 of file itkPointSetToPointSetMetric.h.

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

Type of the parameters.

Definition at line 101 of file itkPointSetToPointSetMetric.h.

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

Definition at line 52 of file itkPointSetToPointSetMetric.h.

template<typename TFixedPointSet , typename TMovingPointSet >
typedef PointSetToPointSetMetric itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::Self

Standard class typedefs.

Definition at line 50 of file itkPointSetToPointSetMetric.h.

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

Definition at line 51 of file itkPointSetToPointSetMetric.h.

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

Definition at line 92 of file itkPointSetToPointSetMetric.h.

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

Definition at line 91 of file itkPointSetToPointSetMetric.h.

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

Definition at line 88 of file itkPointSetToPointSetMetric.h.

template<typename TFixedPointSet , typename TMovingPointSet >
typedef Transform< CoordinateRepresentationType, itkGetStaticConstMacro(MovingPointSetDimension), itkGetStaticConstMacro(FixedPointSetDimension) > itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::TransformType

Type of the Transform Base class

Definition at line 86 of file itkPointSetToPointSetMetric.h.

Constructor & Destructor Documentation

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

Definition at line 133 of file itkPointSetToPointSetMetric.h.

template<typename TFixedPointSet , typename TMovingPointSet >
itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::PointSetToPointSetMetric ( const Self &  )
private

Member Function Documentation

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

Get/Set the Fixed Pointset.

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

Get a pointer to the Transform.

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

Get/Set the Moving Pointset.

template<typename TFixedPointSet , typename TMovingPointSet >
virtual const char* itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::MultipleValuedCostFunction.

Reimplemented in itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >.

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

Return the number of parameters required by the Transform

Implements itk::CostFunctionTemplate< TInternalComputationValueType >.

Definition at line 123 of file itkPointSetToPointSetMetric.h.

References itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::m_Transform.

template<typename TFixedPointSet , typename TMovingPointSet >
virtual const TransformType* itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetTransform ( ) const
virtual
template<typename TFixedPointSet , typename TMovingPointSet >
virtual void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::Initialize ( void  )
throw (ExceptionObject
)
virtual

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

template<typename TFixedPointSet , typename TMovingPointSet >
void itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::operator= ( const Self &  )
private
template<typename TFixedPointSet , typename TMovingPointSet >
virtual 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 >.

Reimplemented in itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >.

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

Get/Set the Fixed Pointset.

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

Get/Set the Moving Pointset.

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

Connect the Transform.

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

Set the parameters defining the Transform.

Member Data Documentation

template<typename TFixedPointSet , typename TMovingPointSet >
const unsigned int itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::FixedPointSetDimension = TFixedPointSet::PointDimension
static

Constants for the pointset dimensions

Definition at line 74 of file itkPointSetToPointSetMetric.h.

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

Definition at line 136 of file itkPointSetToPointSetMetric.h.

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

Definition at line 138 of file itkPointSetToPointSetMetric.h.

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

Definition at line 140 of file itkPointSetToPointSetMetric.h.

Referenced by itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::GetNumberOfParameters().

template<typename TFixedPointSet , typename TMovingPointSet >
const unsigned int itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >::MovingPointSetDimension = TMovingPointSet::PointDimension
static

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.
Generated on Sat Jan 30 2016 05:16:20 for ITK by   doxygen 1.8.5