itk::HistogramImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkHistogramImageToImageMetric.h>

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

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

List of all members.

Public Types
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 Superclass::ParametersValueType	CoordinateRepresentationType
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 TransformType::InputPointType	FixedImagePointType
typedef FixedImageType::RegionType	FixedImageRegionType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef InterpolateImageFunction < MovingImageType, CoordinateRepresentationType >	InterpolatorType
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef MovingImageType::IndexType	MovingImageIndexType
typedef MovingImageMaskType::ConstPointer	MovingImageMaskConstPointer
typedef MovingImageMaskType::Pointer	MovingImageMaskPointer
typedef SpatialObject < itkGetStaticConstMacro(MovingImageDimension) >	MovingImageMaskType
typedef TransformType::OutputPointType	MovingImagePointType
typedef MultiThreader	MultiThreaderType
typedef Superclass::ParametersType	ParametersType
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 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	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const
virtual double	GetDerivativeStepLength () const
virtual const ScalesType &	GetDerivativeStepLengthScales ()
virtual const HistogramPointer &	GetHistogram ()
virtual const HistogramSizeType &	GetHistogramSize ()
virtual const char *	GetNameOfClass () const
virtual const FixedImagePixelType &	GetPaddingValue ()
MeasureType	GetValue (const TransformParametersType &parameters) const
void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
void	Initialize () throw ( ExceptionObject )
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 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	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

Protected Member Functions
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 ()
void	PrintSelf (std::ostream &os, Indent indent) const
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
HistogramSizeType	m_HistogramSize
MeasurementVectorType	m_LowerBound
bool	m_LowerBoundSetByUser
MeasurementVectorType	m_UpperBound
double	m_UpperBoundIncreaseFactor
bool	m_UpperBoundSetByUser
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

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

Private Attributes
double	m_DerivativeStepLength
ScalesType	m_DerivativeStepLengthScales
HistogramPointer	m_Histogram
FixedImagePixelType	m_PaddingValue
bool	m_UsePaddingValue

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)
Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int	DeformationSplineOrder = 3

---

Detailed Description

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

Computes similarity between two objects to be registered.

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

The metric computes the similarity measure between pixels in the moving image and pixels in the fixed image using a histogram.

Definition at line 39 of file itkHistogramImageToImageMetric.h.

---

Member Typedef Documentation

template<class TFixedImage , class TMovingImage >

typedef SmartPointer< const Self > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 47 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::DerivativeType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Type of the derivative.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 62 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageConstPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointerType

Definition at line 68 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageType::PixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 64 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 63 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::GradientPixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType

Gaussian filter to compute the gradient of the Moving Image

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 58 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef HistogramType::Pointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramPointer

Definition at line 79 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef HistogramType::SizeType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramSizeType

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 78 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Statistics::Histogram< double > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramType

Typedefs for histogram. This should have been defined as Histogram<RealType,2> but a bug in VC++7 produced an internal compiler error with such declaration.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 75 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::InputPointType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::InputPointType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 59 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef HistogramType::MeasurementVectorType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MeasurementVectorType

Definition at line 77 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MeasureType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Type of the measure.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 61 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageConstPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointerType

Definition at line 70 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageType::PixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 66 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 65 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::OutputPointType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 60 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef SmartPointer< Self > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Pointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 46 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::RealType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::RealType

Types transferred from the base class

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 50 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Array< double > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ScalesType

The scales type.

Definition at line 124 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef HistogramImageToImageMetric itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 44 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef ImageToImageMetric< TFixedImage, TMovingImage > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Superclass

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 45 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformJacobianType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 57 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformParametersType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 56 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 55 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Type of the Transform Base class

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 54 of file itkHistogramImageToImageMetric.h.

---

Constructor & Destructor Documentation

template<class TFixedImage , class TMovingImage >

itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramImageToImageMetric ( )

protected

Constructor is protected to ensure that New() function is used to create instances.

template<class TFixedImage , class TMovingImage >

virtual itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::~HistogramImageToImageMetric ( )

inlineprotectedvirtual

Definition at line 161 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramImageToImageMetric ( const Self &  )

private

---

Member Function Documentation

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ComputeHistogram ( const TransformParametersType &  parameters, HistogramType &  histogram  ) const

protected

Computes the joint histogram from the transformation parameters passed to the function.

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ComputeHistogram ( const TransformParametersType &  parameters, unsigned int  parameter, double  step, HistogramType &  histogram  ) const

protected

Computes the joint histogram from the transformation parameters passed to the function.

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::CopyHistogram ( HistogramType &  target, HistogramType &  source  ) const

protected

Copies a histogram.

template<class TFixedImage , class TMovingImage >

virtual MeasureType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::EvaluateMeasure ( HistogramType &  histogram ) const

protectedpure virtual

Evaluates the similarity measure using the given histogram. All subclasses must reimplement this method.

Implemented in itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative	(	const TransformParametersType &	parameters,
		DerivativeType &	derivative
	)		const

