itk::PointSetToImageMetric< TFixedPointSet, TMovingImage > Class Template Reference
[Similarity Metrics of Registration Methods]

Computes similarity between a point set and an image. More...

#include <itkPointSetToImageMetric.h>

Inheritance diagram for itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >:

[legend]Collaboration diagram for itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >:

[legend]List of all members.

Public Types
typedef PointSetToImageMetric	Self
typedef SingleValuedCostFunction	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersValueType	CoordinateRepresentationType
typedef TMovingImage	MovingImageType
typedef TMovingImage::PixelType	MovingImagePixelType
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef TFixedPointSet	FixedPointSetType
typedef FixedPointSetType::ConstPointer	FixedPointSetConstPointer
typedef FixedPointSetType::PointsContainer::ConstIterator	PointIterator
typedef FixedPointSetType::PointDataContainer::ConstIterator	PointDataIterator
typedef Transform< CoordinateRepresentationType, itkGetStaticConstMacro(MovingImageDimension), itkGetStaticConstMacro(FixedPointSetDimension)	TransformType )
typedef TransformType::Pointer	TransformPointer
typedef TransformType::InputPointType	InputPointType
typedef TransformType::OutputPointType	OutputPointType
typedef TransformType::ParametersType	TransformParametersType
typedef TransformType::JacobianType	TransformJacobianType
typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >	InterpolatorType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef Superclass::MeasureType	MeasureType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::ParametersType	ParametersType
typedef NumericTraits< MovingImagePixelType >::RealType	RealType
typedef CovariantVector< RealType, itkGetStaticConstMacro(MovingImageDimension)	GradientPixelType )
typedef Image< GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)	GradientImageType )
typedef SmartPointer< GradientImageType >	GradientImagePointer
typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >	GradientImageFilterType
typedef GradientImageFilterType::Pointer	GradientImageFilterPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetFixedPointSet (const FixedPointSetType *_arg)
virtual const FixedPointSetType *	GetFixedPointSet ()
virtual void	SetMovingImage (const MovingImageType *_arg)
virtual const MovingImageType *	GetMovingImage ()
virtual void	SetTransform (TransformType *_arg)
virtual TransformType *	GetTransform ()
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetInterpolator ()
virtual unsigned long	GetNumberOfPixelsCounted () const
void	SetTransformParameters (const ParametersType &parameters) const
unsigned int	GetNumberOfParameters (void) const
virtual void	Initialize (void) throw ( ExceptionObject )
	itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
	itkStaticConstMacro (FixedPointSetDimension, unsigned int, TFixedPointSet::PointDimension)
virtual void	SetComputeGradient (bool _arg)
virtual bool	GetComputeGradient () const
Protected Member Functions
	PointSetToImageMetric ()
virtual	~PointSetToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
unsigned long	m_NumberOfPixelsCounted
FixedPointSetConstPointer	m_FixedPointSet
MovingImageConstPointer	m_MovingImage
TransformPointer	m_Transform
InterpolatorPointer	m_Interpolator
bool	m_ComputeGradient
GradientImagePointer	m_GradientImage

---

Detailed Description

template<class TFixedPointSet, class TMovingImage>
class itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >

Computes similarity between a point set and an image.

This Class is templated over the type of the input point-set and image. It expects a Transform and an Interpolator to be plugged in. This particular class is the base class for a hierarchy of similarity metrics.

This class computes a value that measures the similarity between the values associated with points in the point set and the transformed Moving image. The Interpolator is used to compute intensity values on non-grid positions resulting from mapping points through the Transform.

Definition at line 47 of file itkPointSetToImageMetric.h.

---

Member Typedef Documentation

template<class TFixedPointSet, class TMovingImage> typedef SmartPointer<const Self> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::ConstPointer

Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 54 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::ParametersValueType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::CoordinateRepresentationType

Type used for representing point components Definition at line 57 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::DerivativeType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::DerivativeType

Type of the derivative. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 118 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef FixedPointSetType::ConstPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetConstPointer

Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 69 of file itkPointSetToImageMetric.h. Referenced by itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::~PointSetToImageMetric().

template<class TFixedPointSet, class TMovingImage> typedef TFixedPointSet itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetType

Type of the fixed Image. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 68 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef GradientImageFilterType::Pointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageFilterPointer

Gaussian filter to compute the gradient of the Moving Image Definition at line 108 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType > itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageFilterType

Gaussian filter to compute the gradient of the Moving Image Definition at line 107 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef SmartPointer<GradientImageType> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImagePointer

Gaussian filter to compute the gradient of the Moving Image Definition at line 104 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Image<GradientPixelType, itkGetStaticConstMacro(MovingImageDimension) itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageType)

Gaussian filter to compute the gradient of the Moving Image Definition at line 103 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef CovariantVector<RealType, itkGetStaticConstMacro(MovingImageDimension) itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientPixelType)

Gaussian filter to compute the gradient of the Moving Image Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 101 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TransformType::InputPointType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InputPointType

Definition at line 87 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef InterpolatorType::Pointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InterpolatorPointer

Definition at line 112 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType > itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InterpolatorType

