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

#include <itkKappaStatisticImageToImageMetric.h>

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

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

[legend]List of all members.

---

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.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersValueType	CoordinateRepresentationType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef FixedImageMaskType::Pointer	FixedImageMaskPointer
typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension)	FixedImageMaskType )
typedef Superclass::FixedImageRegionType	FixedImageRegionType
typedef Superclass::FixedImageType	FixedImageType
typedef GradientImageFilterType::Pointer	GradientImageFilterPointer
typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >	GradientImageFilterType
typedef SmartPointer< GradientImageType >	GradientImagePointer
typedef Image< GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)	GradientImageType )
typedef Superclass::GradientPixelType	GradientPixelType
typedef TransformType::InputPointType	InputPointType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >	InterpolatorType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingImageConstPointer	MovingImageConstPointer
typedef MovingImageMaskType::Pointer	MovingImageMaskPointer
typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension)	MovingImageMaskType )
typedef TMovingImage::PixelType	MovingImagePixelType
typedef Superclass::MovingImageType	MovingImageType
typedef TransformType::OutputPointType	OutputPointType
typedef Superclass::ParametersType	ParametersType
typedef double	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RealType	RealType
typedef KappaStatisticImageToImageMetric	Self
typedef ImageToImageMetric< TFixedImage, TMovingImage >	Superclass
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::TransformParametersType	TransformParametersType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformType	TransformType
Public Member Functions
Set Get whether this metric returns *A &the default or *A &	B (|A|+|B|)*(ComplementOn).When using an optimizer that minimizes *metric values use ComplementOn().*/virtual void SetComplement(bool _arg)
Set Get whether this metric returns *A &	B (|A|+|B|)*(ComplementOff
virtual void	ComplementOff ()
virtual void	ComplementOn ()
virtual void	ComputeGradientOff ()
virtual void	ComputeGradientOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
virtual bool	GetComplement ()
virtual const bool &	GetComputeGradient ()
bool	GetDebug () const
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
void	GetDerivative (const TransformParametersType &, DerivativeType &derivative) const
virtual const FixedImageType *	GetFixedImage ()
virtual const FixedImageMaskType *	GetFixedImageMask ()
virtual const FixedImageRegionType &	GetFixedImageRegion ()
virtual RealType	GetForegroundValue ()
virtual const GradientImageType *	GetGradientImage ()
virtual const InterpolatorType *	GetInterpolator ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual const MovingImageType *	GetMovingImage ()
virtual const MovingImageMaskType *	GetMovingImageMask ()
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfParameters (void) const
virtual const unsigned long &	GetNumberOfPixelsCounted ()
virtual int	GetReferenceCount () const
virtual const TransformType *	GetTransform ()
virtual MeasureType	GetValue (const ParametersType &parameters) const =0
MeasureType	GetValue (const TransformParametersType &parameters) const
This method returns the value and derivative of the cost function corresponding *to the specified parameters *virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
bool	HasObserver (const EventObject &event) const
virtual void	Initialize (void) throw ( ExceptionObject )
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
Constants for the image dimensions *	itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
Set Get gradient computation *virtual void	SetComputeGradient (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetFixedImage (const FixedImageType *_arg)
Set Get the fixed image mask *virtual void	SetFixedImageMask (FixedImageMaskType *_arg)
virtual void	SetFixedImageRegion (FixedImageRegionType _arg)
This method allows the user to set the foreground value The default *value is *virtual void	SetForegroundValue (RealType _arg)
virtual void	SetInterpolator (InterpolatorType *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetMovingImage (const MovingImageType *_arg)
Set Get the moving image mask *virtual void	SetMovingImageMask (MovingImageMaskType *_arg)
virtual void	SetReferenceCount (int)
virtual void	SetTransform (TransformType *_arg)
void	SetTransformParameters (const ParametersType &parameters) const
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	KappaStatisticImageToImageMetric ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~KappaStatisticImageToImageMetric ()
Protected Attributes
bool	m_ComputeGradient
FixedImageConstPointer	m_FixedImage
FixedImageMaskPointer	m_FixedImageMask
GradientImagePointer	m_GradientImage
InterpolatorPointer	m_Interpolator
MovingImageConstPointer	m_MovingImage
MovingImageMaskPointer	m_MovingImageMask
unsigned long	m_NumberOfPixelsCounted
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
TransformPointer	m_Transform
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

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::ParametersValueType itk::ImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType [inherited]

Type used for representing point components Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 61 of file itkImageToImageMetric.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 FixedImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskPointer [inherited]

Definition at line 122 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskType) [inherited]

Type for the mask of the fixed image. Only pixels that are "inside" this mask will be considered for the computation of the metric Definition at line 121 of file itkImageToImageMetric.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 GradientImageFilterType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterPointer [inherited]

Definition at line 110 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType > itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterType [inherited]

Definition at line 109 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SmartPointer<GradientImageType> itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImagePointer [inherited]

Definition at line 106 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Image<GradientPixelType, itkGetStaticConstMacro(MovingImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImageType) [inherited]

Definition at line 105 of file itkImageToImageMetric.h.

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

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

template<class TFixedImage, class TMovingImage> typedef TransformType::InputPointType itk::ImageToImageMetric< TFixedImage, TMovingImage >::InputPointType [inherited]

Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 89 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef InterpolatorType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorPointer [inherited]

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 114 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType > itk::ImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType [inherited]

Type of the Interpolator Base class Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 97 of file itkImageToImageMetric.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 MovingImageMaskType::Pointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskPointer [inherited]

Definition at line 128 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension) itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskType) [inherited]

