go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Private Types | Private Member Functions | Private Attributes
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkAdvancedNormalizedCorrelationImageToImageMetric.h>

Detailed Description

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:

The normalized correlation NC is defined as:

\[
\mathrm{NC} = \frac{\sum_x f(x) * m(x+u(x,p))}{\sqrt{ \sum_x f(x)^2 * \sum_x m(x+u(x,p))^2}}
   = \frac{\mathtt{sfm}}{\sqrt{\mathtt{sff} * \mathtt{smm}}}
\]

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:

\[
  \frac{\partial \mathrm{NC}}{\partial p} = \frac{\partial \mathrm{NC}}{\partial m}
    \frac{\partial m}{\partial x} \frac{\partial x}{\partial p}
    = \frac{\partial \mathrm{NC}}{\partial m} * \mathtt{gradient} * \mathtt{jacobian},
\]

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:

\[
  \frac{\partial \mathrm{NC}}{\partial p}
    = \frac{\sum_x[ f(x) * \mathtt{differential} ] - ( \mathtt{sfm} / \mathtt{smm} )
    * \sum_x[ m(x+u(x,p)) * \mathtt{differential} ]}{\sqrt{\mathtt{sff} * \mathtt{smm}}}
\]

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:

\[
\mathrm{NC} = \frac{\sum_x ( f(x) - \mathtt{Af} ) * ( m(x+u(x,p)) - \mathtt{Am})}
    {\sqrt{\sum_x (f(x) - \mathtt{Af})^2 * \sum_x (m(x+u(x,p)) - \mathtt{Am})^2}}
   = \frac{\mathtt{sfm} - \mathtt{sf} * \mathtt{sm} / N}
  {\sqrt{(\mathtt{sff} - \mathtt{sf} * \mathtt{sf} / N) * (\mathtt{smm} - \mathtt{sm} *\mathtt{sm} / N)}},
\]

where Af and Am are the average of f and m, respectively.

Definition at line 91 of file itkAdvancedNormalizedCorrelationImageToImageMetric.h.

Inheritance diagram for itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >:
Inheritance graph
[legend]

Data Structures

struct  CorrelationGetValueAndDerivativePerThreadStruct
 
struct  MultiThreaderAccumulateDerivativeType
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using FixedImageLimiterOutputType = typename FixedImageLimiterType::OutputType
 
using FixedImageLimiterType = LimiterFunctionBase< RealType, FixedImageDimension >
 
using FixedImagePixelType = typename FixedImageType::PixelType
 
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 MovingImageLimiterType = LimiterFunctionBase< RealType, MovingImageDimension >
 
using MovingImageRegionType = typename MovingImageType::RegionType
 
using NumberOfParametersType = typename AdvancedTransformType::NumberOfParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = AdvancedNormalizedCorrelationImageToImageMetric
 
using Superclass = AdvancedImageToImageMetric< TFixedImage, TMovingImage >
 
using ThreaderType = itk::PlatformMultiThreader
 
using ThreadInfoType = typename ThreaderType::WorkUnitInfo
 
- Public Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
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 FixedImageMaskSpatialObject2Type = ImageMaskSpatialObject< Self::FixedImageDimension >
 
using FixedImagePixelType = typename FixedImageType::PixelType
 
using FixedImagePointer = typename FixedImageType::Pointer
 
using HessianType = vnl_sparse_matrix< HessianValueType >
 
using HessianValueType = typename DerivativeType::ValueType
 
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 MovingImageMaskSpatialObject2Type = 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 ThreaderType = itk::PlatformMultiThreader
 
using ThreadInfoType = typename ThreaderType::WorkUnitInfo
 

Public Member Functions

virtual const char * GetClassName () const
 
void GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const override
 
virtual const boolGetSubtractMean ()
 
MeasureType GetValue (const TransformParametersType &parameters) const override
 
void GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override
 
