#include <itkCompareHistogramImageToImageMetric.h>

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >

Compares Histograms between two images to be registered to a Training Histogram.

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

This metric computes the similarity between the histogram produced by two images overlapping and a training histogram.

It is to be sub-classed by the method of comparing the histograms.

Generally, the histogram from the training data is to be computed in exactly the same way as the histogram from the images to be compared are computed. Thus, the user can set the interpolator, region, two training images and the transform and the training histogram will be formed. OR, the user can simply calculate the training histogram separately and set it.

Warning: The Initialize function does nothing if the training histogram already exists. Thus repeated calls to the Initialize function do nothing after the first call. If you wish the training histogram to be re-calculated, you should set it to 0.

Author: Samson Timoner.

Definition at line 56 of file itkCompareHistogramImageToImageMetric.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	HistogramAbsoluteFrequencyType = typename HistogramType::AbsoluteFrequencyType

using	HistogramFrequencyType = HistogramAbsoluteFrequencyType

using	HistogramIteratorType = typename HistogramType::Iterator

using	HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType

using	HistogramPointerType = typename HistogramType::Pointer

using	Pointer = SmartPointer< Self >

using	Self = CompareHistogramImageToImageMetric

using	Superclass = HistogramImageToImageMetric< TFixedImage, TMovingImage >

using	TransformConstPointer = typename TransformType::ConstPointer

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

using	FixedImageConstPointerType = typename Superclass::FixedImageConstPointer

using	FixedImagePixelType = typename Superclass::FixedImageType::PixelType

using	HistogramPointer = typename HistogramType::Pointer

using	HistogramSizeType = typename HistogramType::SizeType

using	HistogramType = Statistics::Histogram< double >

using	MeasurementVectorType = typename HistogramType::MeasurementVectorType

using	MovingImageConstPointerType = typename Superclass::MovingImageConstPointer

using	MovingImagePixelType = typename Superclass::MovingImageType::PixelType

using	Pointer = SmartPointer< Self >

using	ScalesType = Array< double >

using	Self = HistogramImageToImageMetric

using	Superclass = ImageToImageMetric< TFixedImage, TMovingImage >

Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using	ConstPointer = SmartPointer< const Self >

using	CoordinateRepresentationType = typename Superclass::ParametersValueType

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	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	MultiThreaderType = MultiThreaderBase

using	OutputPointType = typename TransformType::OutputPointType

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 >

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< double >
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = OptimizerParameters< double >

using	ParametersValueType = double

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
const char *	GetNameOfClass () const override

unsigned int	GetNumberOfParameters () const override

void	Initialize () override


virtual void	SetTrainingHistogram (HistogramPointerType _arg)

virtual const HistogramPointerType &	GetTrainingHistogram () const


virtual void	SetTrainingFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetTrainingFixedImage () const


virtual void	SetTrainingMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetTrainingMovingImage () const


virtual void	SetTrainingTransform (TransformType *_arg)

virtual TransformType *	GetModifiableTrainingTransform ()


virtual void	SetTrainingInterpolator (InterpolatorType *_arg)

virtual InterpolatorType *	GetModifiableTrainingInterpolator ()


virtual void	SetTrainingFixedImageRegion (FixedImageRegionType _arg)

virtual const FixedImageRegionType &	GetTrainingFixedImageRegion () const

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

virtual double	GetDerivativeStepLength () const

virtual const ScalesType &	GetDerivativeStepLengthScales () const

virtual const HistogramPointer &	GetHistogram () const

virtual const HistogramSizeType &	GetHistogramSize () const

const MeasurementVectorType &	GetLowerBound () const

const char *	GetNameOfClass () const override

virtual const FixedImagePixelType &	GetPaddingValue () const

const MeasurementVectorType &	GetUpperBound () const

MeasureType	GetValue (const TransformParametersType &parameters) const override

void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override

void	Initialize () override

virtual void	SetDerivativeStepLength (double _arg)

virtual void	SetDerivativeStepLengthScales (ScalesType _arg)

virtual void	SetHistogramSize (HistogramSizeType _arg)

void	SetLowerBound (const MeasurementVectorType &bounds)

virtual void	SetPaddingValue (FixedImagePixelType _arg)

void	SetTransform (TransformType *transform) override

void	SetUpperBound (const MeasurementVectorType &bounds)

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

virtual const FixedImageRegionType &	GetFixedImageRegion () const

virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold () const

virtual GradientImageType *	GetModifiableGradientImage ()

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual TransformType *	GetModifiableTransform ()

const char *	GetNameOfClass () const override

