ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference
Data Processing Objects » Filters » Registration Filters » Components of Registration Methods » Similarity Metrics of Registration Methods | Group Registration » Module ITKRegistrationCommon

#include <itkKullbackLeiblerCompareHistogramImageToImageMetric.h>

Detailed Description

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

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

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

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

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

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

PARAMETERS
Epsilon is added to every bin in both histograms. This prevents division by zero problems. Epsilon should generally be set to a number smaller than one divided by the total number bins in the histogram. So, for a 256 by 256 histogram, Epsilon should be much less than 1e-5. Tests have shown that choices of epsilon are not very important as long as it is small enough. The default is 1e-12. I doubt you will need to change it.
Author
Samson Timoner
SUPPORT
This work was supported by the Functional Imaging Research in Schizophrenia Testbed (FIRST) Biomedical Informatics Research Network (BIRN, https://www.birncommunity.org/), which is funded by the National Center for Research Resources at the National Institutes of Health (NIH). This work is also funded by the Neuroimage Analysis Center (P41 RR13218).

Definition at line 72 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using HistogramMeasurementVectorType = typename Superclass::MeasurementVectorType
 
using Pointer = SmartPointer< Self >
 
using Self = KullbackLeiblerCompareHistogramImageToImageMetric
 
using Superclass = CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
 
using TransformConstPointer = typename Superclass::ConstPointer
 
- Public Types inherited from itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
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

virtual const double & GetEpsilon () const
 
const char * GetNameOfClass () const override
 
unsigned int GetNumberOfParameters () const override
 
void Initialize () override
 
virtual void SetEpsilon (double _arg)
 
- Public Member Functions inherited from itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
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
 

Static Public Member Functions

static Pointer New ()
 
- 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 ()
 

Protected Member Functions

MeasureType EvaluateMeasure (HistogramType &histogram) const override
 
void FormTrainingHistogram ()
 
 KullbackLeiblerCompareHistogramImageToImageMetric ()
 
 ~KullbackLeiblerCompareHistogramImageToImageMetric () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
MeasureType EvaluateMeasure (HistogramType &histogram) const override=0
 
void FormTrainingHistogram ()
 
 CompareHistogramImageToImageMetric ()
 
 ~CompareHistogramImageToImageMetric () override=default
 
- 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 ()
 

Protected Attributes

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

Additional Inherited Members

- 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)
 
- 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::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 82 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ HistogramMeasurementVectorType

template<typename TFixedImage , typename TMovingImage >
using itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramMeasurementVectorType = typename Superclass::MeasurementVectorType

Definition at line 108 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage >
using itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 81 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ Self

template<typename TFixedImage , typename TMovingImage >
using itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::Self = KullbackLeiblerCompareHistogramImageToImageMetric

Standard class type aliases.

Definition at line 79 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage >
using itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::Superclass = CompareHistogramImageToImageMetric<TFixedImage, TMovingImage>

Definition at line 80 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ TransformConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformConstPointer = typename Superclass::ConstPointer

Definition at line 94 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

Constructor & Destructor Documentation

◆ KullbackLeiblerCompareHistogramImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >
itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::KullbackLeiblerCompareHistogramImageToImageMetric ( )
protected

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

◆ ~KullbackLeiblerCompareHistogramImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >
itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::~KullbackLeiblerCompareHistogramImageToImageMetric ( )
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::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::EvaluateMeasure ( HistogramType &  histogram) const
overrideprotectedvirtual

Evaluates the mutual information from the histogram.

Implements itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >.

◆ FormTrainingHistogram()

template<typename TFixedImage , typename TMovingImage >
void itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::FormTrainingHistogram ( )
protected

Form the Histogram for the Training data

◆ GetEpsilon()

template<typename TFixedImage , typename TMovingImage >
virtual const double & itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetEpsilon ( ) const
virtual

Get epsilon, the histogram frequency to use if the frequency is 0

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage >
const char * itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

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

◆ GetNumberOfParameters()

template<typename TFixedImage , typename TMovingImage >
unsigned int itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfParameters ( ) const
inlineoverridevirtual

Return the number of parameters required by the Transform

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

Definition at line 124 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ Initialize()

template<typename TFixedImage , typename TMovingImage >
void itk::KullbackLeiblerCompareHistogramImageToImageMetric< 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::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >.

◆ New()

template<typename TFixedImage , typename TMovingImage >
static Pointer itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage >
void itk::KullbackLeiblerCompareHistogramImageToImageMetric< 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::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >.

◆ SetEpsilon()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::SetEpsilon ( double  _arg)
virtual

Set epsilon, which is added to each bin in both Histogram

Member Data Documentation

◆ m_Epsilon

template<typename TFixedImage , typename TMovingImage >
double itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_Epsilon {}
protected

Definition at line 152 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3