#include <itkKappaStatisticImageToImageMetric.h>

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

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef Superclass::FixedImageRegionType	FixedImageRegionType
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::GradientImageType	GradientImageType
typedef Superclass::GradientPixelType	GradientPixelType
typedef Superclass::InputPointType	InputPointType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingImageConstPointer	MovingImageConstPointer
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::OutputPointType	OutputPointType
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 Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef Superclass::ParametersValueType	CoordinateRepresentationType
typedef std::vector < FixedImageIndexType >	FixedImageIndexContainer
typedef FixedImageType::IndexType	FixedImageIndexType
typedef FixedImageIndexType::IndexValueType	FixedImageIndexValueType
typedef FixedImageMaskType::ConstPointer	FixedImageMaskConstPointer
typedef FixedImageMaskType::Pointer	FixedImageMaskPointer
typedef SpatialObject < itkGetStaticConstMacro(FixedImageDimension) >	FixedImageMaskType
typedef TFixedImage::PixelType	FixedImagePixelType
typedef TransformType::InputPointType	FixedImagePointType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef InterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	InterpolatorType
typedef MovingImageType::IndexType	MovingImageIndexType
typedef MovingImageMaskType::ConstPointer	MovingImageMaskConstPointer
typedef MovingImageMaskType::Pointer	MovingImageMaskPointer
typedef SpatialObject < itkGetStaticConstMacro(MovingImageDimension) >	MovingImageMaskType
typedef TMovingImage::PixelType	MovingImagePixelType
typedef TransformType::OutputPointType	MovingImagePointType
typedef MultiThreader	MultiThreaderType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer < GradientImageType >	GradientImagePointer
typedef GradientRecursiveGaussianImageFilter < MovingImageType, GradientImageType >	GradientImageFilterType
typedef GradientImageFilterType::Pointer	GradientImageFilterPointer
Public Types inherited from itk::SingleValuedCostFunction
typedef Superclass::ParametersValueType	ParametersValueType
Public Types inherited from itk::CostFunction
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
void	ComputeGradient ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	GetDerivative (const TransformParametersType &, DerivativeType &derivative) const
virtual const char *	GetNameOfClass () const
MeasureType	GetValue (const TransformParametersType &parameters) const
void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const

virtual void	SetForegroundValue (RealType _arg)
virtual RealType	GetForegroundValue () const
Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual const FixedImageType *	GetFixedImage ()
virtual const FixedImageRegionType &	GetFixedImageRegion ()
virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold ()
virtual const GradientImageType *	GetGradientImage ()
virtual const InterpolatorType *	GetInterpolator ()
virtual const MovingImageType *	GetMovingImage ()
SizeValueType	GetNumberOfMovingImageSamples (void)
unsigned int	GetNumberOfParameters (void) const
virtual const SizeValueType &	GetNumberOfPixelsCounted ()
SizeValueType	GetNumberOfSpatialSamples (void)
virtual const TransformType *	GetTransform ()
virtual const bool &	GetUseAllPixels ()
virtual const bool &	GetUseFixedImageIndexes ()
virtual const bool &	GetUseFixedImageSamplesIntensityThreshold ()
virtual const bool &	GetUseSequentialSampling ()
virtual void	Initialize (void) throw ( ExceptionObject )
virtual void	MultiThreadingInitialize (void) throw ( ExceptionObject )
virtual void	SetFixedImage (const FixedImageType *_arg)
void	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
void	SetFixedImageRegion (const FixedImageRegionType reg)
void	SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual void	SetMovingImage (const MovingImageType *_arg)
void	SetNumberOfSpatialSamples (SizeValueType num)
virtual void	SetTransform (TransformType *_arg)
void	SetTransformParameters (const ParametersType &parameters) const
void	SetUseAllPixels (bool useAllPixels)
void	SetUseFixedImageIndexes (bool useIndex)
void	SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
void	SetUseSequentialSampling (bool sequentialSampling)
void	UseAllPixelsOff (void)
void	UseAllPixelsOn (void)
virtual void	SetMovingImageMask (MovingImageMaskType *_arg)
virtual void	SetMovingImageMask (const MovingImageMaskType *_arg)
virtual const MovingImageMaskType *	GetMovingImageMask ()
virtual void	SetFixedImageMask (FixedImageMaskType *_arg)
virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)
virtual const FixedImageMaskType *	GetFixedImageMask ()
void	SetNumberOfThreads (ThreadIdType numberOfThreads)
virtual const ThreadIdType &	GetNumberOfThreads ()
virtual void	SetComputeGradient (bool _arg)
virtual const bool &	GetComputeGradient ()
virtual void	ComputeGradientOn ()
virtual void	ComputeGradientOff ()
virtual void	SetNumberOfFixedImageSamples (SizeValueType numSamples)
virtual const SizeValueType &	GetNumberOfFixedImageSamples ()
void	ReinitializeSeed ()
void	ReinitializeSeed (int seed)
virtual void	SetUseCachingOfBSplineWeights (bool _arg)
virtual const bool &	GetUseCachingOfBSplineWeights ()
virtual void	UseCachingOfBSplineWeightsOn ()
virtual void	UseCachingOfBSplineWeightsOff ()
virtual const MultiThreaderType *	GetThreader ()
const TransformPointer *	GetThreaderTransform ()
Public Member Functions inherited from itk::SingleValuedCostFunction
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

