#include <itkKullbackLeiblerCompareHistogramImageToImageMetric.h>

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

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

Detailed Description

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

Computes the Kubler Lieblach(KL) metric between the histogram of the two images to be registered and a training histogram.

This class is templated over the type of the fixed and moving images to be compared.

This class computers the KL-metric by comparing the histograms of the testing histogram formed by the overlap of intensities in the images, to a training histogram. It is based on the following paper:

Albert C.S. Chung, William M. Wells III, Alexander Norbash, and W. Eric L. Grimson, Multi-modal Image Registration by Minimising Kullback-Leibler Distance, In Medical Image Computing and Computer-Assisted Intervention - MICCAI 2002, LNCS 2489, pp. 525 - 532.

The metric is given by KL(P_test||P_train) = Sum_{i1,i2} P_test(i1,i2) vcl_log(P_test(i1,i2)/P_train(i1,i2)) where P_test and P_train are probabilities given my normalized histograms, and i1 and i2 are the intensity bins in the histogram.

PARAMETERS: Epsilon is added to every bin in both histograms. This prevents division by zero problems. Epsilon should generally be set to a number smaller than one divided by the total number bins in the histogram. So, for a 256 by 256 histogram, Epsilon should be much less than 1e-5. Tests have shown that choices of epsilon are not very important as long as it is small enough. The default is 1e-12. I doubt you will need to change it.

Author: Samson Timoner

