ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage > Class Template Referenceabstract

#include <itkCompareHistogramImageToImageMetric.h>

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

Public Types

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 const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >
virtual const HistogramSizeTypeGetHistogramSize () const
 
void Initialize () override
 
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 FixedImagePixelTypeGetPaddingValue () const
 
virtual const HistogramPointerGetHistogram () 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 ScalesTypeGetDerivativeStepLengthScales () 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 &bound)
 
const MeasurementVectorTypeGetLowerBound () const
 
void SetUpperBound (const MeasurementVectorType &bound)
 
const MeasurementVectorTypeGetUpperBound () const
 
- Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void SetFixedImage (const FixedImageType *_arg)
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetTransform (TransformType *_arg)
 
virtual TransformTypeGetModifiableTransform ()
 
virtual const TransformTypeGetTransform () const
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual const InterpolatorTypeGetInterpolator () const
 
SizeValueType GetNumberOfMovingImageSamples ()
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
virtual void SetFixedImageRegion (const FixedImageRegionType reg)
 
virtual const FixedImageRegionTypeGetFixedImageRegion () const
 
virtual void SetMovingImageMask (MovingImageMaskType *_arg)
 
virtual void SetMovingImageMask (const MovingImageMaskType *_arg)
 
virtual const MovingImageMaskTypeGetMovingImageMask () const
 
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
 
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
 
virtual const FixedImageMaskTypeGetFixedImageMask () const
 
void SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
 
void SetUseFixedImageIndexes (bool useIndex)
 
virtual const bool & GetUseFixedImageIndexes () const
 
void SetNumberOfWorkUnits (ThreadIdType numberOfThreads)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
virtual void ComputeGradientOn ()
 
virtual void ComputeGradientOff ()
 
virtual void ComputeGradient ()
 
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual const GradientImageTypeGetGradientImage () const
 
void SetTransformParameters (const ParametersType &parameters) const
 
unsigned int GetNumberOfParameters () const override
 
virtual void MultiThreadingInitialize ()
 
virtual void SetNumberOfFixedImageSamples (SizeValueType numSamples)
 
virtual const SizeValueTypeGetNumberOfFixedImageSamples () const
 
void SetNumberOfSpatialSamples (SizeValueType num)
 
SizeValueType GetNumberOfSpatialSamples ()
 
void SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
 
virtual const FixedImagePixelTypeGetFixedImageSamplesIntensityThreshold () 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 sequentialSampling)
 
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 MultiThreaderTypeGetModifiableThreader ()
 
virtual const MultiThreaderTypeGetThreader () const
 
const TransformPointerGetThreaderTransform ()
 
- Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
virtual MeasureType GetValue (const ParametersType &parameters) const =0
 
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
FixedImageConstPointer m_TrainingFixedImage
 
MovingImageConstPointer m_TrainingMovingImage
 
TransformPointer m_TrainingTransform
 
InterpolatorPointer m_TrainingInterpolator
 
FixedImageRegionType m_TrainingFixedImageRegion
 
HistogramPointerType m_TrainingHistogram
 
virtual void SetTrainingHistogram (HistogramPointerType _arg)
 
virtual const HistogramPointerTypeGetTrainingHistogram () const
 
virtual void SetTrainingFixedImage (const FixedImageType *_arg)
 
virtual void SetTrainingMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetTrainingMovingImage () const
 
virtual void SetTrainingTransform (TransformType *_arg)
 
virtual TransformTypeGetModifiableTrainingTransform ()
 
virtual const TransformTypeGetTrainingTransform () const
 
virtual void SetTrainingInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorTypeGetModifiableTrainingInterpolator ()
 
virtual const InterpolatorTypeGetTrainingInterpolator () const
 
virtual void SetTrainingFixedImageRegion (FixedImageRegionType _arg)
 
virtual const FixedImageRegionTypeGetTrainingFixedImageRegion () const
 
unsigned int GetNumberOfParameters () const override
 
void Initialize () override
 
 CompareHistogramImageToImageMetric ()
 
 ~CompareHistogramImageToImageMetric () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void FormTrainingHistogram ()
 
MeasureType EvaluateMeasure (HistogramType &histogram) const override=0
 

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Static Public Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int FixedImageDimension = TFixedImage::ImageDimension
 
static constexpr unsigned int MovingImageDimension = TMovingImage::ImageDimension
 
- Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using FixedImageSampleContainer = std::vector< FixedImageSamplePoint >
 
using BSplineTransformType = BSplineBaseTransform< CoordinateRepresentationType, FixedImageType ::ImageDimension, Self::DeformationSplineOrder >
 
using BSplineTransformWeightsType = typename BSplineTransformType::WeightsType
 
using WeightsValueType = typename BSplineTransformWeightsType::ValueType
 
using BSplineTransformWeightsArrayType = Array2D< WeightsValueType >
 
using BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType
 
using IndexValueType = typename BSplineTransformIndexArrayType::ValueType
 
using BSplineTransformIndicesArrayType = Array2D< IndexValueType >
 
using MovingImagePointArrayType = std::vector< MovingImagePointType >
 
using BooleanArrayType = std::vector< bool >
 
using BSplineParametersOffsetType = FixedArray< SizeValueType, FixedImageType ::ImageDimension >
 
using BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >
 
using DerivativeFunctionType = CentralDifferenceImageFunction< MovingImageType, CoordinateRepresentationType >
 
using ImageDerivativesType = CovariantVector< double, Self::MovingImageDimension >
 
- Protected Member Functions inherited from itk::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
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
 ImageToImageMetric ()
 
 ~ImageToImageMetric () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SampleFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
 
virtual void SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void PreComputeTransformValues ()
 
virtual void TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ThreadIdType threadId) const
 
virtual void TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, 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 &time)
 
- 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 *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueMultiThreadedPostProcess (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeMultiThreaded (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeMultiThreadedPostProcess (void *arg)
 
- 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
 
TransformPointerm_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
 
BSplineTransformWeightsTypem_ThreaderBSplineTransformWeights
 
BSplineTransformIndexArrayTypem_ThreaderBSplineTransformIndices
 
bool m_InterpolatorIsBSpline { false }
 
BSplineInterpolatorType::Pointer m_BSplineInterpolator
 
DerivativeFunctionType::Pointer m_DerivativeCalculator
 
MultiThreaderType::Pointer m_Threader
 
ConstantPointerWrapperm_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::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.

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.

◆ DerivativeType

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

Definition at line 82 of file itkCompareHistogramImageToImageMetric.h.

◆ FixedImageConstPointer

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

Definition at line 85 of file itkCompareHistogramImageToImageMetric.h.

◆ FixedImageRegionType

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

Definition at line 100 of file itkCompareHistogramImageToImageMetric.h.

◆ FixedImageType

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

Definition at line 83 of file itkCompareHistogramImageToImageMetric.h.

◆ GradientPixelType

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

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

◆ HistogramSizeType

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

Definition at line 89 of file itkCompareHistogramImageToImageMetric.h.

◆ HistogramType

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

Definition at line 88 of file itkCompareHistogramImageToImageMetric.h.

◆ InterpolatorPointer

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

Definition at line 98 of file itkCompareHistogramImageToImageMetric.h.

◆ InterpolatorType

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

Definition at line 97 of file itkCompareHistogramImageToImageMetric.h.

◆ MeasureType

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

Definition at line 81 of file itkCompareHistogramImageToImageMetric.h.

◆ MovingImageConstPointer

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

Definition at line 86 of file itkCompareHistogramImageToImageMetric.h.

◆ MovingImageType

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

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

◆ RealType

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

Types transferred from the base class

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

◆ TransformJacobianType

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

Definition at line 78 of file itkCompareHistogramImageToImageMetric.h.

◆ TransformParametersType

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

Definition at line 77 of file itkCompareHistogramImageToImageMetric.h.

◆ TransformPointer

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

Definition at line 74 of file itkCompareHistogramImageToImageMetric.h.

◆ TransformType

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

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

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

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.

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 histogram to be used in the metric calculation

◆ GetModifiableTrainingTransform()

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

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

◆ GetNameOfClass()

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

◆ GetNumberOfParameters()

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

◆ GetTrainingFixedImageRegion()

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

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

◆ 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

◆ GetTrainingInterpolator()

template<typename TFixedImage , typename TMovingImage >
virtual const InterpolatorType* itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetTrainingInterpolator ( ) 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 histogram to be used in the metric calculation

◆ GetTrainingTransform()

template<typename TFixedImage , typename TMovingImage >
virtual const TransformType* itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::GetTrainingTransform ( ) const
virtual

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

◆ 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

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

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

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

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

Definition at line 161 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingFixedImageRegion

template<typename TFixedImage , typename TMovingImage >
FixedImageRegionType itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingFixedImageRegion
private

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

Definition at line 165 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingHistogram

template<typename TFixedImage , typename TMovingImage >
HistogramPointerType itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingHistogram
private

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

Definition at line 166 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingInterpolator

template<typename TFixedImage , typename TMovingImage >
InterpolatorPointer itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingInterpolator
private

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

Definition at line 164 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingMovingImage

template<typename TFixedImage , typename TMovingImage >
MovingImageConstPointer itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingMovingImage
private

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

Definition at line 162 of file itkCompareHistogramImageToImageMetric.h.

◆ m_TrainingTransform

template<typename TFixedImage , typename TMovingImage >
TransformPointer itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >::m_TrainingTransform
private

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

Definition at line 163 of file itkCompareHistogramImageToImageMetric.h.


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