ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet > Class Template Reference
Module ITKMetricsv4

Computes similarity between two point sets. More...

#include <itkPointSetToPointSetMetricv4.h>

Inheritance diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >:
Collaboration diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef PointType::CoordRepType CoordRepType
typedef Superclass::DerivativeType DerivativeType
typedef DerivativeType::ValueType DerivativeValueType
typedef TFixedPointSet::PixelType FixedPixelType
typedef
TFixedPointSet::PointsContainer 		FixedPointsContainer
typedef TFixedPointSet FixedPointSetType
typedef TFixedPointSet::PointType FixedPointType
typedef FixedArray
< DerivativeValueType,
itkGetStaticConstMacro(PointDimension)> 		LocalDerivativeType
typedef Superclass::MeasureType MeasureType
typedef TMovingPointSet::PixelType MovingPixelType
typedef
TMovingPointSet::PointsContainer 		MovingPointsContainer
typedef TMovingPointSet MovingPointSetType
typedef TMovingPointSet::PointType MovingPointType
typedef PointSet
< MovingPixelType,
itkGetStaticConstMacro(PointDimension)> 		MovingTransformedPointSetType
typedef
MovingTransformType::Pointer 		MovingTransformPointer
typedef Transform
< CoordRepType,
itkGetStaticConstMacro(MovingPointDimension),
itkGetStaticConstMacro(PointDimension)> 		MovingTransformType
typedef
PointsLocatorType::NeighborsIdentifierType 		NeighborsIdentifierType
typedef Superclass::ParametersType ParametersType
typedef SmartPointer< Self > Pointer
typedef
PointsContainer::ElementIdentifier 		PointIdentifier
typedef
PointsContainer::ConstIterator 		PointsConstIterator
typedef FixedPointsContainer PointsContainer
typedef PointsLocator
< PointIdentifier,
itkGetStaticConstMacro(PointDimension),
CoordRepType, PointsContainer > 		PointsLocatorType
typedef FixedPointType PointType
typedef PointSetToPointSetMetricv4 Self
typedef ObjectToObjectMetric Superclass
typedef Transform
< CoordRepType,
itkGetStaticConstMacro(FixedPointDimension),
itkGetStaticConstMacro(PointDimension)> 		FixedTransformType
typedef FixedTransformType::Pointer FixedTransformPointer
typedef PointSet
< FixedPixelType,
itkGetStaticConstMacro(PointDimension)> 		FixedTransformedPointSetType

Public Member Functions

virtual void GetDerivative (DerivativeType &) const
virtual const FixedPointSetType * GetFixedPointSet ()
virtual const FixedTransformType * GetFixedTransform ()
virtual const
FixedTransformedPointSetType * 		GetFixedTransformedPointSet ()
virtual LocalDerivativeType GetLocalNeighborhoodDerivative (const PointType &) const
virtual MeasureType GetLocalNeighborhoodValue (const PointType &) const =0
virtual void GetLocalNeighborhoodValueAndDerivative (const PointType &, MeasureType &, LocalDerivativeType &) const =0
virtual const MovingPointSetType * GetMovingPointSet ()
virtual const MovingTransformType * GetMovingTransform ()
virtual const
MovingTransformedPointSetType * 		GetMovingTransformedPointSet ()
virtual const char * GetNameOfClass () const
unsigned int GetNumberOfComponents () const
virtual unsigned int GetNumberOfLocalParameters () const
virtual unsigned int GetNumberOfParameters () const
virtual const ParametersType & GetParameters () const
virtual MeasureType GetValue () const
virtual void GetValueAndDerivative (MeasureType &, DerivativeType &) const
virtual bool HasLocalSupport () const
virtual void Initialize (void) throw ( ExceptionObject )
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
virtual void SetFixedTransform (FixedTransformType *_arg)
virtual void SetMovingPointSet (MovingPointSetType *_arg)
virtual void SetMovingTransform (MovingTransformType *_arg)
virtual void UpdateTransformParameters (DerivativeType &derivative, ParametersValueType factor=1.0)

Static Public Attributes