SUPPORT: This work was supported by the Functional Imaging Research in Schizophrenia Testbed (FIRST) Biomedical Informatics Research Network (BIRN, http://www.birncommunity.org/), which is funded by the National Center for Research Resources at the National Institutes of Health (NIH). This work is also funded by the Neuroimage Analysis Center (P41 RR13218).

Definition at line 72 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::FixedImageConstPointer	FixedImageConstPointer

typedef Superclass::FixedImageType	FixedImageType

typedef Superclass::GradientPixelType	GradientPixelType

typedef Superclass::HistogramFrequencyType	HistogramFrequencyType

typedef Superclass::HistogramIteratorType	HistogramIteratorType

typedef Superclass::MeasurementVectorType	HistogramMeasurementVectorType

typedef Superclass::HistogramPointerType	HistogramPointerType

typedef Superclass::HistogramSizeType	HistogramSizeType

typedef Superclass::HistogramType	HistogramType

typedef Superclass::InterpolatorPointer	InterpolatorPointer

typedef Superclass::InterpolatorType	InterpolatorType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MovingImageConstPointer	MovingImageConstPointer

typedef Superclass::MovingImageType	MovingImageType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RealType	RealType

typedef KullbackLeiblerCompareHistogramImageToImageMetric	Self

typedef CompareHistogramImageToImageMetric < TFixedImage, TMovingImage >	Superclass

typedef Superclass::ConstPointer	TransformConstPointer

typedef Superclass::TransformJacobianType	TransformJacobianType

typedef Superclass::TransformParametersType	TransformParametersType

typedef Superclass::TransformPointer	TransformPointer

typedef Superclass::TransformType	TransformType

Public Types inherited from itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::FixedImageConstPointer	FixedImageConstPointer

typedef Superclass::FixedImageRegionType	FixedImageRegionType

typedef Superclass::FixedImageType	FixedImageType

typedef Superclass::GradientPixelType	GradientPixelType

typedef HistogramType::AbsoluteFrequencyType	HistogramAbsoluteFrequencyType

typedef HistogramAbsoluteFrequencyType	HistogramFrequencyType

typedef HistogramType::Iterator	HistogramIteratorType

typedef HistogramType::MeasurementVectorType	HistogramMeasurementVectorType

typedef HistogramType::Pointer	HistogramPointerType

typedef Superclass::HistogramSizeType	HistogramSizeType

typedef Superclass::HistogramType	HistogramType

typedef Superclass::InterpolatorPointer	InterpolatorPointer

typedef Superclass::InterpolatorType	InterpolatorType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MovingImageConstPointer	MovingImageConstPointer

typedef Superclass::MovingImageType	MovingImageType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RealType	RealType

typedef CompareHistogramImageToImageMetric	Self

typedef HistogramImageToImageMetric < TFixedImage, TMovingImage >	Superclass

typedef TransformType::ConstPointer	TransformConstPointer

typedef Superclass::TransformJacobianType	TransformJacobianType

typedef Superclass::TransformParametersType	TransformParametersType

typedef Superclass::TransformPointer	TransformPointer

typedef Superclass::TransformType	TransformType

Public Types inherited from itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::FixedImageConstPointer	FixedImageConstPointerType

typedef Superclass::FixedImageType::PixelType	FixedImagePixelType

typedef Superclass::FixedImageType	FixedImageType

typedef Superclass::GradientPixelType	GradientPixelType

typedef HistogramType::Pointer	HistogramPointer

typedef HistogramType::SizeType	HistogramSizeType

typedef Statistics::Histogram < double >	HistogramType

typedef Superclass::InputPointType	InputPointType

typedef HistogramType::MeasurementVectorType	MeasurementVectorType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::MovingImageConstPointer	MovingImageConstPointerType

typedef Superclass::MovingImageType::PixelType	MovingImagePixelType

typedef Superclass::MovingImageType	MovingImageType

typedef Superclass::OutputPointType	OutputPointType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RealType	RealType

typedef Array< double >	ScalesType

typedef HistogramImageToImageMetric	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 SmartPointer< const Self >	ConstPointer

typedef Superclass::ParametersValueType	CoordinateRepresentationType

typedef Superclass::DerivativeType	DerivativeType

typedef FixedImageType::ConstPointer	FixedImageConstPointer

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 FixedImageType::RegionType	FixedImageRegionType

typedef TFixedImage	FixedImageType

typedef TransformType::InputPointType	InputPointType

typedef InterpolatorType::Pointer	InterpolatorPointer

typedef InterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	InterpolatorType

typedef Superclass::MeasureType	MeasureType

typedef MovingImageType::ConstPointer	MovingImageConstPointer

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 TMovingImage	MovingImageType

typedef MultiThreader	MultiThreaderType

typedef TransformType::OutputPointType	OutputPointType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageMetric	Self

typedef SingleValuedCostFunction	Superclass

typedef TransformType::JacobianType	TransformJacobianType

typedef TransformType::ParametersType	TransformParametersType

typedef TransformType::Pointer	TransformPointer

typedef Transform < CoordinateRepresentationType, itkGetStaticConstMacro(MovingImageDimension), itkGetStaticConstMacro(FixedImageDimension) >	TransformType

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 Types inherited from itk::SingleValuedCostFunction
typedef SmartPointer< const Self >	ConstPointer

typedef Array < ParametersValueType >	DerivativeType

typedef double	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef SingleValuedCostFunction	Self

typedef CostFunction	Superclass

Public Types inherited from itk::CostFunction
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < ParametersValueType >	ParametersType

typedef double	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef CostFunction	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const double &	GetEpsilon ()

virtual const char *	GetNameOfClass () const

unsigned int	GetNumberOfParameters (void) const

void	Initialize () throw ( ExceptionObject )

virtual void	SetEpsilon (double _arg)

Public Member Functions inherited from itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
virtual void	SetTrainingFixedImage (const FixedImageType *_arg)

virtual void	SetTrainingHistogram (HistogramPointerType _arg)

virtual const HistogramPointerType &	GetTrainingHistogram ()

virtual void	SetTrainingMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetTrainingMovingImage () const

virtual void	SetTrainingTransform (TransformType *_arg)

virtual TransformType *	GetModifiableTrainingTransform ()

virtual const TransformType *	GetTrainingTransform () const

virtual void	SetTrainingInterpolator (InterpolatorType *_arg)

virtual InterpolatorType *	GetModifiableTrainingInterpolator ()

virtual const InterpolatorType *	GetTrainingInterpolator () const

virtual void	SetTrainingFixedImageRegion (FixedImageRegionType _arg)

virtual const FixedImageRegionType &	GetTrainingFixedImageRegion ()

Public Member Functions inherited from itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >
void	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const

virtual double	GetDerivativeStepLength () const

virtual const ScalesType &	GetDerivativeStepLengthScales ()

virtual const HistogramPointer &	GetHistogram ()

virtual const HistogramSizeType &	GetHistogramSize ()

const MeasurementVectorType &	GetLowerBound () const

virtual const FixedImagePixelType &	GetPaddingValue ()

const MeasurementVectorType &	GetUpperBound () const

MeasureType	GetValue (const TransformParametersType &parameters) const

void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const

virtual void	SetDerivativeStepLength (double _arg)

virtual void	SetDerivativeStepLengthScales (ScalesType _arg)

virtual void	SetHistogramSize (HistogramSizeType _arg)

void	SetLowerBound (const MeasurementVectorType &bound)

virtual void	SetPaddingValue (FixedImagePixelType _arg)

void	SetTransform (TransformType *transform)

void	SetUpperBound (const MeasurementVectorType &bound)

virtual void	SetUpperBoundIncreaseFactor (double _arg)

virtual double	GetUpperBoundIncreaseFactor () const

virtual void	SetUsePaddingValue (bool _arg)

virtual bool	GetUsePaddingValue () const

Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeGradient (void)

virtual const FixedImageRegionType &	GetFixedImageRegion ()

virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold ()

virtual const GradientImageType *	GetGradientImage () const

virtual const InterpolatorType *	GetInterpolator () const

virtual GradientImageType *	GetModifiableGradientImage ()

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual TransformType *	GetModifiableTransform ()

SizeValueType	GetNumberOfMovingImageSamples (void)

virtual const SizeValueType &	GetNumberOfPixelsCounted ()

SizeValueType	GetNumberOfSpatialSamples (void)

virtual const TransformType *	GetTransform () const

virtual const bool &	GetUseAllPixels ()

virtual const bool &	GetUseFixedImageIndexes ()

virtual const bool &	GetUseFixedImageSamplesIntensityThreshold ()

virtual const bool &	GetUseSequentialSampling ()

virtual void	MultiThreadingInitialize (void) throw ( ExceptionObject )

void	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)

