template<class TFixedImage, class TMovingImage>
class itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >
Computes normalized correlation between two images, based on AdvancedImageToImageMetric ...
This metric computes the correlation between pixels in the fixed image and pixels in the moving image. The spatial correspondence between fixed and moving image is established through a Transform. Pixel values are taken from the fixed image, their positions are mapped to the moving image and result in general in non-grid position on it. Values at these non-grid position of the moving image are interpolated using a user-selected Interpolator. The correlation is normalized by the autocorrelations of both the fixed and moving images.
This implementation of the NormalizedCorrelation is based on the AdvancedImageToImageMetric , which means that:
It uses the ImageSampler-framework
It makes use of the compact support of B-splines, in case of B-spline transforms.
Image derivatives are computed using either the B-spline interpolator's implementation or by nearest neighbor interpolation of a precomputed central difference image.
A minimum number of samples that should map within the moving image (mask) can be specified.
The normalized correlation NC is defined as:
where x a voxel in the fixed image f, m the moving image, u(x,p) the deformation of x depending on the transform parameters p. sfm, sff and smm is notation used in the source code. The derivative of NC to p equals:
where gradient is the derivative of the moving image m to x, and where Jacobian is the derivative of the transformation to its parameters. gradient * Jacobian is called the differential. This yields for the derivative:
This class has an option to subtract the sample mean from the sample values in the cross correlation formula. This typically results in narrower valleys in the cost function NC. The default value is false. If SubtractMean is true, the NC is defined as:
where Af and Am are the average of f and m, respectively.
Definition at line 91 of file itkAdvancedNormalizedCorrelationImageToImageMetric.h .
using ConstPointer = SmartPointer<const Self >
using DerivativeValueType
using FixedImageLimiterOutputType
using FixedImageLimiterType
using FixedImageMaskPointer
using FixedImageMaskType
using FixedImagePixelType
using ImageSampleContainerPointer
using ImageSampleContainerType
using ImageSamplerPointer
using ImageSamplerType
using MovingImageDerivativeScalesType
using MovingImageLimiterOutputType
using MovingImageLimiterType
using MovingImageMaskPointer
using MovingImageMaskType
using MovingImageRegionType
using NumberOfParametersType
using Pointer = SmartPointer<Self >
using Self = AdvancedNormalizedCorrelationImageToImageMetric
using Superclass = AdvancedImageToImageMetric <TFixedImage, TMovingImage>
using ThreadInfoType
using AdvancedTransformType = AdvancedTransform <ScalarType , FixedImageDimension, MovingImageDimension>
using BSplineOrder1TransformPointer = typename BSplineOrder1TransformType::Pointer
using BSplineOrder1TransformType = AdvancedBSplineDeformableTransform <ScalarType , FixedImageDimension, 1>
using BSplineOrder2TransformPointer = typename BSplineOrder2TransformType::Pointer
using BSplineOrder2TransformType = AdvancedBSplineDeformableTransform <ScalarType , FixedImageDimension, 2>
using BSplineOrder3TransformPointer = typename BSplineOrder3TransformType::Pointer
using BSplineOrder3TransformType = AdvancedBSplineDeformableTransform <ScalarType , FixedImageDimension, 3>
using CombinationTransformType = AdvancedCombinationTransform <ScalarType , FixedImageDimension>
using ConstPointer = SmartPointer<const Self >
using DerivativeValueType = typename DerivativeType::ValueType
using FixedImageLimiterOutputType = typename FixedImageLimiterType::OutputType
using FixedImageLimiterPointer = typename FixedImageLimiterType::Pointer
using FixedImageLimiterType = LimiterFunctionBase <RealType, FixedImageDimension>
using FixedImageMaskConstPointer = SmartPointer<const FixedImageMaskType >
using FixedImageMaskPointer = SmartPointer<FixedImageMaskType >
using FixedImageMaskType = ImageMaskSpatialObject<Self::FixedImageDimension>
using FixedImagePixelType = typename FixedImageType::PixelType
using FixedImagePointer = typename FixedImageType::Pointer
using ImageSampleContainerPointer = typename ImageSamplerType::OutputVectorContainerPointer
using ImageSampleContainerType = typename ImageSamplerType::OutputVectorContainerType
using ImageSamplerPointer = typename ImageSamplerType::Pointer
using ImageSamplerType = ImageSamplerBase <FixedImageType>
using MovingImageDerivativeScalesType = FixedArray<double , Self::MovingImageDimension>
using MovingImageLimiterOutputType = typename MovingImageLimiterType::OutputType
using MovingImageLimiterPointer = typename MovingImageLimiterType::Pointer
using MovingImageLimiterType = LimiterFunctionBase <RealType, MovingImageDimension>
using MovingImageMaskConstPointer = SmartPointer<const MovingImageMaskType >
using MovingImageMaskPointer = SmartPointer<MovingImageMaskType >
using MovingImageMaskType = ImageMaskSpatialObject<Self::MovingImageDimension>
using MovingImagePointer = typename MovingImageType::Pointer
using MovingImageRegionType = typename MovingImageType::RegionType
using NumberOfParametersType = typename AdvancedTransformType::NumberOfParametersType
using Pointer = SmartPointer<Self >
using ScalarType = typename TransformType::ScalarType
using Self = AdvancedImageToImageMetric
using Superclass = ImageToImageMetric<TFixedImage, TMovingImage>
using ThreadInfoType = MultiThreaderBase::WorkUnitInfo
virtual const char * GetClassName () const
void GetDerivative (const TransformParametersType ¶meters, DerivativeType &derivative) const override
MeasureType GetValue (const TransformParametersType ¶meters) const override
void GetValueAndDerivative (const TransformParametersType ¶meters, MeasureType &value, DerivativeType &derivative) const override
void GetValueAndDerivativeSingleThreaded (const TransformParametersType ¶meters, MeasureType &value, DerivativeType &derivative) const
ITK_DISALLOW_COPY_AND_MOVE (AdvancedNormalizedCorrelationImageToImageMetric )
itkStaticConstMacro (FixedImageDimension, unsigned int , FixedImageType::ImageDimension)
itkStaticConstMacro (MovingImageDimension, unsigned int , MovingImageType::ImageDimension)
virtual void BeforeThreadedGetValueAndDerivative (const TransformParametersType ¶meters) const
virtual const FixedImageLimiterType * GetFixedImageLimiter ()
const FixedImageMaskType * GetFixedImageMask () const override
virtual double GetFixedLimitRangeRatio () const
ImageSamplerType * GetImageSampler () const
virtual const MovingImageDerivativeScalesType & GetMovingImageDerivativeScales ()
virtual const MovingImageLimiterType * GetMovingImageLimiter ()
const MovingImageMaskType * GetMovingImageMask () const override
virtual double GetMovingLimitRangeRatio () const
virtual double GetRequiredRatioOfValidSamples () const
virtual bool GetScaleGradientWithRespectToMovingImageOrientation () const
const AdvancedTransformType * GetTransform () const override
AdvancedTransformType * GetTransform () override
virtual bool GetUseFixedImageLimiter () const
virtual bool GetUseImageSampler () const
virtual const bool & GetUseMetricSingleThreaded ()
virtual bool GetUseMovingImageDerivativeScales () const
virtual bool GetUseMovingImageLimiter () const
virtual const bool & GetUseMultiThread ()
void Initialize () override
ITK_DISALLOW_COPY_AND_MOVE (AdvancedImageToImageMetric )
itkStaticConstMacro (FixedImageDimension, unsigned int , TFixedImage::ImageDimension)
itkStaticConstMacro (MovingImageDimension, unsigned int , TMovingImage::ImageDimension)
virtual void SetFixedImageLimiter (FixedImageLimiterType *_arg)
virtual void SetFixedImageMask (const FixedImageMaskType *const arg)
virtual void SetFixedLimitRangeRatio (double _arg)
virtual void SetImageSampler (ImageSamplerType *_arg)
virtual void SetMovingImageDerivativeScales (MovingImageDerivativeScalesType _arg)
virtual void SetMovingImageLimiter (MovingImageLimiterType *_arg)
virtual void SetMovingImageMask (const MovingImageMaskType *const arg)
virtual void SetMovingLimitRangeRatio (double _arg)
virtual void SetRequiredRatioOfValidSamples (double _arg)
virtual void SetScaleGradientWithRespectToMovingImageOrientation (bool _arg)
virtual void SetTransform (AdvancedTransformType *arg)
virtual void SetUseMetricSingleThreaded (bool _arg)
virtual void SetUseMovingImageDerivativeScales (bool _arg)
virtual void SetUseMultiThread (bool _arg)
virtual void UseMetricSingleThreadedOff ()
virtual void UseMetricSingleThreadedOn ()
virtual void UseMultiThreadOff ()
virtual void UseMultiThreadOn ()
AdvancedNormalizedCorrelationImageToImageMetric ()
void AfterThreadedGetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override
void InitializeThreadingParameters () const override
void PrintSelf (std::ostream &os, Indent indent) const override
void ThreadedGetValueAndDerivative (ThreadIdType threadID) const override
void UpdateDerivativeTerms (const RealType fixedImageValue, const RealType movingImageValue, const DerivativeType &imageJacobian, const NonZeroJacobianIndicesType &nzji, DerivativeType &derivativeF, DerivativeType &derivativeM, DerivativeType &differential) const
~AdvancedNormalizedCorrelationImageToImageMetric () override=default
AdvancedImageToImageMetric ()
virtual void AfterThreadedGetValue (MeasureType &) const
void CheckForAdvancedTransform ()
void CheckForBSplineInterpolator ()
void CheckForBSplineTransform () const
void CheckNumberOfSamples (unsigned long wanted, unsigned long found) const
virtual bool EvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient) const
bool EvaluateTransformJacobian (const FixedImagePointType &fixedImagePoint, TransformJacobianType &jacobian, NonZeroJacobianIndicesType &nzji) const
virtual void EvaluateTransformJacobianInnerProduct (const TransformJacobianType &jacobian, const MovingImageDerivativeType &movingImageDerivative, DerivativeType &imageJacobian) const
bool FastEvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient, const ThreadIdType threadId) const
virtual void InitializeImageSampler ()
void InitializeLimiters ()
virtual bool IsInsideMovingMask (const MovingImagePointType &point) const
itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedGetValueAndDerivativePerThreadStruct, AlignedGetValueAndDerivativePerThreadStruct)
itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, GetValueAndDerivativePerThreadStruct , PaddedGetValueAndDerivativePerThreadStruct)
void LaunchGetValueAndDerivativeThreaderCallback () const
void LaunchGetValueThreaderCallback () const
void PrintSelf (std::ostream &os, Indent indent) const override
void SetFixedImageMask (const typename Superclass::FixedImageMaskType *) final
void SetFixedImageMask (typename Superclass::FixedImageMaskType *) final
void SetMovingImageMask (const typename Superclass::MovingImageMaskType *) final
void SetMovingImageMask (typename Superclass::MovingImageMaskType *) final
virtual void SetUseFixedImageLimiter (bool _arg)
virtual void SetUseImageSampler (bool _arg)
virtual void SetUseMovingImageLimiter (bool _arg)
virtual void ThreadedGetValue (ThreadIdType) const
MovingImagePointType TransformPoint (const FixedImagePointType &fixedImagePoint) const
~AdvancedImageToImageMetric () override=default