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

Computes similarity between two binary objects to be registered. More...

#include <itkKappaStatisticImageToImageMetric.h>

Inheritance diagram for itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >:

[legend]Collaboration diagram for itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >:

[legend]List of all members.

Public Types
typedef KappaStatisticImageToImageMetric	Self
typedef ImageToImageMetric< TFixedImage, TMovingImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::RealType	RealType
typedef Superclass::TransformType	TransformType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformParametersType	TransformParametersType
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::GradientPixelType	GradientPixelType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef Superclass::MovingImageConstPointer	MovingImageConstPointer
typedef Superclass::FixedImageRegionType	FixedImageRegionType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	GetDerivative (const TransformParametersType &, DerivativeType &derivative) const
MeasureType	GetValue (const TransformParametersType &parameters) const
virtual void	SetForegroundValue (RealType _arg)
virtual RealType	GetForegroundValue ()
virtual void	SetComplement (bool _arg)
virtual void	ComplementOn ()
virtual void	ComplementOff ()
virtual bool	GetComplement ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	KappaStatisticImageToImageMetric ()
virtual	~KappaStatisticImageToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TFixedImage, class TMovingImage>
class itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >

Computes similarity between two binary objects to be registered.

This Class is templated over the type of the fixed and moving images to be compared. The metric here is designed for matching pixels in two images with the same exact value. Only one value can be considered (the default is 255) and can be specified with the SetForegroundValue method. In the computation of the metric, only foreground pixels are considered. The metric value is given by 2*|A&B|/(|A|+|B|), where A is the foreground region in the moving image, B is the foreground region in the fixed image, & is intersection, and |.| indicates the area of the enclosed set. The metric is described in "Morphometric Analysis of White Matter Lesions in MR Images: Method and Validation", A. P. Zijdenbos, B. M. Dawant, R. A. Margolin, A. C. Palmer.

This metric is especially useful when considering the similarity between binary images. Given the nature of binary images, a nearest neighbor interpolator is the preferred interpolator.

Metric values range from 0.0 (no foreground alignment) to 1.0 (perfect foreground alignment). When dealing with optimizers that can only minimize a metric, use the ComplementOn() method.

Definition at line 52 of file itkKappaStatisticImageToImageMetric.h.

---

Member Typedef Documentation

template<class TFixedImage, class TMovingImage> typedef SmartPointer<const Self> itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 62 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::DerivativeType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Type of the derivative. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 79 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::FixedImageConstPointer itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 82 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::FixedImageRegionType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::FixedImageRegionType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 84 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::FixedImageType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 80 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::GradientPixelType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType

Gaussian filter to compute the gradient of the Moving Image Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 76 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::MeasureType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Type of the measure. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 78 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::MovingImageConstPointer itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 83 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::MovingImageType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 81 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SmartPointer<Self> itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::Pointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 61 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::RealType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::RealType

Types transferred from the base class Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 71 of file itkKappaStatisticImageToImageMetric.h. Referenced by itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::~KappaStatisticImageToImageMetric().

template<class TFixedImage, class TMovingImage> typedef KappaStatisticImageToImageMetric itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 58 of file itkKappaStatisticImageToImageMetric.h. Referenced by itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::~KappaStatisticImageToImageMetric().

template<class TFixedImage, class TMovingImage> typedef ImageToImageMetric<TFixedImage, TMovingImage > itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::Superclass

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 59 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::TransformJacobianType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 75 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::TransformParametersType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 74 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::TransformPointer itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 73 of file itkKappaStatisticImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::TransformType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Type of the Transform Base class Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 72 of file itkKappaStatisticImageToImageMetric.h.

---

Constructor & Destructor Documentation

template<class TFixedImage, class TMovingImage> itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::KappaStatisticImageToImageMetric (   )  [protected]

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

Definition at line 118 of file itkKappaStatisticImageToImageMetric.h. References itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::RealType, and itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::Self.

---

Member Function Documentation

template<class TFixedImage, class TMovingImage> virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::ComplementOff (   )  [virtual]

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

template<class TFixedImage, class TMovingImage> virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::ComplementOn (   )  [virtual]

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

template<class TFixedImage, class TMovingImage> virtual bool itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetComplement (   )  [virtual]

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

template<class TFixedImage, class TMovingImage> void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative (  const TransformParametersType &  , DerivativeType &  derivative )  const

Get the derivatives of the match measure.

template<class TFixedImage, class TMovingImage> virtual RealType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetForegroundValue (   )  [virtual]

This method allows the user to set the foreground value. The default value is 255.

template<class TFixedImage, class TMovingImage> virtual const char* itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> MeasureType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetValue (  const TransformParametersType &  parameters  )  const

Get the value of the metric at a particular parameter setting. The metric value is given by 2*|A&B|/(|A|+|B|), where A is the moving image, B is the fixed image, & is intersection, and |.| indicates the area of the enclosed set. If ComplementOn has been set, the metric value is 1.0-2*|A&B|/(|A|+|B|).

template<class TFixedImage, class TMovingImage> Pointer itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::New (   )  [static]

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

template<class TFixedImage, class TMovingImage> void itk::KappaStatisticImageToImageMetric< TFixedImage, 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::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::SetComplement (  bool  _arg  )  [virtual]

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

template<class TFixedImage, class TMovingImage> virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::SetForegroundValue (  RealType  _arg  )  [virtual]

This method allows the user to set the foreground value. The default value is 255.

---

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

• itkKappaStatisticImageToImageMetric.h

---