void	SetFixedImageRegion (const FixedImageRegionType reg)

void	SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)

virtual void	SetInterpolator (InterpolatorType *_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	SetFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetFixedImage () const

virtual void	SetMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetMovingImage () const

virtual void	SetMovingImageMask (MovingImageMaskType *_arg)

virtual void	SetMovingImageMask (const MovingImageMaskType *_arg)

virtual const MovingImageMaskType *	GetMovingImageMask () const

virtual void	SetFixedImageMask (FixedImageMaskType *_arg)

virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)

virtual const FixedImageMaskType *	GetFixedImageMask () const

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 MultiThreaderType *	GetModifiableThreader ()

virtual const MultiThreaderType *	GetThreader () const

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
virtual MeasureType	EvaluateMeasure (HistogramType &histogram) const

void	FormTrainingHistogram () throw ( ExceptionObject )


	KullbackLeiblerCompareHistogramImageToImageMetric ()

virtual	~KullbackLeiblerCompareHistogramImageToImageMetric ()

void	PrintSelf (std::ostream &os, Indent indent) const

Protected Member Functions inherited from itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
void	FormTrainingHistogram () throw ( ExceptionObject )

	CompareHistogramImageToImageMetric ()

virtual	~CompareHistogramImageToImageMetric ()

Protected Member Functions inherited from itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >
void	ComputeHistogram (const TransformParametersType &parameters, HistogramType &histogram) const

void	ComputeHistogram (const TransformParametersType &parameters, unsigned int parameter, double step, HistogramType &histogram) const

void	CopyHistogram (HistogramType &target, HistogramType &source) const

virtual MeasureType	EvaluateMeasure (HistogramType &histogram) const =0

	HistogramImageToImageMetric ()

virtual	~HistogramImageToImageMetric ()

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

Protected Attributes
double	m_Epsilon

Private Member Functions
	KullbackLeiblerCompareHistogramImageToImageMetric (Self const &)

void	operator= (Self 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, FixedImageType::ImageDimension >	BSplineParametersOffsetType

typedef BSplineTransformType::ParameterIndexArrayType	BSplineTransformIndexArrayType

typedef Array2D< IndexValueType >	BSplineTransformIndicesArrayType

typedef BSplineBaseTransform < CoordinateRepresentationType, 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)

Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int	DeformationSplineOrder = 3