ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | 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 MethodsGroup Registration » | Module ITKRegistrationCommon

#include <itkKullbackLeiblerCompareHistogramImageToImageMetric.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = typename Superclass::DerivativeType
 
using FixedImageConstPointer = typename Superclass::FixedImageConstPointer
 
using FixedImageType = typename Superclass::FixedImageType
 
using GradientPixelType = typename Superclass::GradientPixelType
 
using HistogramFrequencyType = typename Superclass::HistogramFrequencyType
 
using HistogramIteratorType = typename Superclass::HistogramIteratorType
 
using HistogramMeasurementVectorType = typename Superclass::MeasurementVectorType
 
using HistogramPointerType = typename Superclass::HistogramPointerType
 
using HistogramSizeType = typename Superclass::HistogramSizeType
 
using HistogramType = typename Superclass::HistogramType
 
using InterpolatorPointer = typename Superclass::InterpolatorPointer
 
using InterpolatorType = typename Superclass::InterpolatorType
 
using MeasureType = typename Superclass::MeasureType
 
using MovingImageConstPointer = typename Superclass::MovingImageConstPointer
 
using MovingImageType = typename Superclass::MovingImageType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename Superclass::RealType
 
using Self = KullbackLeiblerCompareHistogramImageToImageMetric
 
using Superclass = CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
 
using TransformConstPointer = typename Superclass::ConstPointer
 
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::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = typename Superclass::DerivativeType
 
using FixedImageConstPointer = typename Superclass::FixedImageConstPointer
 
using FixedImageRegionType = typename Superclass::FixedImageRegionType
 
using FixedImageType = typename Superclass::FixedImageType
 
using GradientPixelType = typename Superclass::GradientPixelType
 
using HistogramAbsoluteFrequencyType = typename HistogramType::AbsoluteFrequencyType
 
using HistogramFrequencyType = HistogramAbsoluteFrequencyType
 
using HistogramIteratorType = typename HistogramType::Iterator
 
using HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType
 
using HistogramPointerType = typename HistogramType::Pointer
 
using HistogramSizeType = typename Superclass::HistogramSizeType
 
using HistogramType = typename Superclass::HistogramType
 
using InterpolatorPointer = typename Superclass::InterpolatorPointer
 
using InterpolatorType = typename Superclass::InterpolatorType
 
using MeasureType = typename Superclass::MeasureType
 
using MovingImageConstPointer = typename Superclass::MovingImageConstPointer
 
using MovingImageType = typename Superclass::MovingImageType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename Superclass::RealType
 
using Self = CompareHistogramImageToImageMetric
 
using Superclass = HistogramImageToImageMetric< TFixedImage, TMovingImage >
 
using TransformConstPointer = typename TransformType::ConstPointer
 
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::HistogramImageToImageMetric< TFixedImage, TMovingImage >
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
 
using ScalesType = Array< double >
 
- 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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual const double & GetEpsilon () const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNumberOfParameters () const override
 
void Initialize () override
 
virtual void SetEpsilon (double _arg)
 
- Public Member Functions inherited from itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
virtual void SetTrainingHistogram (HistogramPointerType _arg)
 
virtual const HistogramPointerType & GetTrainingHistogram () const
 
virtual void SetTrainingFixedImage (const FixedImageType *_arg)
 
virtual void SetTrainingMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageType * GetTrainingMovingImage () const
 
virtual void SetTrainingTransform (TransformType *_arg)
 
virtual TransformType * GetModifiableTrainingTransform ()
 
virtual const TransformType * GetTrainingTransform () const
 
virtual void SetTrainingInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorType * GetModifiableTrainingInterpolator ()
 
virtual const InterpolatorType * GetTrainingInterpolator () const
 
virtual void SetTrainingFixedImageRegion (FixedImageRegionType _arg)
 
virtual const FixedImageRegionType & GetTrainingFixedImageRegion () const
 
- Public Member Functions inherited from itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >
virtual const HistogramSizeType & GetHistogramSize () const
 
virtual void SetHistogramSize (HistogramSizeType _arg)
 
void SetTransform (TransformType *transform) override
 
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
 
- 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
 
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
 
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
 

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 ()
 
double m_Epsilon
 
 KullbackLeiblerCompareHistogramImageToImageMetric ()
 
 ~KullbackLeiblerCompareHistogramImageToImageMetric () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void FormTrainingHistogram ()
 
MeasureType EvaluateMeasure (HistogramType &histogram) const override
 

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 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::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >
 CompareHistogramImageToImageMetric ()
 
 ~CompareHistogramImageToImageMetric () override=default
 
void FormTrainingHistogram ()
 
- Protected Member Functions inherited from itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >
 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
 
- Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
 ImageToImageMetric ()
 
 ~ImageToImageMetric () 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::HistogramImageToImageMetric< TFixedImage, TMovingImage >
HistogramSizeType m_HistogramSize
 
MeasurementVectorType m_LowerBound
 
MeasurementVectorType m_UpperBound
 
double m_UpperBoundIncreaseFactor
 
bool m_LowerBoundSetByUser
 
bool m_UpperBoundSetByUser
 
- 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::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, http://www.birncommunity.org/), which is funded by the National Center for Research Resources at the National Institutes of Health (NIH). This work is also funded by the Neuroimage Analysis Center (P41 RR13218).

Definition at line 72 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

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.

◆ DerivativeType

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

Definition at line 100 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ FixedImageConstPointer

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

Definition at line 103 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ FixedImageType

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

Definition at line 101 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ GradientPixelType

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

Definition at line 97 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ HistogramFrequencyType

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

Definition at line 110 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ HistogramIteratorType

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

Definition at line 111 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.

◆ HistogramPointerType

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

Definition at line 112 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ HistogramSizeType

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

Definition at line 107 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ HistogramType

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

Definition at line 106 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ InterpolatorPointer

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

Definition at line 114 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ InterpolatorType

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

Definition at line 113 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ MeasureType

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

Definition at line 99 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ MovingImageConstPointer

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

Definition at line 104 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ MovingImageType

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

Definition at line 102 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.

◆ RealType

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

Types transferred from the base class

Definition at line 91 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.

◆ TransformJacobianType

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

Definition at line 96 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ TransformParametersType

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

Definition at line 95 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ TransformPointer

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

Definition at line 93 of file itkKullbackLeiblerCompareHistogramImageToImageMetric.h.

◆ TransformType

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

Definition at line 92 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

◆ CreateAnother()

template<typename TFixedImage , typename TMovingImage >
virtual::itk::LightObject::Pointer itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ 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 >
virtual const char* itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

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

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.
Generated on Thu Apr 1 2021 02:25:49 for ITK by   doxygen 1.8.16