Static Public Member Functions
static Pointer	New ()
Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadID) const
void	GetValueAndDerivativeMultiThreadedInitiate (void) const
void	GetValueAndDerivativeMultiThreadedPostProcessInitiate (void) const
void	GetValueAndDerivativeMultiThreadedPreProcessInitiate (void) const
virtual void	GetValueAndDerivativeThread (ThreadIdType threadID) const
virtual void	GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const
virtual void	GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const
virtual bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const
void	GetValueMultiThreadedInitiate (void) const
void	GetValueMultiThreadedPostProcessInitiate (void) const
void	GetValueMultiThreadedPreProcessInitiate (void) const
virtual void	GetValueThread (ThreadIdType threadID) const
virtual void	GetValueThreadPostProcess (ThreadIdType, bool) const
virtual void	GetValueThreadPreProcess (ThreadIdType, bool) const
virtual bool	GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const
	ImageToImageMetric ()
virtual void	PreComputeTransformValues (void)
virtual void	SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
virtual void	SampleFixedImageRegion (FixedImageSampleContainer &samples) const
virtual void	SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const
virtual void	SynchronizeTransforms () const
virtual void	TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ThreadIdType threadID) const
virtual void	TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, ThreadIdType threadID) const
virtual	~ImageToImageMetric ()
Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()
virtual	~SingleValuedCostFunction ()
Protected Member Functions inherited from itk::CostFunction
	CostFunction ()
virtual	~CostFunction ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
	KappaStatisticImageToImageMetric (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_Complement
RealType	m_ForegroundValue
virtual void	SetComplement (bool _arg)
virtual void	ComplementOn ()
virtual void	ComplementOff ()
virtual bool	GetComplement () const
	KappaStatisticImageToImageMetric ()
virtual	~KappaStatisticImageToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const

Additional Inherited Members
Static Public Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int	MovingImageDimension = TMovingImage::ImageDimension
static const unsigned int	FixedImageDimension = TFixedImage::ImageDimension
Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef std::vector< bool >	BooleanArrayType
typedef BSplineInterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	BSplineInterpolatorType
typedef FixedArray < SizeValueType,::itk::GetImageDimension < FixedImageType > ::ImageDimension >	BSplineParametersOffsetType
typedef BSplineTransformType::ParameterIndexArrayType	BSplineTransformIndexArrayType
typedef Array2D< IndexValueType >	BSplineTransformIndicesArrayType
typedef BSplineBaseTransform < CoordinateRepresentationType,::itk::GetImageDimension < FixedImageType > ::ImageDimension, itkGetStaticConstMacro(DeformationSplineOrder) >	BSplineTransformType
typedef Array2D< WeightsValueType >	BSplineTransformWeightsArrayType
typedef BSplineTransformType::WeightsType	BSplineTransformWeightsType
typedef CentralDifferenceImageFunction < MovingImageType, CoordinateRepresentationType >	DerivativeFunctionType
typedef std::vector < FixedImageSamplePoint >	FixedImageSampleContainer
typedef CovariantVector < double, itkGetStaticConstMacro(MovingImageDimension) >	ImageDerivativesType
typedef BSplineTransformIndexArrayType::ValueType	IndexValueType
typedef std::vector < MovingImagePointType >	MovingImagePointArrayType
typedef BSplineTransformWeightsType::ValueType	WeightsValueType
Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreaded (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreadedPostProcess (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueAndDerivativeMultiThreadedPreProcess (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueMultiThreaded (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueMultiThreadedPostProcess (void *arg)
static ITK_THREAD_RETURN_TYPE	GetValueMultiThreadedPreProcess (void *arg)
Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
BSplineInterpolatorType::Pointer	m_BSplineInterpolator
BSplineParametersOffsetType	m_BSplineParametersOffset
MovingImagePointArrayType	m_BSplinePreTransformPointsArray
BSplineTransformType::Pointer	m_BSplineTransform
BSplineTransformIndexArrayType	m_BSplineTransformIndices
BSplineTransformIndicesArrayType	m_BSplineTransformIndicesArray
BSplineTransformWeightsType	m_BSplineTransformWeights
BSplineTransformWeightsArrayType	m_BSplineTransformWeightsArray
bool	m_ComputeGradient
DerivativeFunctionType::Pointer	m_DerivativeCalculator
FixedImageConstPointer	m_FixedImage
FixedImageIndexContainer	m_FixedImageIndexes
FixedImageMaskConstPointer	m_FixedImageMask
FixedImageSampleContainer	m_FixedImageSamples
FixedImagePixelType	m_FixedImageSamplesIntensityThreshold
GradientImagePointer	m_GradientImage
InterpolatorPointer	m_Interpolator
bool	m_InterpolatorIsBSpline
MovingImageConstPointer	m_MovingImage
MovingImageMaskConstPointer	m_MovingImageMask
SizeValueType	m_NumberOfFixedImageSamples
SizeValueType	m_NumberOfParameters
SizeValueType	m_NumberOfPixelsCounted
ThreadIdType	m_NumberOfThreads
SizeValueType	m_NumBSplineWeights
int	m_RandomSeed
bool	m_ReseedIterator
MultiThreaderType::Pointer	m_Threader
BSplineTransformIndexArrayType *	m_ThreaderBSplineTransformIndices
BSplineTransformWeightsType *	m_ThreaderBSplineTransformWeights
unsigned int *	m_ThreaderNumberOfMovingImageSamples
MultiThreaderParameterType	m_ThreaderParameter
TransformPointer *	m_ThreaderTransform
TransformPointer	m_Transform
bool	m_TransformIsBSpline
bool	m_UseAllPixels
bool	m_UseCachingOfBSplineWeights
bool	m_UseFixedImageIndexes
bool	m_UseFixedImageSamplesIntensityThreshold
bool	m_UseSequentialSampling
BooleanArrayType	m_WithinBSplineSupportRegionArray
bool	m_WithinThreadPostProcess
bool	m_WithinThreadPreProcess
Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int	DeformationSplineOrder = 3

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