void GetValueAndDerivativeSingleThreaded (const TransformParametersType &parameters, 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 SetSubtractMean (bool _arg)
 
virtual void SubtractMeanOff ()
 
virtual void SubtractMeanOn ()
 
- Public Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
virtual void BeforeThreadedGetValueAndDerivative (const TransformParametersType &parameters) const
 
virtual const char * GetClassName () const
 
virtual const FixedImageLimiterTypeGetFixedImageLimiter ()
 
virtual double GetFixedLimitRangeRatio () const
 
virtual ImageSamplerTypeGetImageSampler () const
 
virtual const MovingImageDerivativeScalesTypeGetMovingImageDerivativeScales ()
 
virtual const MovingImageLimiterTypeGetMovingImageLimiter ()
 
virtual double GetMovingLimitRangeRatio () const
 
virtual double GetRequiredRatioOfValidSamples () const
 
virtual bool GetScaleGradientWithRespectToMovingImageOrientation () const
 
virtual void GetSelfHessian (const TransformParametersType &parameters, HessianType &H) const
 
const AdvancedTransformTypeGetTransform () const override
 
virtual bool GetUseFixedImageLimiter () const
 
virtual bool GetUseImageSampler () const
 
virtual const boolGetUseMetricSingleThreaded ()
 
virtual bool GetUseMovingImageDerivativeScales () const
 
virtual bool GetUseMovingImageLimiter () const
 
virtual const boolGetUseMultiThread ()
 
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 SetFixedLimitRangeRatio (double _arg)
 
virtual void SetImageSampler (ImageSamplerType *_arg)
 
virtual void SetMovingImageDerivativeScales (MovingImageDerivativeScalesType _arg)
 
virtual void SetMovingImageLimiter (MovingImageLimiterType *_arg)
 
virtual void SetMovingLimitRangeRatio (double _arg)
 
virtual void SetNumberOfWorkUnits (ThreadIdType numberOfThreads)
 
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 ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Types

using BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >
 
using CentralDifferenceGradientFilterType = GradientImageFilter< MovingImageType, RealType, RealType >
 
using FixedImageIndexType = typename FixedImageType::IndexType
 
using FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
 
using FixedImagePointType = typename TransformType::InputPointType
 
using MovingImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType
 
using MovingImageDerivativeType = typename BSplineInterpolatorType::CovariantVectorType
 
using MovingImageIndexType = typename MovingImageType::IndexType
 
using MovingImagePointType = typename TransformType::OutputPointType
 
using NonZeroJacobianIndicesType = typename AdvancedTransformType::NonZeroJacobianIndicesType
 
- Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
using BSplineInterpolatorFloatPointer = typename BSplineInterpolatorFloatType::Pointer
 
using BSplineInterpolatorFloatType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, float >
 
using BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer
 
using BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >
 
using CentralDifferenceGradientFilterPointer = typename CentralDifferenceGradientFilterType::Pointer
 
using CentralDifferenceGradientFilterType = GradientImageFilter< MovingImageType, RealType, RealType >
 
using FixedImageIndexType = typename FixedImageType::IndexType
 
using FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
 
using FixedImagePointType = typename TransformType::InputPointType
 
using LinearInterpolatorPointer = typename LinearInterpolatorType::Pointer
 
using LinearInterpolatorType = AdvancedLinearInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >
 
using MovingImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType
 
using MovingImageDerivativeType = typename BSplineInterpolatorType::CovariantVectorType
 
using MovingImageIndexType = typename MovingImageType::IndexType
 
using MovingImagePointType = typename TransformType::OutputPointType
 
using NonZeroJacobianIndicesType = typename AdvancedTransformType::NonZeroJacobianIndicesType
 
using ReducedBSplineInterpolatorPointer = typename ReducedBSplineInterpolatorType::Pointer
 
using ReducedBSplineInterpolatorType = ReducedDimensionBSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >
 

Protected Member Functions

 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) 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
 
- Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
 AdvancedImageToImageMetric ()
 
virtual void AfterThreadedGetValue (MeasureType &value) const
 
virtual void AfterThreadedGetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const
 
virtual void CheckForAdvancedTransform ()
 
virtual void CheckForBSplineInterpolator ()
 
virtual void CheckForBSplineTransform () const
 
virtual void CheckNumberOfSamples (unsigned long wanted, unsigned long found) const
 
virtual bool EvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient) const
 
virtual 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 ()
 
virtual void InitializeLimiters ()
 
virtual void InitializeThreadingParameters () const
 
virtual bool IsInsideMovingMask (const MovingImagePointType &point) const
 
 itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedGetValueAndDerivativePerThreadStruct, AlignedGetValueAndDerivativePerThreadStruct)
 
 itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedGetValuePerThreadStruct, AlignedGetValuePerThreadStruct)
 
 itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, GetValueAndDerivativePerThreadStruct, PaddedGetValueAndDerivativePerThreadStruct)
 
 itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, GetValuePerThreadStruct, PaddedGetValuePerThreadStruct)
 
void LaunchGetValueAndDerivativeThreaderCallback () const
 
void LaunchGetValueThreaderCallback () const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetUseFixedImageLimiter (bool _arg)
 
virtual void SetUseImageSampler (bool _arg)
 
virtual void SetUseMovingImageLimiter (bool _arg)
 
