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

#include <itkHistogramImageToImageMetric.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = typename Superclass::DerivativeType
using	FixedImageConstPointerType = typename Superclass::FixedImageConstPointer
using	FixedImagePixelType = typename Superclass::FixedImageType::PixelType
using	FixedImageType = typename Superclass::FixedImageType
using	GradientPixelType = typename Superclass::GradientPixelType
using	HistogramPointer = typename HistogramType::Pointer
using	HistogramSizeType = typename HistogramType::SizeType
using	HistogramType = Statistics::Histogram< double >
using	InputPointType = typename Superclass::InputPointType
using	MeasurementVectorType = typename HistogramType::MeasurementVectorType
using	MeasureType = typename Superclass::MeasureType
using	MovingImageConstPointerType = typename Superclass::MovingImageConstPointer
using	MovingImagePixelType = typename Superclass::MovingImageType::PixelType
using	MovingImageType = typename Superclass::MovingImageType
using	OutputPointType = typename Superclass::OutputPointType
using	Pointer = SmartPointer< Self >
using	RealType = typename Superclass::RealType
using	Self = HistogramImageToImageMetric
using	Superclass = ImageToImageMetric< TFixedImage, TMovingImage >
using	TransformJacobianType = typename Superclass::TransformJacobianType
using	TransformParametersType = typename Superclass::TransformParametersType
using	TransformPointer = typename Superclass::TransformPointer
using	TransformType = typename Superclass::TransformType
Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using	ConstPointer = SmartPointer< const Self >
using	CoordinateRepresentationType = typename Superclass::ParametersValueType
using	DerivativeType = typename Superclass::DerivativeType
using	FixedImageConstPointer = typename FixedImageType::ConstPointer
using	FixedImageIndexContainer = std::vector< FixedImageIndexType >
using	FixedImageIndexType = typename FixedImageType::IndexType
using	FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
using	FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer
using	FixedImageMaskPointer = typename FixedImageMaskType::Pointer
using	FixedImageMaskType = SpatialObject< Self::FixedImageDimension >
using	FixedImagePixelType = typename TFixedImage::PixelType
using	FixedImagePointType = typename TransformType::InputPointType
using	FixedImageRegionType = typename FixedImageType::RegionType
using	FixedImageType = TFixedImage
using	GradientImageFilterPointer = typename GradientImageFilterType::Pointer
using	GradientImageFilterType = GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >
using	GradientImagePointer = SmartPointer< GradientImageType >
using	GradientImageType = Image< GradientPixelType, Self::MovingImageDimension >
using	GradientPixelType = CovariantVector< RealType, Self::MovingImageDimension >
using	InputPointType = typename TransformType::InputPointType
using	InterpolatorPointer = typename InterpolatorType::Pointer
using	InterpolatorType = InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >
using	MeasureType = typename Superclass::MeasureType
using	MovingImageConstPointer = typename MovingImageType::ConstPointer
using	MovingImageIndexType = typename MovingImageType::IndexType
using	MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer
using	MovingImageMaskPointer = typename MovingImageMaskType::Pointer
using	MovingImageMaskType = SpatialObject< Self::MovingImageDimension >
using	MovingImagePixelType = typename TMovingImage::PixelType
using	MovingImagePointType = typename TransformType::OutputPointType
using	MovingImageType = TMovingImage
using	OutputPointType = typename TransformType::OutputPointType
using	ParametersType = typename Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	RealType = typename NumericTraits< MovingImagePixelType >::RealType
using	Self = ImageToImageMetric
using	Superclass = SingleValuedCostFunction
using	TransformJacobianType = typename TransformType::JacobianType
using	TransformParametersType = typename TransformType::ParametersType
using	TransformPointer = typename TransformType::Pointer
using	TransformType = Transform< CoordinateRepresentationType, Self::MovingImageDimension, Self::FixedImageDimension >
using	MultiThreaderType = MultiThreaderBase
Public Types inherited from itk::SingleValuedCostFunction
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = Array< ParametersValueType >
using	MeasureType = double
using	ParametersType = Superclass::ParametersType
using	ParametersValueType = Superclass::ParametersValueType
using	Pointer = SmartPointer< Self >
using	Self = SingleValuedCostFunction
using	Superclass = CostFunction
Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >
using	ParametersType = OptimizerParameters< TInternalComputationValueType >
using	ParametersValueType = TInternalComputationValueType
using	Pointer = SmartPointer< Self >
using	Self = CostFunctionTemplate
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
virtual const HistogramSizeType &	GetHistogramSize () const
virtual const char *	GetNameOfClass () const
void	Initialize () override
virtual void	SetHistogramSize (HistogramSizeType _arg)
void	SetTransform (TransformType *transform) override
Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	SetFixedImage (const FixedImageType *_arg)
virtual const FixedImageType *	GetFixedImage () const
virtual void	SetMovingImage (const MovingImageType *_arg)
virtual const MovingImageType *	GetMovingImage () const
virtual void	SetTransform (TransformType *_arg)
virtual TransformType *	GetModifiableTransform ()
virtual const TransformType *	GetTransform () const
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetModifiableInterpolator ()
virtual const InterpolatorType *	GetInterpolator () const
SizeValueType	GetNumberOfMovingImageSamples ()
virtual const SizeValueType &	GetNumberOfPixelsCounted () const
virtual void	SetFixedImageRegion (const FixedImageRegionType reg)
virtual const FixedImageRegionType &	GetFixedImageRegion () 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	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
void	SetUseFixedImageIndexes (bool useIndexes)
virtual const bool &	GetUseFixedImageIndexes () const
void	SetNumberOfWorkUnits (ThreadIdType numberOfThreads)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
virtual void	SetComputeGradient (bool _arg)
virtual const bool &	GetComputeGradient () const
virtual void	ComputeGradientOn ()
virtual void	ComputeGradientOff ()
virtual void	ComputeGradient ()
virtual GradientImageType *	GetModifiableGradientImage ()
virtual const GradientImageType *	GetGradientImage () const
void	SetTransformParameters (const ParametersType &parameters) const
unsigned int	GetNumberOfParameters () const override
virtual void	MultiThreadingInitialize ()
virtual void	SetNumberOfFixedImageSamples (SizeValueType numSamples)
virtual const SizeValueType &	GetNumberOfFixedImageSamples () const
void	SetNumberOfSpatialSamples (SizeValueType num)
SizeValueType	GetNumberOfSpatialSamples ()
void	SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold () const
void	SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
virtual const bool &	GetUseFixedImageSamplesIntensityThreshold () const
void	SetUseAllPixels (bool useAllPixels)
void	UseAllPixelsOn ()
void	UseAllPixelsOff ()
virtual const bool &	GetUseAllPixels () const
void	SetUseSequentialSampling (bool useSequential)
virtual const bool &	GetUseSequentialSampling () const
void	ReinitializeSeed ()
void	ReinitializeSeed (int seed)
virtual void	SetUseCachingOfBSplineWeights (bool _arg)
virtual const bool &	GetUseCachingOfBSplineWeights () const
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
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
using	ScalesType = Array< double >
HistogramSizeType	m_HistogramSize
MeasurementVectorType	m_LowerBound
MeasurementVectorType	m_UpperBound
double	m_UpperBoundIncreaseFactor
bool	m_LowerBoundSetByUser
bool	m_UpperBoundSetByUser
FixedImagePixelType	m_PaddingValue
bool	m_UsePaddingValue
double	m_DerivativeStepLength
ScalesType	m_DerivativeStepLengthScales
HistogramPointer	m_Histogram
virtual void	SetUpperBoundIncreaseFactor (double _arg)
virtual double	GetUpperBoundIncreaseFactor () const
virtual void	SetPaddingValue (FixedImagePixelType _arg)
virtual const FixedImagePixelType &	GetPaddingValue () const
virtual const HistogramPointer &	GetHistogram () const
virtual void	SetUsePaddingValue (bool _arg)
virtual bool	GetUsePaddingValue () const
virtual void	SetDerivativeStepLength (double _arg)
virtual double	GetDerivativeStepLength () const
virtual void	SetDerivativeStepLengthScales (ScalesType _arg)
virtual const ScalesType &	GetDerivativeStepLengthScales () const
MeasureType	GetValue (const TransformParametersType &parameters) const override
void	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const override
void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override
void	SetLowerBound (const MeasurementVectorType &bounds)
const MeasurementVectorType &	GetLowerBound () const
void	SetUpperBound (const MeasurementVectorType &bounds)
const MeasurementVectorType &	GetUpperBound () const
	HistogramImageToImageMetric ()
	~HistogramImageToImageMetric () override=default
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
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
Static Public Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int	FixedImageDimension = TFixedImage::ImageDimension
static constexpr unsigned int	MovingImageDimension = TMovingImage::ImageDimension
Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using	FixedImageSampleContainer = std::vector< FixedImageSamplePoint >
using	BSplineTransformType = BSplineBaseTransform< CoordinateRepresentationType, FixedImageType::ImageDimension, Self::DeformationSplineOrder >
using	BSplineTransformWeightsType = typename BSplineTransformType::WeightsType
using	WeightsValueType = typename BSplineTransformWeightsType::ValueType
using	BSplineTransformWeightsArrayType = Array2D< WeightsValueType >
using	BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType
using	IndexValueType = typename BSplineTransformIndexArrayType::ValueType
using	BSplineTransformIndicesArrayType = Array2D< IndexValueType >
using	MovingImagePointArrayType = std::vector< MovingImagePointType >
using	BooleanArrayType = std::vector< bool >
using	BSplineParametersOffsetType = FixedArray< SizeValueType, FixedImageType::ImageDimension >
using	BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >
using	DerivativeFunctionType = CentralDifferenceImageFunction< MovingImageType, CoordinateRepresentationType >
using	ImageDerivativesType = CovariantVector< double, Self::MovingImageDimension >
Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
	ImageToImageMetric ()
	~ImageToImageMetric () override
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SampleFixedImageRegion (FixedImageSampleContainer &samples) const
virtual void	SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
virtual void	SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const
virtual void	PreComputeTransformValues ()
virtual void	TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ThreadIdType threadId) const
virtual void	TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ImageDerivativesType &movingImageGradient, ThreadIdType threadId) const
virtual void	ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const
void	GetValueMultiThreadedInitiate () const
void	GetValueMultiThreadedPostProcessInitiate () const
virtual void	GetValueThread (ThreadIdType threadId) const
virtual void	GetValueThreadPreProcess (ThreadIdType, bool) const
virtual bool	GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const
virtual void	GetValueThreadPostProcess (ThreadIdType, bool) const
void	GetValueAndDerivativeMultiThreadedInitiate () const
void	GetValueAndDerivativeMultiThreadedPostProcessInitiate () const
virtual void	GetValueAndDerivativeThread (ThreadIdType threadId) const
virtual void	GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const
virtual bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const
virtual void	GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const
virtual void	SynchronizeTransforms () const
Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()=default
	~SingleValuedCostFunction () override
Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
	CostFunctionTemplate ()=default
	~CostFunctionTemplate () override=default
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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 ()
Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreaded (void *workunitInfoAsVoid)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreadedPostProcess (void *workunitInfoAsVoid)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreaded (void *workunitInfoAsVoid)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreadedPostProcess (void *workunitInfoAsVoid)
Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
bool	m_UseFixedImageIndexes { false }
FixedImageIndexContainer	m_FixedImageIndexes
bool	m_UseFixedImageSamplesIntensityThreshold { false }
FixedImagePixelType	m_FixedImageSamplesIntensityThreshold
FixedImageSampleContainer	m_FixedImageSamples
SizeValueType	m_NumberOfParameters { 0 }
SizeValueType	m_NumberOfFixedImageSamples { 50000 }
SizeValueType	m_NumberOfPixelsCounted { 0 }
FixedImageConstPointer	m_FixedImage
MovingImageConstPointer	m_MovingImage
TransformPointer	m_Transform
TransformPointer *	m_ThreaderTransform
InterpolatorPointer	m_Interpolator
bool	m_ComputeGradient { true }
GradientImagePointer	m_GradientImage
FixedImageMaskConstPointer	m_FixedImageMask
MovingImageMaskConstPointer	m_MovingImageMask
ThreadIdType	m_NumberOfWorkUnits { 1 }
bool	m_UseAllPixels { false }
bool	m_UseSequentialSampling { false }
bool	m_ReseedIterator { false }
int	m_RandomSeed
bool	m_TransformIsBSpline { false }
SizeValueType	m_NumBSplineWeights { 0 }
BSplineTransformType::Pointer	m_BSplineTransform
BSplineTransformWeightsArrayType	m_BSplineTransformWeightsArray
BSplineTransformIndicesArrayType	m_BSplineTransformIndicesArray
MovingImagePointArrayType	m_BSplinePreTransformPointsArray
BooleanArrayType	m_WithinBSplineSupportRegionArray
BSplineParametersOffsetType	m_BSplineParametersOffset
bool	m_UseCachingOfBSplineWeights { true }
BSplineTransformWeightsType	m_BSplineTransformWeights
BSplineTransformIndexArrayType	m_BSplineTransformIndices
BSplineTransformWeightsType *	m_ThreaderBSplineTransformWeights
BSplineTransformIndexArrayType *	m_ThreaderBSplineTransformIndices
bool	m_InterpolatorIsBSpline { false }
BSplineInterpolatorType::Pointer	m_BSplineInterpolator
DerivativeFunctionType::Pointer	m_DerivativeCalculator
MultiThreaderType::Pointer	m_Threader
ConstantPointerWrapper *	m_ConstSelfWrapper
unsigned int *	m_ThreaderNumberOfMovingImageSamples { nullptr }
bool	m_WithinThreadPreProcess { false }
bool	m_WithinThreadPostProcess { false }
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount
Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int	DeformationSplineOrder = 3