SizeValueType	GetNumberOfMovingImageSamples ()

unsigned int	GetNumberOfParameters () const override

virtual const SizeValueType &	GetNumberOfPixelsCounted () const

SizeValueType	GetNumberOfSpatialSamples ()

virtual const bool &	GetUseAllPixels () const

virtual const bool &	GetUseFixedImageIndexes () const

virtual const bool &	GetUseFixedImageSamplesIntensityThreshold () const

virtual const bool &	GetUseSequentialSampling () const

virtual void	Initialize ()

virtual void	MultiThreadingInitialize ()

void	SetFixedImageIndexes (const FixedImageIndexContainer &indexes)

virtual 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 useIndexes)

void	SetUseFixedImageSamplesIntensityThreshold (bool useThresh)

void	SetUseSequentialSampling (bool useSequential)

void	UseAllPixelsOff ()

void	UseAllPixelsOn ()

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 (const MovingImageMaskType *_arg)

virtual const MovingImageMaskType *	GetMovingImageMask () const

virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)

virtual const FixedImageMaskType *	GetFixedImageMask () 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	SetNumberOfFixedImageSamples (SizeValueType numSamples)

virtual const SizeValueType &	GetNumberOfFixedImageSamples () const

void	ReinitializeSeed ()

void	ReinitializeSeed (int seed)

virtual void	SetUseCachingOfBSplineWeights (bool _arg)

virtual const bool &	GetUseCachingOfBSplineWeights () const

virtual void	UseCachingOfBSplineWeightsOn ()

virtual MultiThreaderType *	GetModifiableThreader ()

const TransformPointer *	GetThreaderTransform ()

Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0

const char *	GetNameOfClass () const override

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::CostFunctionTemplate< double >
const char *	GetNameOfClass () const override

virtual unsigned int	GetNumberOfParameters () const=0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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

const char *	GetNameOfClass () const override

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

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Protected Member Functions
MeasureType	EvaluateMeasure (HistogramType &histogram) const override=0

void	FormTrainingHistogram ()


	CompareHistogramImageToImageMetric ()

	~CompareHistogramImageToImageMetric () override=default

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

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

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

	HistogramImageToImageMetric ()

	~HistogramImageToImageMetric () override=default

Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void	ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const

void	GetValueAndDerivativeMultiThreadedInitiate () const

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

	ImageToImageMetric ()

virtual void	PreComputeTransformValues ()

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

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 &sampleOk, double &movingImageValue, ThreadIdType threadId) const

virtual void	TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ImageDerivativesType &movingImageGradient, ThreadIdType threadId) const

	~ImageToImageMetric () override=default

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

Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()=default

	~SingleValuedCostFunction () override

Protected Member Functions inherited from itk::CostFunctionTemplate< double >
	CostFunctionTemplate ()=default

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

	~CostFunctionTemplate () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

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

virtual	~LightObject ()

Private Attributes
FixedImageConstPointer	m_TrainingFixedImage {}

FixedImageRegionType	m_TrainingFixedImageRegion {}

HistogramPointerType	m_TrainingHistogram {}

InterpolatorPointer	m_TrainingInterpolator {}

MovingImageConstPointer	m_TrainingMovingImage {}

TransformPointer	m_TrainingTransform {}

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	BooleanArrayType = std::vector< bool >

using	BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >

using	BSplineParametersOffsetType = FixedArray< SizeValueType, FixedImageType::ImageDimension >

using	BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType

using	BSplineTransformIndicesArrayType = Array2D< IndexValueType >

using	BSplineTransformType = BSplineBaseTransform< CoordinateRepresentationType, FixedImageType::ImageDimension, Self::DeformationSplineOrder >

using	BSplineTransformWeightsArrayType = Array2D< WeightsValueType >

using	BSplineTransformWeightsType = typename BSplineTransformType::WeightsType

using	DerivativeFunctionType = CentralDifferenceImageFunction< MovingImageType, CoordinateRepresentationType >

using	FixedImageSampleContainer = std::vector< FixedImageSamplePoint >

using	ImageDerivativesType = CovariantVector< double, Self::MovingImageDimension >

using	IndexValueType = typename BSplineTransformIndexArrayType::ValueType

using	MovingImagePointArrayType = std::vector< MovingImagePointType >