virtual void ThreadedGetValue (ThreadIdType threadID)
 
virtual void ThreadedGetValueAndDerivative (ThreadIdType threadID)
 
MovingImagePointType TransformPoint (const FixedImagePointType &fixedImagePoint) const
 
 ~AdvancedImageToImageMetric () override=default
 

Static Protected Member Functions

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION AccumulateDerivativesThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION AccumulateDerivativesThreaderCallback (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeThreaderCallback (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueThreaderCallback (void *arg)
 

Private Types

using AccumulateType = typename NumericTraits< MeasureType >::AccumulateType
 

Private Member Functions

 itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedCorrelationGetValueAndDerivativePerThreadStruct, AlignedCorrelationGetValueAndDerivativePerThreadStruct)
 
 itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, CorrelationGetValueAndDerivativePerThreadStruct, PaddedCorrelationGetValueAndDerivativePerThreadStruct)
 

Private Attributes

std::vector< AlignedCorrelationGetValueAndDerivativePerThreadStruct > m_CorrelationGetValueAndDerivativePerThreadVariables
 
bool m_SubtractMean
 

Additional Inherited Members

- Protected Attributes inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
AdvancedTransformType::Pointer m_AdvancedTransform { nullptr }
 
BSplineInterpolatorPointer m_BSplineInterpolator { nullptr }
 
BSplineInterpolatorFloatPointer m_BSplineInterpolatorFloat { nullptr }
 
CentralDifferenceGradientFilterPointer m_CentralDifferenceGradientFilter { nullptr }
 
FixedImageLimiterPointer m_FixedImageLimiter { nullptr }
 
FixedImageLimiterOutputType m_FixedImageMaxLimit { 1 }
 
FixedImageLimiterOutputType m_FixedImageMinLimit { 0 }
 
FixedImagePixelType m_FixedImageTrueMax { 1 }
 
FixedImagePixelType m_FixedImageTrueMin { 0 }
 
double m_FixedLimitRangeRatio { 0.01 }
 
std::unique_ptr< AlignedGetValueAndDerivativePerThreadStruct[]> m_GetValueAndDerivativePerThreadVariables
 
ThreadIdType m_GetValueAndDerivativePerThreadVariablesSize { 0 }
 
std::unique_ptr< AlignedGetValuePerThreadStruct[]> m_GetValuePerThreadVariables { nullptr }
 
ThreadIdType m_GetValuePerThreadVariablesSize { 0 }
 
ImageSamplerPointer m_ImageSampler { nullptr }
 
bool m_InterpolatorIsBSpline { false }
 
bool m_InterpolatorIsBSplineFloat { false }
 
bool m_InterpolatorIsLinear { false }
 
bool m_InterpolatorIsReducedBSpline { false }
 
LinearInterpolatorPointer m_LinearInterpolator { nullptr }
 
MovingImageLimiterPointer m_MovingImageLimiter { nullptr }
 
MovingImageLimiterOutputType m_MovingImageMaxLimit { 1 }
 
MovingImageLimiterOutputType m_MovingImageMinLimit { 0 }
 
MovingImagePixelType m_MovingImageTrueMax { 1 }
 
MovingImagePixelType m_MovingImageTrueMin { 0 }
 
double m_MovingLimitRangeRatio { 0.01 }
 
ReducedBSplineInterpolatorPointer m_ReducedBSplineInterpolator { nullptr }
 
MultiThreaderParameterType m_ThreaderMetricParameters
 
bool m_TransformIsAdvanced { false }
 
bool m_TransformIsBSpline { false }
 
bool m_UseMetricSingleThreaded { true }
 
bool m_UseMultiThread { false }
 
bool m_UseOpenMP
 

Member Typedef Documentation

◆ AccumulateType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AccumulateType = typename NumericTraits<MeasureType>::AccumulateType
private

◆ BSplineInterpolatorType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineInterpolatorType = BSplineInterpolateImageFunction<MovingImageType, CoordinateRepresentationType, double>
protected

Typedefs used for computing image derivatives.

Definition at line 321 of file itkAdvancedImageToImageMetric.h.

◆ CentralDifferenceGradientFilterType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CentralDifferenceGradientFilterType = GradientImageFilter<MovingImageType, RealType, RealType>
protected

Definition at line 333 of file itkAdvancedImageToImageMetric.h.

◆ ConstPointer

template<class TFixedImage , class TMovingImage >
using itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

◆ DerivativeValueType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::DerivativeValueType = typename DerivativeType::ValueType

Definition at line 131 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageIndexType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexType = typename FixedImageType::IndexType
protected