Type of the Interpolator Base class Definition at line 95 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::MeasureType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MeasureType

Type of the measure. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 115 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef MovingImageType::ConstPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageConstPointer

Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 65 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TMovingImage::PixelType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImagePixelType

Definition at line 64 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TMovingImage itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageType

Type of the moving Image. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 63 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TransformType::OutputPointType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::OutputPointType

Definition at line 88 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::ParametersType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::ParametersType

Type of the parameters. Reimplemented from itk::SingleValuedCostFunction. Definition at line 121 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef FixedPointSetType::PointDataContainer::ConstIterator itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::PointDataIterator

Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 79 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef SmartPointer<Self> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::Pointer

Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 53 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef FixedPointSetType::PointsContainer::ConstIterator itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::PointIterator

Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 78 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef NumericTraits<MovingImagePixelType>::RealType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::RealType

Gaussian filter to compute the gradient of the Moving Image Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 99 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef PointSetToImageMetric itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::Self

Standard class typedefs. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 51 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef SingleValuedCostFunction itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::Superclass

Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 52 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TransformType::JacobianType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformJacobianType

Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 90 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TransformType::ParametersType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformParametersType

Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 89 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TransformType::Pointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformPointer

Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 86 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Transform<CoordinateRepresentationType, itkGetStaticConstMacro(MovingImageDimension), itkGetStaticConstMacro(FixedPointSetDimension) itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformType)

Type of the Transform Base class Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 84 of file itkPointSetToImageMetric.h.

---

Constructor & Destructor Documentation

template<class TFixedPointSet, class TMovingImage> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::PointSetToImageMetric (   )  [protected]

template<class TFixedPointSet, class TMovingImage> virtual itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::~PointSetToImageMetric (   )  [inline, protected, virtual]

Definition at line 174 of file itkPointSetToImageMetric.h. References itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetConstPointer.

---

Member Function Documentation

template<class TFixedPointSet, class TMovingImage> virtual const char* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >.

template<class TFixedPointSet, class TMovingImage> virtual bool itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetComputeGradient (   )  const [virtual]

Set/Get the flag for computing the image gradient. When ON the metric derivative is computed using the Jacobian of the transformation and the image gradient. When OFF the metric derivative is computed by finite differences. Mode ON results in higher speed at the price of large memory footprint. Mode OFF results in small memory footprint at the price of large computation time

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

Get the Fixed Image.

template<class TFixedPointSet, class TMovingImage> virtual InterpolatorType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetInterpolator (   )  [virtual]

Get a pointer to the Interpolator.

template<class TFixedPointSet, class TMovingImage> virtual const MovingImageType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetMovingImage (   )  [virtual]

Get the Moving Image.

template<class TFixedPointSet, class TMovingImage> unsigned int itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetNumberOfParameters (  void   )  const [inline, virtual]

Return the number of parameters required by the Transform Implements itk::CostFunction. Definition at line 165 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> virtual unsigned long itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetNumberOfPixelsCounted (   )  const [virtual]

Get the number of pixels considered in the computation.

template<class TFixedPointSet, class TMovingImage> virtual TransformType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetTransform (   )  [virtual]

Get a pointer to the Transform.

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

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

template<class TFixedPointSet, class TMovingImage> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::itkStaticConstMacro (  FixedPointSetDimension  , unsigned  int, TFixedPointSet::PointDimension  )

Constants for the image dimensions

template<class TFixedPointSet, class TMovingImage> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::itkStaticConstMacro (  MovingImageDimension  , unsigned  int, TMovingImage::ImageDimension  )

Constants for the image dimensions

template<class TFixedPointSet, class TMovingImage> void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::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::CostFunction.

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetComputeGradient (  bool  _arg  )  [virtual]

Set/Get the flag for computing the image gradient. When ON the metric derivative is computed using the Jacobian of the transformation and the image gradient. When OFF the metric derivative is computed by finite differences. Mode ON results in higher speed at the price of large memory footprint. Mode OFF results in small memory footprint at the price of large computation time

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

Connect the Fixed Image.

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetInterpolator (  InterpolatorType *  _arg  )  [virtual]

Connect the Interpolator.

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetMovingImage (  const MovingImageType *  _arg  )  [virtual]

Connect the Moving Image.

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetTransform (  TransformType *  _arg  )  [virtual]

Connect the Transform.

template<class TFixedPointSet, class TMovingImage> void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetTransformParameters (  const ParametersType &  parameters  )  const

Set the parameters defining the Transform.

---

Member Data Documentation

template<class TFixedPointSet, class TMovingImage> bool itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_ComputeGradient [protected]

Definition at line 185 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> FixedPointSetConstPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_FixedPointSet [protected]

Definition at line 179 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> GradientImagePointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_GradientImage [protected]

Definition at line 186 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> InterpolatorPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_Interpolator [protected]

Definition at line 183 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> MovingImageConstPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_MovingImage [protected]

Definition at line 180 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> unsigned long itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_NumberOfPixelsCounted [mutable, protected]

Definition at line 177 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> TransformPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_Transform [mutable, protected]

Definition at line 182 of file itkPointSetToImageMetric.h.

---

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

• itkPointSetToImageMetric.h

---