#include <itkNormalizedGradientCorrelationImageToImageMetric.h>

Detailed Description

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

An metric based on the itk::NormalizedGradientCorrelationImageToImageMetric.

Definition at line 44 of file itkNormalizedGradientCorrelationImageToImageMetric.h.

Inheritance diagram for itk::NormalizedGradientCorrelationImageToImageMetric< TFixedImage, TMovingImage >:

Public Types
using	CastFixedImageFilterPointer = typename CastFixedImageFilterType::Pointer
using	CastFixedImageFilterType = itk::CastImageFilter<FixedImageType, FixedGradientImageType>
using	CastMovedImageFilterPointer = typename CastMovedImageFilterType::Pointer
using	CastMovedImageFilterType = itk::CastImageFilter<TransformedMovingImageType, MovedGradientImageType>
using	CombinationTransformPointer = typename CombinationTransformType::Pointer
using	CombinationTransformType = typename itk::AdvancedCombinationTransform<ScalarType, FixedImageDimension>
using	ConstPointer = SmartPointer<const Self>
using	FixedGradientImageType = itk::Image<RealType, Self::FixedImageDimension>
using	FixedGradientPixelType = typename FixedGradientImageType::PixelType
using	FixedImagePixelType = typename TFixedImage::PixelType
using	InterpolatorPointer = typename InterpolatorType::Pointer
using	MaskImageType = itk::Image<unsigned char, Self::FixedImageDimension>
using	MaskImageTypePointer = typename MaskImageType::Pointer
using	MovedGradientImageType = itk::Image<RealType, Self::MovedImageDimension>
using	MovedGradientPixelType = typename MovedGradientImageType::PixelType
using	MovedImagePixelType = typename TMovingImage::PixelType
using	MovingImagePointer
using	MovingImageRegionType
using	Pointer = SmartPointer<Self>
using	RayCastInterpolatorPointer = typename RayCastInterpolatorType::Pointer
using	RayCastInterpolatorType = typename itk::AdvancedRayCastInterpolateImageFunction<MovingImageType, ScalarType>
using	ScalarType = typename TransformType::ScalarType
using	ScalesType = typename Optimizer::ScalesType
using	Self = NormalizedGradientCorrelationImageToImageMetric
using	Superclass = AdvancedImageToImageMetric<TFixedImage, TMovingImage>
using	TransformConstPointer = typename TransformType::ConstPointer
using	TransformedMovingImageType = itk::Image<FixedImagePixelType, Self::FixedImageDimension>
using	TransformMovingImageFilterPointer = typename TransformMovingImageFilterType::Pointer
using	TransformMovingImageFilterType = itk::ResampleImageFilter<MovingImageType, TransformedMovingImageType>
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	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

Public Member Functions
void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override
virtual const double &	GetDerivativeDelta ()
virtual const ScalesType &	GetScales ()
MeasureType	GetValue (const ParametersType &parameters) const override
void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &derivative) const override
void	Initialize () override
	ITK_DISALLOW_COPY_AND_MOVE (NormalizedGradientCorrelationImageToImageMetric)
	itkOverrideGetNameOfClassMacro (NormalizedGradientCorrelationImageToImageMetric)
	itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
	itkStaticConstMacro (MovedImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void	SetDerivativeDelta (double _arg)
virtual void	SetScales (ScalesType _arg)
void	SetTransformParameters (const ParametersType &parameters) const
void	WriteGradientImagesToFiles () const
Public Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
virtual void	BeforeThreadedGetValueAndDerivative (const TransformParametersType &parameters) 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)
	itkOverrideGetNameOfClassMacro (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)
void	SetRandomVariateGenerator (Statistics::MersenneTwisterRandomVariateGenerator &randomVariateGenerator)
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	FixedSobelFilter = NeighborhoodOperatorImageFilter<FixedGradientImageType, FixedGradientImageType>
using	MovedSobelFilter = NeighborhoodOperatorImageFilter<MovedGradientImageType, MovedGradientImageType>
Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
using	BSplineInterpolatorFloatPointer = typename BSplineInterpolatorFloatType::Pointer
using	BSplineInterpolatorFloatType
using	BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer
using	BSplineInterpolatorType
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

Protected Member Functions
void	ComputeMeanFixedGradient () const
void	ComputeMeanMovedGradient () const
MeasureType	ComputeMeasure (const ParametersType &parameters) const
	NormalizedGradientCorrelationImageToImageMetric ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~NormalizedGradientCorrelationImageToImageMetric () override=default
Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
	AdvancedImageToImageMetric ()
virtual void	AfterThreadedGetValue (MeasureType &) const
virtual void	AfterThreadedGetValueAndDerivative (MeasureType &, DerivativeType &) const
void	CheckForAdvancedTransform ()
void	CheckForBSplineInterpolator ()
void	CheckForBSplineTransform () const
void	CheckNumberOfSamples () 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
Statistics::MersenneTwisterRandomVariateGenerator &	GetMutableRandomVariateGenerator () const
Statistics::MersenneTwisterRandomVariateGenerator &	GetRandomVariateGenerator ()
virtual void	InitializeImageSampler ()
void	InitializeLimiters ()
virtual void	InitializeThreadingParameters () const
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
virtual void	ThreadedGetValueAndDerivative (ThreadIdType) const
MovingImagePointType	TransformPoint (const FixedImagePointType &fixedImagePoint) const
	~AdvancedImageToImageMetric () override=default

Private Attributes
CastFixedImageFilterPointer	m_CastFixedImageFilter { CastFixedImageFilterType::New() }
CastMovedImageFilterPointer	m_CastMovedImageFilter { CastMovedImageFilterType::New() }
CombinationTransformPointer	m_CombinationTransform { CombinationTransformType::New() }
double	m_DerivativeDelta { 0.001 }
ZeroFluxNeumannBoundaryCondition< FixedGradientImageType >	m_FixedBoundCond {}
FixedSobelFilter::Pointer	m_FixedSobelFilters [Self::FixedImageDimension] {}
SobelOperator< FixedGradientPixelType, Self::FixedImageDimension >	m_FixedSobelOperators [FixedImageDimension] {}
FixedGradientPixelType	m_MeanFixedGradient [FixedImageDimension] {}
MovedGradientPixelType	m_MeanMovedGradient [MovedImageDimension] {}
ZeroFluxNeumannBoundaryCondition< MovedGradientImageType >	m_MovedBoundCond {}
MovedSobelFilter::Pointer	m_MovedSobelFilters [Self::MovedImageDimension] {}
SobelOperator< MovedGradientPixelType, Self::MovedImageDimension >	m_MovedSobelOperators [MovedImageDimension] {}
ScalesType	m_Scales {}
TransformMovingImageFilterPointer	m_TransformMovingImageFilter { TransformMovingImageFilterType::New() }

Additional Inherited Members
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)
Protected Attributes inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
AdvancedTransformType::Pointer	m_AdvancedTransform { 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 }
ImageSamplerPointer	m_ImageSampler { nullptr }
MovingImageLimiterOutputType	m_MovingImageMaxLimit { 1 }
MovingImageLimiterOutputType	m_MovingImageMinLimit { 0 }
MovingImagePixelType	m_MovingImageTrueMax { 1 }
MovingImagePixelType	m_MovingImageTrueMin { 0 }
double	m_MovingLimitRangeRatio { 0.01 }
MultiThreaderParameterType	m_ThreaderMetricParameters {}
bool	m_TransformIsBSpline { false }
bool	m_UseMetricSingleThreaded { true }
bool	m_UseMultiThread { false }