Protected Typedefs Typedefs for indices and points.

Definition at line 313 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageIndexValueType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
protected

Definition at line 314 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageLimiterOutputType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageLimiterOutputType = typename FixedImageLimiterType::OutputType

Definition at line 151 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageLimiterType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageLimiterType = LimiterFunctionBase<RealType, FixedImageDimension>

Typedefs for Limiter support.

Definition at line 149 of file itkAdvancedImageToImageMetric.h.

◆ FixedImagePixelType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType = typename FixedImageType::PixelType

Some useful extra typedefs.

Definition at line 138 of file itkAdvancedImageToImageMetric.h.

◆ FixedImagePointType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePointType = typename TransformType::InputPointType
protected

Definition at line 316 of file itkAdvancedImageToImageMetric.h.

◆ ImageSampleContainerPointer

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSampleContainerPointer = typename ImageSamplerType::OutputVectorContainerPointer

Definition at line 146 of file itkAdvancedImageToImageMetric.h.

◆ ImageSampleContainerType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSampleContainerType = typename ImageSamplerType::OutputVectorContainerType

Definition at line 145 of file itkAdvancedImageToImageMetric.h.

◆ ImageSamplerPointer

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSamplerPointer = typename ImageSamplerType::Pointer

Definition at line 144 of file itkAdvancedImageToImageMetric.h.

◆ ImageSamplerType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSamplerType = ImageSamplerBase<FixedImageType>

Typedefs for the ImageSampler.

Definition at line 143 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageContinuousIndexType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType
protected

Definition at line 318 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageDerivativeScalesType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeScalesType = FixedArray<double, Self::MovingImageDimension>

Definition at line 140 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageDerivativeType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeType = typename BSplineInterpolatorType::CovariantVectorType
protected

Definition at line 332 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageIndexType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageIndexType = typename MovingImageType::IndexType
protected

Definition at line 315 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageLimiterOutputType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageLimiterOutputType = typename MovingImageLimiterType::OutputType

Definition at line 154 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageLimiterType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageLimiterType = LimiterFunctionBase<RealType, MovingImageDimension>

Definition at line 152 of file itkAdvancedImageToImageMetric.h.

◆ MovingImagePointType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType = typename TransformType::OutputPointType
protected

Definition at line 317 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageRegionType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageRegionType = typename MovingImageType::RegionType

Definition at line 139 of file itkAdvancedImageToImageMetric.h.

◆ NonZeroJacobianIndicesType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::NonZeroJacobianIndicesType = typename AdvancedTransformType::NonZeroJacobianIndicesType
protected

Typedefs for support of sparse Jacobians and compact support of transformations.

Definition at line 337 of file itkAdvancedImageToImageMetric.h.

◆ NumberOfParametersType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::NumberOfParametersType = typename AdvancedTransformType::NumberOfParametersType

Definition at line 159 of file itkAdvancedImageToImageMetric.h.

◆ Pointer

template<class TFixedImage , class TMovingImage >
using itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

◆ Self

template<class TFixedImage , class TMovingImage >
using itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Self = AdvancedNormalizedCorrelationImageToImageMetric

Standard class typedefs.

Definition at line 98 of file itkAdvancedNormalizedCorrelationImageToImageMetric.h.

◆ Superclass

template<class TFixedImage , class TMovingImage >
using itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Superclass = AdvancedImageToImageMetric<TFixedImage, TMovingImage>

◆ ThreaderType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ThreaderType = itk::PlatformMultiThreader

Typedefs for multi-threading.

Definition at line 175 of file itkAdvancedImageToImageMetric.h.

◆ ThreadInfoType

template<class TFixedImage , class TMovingImage >
using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ThreadInfoType = typename ThreaderType::WorkUnitInfo

Definition at line 176 of file itkAdvancedImageToImageMetric.h.

Constructor & Destructor Documentation

◆ AdvancedNormalizedCorrelationImageToImageMetric()

template<class TFixedImage , class TMovingImage >
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AdvancedNormalizedCorrelationImageToImageMetric ( )
protected

◆ ~AdvancedNormalizedCorrelationImageToImageMetric()

template<class TFixedImage , class TMovingImage >
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::~AdvancedNormalizedCorrelationImageToImageMetric ( )
overrideprotecteddefault

Member Function Documentation

◆ AccumulateDerivativesThreaderCallback()

template<class TFixedImage , class TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AccumulateDerivativesThreaderCallback ( void *  arg)
staticprotected

AccumulateDerivatives threader callback function