Detailed Description

template<typename TFixedImage, typename 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

ConstPointer

template<typename TFixedImage , typename TMovingImage >

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

Definition at line 48 of file itkHistogramImageToImageMetric.h.

DerivativeType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType = typename Superclass::DerivativeType

Definition at line 63 of file itkHistogramImageToImageMetric.h.

FixedImageConstPointerType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointerType = typename Superclass::FixedImageConstPointer

Definition at line 68 of file itkHistogramImageToImageMetric.h.

FixedImagePixelType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType = typename Superclass::FixedImageType::PixelType

Definition at line 65 of file itkHistogramImageToImageMetric.h.

FixedImageType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType = typename Superclass::FixedImageType

Definition at line 64 of file itkHistogramImageToImageMetric.h.

GradientPixelType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType = typename Superclass::GradientPixelType

Definition at line 59 of file itkHistogramImageToImageMetric.h.

HistogramPointer

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramPointer = typename HistogramType::Pointer

Definition at line 78 of file itkHistogramImageToImageMetric.h.

HistogramSizeType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramSizeType = typename HistogramType::SizeType

Definition at line 77 of file itkHistogramImageToImageMetric.h.

HistogramType

template<typename TFixedImage , typename TMovingImage >

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

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.

Definition at line 74 of file itkHistogramImageToImageMetric.h.

