itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject > Class Template Reference

Computes similarity between a moving spatial obejct and an Image to be registered. More...

#include <itkImageToSpatialObjectMetric.h>

Inheritance diagram for itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >:

[legend]Collaboration diagram for itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >:

[legend]List of all members.

Public Types
typedef ImageToSpatialObjectMetric	Self
typedef SingleValuedCostFunction	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TFixedImage	FixedImageType
typedef TMovingSpatialObject	MovingSpatialObjectType
typedef Superclass::ParametersValueType	CoordinateRepresentationType
typedef Transform< CoordinateRepresentationType, itkGetStaticConstMacro(ObjectDimension), itkGetStaticConstMacro(ImageDimension)	TransformType )
typedef TransformType::Pointer	TransformPointer
typedef TransformType::InputPointType	InputPointType
typedef TransformType::OutputPointType	OutputPointType
typedef TransformType::ParametersType	TransformParametersType
typedef TransformType::JacobianType	TransformJacobianType
typedef LinearInterpolateImageFunction< TFixedImage, CoordinateRepresentationType >	InterpolatorType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef vnl_vector_fixed< double, itkGetStaticConstMacro(ObjectDimension)	VectorType )
typedef Superclass::MeasureType	MeasureType
typedef Superclass::DerivativeType	DerivativeType
typedef FixedImageType::Pointer	FixedImagePointer
typedef MovingSpatialObjectType::Pointer	MovingSpatialObjectPointer
typedef FixedImageType::ConstPointer	FixedImageConstPointer
typedef MovingSpatialObjectType::ConstPointer	MovingSpatialObjectConstPointer
typedef Superclass::ParametersType	ParametersType
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (ObjectDimension, unsigned int, MovingSpatialObjectType::ObjectDimension)
virtual const char *	GetClassName () const
virtual void	SetFixedImage (const FixedImageType *_arg)
virtual const FixedImageType *	GetFixedImage ()
virtual void	SetMovingSpatialObject (const MovingSpatialObjectType *_arg)
virtual const MovingSpatialObjectType *	GetMovingSpatialObject ()
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetInterpolator ()
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
virtual MeasureType	GetValue (const ParametersType &parameters) const =0
virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const =0
virtual void	Initialize (void)
virtual const ParametersType &	GetLastTransformParameters ()
virtual void	SetTransform (TransformType *_arg)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImageToSpatialObjectMetric ()
virtual	~ImageToSpatialObjectMetric ()
	ImageToSpatialObjectMetric (const Self &)
void	operator= (const Self &)
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
MeasureType	m_MatchMeasure
DerivativeType	m_MatchMeasureDerivatives
TransformPointer	m_Transform
InterpolatorPointer	m_Interpolator
MovingSpatialObjectConstPointer	m_MovingSpatialObject
FixedImageConstPointer	m_FixedImage
ParametersType	m_LastTransformParameters

---

Detailed Description

template<class TFixedImage, class TMovingSpatialObject>
class itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >

Computes similarity between a moving spatial obejct and an Image to be registered.

Definition at line 34 of file itkImageToSpatialObjectMetric.h.

---

Member Typedef Documentation

template<class TFixedImage, class TMovingSpatialObject> typedef SmartPointer<const Self> itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ConstPointer

Reimplemented from itk::SingleValuedCostFunction. Definition at line 46 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef Superclass::ParametersValueType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::CoordinateRepresentationType

Type used for representing point components Definition at line 55 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef Superclass::DerivativeType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::DerivativeType

Type of the derivative of the match measure Reimplemented from itk::SingleValuedCostFunction. Definition at line 89 of file itkImageToSpatialObjectMetric.h. Referenced by itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::operator=().

template<class TFixedImage, class TMovingSpatialObject> typedef FixedImageType::ConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImageConstPointer

Const pointer type for the FixedImage Definition at line 99 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef FixedImageType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImagePointer

Pointer type for the FixedImage Definition at line 92 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef TFixedImage itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::FixedImageType

Type of the fixed image Definition at line 49 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef TransformType::InputPointType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InputPointType

Definition at line 69 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef InterpolatorType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InterpolatorPointer

Definition at line 79 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef LinearInterpolateImageFunction< TFixedImage, CoordinateRepresentationType > itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::InterpolatorType

Type of the Interpolator Base class Definition at line 77 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef Superclass::MeasureType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MeasureType

Type of the match measure Reimplemented from itk::SingleValuedCostFunction. Definition at line 86 of file itkImageToSpatialObjectMetric.h. Referenced by itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::operator=().

template<class TFixedImage, class TMovingSpatialObject> typedef MovingSpatialObjectType::ConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectConstPointer

Const pointer type for the MovingSpatialObject Definition at line 103 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef MovingSpatialObjectType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectPointer

Pointer type for the MovingSpatialObject Definition at line 96 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef TMovingSpatialObject itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectType

Type of the MovingSpatialObject Definition at line 52 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef TransformType::OutputPointType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::OutputPointType

Definition at line 70 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef Superclass::ParametersType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ParametersType

ParametersType typedef. It defines a position in the optimization search space. Reimplemented from itk::SingleValuedCostFunction. Definition at line 107 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef SmartPointer<Self> itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Pointer

Smart pointer typedef support Reimplemented from itk::SingleValuedCostFunction. Definition at line 45 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef ImageToSpatialObjectMetric itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Self

Standard "Self" typedef. Reimplemented from itk::SingleValuedCostFunction. Definition at line 39 of file itkImageToSpatialObjectMetric.h. Referenced by itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::~ImageToSpatialObjectMetric().