static const unsigned int FixedPointDimension = TFixedPointSet::PointDimension
static const unsigned int MovingPointDimension = TFixedPointSet::PointDimension
static const unsigned int PointDimension = TFixedPointSet::PointDimension

Protected Member Functions

void InitializePointsLocators ()
 PointSetToPointSetMetricv4 ()
void PrintSelf (std::ostream &os, Indent indent) const
void TransformFixedPointSet ()
void TransformMovingPointSet ()
virtual ~PointSetToPointSetMetricv4 ()

Protected Attributes

FixedPointSetType::ConstPointer m_FixedPointSet
FixedTransformPointer m_FixedTransform
FixedTransformedPointSetType::Pointer m_FixedTransformedPointSet
PointsLocatorType::Pointer m_FixedTransformedPointsLocator
MovingPointSetType::ConstPointer m_MovingPointSet
MovingTransformPointer m_MovingTransform
MovingTransformedPointSetType::Pointer m_MovingTransformedPointSet
PointsLocatorType::Pointer m_MovingTransformedPointsLocator

Private Member Functions

void operator= (const Self &)
 PointSetToPointSetMetricv4 (const Self &)

Detailed Description

template<class TFixedPointSet, class TMovingPointSet>
class itk::PointSetToPointSetMetricv4< 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 44 of file itkPointSetToPointSetMetricv4.h.

Member Typedef Documentation

template<class TFixedPointSet, class TMovingPointSet>
typedef SmartPointer<const Self> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::ConstPointer

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 53 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointType::CoordRepType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::CoordRepType

Reimplemented in itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 86 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef Superclass::DerivativeType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::DerivativeType

Type of the derivative.

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 121 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef DerivativeType::ValueType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::DerivativeValueType

Definition at line 123 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TFixedPointSet::PixelType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedPixelType

Definition at line 61 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TFixedPointSet::PointsContainer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedPointsContainer

Definition at line 62 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TFixedPointSet itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedPointSetType

Type of the fixed point set.

Definition at line 56 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TFixedPointSet::PointType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedPointType

Definition at line 60 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointSet<FixedPixelType, itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedTransformedPointSetType

Type of the Transform Base class

Definition at line 104 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef FixedTransformType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedTransformPointer

Type of the Transform Base class

Definition at line 102 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef Transform<CoordRepType, itkGetStaticConstMacro( FixedPointDimension ), itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedTransformType

Type of the Transform Base class

Definition at line 101 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef FixedArray<DerivativeValueType, itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::LocalDerivativeType

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 125 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef Superclass::MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MeasureType

Type of the measure.

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 115 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TMovingPointSet::PixelType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingPixelType

Definition at line 70 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TMovingPointSet::PointsContainer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingPointsContainer

Definition at line 71 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TMovingPointSet itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingPointSetType

Type of the moving point set.

Definition at line 68 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef TMovingPointSet::PointType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingPointType

Definition at line 69 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointSet<MovingPixelType, itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingTransformedPointSetType

Definition at line 112 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef MovingTransformType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingTransformPointer

Definition at line 110 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef Transform<CoordRepType, itkGetStaticConstMacro( MovingPointDimension ), itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingTransformType

Definition at line 109 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointsLocatorType:: NeighborsIdentifierType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::NeighborsIdentifierType

Reimplemented in itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 96 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef Superclass::ParametersType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::ParametersType

Type of the measure.

Reimplemented from itk::ObjectToObjectMetric.

Definition at line 118 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef SmartPointer<Self> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::Pointer

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 52 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointsContainer::ElementIdentifier itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointIdentifier

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 89 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointsContainer::ConstIterator itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointsConstIterator

Definition at line 88 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef FixedPointsContainer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointsContainer

Reimplemented in itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 87 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointsLocator<PointIdentifier, itkGetStaticConstMacro( PointDimension ), CoordRepType, PointsContainer> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointsLocatorType

Typedef for points locator class to speed up finding neighboring points

Definition at line 94 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef FixedPointType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointType

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 85 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef PointSetToPointSetMetricv4 itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::Self