InputPointType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::InputPointType = typename Superclass::InputPointType

Definition at line 60 of file itkHistogramImageToImageMetric.h.

MeasurementVectorType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MeasurementVectorType = typename HistogramType::MeasurementVectorType

Definition at line 76 of file itkHistogramImageToImageMetric.h.

MeasureType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MeasureType = typename Superclass::MeasureType

Definition at line 62 of file itkHistogramImageToImageMetric.h.

MovingImageConstPointerType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointerType = typename Superclass::MovingImageConstPointer

Definition at line 69 of file itkHistogramImageToImageMetric.h.

MovingImagePixelType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType = typename Superclass::MovingImageType::PixelType

Definition at line 67 of file itkHistogramImageToImageMetric.h.

MovingImageType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType = typename Superclass::MovingImageType

Definition at line 66 of file itkHistogramImageToImageMetric.h.

OutputPointType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType = typename Superclass::OutputPointType

Definition at line 61 of file itkHistogramImageToImageMetric.h.

Pointer

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 47 of file itkHistogramImageToImageMetric.h.

RealType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::RealType = typename Superclass::RealType

Types transferred from the base class

Definition at line 54 of file itkHistogramImageToImageMetric.h.

ScalesType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ScalesType = Array<double>

The scales type.

Definition at line 127 of file itkHistogramImageToImageMetric.h.