Get the derivatives of the match measure.

template<class TFixedImage , class TMovingImage >

virtual double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetDerivativeStepLength ( ) const

virtual

Returns the step length used to calculate the derivative.

template<class TFixedImage , class TMovingImage >

virtual const ScalesType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetDerivativeStepLengthScales ( )

virtual

Returns the derivate step length scales.

template<class TFixedImage , class TMovingImage >

virtual const HistogramPointer& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetHistogram ( )

virtual

Return the joint histogram. This is updated during every call to the GetValue() method. The histogram can for instance be used by itk::HistogramToImageFilter to plot the joint histogram.

template<class TFixedImage , class TMovingImage >

virtual const HistogramSizeType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetHistogramSize ( )

virtual

Gets the histogram size.

template<class TFixedImage , class TMovingImage >

virtual const char* itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

virtual const FixedImagePixelType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetPaddingValue ( )

virtual

Returns the padding value.

template<class TFixedImage , class TMovingImage >

virtual double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetUpperBoundIncreaseFactor ( ) const

virtual

Factor to increase the upper bound for the samples in the histogram. Default value is 0.001

template<class TFixedImage , class TMovingImage >

virtual bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetUsePaddingValue ( ) const

virtual

Set whether the padding value should be used to determine which pixels should be ignored when calculating the similarity measure. Those pixels in the fixed image which have the padding value will be ignored.

template<class TFixedImage , class TMovingImage >

MeasureType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetValue

(

const TransformParametersType &

parameters

)

const

Get the value for single valued optimizers.

template<class TFixedImage , class TMovingImage >

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

Get value and derivatives for multiple valued optimizers.

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Initialize ( ) throw ( ExceptionObject )

virtual

Initializes the metric.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::operator= ( const Self &  )

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

PrintSelf function

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetDerivativeStepLength ( double  _arg )

virtual

Sets the step length used to calculate the derivative.

template<class TFixedImage , class TMovingImage >

virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetDerivativeStepLengthScales ( ScalesType  _arg )

virtual

Sets the derivative step length scales.

template<class TFixedImage , class TMovingImage >

virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetHistogramSize ( HistogramSizeType  _arg )

virtual

Sets the histogram size. Note this function must be called before Initialize().

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetLowerBound

(

const MeasurementVectorType &

bound

)

Set the lower bounds of the intensities to be considered for computing the histogram. This option allows to focus the computation of the Metric in a particular range of intensities that correspond to features of interest.

template<class TFixedImage , class TMovingImage >

virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetPaddingValue ( FixedImagePixelType  _arg )

virtual

The padding value.

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTransform

(

TransformType *

transform

)

Define the transform and thereby the parameter space of the metric and the space of its derivatives

template<class TFixedImage , class TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetUpperBound

(

const MeasurementVectorType &

bound

)

Set the upper bounds of the intensities to be considered for computing the histogram. This option allows to focus the computation of the Metric in a particular range of intensities that correspond to features of interest.

template<class TFixedImage , class TMovingImage >

virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetUpperBoundIncreaseFactor ( double  _arg )

virtual

Factor to increase the upper bound for the samples in the histogram. Default value is 0.001

template<class TFixedImage , class TMovingImage >

virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetUsePaddingValue ( bool  _arg )

virtual

Set whether the padding value should be used to determine which pixels should be ignored when calculating the similarity measure. Those pixels in the fixed image which have the padding value will be ignored.

---

Member Data Documentation

template<class TFixedImage , class TMovingImage >

double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_DerivativeStepLength

private

The step length used to calculate the derivative.

Definition at line 218 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

ScalesType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_DerivativeStepLengthScales

private

The derivative step length scales.

Definition at line 221 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

HistogramPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_Histogram

private

Pointer to the joint histogram. This is updated during every call to GetValue()

Definition at line 225 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

HistogramSizeType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_HistogramSize

protected

The histogram size.

Definition at line 164 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

MeasurementVectorType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_LowerBound

mutableprotected

The lower bound for samples in the histogram.

Definition at line 167 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_LowerBoundSetByUser

protected

Boolean flag to indicate whether the user supplied lower bounds or whether they should be computed from the min of image intensities

Definition at line 177 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

FixedImagePixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_PaddingValue

private

The padding value.

Definition at line 210 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

MeasurementVectorType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UpperBound

mutableprotected

The upper bound for samples in the histogram.

Definition at line 170 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UpperBoundIncreaseFactor

protected

The increase in the upper bound.

Definition at line 173 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UpperBoundSetByUser

protected

Boolean flag to indicate whether the user supplied upper bounds or whether they should be computed from the max of image intensities

Definition at line 181 of file itkHistogramImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UsePaddingValue

private

True if those pixels in the fixed image with the same value as the padding value should be ignored when calculating the similarity measure.

Definition at line 215 of file itkHistogramImageToImageMetric.h.

---

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

• itkHistogramImageToImageMetric.h