Standard class typedefs.

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 50 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
typedef ObjectToObjectMetric itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::Superclass

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 51 of file itkPointSetToPointSetMetricv4.h.

Constructor & Destructor Documentation

template<class TFixedPointSet, class TMovingPointSet>
itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointSetToPointSetMetricv4 ( ) [protected]
template<class TFixedPointSet, class TMovingPointSet>
virtual itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::~PointSetToPointSetMetricv4 ( ) [protected, virtual]
template<class TFixedPointSet, class TMovingPointSet>
itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointSetToPointSetMetricv4 ( const Self &  ) [private]

Member Function Documentation

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetDerivative ( DerivativeType &  ) const [virtual]

This method returns the derivative based on the current transformation(s). This function can be redefined in derived classes but many point set metrics follow the same structure---one iterates through the points and, for each point a derivative is calculated. The set of all these local derivatives constitutes the total derivative. Note that this might not be applicable to all point set metrics. For those cases, the developer will have to redefine the GetDerivative() function.

Reimplemented in itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

template<class TFixedPointSet, class TMovingPointSet>
virtual const FixedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetFixedPointSet ( ) [virtual]

Get the fixed point set.

template<class TFixedPointSet, class TMovingPointSet>
virtual const FixedTransformType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetFixedTransform ( ) [virtual]

Get a pointer to the fixed transform.

template<class TFixedPointSet, class TMovingPointSet>
virtual const FixedTransformedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetFixedTransformedPointSet ( ) [virtual]

Get the moving transformed point set.

template<class TFixedPointSet, class TMovingPointSet>
virtual LocalDerivativeType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetLocalNeighborhoodDerivative ( const PointType &  ) const [virtual]

Calculates the local derivative for a single point.

template<class TFixedPointSet, class TMovingPointSet>
virtual MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetLocalNeighborhoodValue ( const PointType &  ) const [pure virtual]

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetLocalNeighborhoodValueAndDerivative ( const PointType &  ,
MeasureType &  ,
LocalDerivativeType &   
) const [pure virtual]

Calculates the local value/derivative for a single point.

template<class TFixedPointSet, class TMovingPointSet>
virtual const MovingPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetMovingPointSet ( ) [virtual]

Get the moving point set.

template<class TFixedPointSet, class TMovingPointSet>
virtual const MovingTransformType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetMovingTransform ( ) [virtual]

Get a pointer to the moving transform.

template<class TFixedPointSet, class TMovingPointSet>
virtual const MovingTransformedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetMovingTransformedPointSet ( ) [virtual]

Get the moving transformed point set.

template<class TFixedPointSet, class TMovingPointSet>
virtual const char* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

template<class TFixedPointSet, class TMovingPointSet>
unsigned int itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetNumberOfComponents ( ) const

For now return the number of points used in the value/derivative calculations.

template<class TFixedPointSet, class TMovingPointSet>
virtual unsigned int itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetNumberOfLocalParameters ( ) const [virtual]

Get the number of local transform parameters of the currently active transform.

Implements itk::ObjectToObjectMetric.

template<class TFixedPointSet, class TMovingPointSet>
virtual unsigned int itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetNumberOfParameters ( ) const [virtual]

Get the number of transform parameters of the currently active transform.

Implements itk::ObjectToObjectMetric.

template<class TFixedPointSet, class TMovingPointSet>
virtual const ParametersType& itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetParameters ( ) const [virtual]

Get the transform parameters of the currently active transform.

Implements itk::ObjectToObjectMetric.

template<class TFixedPointSet, class TMovingPointSet>
virtual MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetValue ( ) const [virtual]

This method returns the value of the metric based on the current transformation(s). This function can be redefined in derived classes but many point set metrics follow the same structure---one iterates through the points and, for each point a metric value is calculated. The summation of these individual point metric values gives the total value of the metric. Note that this might not be applicable to all point set metrics. For those cases, the developer will have to redefine the GetValue() function.

Implements itk::SingleValuedCostFunctionv4.

Reimplemented in itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::GetValueAndDerivative ( MeasureType &  ,
DerivativeType &   
) const [virtual]