Self

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Self = HistogramImageToImageMetric

Standard class type aliases.

Definition at line 45 of file itkHistogramImageToImageMetric.h.

Superclass

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Superclass = ImageToImageMetric<TFixedImage, TMovingImage>

Definition at line 46 of file itkHistogramImageToImageMetric.h.

TransformJacobianType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType = typename Superclass::TransformJacobianType

Definition at line 58 of file itkHistogramImageToImageMetric.h.

TransformParametersType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType = typename Superclass::TransformParametersType

Definition at line 57 of file itkHistogramImageToImageMetric.h.

TransformPointer

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer = typename Superclass::TransformPointer

Definition at line 56 of file itkHistogramImageToImageMetric.h.

TransformType

template<typename TFixedImage , typename TMovingImage >

using itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformType = typename Superclass::TransformType

Definition at line 55 of file itkHistogramImageToImageMetric.h.

Constructor & Destructor Documentation

HistogramImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >

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

protected

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

~HistogramImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >

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

overrideprotecteddefault

The scales type.

Member Function Documentation

ComputeHistogram() [1/2]

template<typename TFixedImage , typename 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.

ComputeHistogram() [2/2]

template<typename TFixedImage , typename 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.

CopyHistogram()

template<typename TFixedImage , typename TMovingImage >

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

protected

Copies a histogram.

EvaluateMeasure()

template<typename TFixedImage , typename 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 >.

GetDerivative()

template<typename TFixedImage , typename TMovingImage >

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

override

Get the derivatives of the match measure.

GetDerivativeStepLength()

template<typename TFixedImage , typename TMovingImage >

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

virtual

Returns the step length used to calculate the derivative.

GetDerivativeStepLengthScales()