Type for the mask of the moving image. Only pixels that are "inside" this mask will be considered for the computation of the metric Definition at line 127 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef TMovingImage::PixelType itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType [inherited]

Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 68 of file itkImageToImageMetric.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 TransformType::OutputPointType itk::ImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType [inherited]

Reimplemented in itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 90 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> typedef Superclass::ParametersType itk::ImageToImageMetric< TFixedImage, TMovingImage >::ParametersType [inherited]

Type of the parameters. Reimplemented from itk::SingleValuedCostFunction. Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 139 of file itkImageToImageMetric.h.

typedef double itk::CostFunction::ParametersValueType [inherited]

ParametersType typedef. It defines a position in the optimization search space. Definition at line 46 of file itkCostFunction.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 68 of file itkKappaStatisticImageToImageMetric.h.

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.

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 122 of file itkKappaStatisticImageToImageMetric.h.

---

Member Function Documentation

template<class TFixedImage, class TMovingImage> Set Get whether this metric returns* A& the default or* A& itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::B (  |A|+|B|   )

template<class TFixedImage, class TMovingImage> Set Get whether this metric returns* A& itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::B (  |A|+|B|   )

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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

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

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::ComputeGradientOff (   )  [virtual, inherited]

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::ComputeGradientOn (   )  [virtual, inherited]

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class. Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

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

template<class TFixedImage, class TMovingImage> virtual const bool& itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetComputeGradient (   )  [virtual, inherited]

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

virtual void itk::SingleValuedCostFunction::GetDerivative (  const ParametersType &  parameters, DerivativeType &  derivative )  const [pure virtual, inherited]

This method returns the derivative of the cost function corresponding to the specified parameters. Implemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

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 const FixedImageType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImage (   )  [virtual, inherited]

Get the Fixed Image.

template<class TFixedImage, class TMovingImage> virtual const FixedImageMaskType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageMask (   )  [virtual, inherited]

template<class TFixedImage, class TMovingImage> virtual const FixedImageRegionType& itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageRegion (   )  [virtual, inherited]

Get the region over which the metric will be computed

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

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class TFixedImage, class TMovingImage> virtual const GradientImageType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetGradientImage (   )  [virtual, inherited]

Get Gradient Image.

template<class TFixedImage, class TMovingImage> virtual const InterpolatorType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetInterpolator (   )  [virtual, inherited]

Get a pointer to the Interpolator.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

template<class TFixedImage, class TMovingImage> virtual const MovingImageType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImage (   )  [virtual, inherited]

Get the Moving Image.

template<class TFixedImage, class TMovingImage> virtual const MovingImageMaskType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageMask (   )  [virtual, inherited]

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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> unsigned int itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfParameters (  void   )  const [inline, virtual, inherited]

Return the number of parameters required by the Transform Implements itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 197 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> virtual const unsigned long& itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfPixelsCounted (   )  [virtual, inherited]