This method returns the derivative and value based on the current transformation(s). This function can be redefined in derived classes but many point set metrics follow the same structure---one iterates through the points and, for each point a derivative and value is calculated. The set of all these local derivatives/values constitutes the total derivative and value. Note that this might not be applicable to all point set metrics. For those cases, the developer will have to redefine the GetValue() and GetDerivative() functions.

Reimplemented in itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

template<class TFixedPointSet, class TMovingPointSet>
virtual bool itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::HasLocalSupport ( ) const [virtual]

Return whether the metric's active transform has local support, e.g. whether it is dense/high-dimensional.

Implements itk::ObjectToObjectMetric.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::Initialize ( void  ) throw ( ExceptionObject ) [virtual]

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

Implements itk::ObjectToObjectMetric.

Reimplemented in itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

template<class TFixedPointSet, class TMovingPointSet>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::InitializePointsLocators ( ) [protected]

Build point locators for the fixed and moving point sets to speed up derivative and value calculations.

template<class TFixedPointSet, class TMovingPointSet>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::operator= ( const Self &  ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

template<class TFixedPointSet, class TMovingPointSet>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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::ObjectToObjectMetric.

Reimplemented in itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::SetFixedPointSet ( const FixedPointSetType *  _arg) [virtual]

Connect the fixed pointset.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::SetFixedTransform ( FixedTransformType *  _arg) [virtual]

Connect the fixed transform.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::SetMovingPointSet ( MovingPointSetType *  _arg) [virtual]

Connect the moving point set.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::SetMovingTransform ( MovingTransformType *  _arg) [virtual]

Connect the moving transform.

template<class TFixedPointSet, class TMovingPointSet>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::TransformFixedPointSet ( ) [protected]

Warp the fixed point set based on the fixed transform. Note that the warped moving point set is of type FixedPointSetType since the transform takes the points from the fixed to the moving domain.

template<class TFixedPointSet, class TMovingPointSet>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::TransformMovingPointSet ( ) [protected]

Warp the moving point set based on the moving transform. Note that the warped moving point set is of type FixedPointSetType since the transform takes the points from the moving to the fixed domain.

template<class TFixedPointSet, class TMovingPointSet>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::UpdateTransformParameters ( DerivativeType &  derivative,
ParametersValueType  factor = 1.0 
) [virtual]

Update the parameters of the metric's active transform. Typically this call is passed through directly to the transform. factor is a scalar multiplier for each value in update, and defaults to 1.0 . derivative must be the proper size, as retrieved from GetNumberOfParameters.

Implements itk::ObjectToObjectMetric.

Member Data Documentation

template<class TFixedPointSet, class TMovingPointSet>
const unsigned int itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::FixedPointDimension = TFixedPointSet::PointDimension [static]

Definition at line 65 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
FixedPointSetType::ConstPointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_FixedPointSet [protected]

Definition at line 254 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
FixedTransformPointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_FixedTransform [protected]

Definition at line 257 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
FixedTransformedPointSetType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_FixedTransformedPointSet [protected]

Definition at line 255 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
PointsLocatorType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_FixedTransformedPointsLocator [protected]

Definition at line 258 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
MovingPointSetType::ConstPointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_MovingPointSet [protected]

Definition at line 260 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
MovingTransformPointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_MovingTransform [protected]

Definition at line 263 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
MovingTransformedPointSetType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_MovingTransformedPointSet [protected]

Definition at line 261 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
PointsLocatorType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::m_MovingTransformedPointsLocator [protected]

Definition at line 264 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
const unsigned int itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::MovingPointDimension = TFixedPointSet::PointDimension [static]

Definition at line 74 of file itkPointSetToPointSetMetricv4.h.

template<class TFixedPointSet, class TMovingPointSet>
const unsigned int itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >::PointDimension = TFixedPointSet::PointDimension [static]

typedefs for the data types used in the point set metric calculations. It is assumed that the constants of the fixed point set, such as the point dimension, are the same for the "common space" in which the metric calculation occurs.

Reimplemented in itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >.

Definition at line 83 of file itkPointSetToPointSetMetricv4.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 01:06:09 for ITK by doxygen 1.7.4