using	WeightsValueType = typename BSplineTransformWeightsType::ValueType

Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreaded (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreadedPostProcess (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreaded (void *workunitInfoAsVoid)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreadedPostProcess (void *workunitInfoAsVoid)

Protected Attributes inherited from itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >
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 { true }

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 {}

MovingImageConstPointer	m_MovingImage {}

MovingImageMaskConstPointer	m_MovingImageMask {}

SizeValueType	m_NumberOfFixedImageSamples { 50000 }

SizeValueType	m_NumberOfParameters { 0 }

SizeValueType	m_NumberOfPixelsCounted { 0 }

ThreadIdType	m_NumberOfWorkUnits { 1 }

SizeValueType	m_NumBSplineWeights { 0 }

int	m_RandomSeed {}

bool	m_ReseedIterator { false }

std::unique_ptr< BSplineTransformIndexArrayType[]>	m_ThreaderBSplineTransformIndices

std::unique_ptr< BSplineTransformWeightsType[]>	m_ThreaderBSplineTransformWeights

std::unique_ptr< TransformPointer[]>	m_ThreaderTransform

TransformPointer	m_Transform {}

bool	m_UseAllPixels { false }

bool	m_UseCachingOfBSplineWeights { true }

bool	m_UseFixedImageIndexes { false }

bool	m_UseFixedImageSamplesIntensityThreshold { false }

bool	m_UseSequentialSampling { false }

BooleanArrayType	m_WithinBSplineSupportRegionArray {}

MultiThreaderType::Pointer	m_Threader {}

std::unique_ptr< ConstantPointerWrapper >	m_ConstSelfWrapper

std::unique_ptr< unsigned int[]>	m_ThreaderNumberOfMovingImageSamples

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

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage >

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

Definition at line 66 of file itkCompareHistogramImageToImageMetric.h.

◆ HistogramAbsoluteFrequencyType

template<typename TFixedImage , typename TMovingImage >

using itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramAbsoluteFrequencyType = typename HistogramType::AbsoluteFrequencyType

Definition at line 91 of file itkCompareHistogramImageToImageMetric.h.

◆ HistogramFrequencyType

template<typename TFixedImage , typename TMovingImage >

using itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramFrequencyType = HistogramAbsoluteFrequencyType

Definition at line 92 of file itkCompareHistogramImageToImageMetric.h.

◆ HistogramIteratorType

template<typename TFixedImage , typename TMovingImage >

using itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramIteratorType = typename HistogramType::Iterator

Definition at line 94 of file itkCompareHistogramImageToImageMetric.h.

◆ HistogramMeasurementVectorType

template<typename TFixedImage , typename TMovingImage >

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

Definition at line 90 of file itkCompareHistogramImageToImageMetric.h.

◆ HistogramPointerType

template<typename TFixedImage , typename TMovingImage >

using itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramPointerType = typename HistogramType::Pointer

Definition at line 95 of file itkCompareHistogramImageToImageMetric.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage >

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

Definition at line 65 of file itkCompareHistogramImageToImageMetric.h.

◆ Self

template<typename TFixedImage , typename TMovingImage >

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

Standard class type aliases.

Definition at line 63 of file itkCompareHistogramImageToImageMetric.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage >

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

Definition at line 64 of file itkCompareHistogramImageToImageMetric.h.

◆ TransformConstPointer

template<typename TFixedImage , typename TMovingImage >

using itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformConstPointer = typename TransformType::ConstPointer

Definition at line 75 of file itkCompareHistogramImageToImageMetric.h.

Constructor & Destructor Documentation

◆ CompareHistogramImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >

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

protected

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

◆ ~CompareHistogramImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >

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

overrideprotecteddefault

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

Member Function Documentation

◆ EvaluateMeasure()

template<typename TFixedImage , typename TMovingImage >

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

overrideprotectedpure virtual

Evaluates the comparison histogram metric. All sub-classes must re-implement method.

Implements itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >.

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

◆ FormTrainingHistogram()

template<typename TFixedImage , typename TMovingImage >

void itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::FormTrainingHistogram ( )

protected

Form the Histogram for the Training data

◆ GetModifiableTrainingInterpolator()

template<typename TFixedImage , typename TMovingImage >

virtual InterpolatorType * itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetModifiableTrainingInterpolator ( )

virtual

Get/Set the Interpolator.

◆ GetModifiableTrainingTransform()

template<typename TFixedImage , typename TMovingImage >

virtual TransformType * itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetModifiableTrainingTransform ( )

virtual

Get/Set the Training Transform.

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::SingleValuedCostFunction.

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

◆ GetNumberOfParameters()

template<typename TFixedImage , typename TMovingImage >

unsigned int itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfParameters ( ) const

inlineoverridevirtual

Return the number of parameters required by the Transform

Implements itk::CostFunctionTemplate< double >.

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

Definition at line 134 of file itkCompareHistogramImageToImageMetric.h.

◆ GetTrainingFixedImage()

template<typename TFixedImage , typename TMovingImage >

virtual const FixedImageType * itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetTrainingFixedImage ( ) const

virtual

Get/Set the Training Fixed Image.

◆ GetTrainingFixedImageRegion()

template<typename TFixedImage , typename TMovingImage >

virtual const FixedImageRegionType & itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetTrainingFixedImageRegion ( ) const

virtual

Get/Set the region over which the training histogram will be computed

◆ GetTrainingHistogram()

template<typename TFixedImage , typename TMovingImage >

virtual const HistogramPointerType & itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetTrainingHistogram ( ) const

virtual

Get/Set the histogram to be used in the metric calculation

◆ GetTrainingMovingImage()

template<typename TFixedImage , typename TMovingImage >

virtual const MovingImageType * itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetTrainingMovingImage ( ) const

virtual

Get/Set the Training Moving Image.

◆ Initialize()

template<typename TFixedImage , typename TMovingImage >

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

overridevirtual

Forms the histogram of the training images to prepare to evaluate the metric. Must set all parameters first.

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

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

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage >

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

overrideprotectedvirtual

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

Reimplemented from itk::Object.

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

◆ SetTrainingFixedImage()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTrainingFixedImage ( const FixedImageType * _arg )

virtual

Get/Set the Training Fixed Image.

◆ SetTrainingFixedImageRegion()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTrainingFixedImageRegion ( FixedImageRegionType _arg )

virtual

Get/Set the region over which the training histogram will be computed

◆ SetTrainingHistogram()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTrainingHistogram ( HistogramPointerType _arg )

virtual

Get/Set the histogram to be used in the metric calculation

◆ SetTrainingInterpolator()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTrainingInterpolator ( InterpolatorType * _arg )

virtual

Get/Set the Interpolator.

◆ SetTrainingMovingImage()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTrainingMovingImage ( const MovingImageType * _arg )

virtual

Get/Set the Training Moving Image.

◆ SetTrainingTransform()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTrainingTransform ( TransformType * _arg )

virtual

Get/Set the Training Transform.

Member Data Documentation

◆ m_TrainingFixedImage

template<typename TFixedImage , typename TMovingImage >

FixedImageConstPointer itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingFixedImage {}

private

Definition at line 163 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingFixedImageRegion

template<typename TFixedImage , typename TMovingImage >

FixedImageRegionType itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingFixedImageRegion {}

private

Definition at line 167 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingHistogram

template<typename TFixedImage , typename TMovingImage >

HistogramPointerType itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingHistogram {}

private

Definition at line 168 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingInterpolator

template<typename TFixedImage , typename TMovingImage >

InterpolatorPointer itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingInterpolator {}

private

Definition at line 166 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingMovingImage

template<typename TFixedImage , typename TMovingImage >

MovingImageConstPointer itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingMovingImage {}

private

Definition at line 164 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingTransform

template<typename TFixedImage , typename TMovingImage >

TransformPointer itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingTransform {}

private

Definition at line 165 of file itkCompareHistogramImageToImageMetric.h.

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

itkCompareHistogramImageToImageMetric.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ HistogramAbsoluteFrequencyType

◆ HistogramFrequencyType

◆ HistogramIteratorType

◆ HistogramMeasurementVectorType

◆ HistogramPointerType

◆ Pointer

◆ Self

◆ Superclass

◆ TransformConstPointer

Constructor & Destructor Documentation

◆ CompareHistogramImageToImageMetric()

◆ ~CompareHistogramImageToImageMetric()

Member Function Documentation

◆ EvaluateMeasure()

◆ FormTrainingHistogram()

◆ GetModifiableTrainingInterpolator()

◆ GetModifiableTrainingTransform()

◆ GetNameOfClass()

◆ GetNumberOfParameters()

◆ GetTrainingFixedImage()

◆ GetTrainingFixedImageRegion()

◆ GetTrainingHistogram()

◆ GetTrainingMovingImage()

◆ Initialize()

◆ PrintSelf()

◆ SetTrainingFixedImage()

◆ SetTrainingFixedImageRegion()

◆ SetTrainingHistogram()

◆ SetTrainingInterpolator()

◆ SetTrainingMovingImage()

◆ SetTrainingTransform()

Member Data Documentation

◆ m_TrainingFixedImage

◆ m_TrainingFixedImageRegion

◆ m_TrainingHistogram

◆ m_TrainingInterpolator

◆ m_TrainingMovingImage

◆ m_TrainingTransform