Get the number of pixels considered in the computation.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TFixedImage, class TMovingImage> virtual const TransformType* itk::ImageToImageMetric< TFixedImage, TMovingImage >::GetTransform (   )  [virtual, inherited]

Get a pointer to the Transform.

virtual MeasureType itk::SingleValuedCostFunction::GetValue (  const ParametersType &  parameters  )  const [pure virtual, inherited]

This method returns the value of the cost function corresponding to the specified parameters. Implemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

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|).

This method returns the value and derivative of the cost function corresponding* to the specified parameters* virtual void itk::SingleValuedCostFunction::GetValueAndDerivative (  const ParametersType &  parameters, MeasureType &  value, DerivativeType &  derivative )  const [inline, virtual, inherited]

Reimplemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 71 of file itkSingleValuedCostFunction.h.

template<class TFixedImage, class TMovingImage> void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative (  const TransformParametersType &  parameters, MeasureType &  Value, DerivativeType &  Derivative )  const

Get both the value and derivative. This method internally calls the GetValue() and the GetDerivative() method.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::Initialize (  void   )  throw ( ExceptionObject ) [virtual, inherited]

Initialize the Metric by making sure that all the components are present and plugged together correctly Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

template<class TFixedImage, class TMovingImage> itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro (  FixedImageDimension  , unsigned  int, TFixedImage::ImageDimension  )  [inherited]

Reimplemented in itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage, class TMovingImage> Constants for the image dimensions* itk::ImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro (  MovingImageDimension  , unsigned  int, TMovingImage::ImageDimension  )  [inherited]

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

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

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

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

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

template<class TFixedImage, class TMovingImage> Set Get gradient computation* virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetComputeGradient (  bool  _arg  )  [virtual, inherited]

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImage (  const FixedImageType *  _arg  )  [virtual, inherited]

Connect the Fixed Image.

template<class TFixedImage, class TMovingImage> Set Get the fixed image mask* virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageMask (  FixedImageMaskType *  _arg  )  [virtual, inherited]

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageRegion (  FixedImageRegionType  _arg  )  [virtual, inherited]

Set the region over which the metric will be computed

template<class TFixedImage, class TMovingImage> This method allows the user to set the foreground value The default* value is* virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::SetForegroundValue (  RealType  _arg  )  [virtual]

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetInterpolator (  InterpolatorType *  _arg  )  [virtual, inherited]

Connect the Interpolator.

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImage (  const MovingImageType *  _arg  )  [virtual, inherited]

Connect the Moving Image.

template<class TFixedImage, class TMovingImage> Set Get the moving image mask* virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageMask (  MovingImageMaskType *  _arg  )  [virtual, inherited]

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TFixedImage, class TMovingImage> virtual void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetTransform (  TransformType *  _arg  )  [virtual, inherited]

Connect the Transform.

template<class TFixedImage, class TMovingImage> void itk::ImageToImageMetric< TFixedImage, TMovingImage >::SetTransformParameters (  const ParametersType &  parameters  )  const [inherited]

Set the parameters defining the Transform.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

template<class TFixedImage, class TMovingImage> bool itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_ComputeGradient [protected, inherited]

Definition at line 217 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> FixedImageConstPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImage [protected, inherited]

Definition at line 211 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> FixedImageMaskPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageMask [mutable, protected, inherited]

Definition at line 220 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> GradientImagePointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_GradientImage [protected, inherited]

Definition at line 218 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> InterpolatorPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_Interpolator [protected, inherited]

Definition at line 215 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> MovingImageConstPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImage [protected, inherited]

Definition at line 212 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> MovingImageMaskPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_MovingImageMask [mutable, protected, inherited]

Definition at line 221 of file itkImageToImageMetric.h.

template<class TFixedImage, class TMovingImage> unsigned long itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_NumberOfPixelsCounted [mutable, protected, inherited]

Definition at line 209 of file itkImageToImageMetric.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

template<class TFixedImage, class TMovingImage> TransformPointer itk::ImageToImageMetric< TFixedImage, TMovingImage >::m_Transform [mutable, protected, inherited]

Definition at line 214 of file itkImageToImageMetric.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkKappaStatisticImageToImageMetric.h

---