template<class TFixedImage, class TMovingSpatialObject> typedef SingleValuedCostFunction itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Superclass

Standard "Superclass" typedef. Reimplemented from itk::SingleValuedCostFunction. Definition at line 42 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef TransformType::JacobianType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformJacobianType

Definition at line 72 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef TransformType::ParametersType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformParametersType

Definition at line 71 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef TransformType::Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformPointer

Definition at line 68 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef Transform<CoordinateRepresentationType, itkGetStaticConstMacro(ObjectDimension), itkGetStaticConstMacro(ImageDimension) itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::TransformType)

Type of the Transform Base class Definition at line 66 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> typedef vnl_vector_fixed<double, itkGetStaticConstMacro(ObjectDimension) itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::VectorType)

Typede of the vector type to return derivatives Definition at line 83 of file itkImageToSpatialObjectMetric.h.

---

Constructor & Destructor Documentation

template<class TFixedImage, class TMovingSpatialObject> itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectMetric (   )  [protected]

template<class TFixedImage, class TMovingSpatialObject> virtual itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::~ImageToSpatialObjectMetric (   )  [inline, protected, virtual]

Definition at line 157 of file itkImageToSpatialObjectMetric.h. References itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Self.

template<class TFixedImage, class TMovingSpatialObject> itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectMetric (  const Self &   )  [inline, protected]

Definition at line 158 of file itkImageToSpatialObjectMetric.h.

---

Member Function Documentation

template<class TFixedImage, class TMovingSpatialObject> virtual const char* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SingleValuedCostFunction.

template<class TFixedImage, class TMovingSpatialObject> virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetDerivative (  const ParametersType &  parameters, DerivativeType &  derivative )  const [pure virtual]

Get the Derivatives of the Match Measure Implements itk::SingleValuedCostFunction.

template<class TFixedImage, class TMovingSpatialObject> virtual const FixedImageType* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetFixedImage (   )  [virtual]

Get the FixedImage.

template<class TFixedImage, class TMovingSpatialObject> virtual InterpolatorType* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetInterpolator (   )  [virtual]

Get the Interpolator.

template<class TFixedImage, class TMovingSpatialObject> virtual const ParametersType& itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetLastTransformParameters (   )  [virtual]

Get the last transformation parameters visited by the optimizer. This function overload the superclass's one

template<class TFixedImage, class TMovingSpatialObject> virtual const MovingSpatialObjectType* itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetMovingSpatialObject (   )  [virtual]

Get the MovingSpatialObject.

template<class TFixedImage, class TMovingSpatialObject> virtual MeasureType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetValue (  const ParametersType &  parameters  )  const [pure virtual]

Get the Value for SingleValue Optimizers Implements itk::SingleValuedCostFunction.

template<class TFixedImage, class TMovingSpatialObject> virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::GetValueAndDerivative (  const ParametersType &  parameters, MeasureType &  Value, DerivativeType &  Derivative )  const [pure virtual]

Get Value and Derivatives for MultipleValuedOptimizers Reimplemented from itk::SingleValuedCostFunction.

template<class TFixedImage, class TMovingSpatialObject> virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::Initialize (  void   )  [inline, virtual]

Initialize the metric Definition at line 145 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::itkStaticConstMacro (  ObjectDimension  , unsigned  int, MovingSpatialObjectType::ObjectDimension  )

Object dimension enumeration.

template<class TFixedImage, class TMovingSpatialObject> itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::itkStaticConstMacro (  ImageDimension  , unsigned  int, FixedImageType::ImageDimension  )

Image dimension enumeration.

template<class TFixedImage, class TMovingSpatialObject> Pointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TFixedImage, class TMovingSpatialObject> void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::operator= (  const Self &   )  [inline, protected]

Reimplemented from itk::SingleValuedCostFunction. Definition at line 159 of file itkImageToSpatialObjectMetric.h. References itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::DerivativeType, and itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::MeasureType.

template<class TFixedImage, class TMovingSpatialObject> void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::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 TFixedImage, class TMovingSpatialObject> virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetFixedImage (  const FixedImageType *  _arg  )  [virtual]

Connect the FixedImage.

template<class TFixedImage, class TMovingSpatialObject> virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetInterpolator (  InterpolatorType *  _arg  )  [virtual]

Connect the Interpolator.

template<class TFixedImage, class TMovingSpatialObject> virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetMovingSpatialObject (  const MovingSpatialObjectType *  _arg  )  [virtual]

Connect the MovingSpatialObject

template<class TFixedImage, class TMovingSpatialObject> virtual void itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::SetTransform (  TransformType *  _arg  )  [virtual]

Set/Get the Transform.

---

Member Data Documentation

template<class TFixedImage, class TMovingSpatialObject> FixedImageConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_FixedImage [protected]

Definition at line 168 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> InterpolatorPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_Interpolator [protected]

Definition at line 165 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> ParametersType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_LastTransformParameters [protected]

Definition at line 169 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> MeasureType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_MatchMeasure [protected]

Definition at line 162 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> DerivativeType itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_MatchMeasureDerivatives [protected]

Definition at line 163 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> MovingSpatialObjectConstPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_MovingSpatialObject [protected]

Definition at line 167 of file itkImageToSpatialObjectMetric.h.

template<class TFixedImage, class TMovingSpatialObject> TransformPointer itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >::m_Transform [mutable, protected]

Definition at line 164 of file itkImageToSpatialObjectMetric.h.

---

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

• itkImageToSpatialObjectMetric.h

---