template<typename TFixedImage , typename TMovingImage >

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

virtual

Returns the derivate step length scales.

GetHistogram()

template<typename TFixedImage , typename TMovingImage >

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

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.

GetHistogramSize()

template<typename TFixedImage , typename TMovingImage >

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

virtual

Gets the histogram size.

GetLowerBound()

template<typename TFixedImage , typename TMovingImage >

const MeasurementVectorType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetLowerBound

(

)

const

Returns the current state of m_LowerBound.

GetNameOfClass()

template<typename TFixedImage , typename 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 >.

GetPaddingValue()

template<typename TFixedImage , typename TMovingImage >

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

virtual

Returns the padding value.

GetUpperBound()

template<typename TFixedImage , typename TMovingImage >

const MeasurementVectorType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetUpperBound

(

)

const

Returns the current state of m_UpperBound.

GetUpperBoundIncreaseFactor()

template<typename TFixedImage , typename TMovingImage >

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

virtual

The scales type.

GetUsePaddingValue()

template<typename TFixedImage , typename TMovingImage >

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

virtual

The scales type.

GetValue()

template<typename TFixedImage , typename TMovingImage >

MeasureType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const TransformParametersType &  parameters ) const

override

Get the value for single valued optimizers.

GetValueAndDerivative()

template<typename TFixedImage , typename TMovingImage >

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

override

Get value and derivatives for multiple valued optimizers.

Initialize()

template<typename TFixedImage , typename TMovingImage >

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

overridevirtual

Initializes the metric.

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

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

PrintSelf()

template<typename TFixedImage , typename TMovingImage >

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

overrideprotectedvirtual

PrintSelf function

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

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

SetDerivativeStepLength()

template<typename TFixedImage , typename TMovingImage >

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

virtual

Sets the step length used to calculate the derivative.

SetDerivativeStepLengthScales()

template<typename TFixedImage , typename TMovingImage >

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

virtual

Sets the derivative step length scales.

SetHistogramSize()

template<typename TFixedImage , typename TMovingImage >

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

virtual

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

SetLowerBound()

template<typename TFixedImage , typename TMovingImage >

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

(

const MeasurementVectorType &

bounds

)

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.

SetPaddingValue()

template<typename TFixedImage , typename TMovingImage >

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

virtual

The padding value.

SetTransform()

template<typename TFixedImage , typename TMovingImage >

void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTransform ( TransformType *  transform )

override

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

SetUpperBound()

template<typename TFixedImage , typename TMovingImage >

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

(

const MeasurementVectorType &

bounds

)

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.

SetUpperBoundIncreaseFactor()

template<typename TFixedImage , typename 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

SetUsePaddingValue()

template<typename TFixedImage , typename 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

m_DerivativeStepLength

template<typename TFixedImage , typename TMovingImage >

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

private

The step length used to calculate the derivative.

Definition at line 232 of file itkHistogramImageToImageMetric.h.

m_DerivativeStepLengthScales

template<typename TFixedImage , typename TMovingImage >

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

private

The derivative step length scales.

Definition at line 235 of file itkHistogramImageToImageMetric.h.

m_Histogram

template<typename TFixedImage , typename 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 239 of file itkHistogramImageToImageMetric.h.

m_HistogramSize

template<typename TFixedImage , typename TMovingImage >

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

protected

The histogram size.

Definition at line 177 of file itkHistogramImageToImageMetric.h.

m_LowerBound

template<typename TFixedImage , typename TMovingImage >

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

mutableprotected

The lower bound for samples in the histogram.

Definition at line 180 of file itkHistogramImageToImageMetric.h.

m_LowerBoundSetByUser

template<typename TFixedImage , typename 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 190 of file itkHistogramImageToImageMetric.h.

m_PaddingValue

template<typename TFixedImage , typename TMovingImage >

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

private

The padding value.

Definition at line 224 of file itkHistogramImageToImageMetric.h.

m_UpperBound

template<typename TFixedImage , typename TMovingImage >

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

mutableprotected

The upper bound for samples in the histogram.

Definition at line 183 of file itkHistogramImageToImageMetric.h.

m_UpperBoundIncreaseFactor

template<typename TFixedImage , typename TMovingImage >

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

protected

The increase in the upper bound.

Definition at line 186 of file itkHistogramImageToImageMetric.h.

m_UpperBoundSetByUser

template<typename TFixedImage , typename 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 194 of file itkHistogramImageToImageMetric.h.

m_UsePaddingValue

template<typename TFixedImage , typename 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 229 of file itkHistogramImageToImageMetric.h.

---

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

• itkHistogramImageToImageMetric.h