◆ AfterThreadedGetValueAndDerivative()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AfterThreadedGetValueAndDerivative ( MeasureType &  value,
DerivativeType &  derivative 
) const
overrideprotectedvirtual

Gather the values and derivatives from all threads

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

◆ GetClassName()

template<class TFixedImage , class TMovingImage >
virtual const char * itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

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

Reimplemented in elastix::AdvancedNormalizedCorrelationMetric< TElastix >.

◆ GetDerivative()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const TransformParametersType &  parameters,
DerivativeType &  derivative 
) const
override

Get the derivatives of the match measure.

◆ GetSubtractMean()

template<class TFixedImage , class TMovingImage >
virtual const bool & itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetSubtractMean ( )
virtual

◆ GetValue()

template<class TFixedImage , class TMovingImage >
MeasureType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const TransformParametersType &  parameters) const
override

Get the value for single valued optimizers.

◆ GetValueAndDerivative()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative ( const TransformParametersType &  parameters,
MeasureType &  value,
DerivativeType &  derivative 
) const
override

◆ GetValueAndDerivativeSingleThreaded()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeSingleThreaded ( const TransformParametersType &  parameters,
MeasureType &  value,
DerivativeType &  derivative 
) const

Get value and derivatives for multiple valued optimizers.

◆ InitializeThreadingParameters()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::InitializeThreadingParameters ( ) const
overrideprotectedvirtual

Initialize some multi-threading related parameters. Overrides function in AdvancedImageToImageMetric, because here we use other parameters.

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

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TFixedImage , class TMovingImage >
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ITK_DISALLOW_COPY_AND_MOVE ( AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >  )

◆ itkAlignedTypedef()

template<class TFixedImage , class TMovingImage >
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkAlignedTypedef ( ITK_CACHE_LINE_ALIGNMENT  ,
PaddedCorrelationGetValueAndDerivativePerThreadStruct  ,
AlignedCorrelationGetValueAndDerivativePerThreadStruct   
)
private

◆ itkPadStruct()

template<class TFixedImage , class TMovingImage >
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkPadStruct ( ITK_CACHE_LINE_ALIGNMENT  ,
CorrelationGetValueAndDerivativePerThreadStruct  ,
PaddedCorrelationGetValueAndDerivativePerThreadStruct   
)
private

◆ itkStaticConstMacro() [1/2]

template<class TFixedImage , class TMovingImage >
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned int  ,
FixedImageType::ImageDimension   
)

The fixed image dimension.

◆ itkStaticConstMacro() [2/2]

template<class TFixedImage , class TMovingImage >
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned int  ,
MovingImageType::ImageDimension   
)

The moving image dimension.

◆ New()

template<class TFixedImage , class TMovingImage >
static Pointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

◆ SetSubtractMean()

template<class TFixedImage , class TMovingImage >
virtual void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::SetSubtractMean ( bool  _arg)
virtual

Set/Get SubtractMean boolean. If true, the sample mean is subtracted from the sample values in the cross-correlation formula and typically results in narrower valleys in the cost function. Default value is false.

◆ SubtractMeanOff()

template<class TFixedImage , class TMovingImage >
virtual void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::SubtractMeanOff ( )
virtual

◆ SubtractMeanOn()

template<class TFixedImage , class TMovingImage >
virtual void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::SubtractMeanOn ( )
virtual

◆ ThreadedGetValueAndDerivative()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ThreadedGetValueAndDerivative ( ThreadIdType  threadID)
overrideprotectedvirtual

Get value and derivatives for each thread.

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

◆ UpdateDerivativeTerms()

template<class TFixedImage , class TMovingImage >
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::UpdateDerivativeTerms ( const RealType &  fixedImageValue,
const RealType &  movingImageValue,
const DerivativeType &  imageJacobian,
const NonZeroJacobianIndicesType nzji,
DerivativeType &  derivativeF,
DerivativeType &  derivativeM,
DerivativeType &  differential 
) const
protected

Compute a pixel's contribution to the derivative terms; Called by GetValueAndDerivative().

Field Documentation

◆ m_CorrelationGetValueAndDerivativePerThreadVariables

template<class TFixedImage , class TMovingImage >
std::vector<AlignedCorrelationGetValueAndDerivativePerThreadStruct> itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::m_CorrelationGetValueAndDerivativePerThreadVariables
mutableprivate

◆ m_SubtractMean

template<class TFixedImage , class TMovingImage >
bool itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::m_SubtractMean
mutableprivate


Generated on 2023-01-13 for elastix by doxygen 1.9.6 elastix logo