elastix::AdvancedNormalizedCorrelationMetric< TElastix > Class Template Reference

#include <elxAdvancedNormalizedCorrelationMetric.h>

Detailed Description

template<class TElastix>
class elastix::AdvancedNormalizedCorrelationMetric< TElastix >

An metric based on the itk::AdvancedNormalizedCorrelationImageToImageMetric.

The parameters used in this class are:

Parameters:

Metric: Select this metric as follows:
(Metric "AdvancedNormalizedCorrelation")

SubtractMean: Flag to set if the sample mean is subtracted from the sample values in the cross correlation formula. This typically results in narrower valleys in the cost function. Default value is true. Can be defined for each resolution
example: (SubtractMean "false")

Definition at line 44 of file elxAdvancedNormalizedCorrelationMetric.h.

Inheritance diagram for elastix::AdvancedNormalizedCorrelationMetric< TElastix >:

Public Types
typedef Superclass2::ConfigurationPointer	ConfigurationPointer
typedef Superclass2::ConfigurationType	ConfigurationType
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass1::CoordinateRepresentationType	CoordinateRepresentationType
typedef Superclass1::DerivativeType	DerivativeType
typedef Superclass2::ElastixPointer	ElastixPointer
typedef Superclass2::ElastixType	ElastixType
typedef Superclass1::FixedImageConstPointer	FixedImageConstPointer
typedef Superclass1::FixedImageLimiterOutputType	FixedImageLimiterOutputType
typedef Superclass1::FixedImageLimiterType	FixedImageLimiterType
typedef Superclass1::FixedImageMaskPointer	FixedImageMaskPointer
typedef Superclass1::FixedImageMaskType	FixedImageMaskType
typedef Superclass1::FixedImagePixelType	FixedImagePixelType
typedef Superclass1::FixedImageRegionType	FixedImageRegionType
typedef Superclass1::FixedImageType	FixedImageType
typedef Superclass1::GradientImageFilterPointer	GradientImageFilterPointer
typedef Superclass1::GradientImageFilterType	GradientImageFilterType
typedef Superclass1::GradientImagePointer	GradientImagePointer
typedef Superclass1::GradientImageType	GradientImageType
typedef Superclass1::GradientPixelType	GradientPixelType
typedef Superclass1::ImageSampleContainerPointer	ImageSampleContainerPointer
typedef Superclass1::ImageSampleContainerType	ImageSampleContainerType
typedef Superclass1::ImageSamplerPointer	ImageSamplerPointer
typedef Superclass1::ImageSamplerType	ImageSamplerType
typedef Superclass1::InputPointType	InputPointType
typedef Superclass1::InterpolatorPointer	InterpolatorPointer
typedef Superclass1::InterpolatorType	InterpolatorType
typedef Superclass2::ITKBaseType	ITKBaseType
typedef Superclass1::MeasureType	MeasureType
typedef Superclass1::MovingImageConstPointer	MovingImageConstPointer
typedef Superclass1::MovingImageDerivativeScalesType	MovingImageDerivativeScalesType
typedef Superclass1::MovingImageLimiterOutputType	MovingImageLimiterOutputType
typedef Superclass1::MovingImageLimiterType	MovingImageLimiterType
typedef Superclass1::MovingImageMaskPointer	MovingImageMaskPointer
typedef Superclass1::MovingImageMaskType	MovingImageMaskType
typedef Superclass1::MovingImagePixelType	MovingImagePixelType
typedef Superclass1::MovingImageRegionType	MovingImageRegionType
typedef Superclass1::MovingImageType	MovingImageType
typedef Superclass1::OutputPointType	OutputPointType
typedef Superclass1::ParametersType	ParametersType
typedef itk::SmartPointer< Self >	Pointer
typedef Superclass1::RealType	RealType
typedef Superclass2::RegistrationPointer	RegistrationPointer
typedef Superclass2::RegistrationType	RegistrationType
typedef AdvancedNormalizedCorrelationMetric	Self
typedef itk::AdvancedNormalizedCorrelationImageToImageMetric< typename MetricBase< TElastix >::FixedImageType, typename MetricBase< TElastix >::MovingImageType >	Superclass1
typedef MetricBase< TElastix >	Superclass2
typedef Superclass1::TransformJacobianType	TransformJacobianType
typedef Superclass1::TransformParametersType	TransformParametersType
typedef Superclass1::TransformPointer	TransformPointer
typedef Superclass1::TransformType	TransformType
Public Types inherited from itk::AdvancedNormalizedCorrelationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::DerivativeValueType	DerivativeValueType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef Superclass::FixedImageLimiterOutputType	FixedImageLimiterOutputType
typedef Superclass::FixedImageLimiterType	FixedImageLimiterType
typedef Superclass::FixedImageMaskPointer	FixedImageMaskPointer
typedef Superclass::FixedImageMaskType	FixedImageMaskType
typedef Superclass::FixedImagePixelType	FixedImagePixelType
typedef Superclass::FixedImageRegionType	FixedImageRegionType
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::GradientImageFilterPointer	GradientImageFilterPointer
typedef Superclass::GradientImageFilterType	GradientImageFilterType
typedef Superclass::GradientImagePointer	GradientImagePointer
typedef Superclass::GradientImageType	GradientImageType
typedef Superclass::GradientPixelType	GradientPixelType
typedef Superclass::ImageSampleContainerPointer	ImageSampleContainerPointer
typedef Superclass::ImageSampleContainerType	ImageSampleContainerType
typedef Superclass::ImageSamplerPointer	ImageSamplerPointer
typedef Superclass::ImageSamplerType	ImageSamplerType
typedef Superclass::InputPointType	InputPointType
typedef Superclass::InterpolatorPointer	InterpolatorPointer
typedef Superclass::InterpolatorType	InterpolatorType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingImageConstPointer	MovingImageConstPointer
typedef Superclass::MovingImageDerivativeScalesType	MovingImageDerivativeScalesType
typedef Superclass::MovingImageLimiterOutputType	MovingImageLimiterOutputType
typedef Superclass::MovingImageLimiterType	MovingImageLimiterType
typedef Superclass::MovingImageMaskPointer	MovingImageMaskPointer
typedef Superclass::MovingImageMaskType	MovingImageMaskType
typedef Superclass::MovingImagePixelType	MovingImagePixelType
typedef Superclass::MovingImageRegionType	MovingImageRegionType
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::NumberOfParametersType	NumberOfParametersType
typedef Superclass::OutputPointType	OutputPointType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RealType	RealType
typedef AdvancedNormalizedCorrelationImageToImageMetric	Self
typedef AdvancedImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >	Superclass
typedef Superclass::ThreaderType	ThreaderType
typedef Superclass::ThreadInfoType	ThreadInfoType
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::TransformParametersType	TransformParametersType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformType	TransformType
Public Types inherited from itk::AdvancedImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
typedef AdvancedTransform< ScalarType, FixedImageDimension, MovingImageDimension >	AdvancedTransformType
typedef BSplineOrder1TransformType::Pointer	BSplineOrder1TransformPointer
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 1 >	BSplineOrder1TransformType
typedef BSplineOrder2TransformType::Pointer	BSplineOrder2TransformPointer
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 2 >	BSplineOrder2TransformType
typedef BSplineOrder3TransformType::Pointer	BSplineOrder3TransformPointer
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 3 >	BSplineOrder3TransformType
typedef AdvancedCombinationTransform< ScalarType, FixedImageDimension >	CombinationTransformType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType
typedef Superclass::DerivativeType	DerivativeType
typedef DerivativeType::ValueType	DerivativeValueType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef FixedImageLimiterType::OutputType	FixedImageLimiterOutputType
typedef FixedImageLimiterType::Pointer	FixedImageLimiterPointer
typedef LimiterFunctionBase< RealType, FixedImageDimension >	FixedImageLimiterType
typedef Superclass::FixedImageMaskPointer	FixedImageMaskPointer
typedef ImageMaskSpatialObject< itkGetStaticConstMacro(FixedImageDimension) >	FixedImageMaskSpatialObject2Type
typedef Superclass::FixedImageMaskType	FixedImageMaskType
typedef FixedImageType::PixelType	FixedImagePixelType
typedef FixedImageType::Pointer	FixedImagePointer
typedef Superclass::FixedImageRegionType	FixedImageRegionType
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::GradientImageFilterPointer	GradientImageFilterPointer
typedef Superclass::GradientImageFilterType	GradientImageFilterType
typedef Superclass::GradientImagePointer	GradientImagePointer
typedef Superclass::GradientImageType	GradientImageType
typedef Superclass::GradientPixelType	GradientPixelType
typedef vnl_sparse_matrix< HessianValueType >	HessianType
typedef DerivativeType::ValueType	HessianValueType
typedef ImageSamplerType::OutputVectorContainerPointer	ImageSampleContainerPointer
typedef ImageSamplerType::OutputVectorContainerType	ImageSampleContainerType
typedef ImageSamplerType::Pointer	ImageSamplerPointer
typedef ImageSamplerBase< FixedImageType >	ImageSamplerType
typedef Superclass::InputPointType	InputPointType
typedef Superclass::InterpolatorPointer	InterpolatorPointer
typedef Superclass::InterpolatorType	InterpolatorType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingImageConstPointer	MovingImageConstPointer
typedef FixedArray< double, Self::MovingImageDimension >	MovingImageDerivativeScalesType
typedef MovingImageLimiterType::OutputType	MovingImageLimiterOutputType
typedef MovingImageLimiterType::Pointer	MovingImageLimiterPointer
typedef LimiterFunctionBase< RealType, MovingImageDimension >	MovingImageLimiterType
typedef Superclass::MovingImageMaskPointer	MovingImageMaskPointer
typedef ImageMaskSpatialObject< itkGetStaticConstMacro(MovingImageDimension) >	MovingImageMaskSpatialObject2Type
typedef Superclass::MovingImageMaskType	MovingImageMaskType
typedef Superclass::MovingImagePixelType	MovingImagePixelType
typedef MovingImageType::Pointer	MovingImagePointer
typedef MovingImageType::RegionType	MovingImageRegionType
typedef Superclass::MovingImageType	MovingImageType
typedef AdvancedTransformType::NumberOfParametersType	NumberOfParametersType
typedef Superclass::OutputPointType	OutputPointType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RealType	RealType
typedef TransformType::ScalarType	ScalarType
typedef AdvancedImageToImageMetric	Self
typedef ImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >	Superclass
typedef itk::PlatformMultiThreader	ThreaderType
typedef ThreaderType::WorkUnitInfo	ThreadInfoType
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::TransformParametersType	TransformParametersType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformType	TransformType
Public Types inherited from elastix::MetricBase< TElastix >
typedef itk::AdvancedImageToImageMetric< FixedImageType, MovingImageType >	AdvancedMetricType
typedef Superclass::ConfigurationPointer	ConfigurationPointer
typedef Superclass::ConfigurationType	ConfigurationType
typedef ITKBaseType::ParametersValueType	CoordinateRepresentationType
typedef Superclass::ElastixPointer	ElastixPointer
typedef Superclass::ElastixType	ElastixType
typedef ElastixType::FixedImageType	FixedImageType
typedef itk::PointSet< CoordinateRepresentationType, FixedImageDimension, itk::DefaultStaticMeshTraits< CoordinateRepresentationType, FixedImageDimension, FixedImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >	FixedPointSetType
typedef FixedImageType::PointType	FixedPointType
typedef FixedPointType::ValueType	FixedPointValueType
typedef AdvancedMetricType::ImageSamplerType	ImageSamplerBaseType
typedef itk::SingleValuedCostFunction	ITKBaseType
typedef ITKBaseType::MeasureType	MeasureType
typedef AdvancedMetricType::MovingImageDerivativeScalesType	MovingImageDerivativeScalesType
typedef ElastixType::MovingImageType	MovingImageType
typedef itk::PointSet< CoordinateRepresentationType, MovingImageDimension, itk::DefaultStaticMeshTraits< CoordinateRepresentationType, MovingImageDimension, MovingImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >	MovingPointSetType
typedef MovingImageType::PointType	MovingPointType
typedef MovingPointType::ValueType	MovingPointValueType
typedef Superclass::RegistrationPointer	RegistrationPointer
typedef Superclass::RegistrationType	RegistrationType
typedef MetricBase	Self
typedef BaseComponentSE< TElastix >	Superclass
Public Types inherited from elastix::BaseComponentSE< TElastix >
typedef Configuration::Pointer	ConfigurationPointer
typedef Configuration	ConfigurationType
typedef itk::WeakPointer< ElastixType >	ElastixPointer
typedef TElastix	ElastixType
typedef RegistrationType *	RegistrationPointer
typedef ElastixType::RegistrationBaseType	RegistrationType
typedef BaseComponentSE	Self
typedef BaseComponent	Superclass

Public Member Functions
void	BeforeEachResolution (void) override
	elxClassNameMacro ("AdvancedNormalizedCorrelation")
virtual const char *	GetClassName () const
void	Initialize (void) override
	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
Public Member Functions inherited from itk::AdvancedNormalizedCorrelationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
virtual const char *	GetClassName () const
void	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const override
virtual const bool &	GetSubtractMean ()
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
	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< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
virtual void	BeforeThreadedGetValueAndDerivative (const TransformParametersType &parameters) const
virtual const char *	GetClassName () const
virtual const FixedImageLimiterType *	GetFixedImageLimiter ()
virtual double	GetFixedLimitRangeRatio () const
virtual ImageSamplerType *	GetImageSampler (void) const
virtual const MovingImageDerivativeScalesType &	GetMovingImageDerivativeScales ()
virtual const MovingImageLimiterType *	GetMovingImageLimiter ()
virtual double	GetMovingLimitRangeRatio () const
virtual double	GetRequiredRatioOfValidSamples () const
virtual bool	GetScaleGradientWithRespectToMovingImageOrientation () const
virtual void	GetSelfHessian (const TransformParametersType &parameters, HessianType &H) const
const AdvancedTransformType *	GetTransform (void) const 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 (void) override
	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 ()
Public Member Functions inherited from elastix::MetricBase< TElastix >
void	AfterEachIterationBase (void) override
void	BeforeEachResolutionBase (void) override
virtual ImageSamplerBaseType *	GetAdvancedMetricImageSampler (void) const
virtual bool	GetAdvancedMetricUseImageSampler (void) const
virtual ITKBaseType *	GetAsITKBaseType (void)
virtual const ITKBaseType *	GetAsITKBaseType (void) const
virtual const char *	GetClassName () const
virtual MeasureType	GetCurrentExactMetricValue (void) const
virtual bool	GetShowExactMetricValue (void) const
	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void	SelectNewSamples (void)
virtual void	SetAdvancedMetricImageSampler (ImageSamplerBaseType *sampler)
Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
ConfigurationType *	GetConfiguration (void) const
ElastixType *	GetElastix (void) const
RegistrationPointer	GetRegistration (void) const
	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponentSE)
void	SetConfiguration (ConfigurationType *_arg)
void	SetElastix (ElastixType *_arg)
Public Member Functions inherited from elastix::BaseComponent
virtual void	AfterEachIteration (void)
virtual void	AfterEachIterationBase (void)
virtual void	AfterEachResolution (void)
virtual void	AfterEachResolutionBase (void)
virtual void	AfterRegistration (void)
virtual void	AfterRegistrationBase (void)
virtual int	BeforeAll (void)
virtual int	BeforeAllBase (void)
virtual void	BeforeEachResolution (void)
virtual void	BeforeEachResolutionBase (void)
virtual void	BeforeRegistration (void)
virtual void	BeforeRegistrationBase (void)
virtual const char *	elxGetClassName (void) const
const char *	GetComponentLabel (void) const
	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponent)
	itkTypeMacroNoParent (BaseComponent)
void	SetComponentLabel (const char *label, unsigned int idx)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::AdvancedNormalizedCorrelationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
static Pointer	New ()
Static Public Member Functions inherited from elastix::BaseComponent
static std::string	ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision)
static void	InitializeElastixExecutable ()
static bool	IsElastixLibrary ()

Protected Member Functions
	AdvancedNormalizedCorrelationMetric ()
	~AdvancedNormalizedCorrelationMetric () override
Protected Member Functions inherited from itk::AdvancedNormalizedCorrelationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
	AdvancedNormalizedCorrelationImageToImageMetric ()
void	AfterThreadedGetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override
void	InitializeThreadingParameters (void) 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
Protected Member Functions inherited from itk::AdvancedImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
	AdvancedImageToImageMetric ()
virtual void	AfterThreadedGetValue (MeasureType &value) const
virtual void	AfterThreadedGetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const
virtual void	CheckForAdvancedTransform (void)
virtual void	CheckForBSplineInterpolator (void)
virtual void	CheckForBSplineTransform (void) 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
virtual void	InitializeImageSampler (void)
virtual void	InitializeLimiters (void)
virtual void	InitializeThreadingParameters (void) 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 (void) const
void	LaunchGetValueThreaderCallback (void) 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)
virtual bool	TransformPoint (const FixedImagePointType &fixedImagePoint, MovingImagePointType &mappedPoint) const
	~AdvancedImageToImageMetric () override
Protected Member Functions inherited from elastix::MetricBase< TElastix >
virtual MeasureType	GetExactValue (const ParametersType &parameters)
	MetricBase ()
	~MetricBase () override
Protected Member Functions inherited from elastix::BaseComponentSE< TElastix >
	BaseComponentSE ()=default
	~BaseComponentSE () override=default
Protected Member Functions inherited from elastix::BaseComponent
	BaseComponent ()=default
virtual	~BaseComponent ()=default

Private Member Functions
	AdvancedNormalizedCorrelationMetric (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Protected Types inherited from itk::AdvancedNormalizedCorrelationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
typedef Superclass::BSplineInterpolatorType	BSplineInterpolatorType
typedef Superclass::CentralDifferenceGradientFilterType	CentralDifferenceGradientFilterType
typedef Superclass::FixedImageIndexType	FixedImageIndexType
typedef Superclass::FixedImageIndexValueType	FixedImageIndexValueType
typedef Superclass::FixedImagePointType	FixedImagePointType
typedef Superclass::MovingImageContinuousIndexType	MovingImageContinuousIndexType
typedef Superclass::MovingImageDerivativeType	MovingImageDerivativeType
typedef Superclass::MovingImageIndexType	MovingImageIndexType
typedef Superclass::MovingImagePointType	MovingImagePointType
typedef Superclass::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType
Protected Types inherited from itk::AdvancedImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
typedef BSplineInterpolatorFloatType::Pointer	BSplineInterpolatorFloatPointer
typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, float >	BSplineInterpolatorFloatType
typedef BSplineInterpolatorType::Pointer	BSplineInterpolatorPointer
typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >	BSplineInterpolatorType
typedef CentralDifferenceGradientFilterType::Pointer	CentralDifferenceGradientFilterPointer
typedef GradientImageFilter< MovingImageType, RealType, RealType >	CentralDifferenceGradientFilterType
typedef FixedImageType::IndexType	FixedImageIndexType
typedef FixedImageIndexType::IndexValueType	FixedImageIndexValueType
typedef TransformType::InputPointType	FixedImagePointType
typedef LinearInterpolatorType::Pointer	LinearInterpolatorPointer
typedef AdvancedLinearInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >	LinearInterpolatorType
typedef InterpolatorType::ContinuousIndexType	MovingImageContinuousIndexType
typedef BSplineInterpolatorType::CovariantVectorType	MovingImageDerivativeType
typedef MovingImageType::IndexType	MovingImageIndexType
typedef TransformType::OutputPointType	MovingImagePointType
typedef AdvancedTransformType::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType
typedef ReducedBSplineInterpolatorType::Pointer	ReducedBSplineInterpolatorPointer
typedef ReducedDimensionBSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >	ReducedBSplineInterpolatorType
Protected Types inherited from elastix::MetricBase< TElastix >
typedef ExactMetricImageSamplerType::Pointer	ExactMetricImageSamplerPointer
typedef itk::ImageGridSampler< FixedImageType >	ExactMetricImageSamplerType
typedef ExactMetricImageSamplerType::SampleGridSpacingType	ExactMetricSampleGridSpacingType
typedef ITKBaseType::ParametersType	ParametersType
Static Protected Member Functions inherited from itk::AdvancedNormalizedCorrelationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	AccumulateDerivativesThreaderCallback (void *arg)
Static Protected Member Functions inherited from itk::AdvancedImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
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< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
AdvancedTransformType::Pointer	m_AdvancedTransform
BSplineInterpolatorPointer	m_BSplineInterpolator
BSplineInterpolatorFloatPointer	m_BSplineInterpolatorFloat
CentralDifferenceGradientFilterPointer	m_CentralDifferenceGradientFilter
FixedImageLimiterPointer	m_FixedImageLimiter
FixedImageLimiterOutputType	m_FixedImageMaxLimit
FixedImageLimiterOutputType	m_FixedImageMinLimit
FixedImagePixelType	m_FixedImageTrueMax
FixedImagePixelType	m_FixedImageTrueMin
double	m_FixedLimitRangeRatio
AlignedGetValueAndDerivativePerThreadStruct *	m_GetValueAndDerivativePerThreadVariables
ThreadIdType	m_GetValueAndDerivativePerThreadVariablesSize
AlignedGetValuePerThreadStruct *	m_GetValuePerThreadVariables
ThreadIdType	m_GetValuePerThreadVariablesSize
ImageSamplerPointer	m_ImageSampler
bool	m_InterpolatorIsBSpline
bool	m_InterpolatorIsBSplineFloat
bool	m_InterpolatorIsLinear
bool	m_InterpolatorIsReducedBSpline
LinearInterpolatorPointer	m_LinearInterpolator
MovingImageLimiterPointer	m_MovingImageLimiter
MovingImageLimiterOutputType	m_MovingImageMaxLimit
MovingImageLimiterOutputType	m_MovingImageMinLimit
MovingImagePixelType	m_MovingImageTrueMax
MovingImagePixelType	m_MovingImageTrueMin
double	m_MovingLimitRangeRatio
ReducedBSplineInterpolatorPointer	m_ReducedBSplineInterpolator
MultiThreaderParameterType	m_ThreaderMetricParameters
bool	m_TransformIsAdvanced
bool	m_TransformIsBSpline
bool	m_UseMetricSingleThreaded
bool	m_UseMultiThread
bool	m_UseOpenMP
Protected Attributes inherited from elastix::MetricBase< TElastix >
MeasureType	m_CurrentExactMetricValue
unsigned int	m_ExactMetricEachXNumberOfIterations
ExactMetricSampleGridSpacingType	m_ExactMetricSampleGridSpacing
ExactMetricImageSamplerPointer	m_ExactMetricSampler
bool	m_ShowExactMetricValue
Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer	m_Configuration {}
ElastixPointer	m_Elastix {}
RegistrationPointer	m_Registration {}

Member Typedef Documentation

ConfigurationPointer

template<class TElastix >

typedef Superclass2::ConfigurationPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ConfigurationPointer

Definition at line 132 of file elxAdvancedNormalizedCorrelationMetric.h.

ConfigurationType

template<class TElastix >

typedef Superclass2::ConfigurationType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ConfigurationType

Definition at line 131 of file elxAdvancedNormalizedCorrelationMetric.h.

ConstPointer

template<class TElastix >

typedef itk::SmartPointer< const Self > elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ConstPointer

Definition at line 60 of file elxAdvancedNormalizedCorrelationMetric.h.

CoordinateRepresentationType

template<class TElastix >

typedef Superclass1::CoordinateRepresentationType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::CoordinateRepresentationType

Typedefs from the superclass.

Definition at line 76 of file elxAdvancedNormalizedCorrelationMetric.h.

DerivativeType

template<class TElastix >

typedef Superclass1::DerivativeType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::DerivativeType

Definition at line 102 of file elxAdvancedNormalizedCorrelationMetric.h.

ElastixPointer

template<class TElastix >

typedef Superclass2::ElastixPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ElastixPointer

Definition at line 130 of file elxAdvancedNormalizedCorrelationMetric.h.

ElastixType

template<class TElastix >

typedef Superclass2::ElastixType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ElastixType

Typedef's inherited from Elastix.

Definition at line 129 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImageConstPointer

template<class TElastix >

typedef Superclass1::FixedImageConstPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImageConstPointer

Definition at line 81 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImageLimiterOutputType

template<class TElastix >

typedef Superclass1::FixedImageLimiterOutputType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImageLimiterOutputType

Definition at line 114 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImageLimiterType

template<class TElastix >

typedef Superclass1::FixedImageLimiterType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImageLimiterType

Definition at line 111 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImageMaskPointer

template<class TElastix >

typedef Superclass1::FixedImageMaskPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImageMaskPointer

Definition at line 98 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImageMaskType

template<class TElastix >

typedef Superclass1::FixedImageMaskType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImageMaskType

Definition at line 97 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImagePixelType

template<class TElastix >

typedef Superclass1::FixedImagePixelType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImagePixelType

Definition at line 104 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImageRegionType

template<class TElastix >

typedef Superclass1::FixedImageRegionType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImageRegionType

Definition at line 82 of file elxAdvancedNormalizedCorrelationMetric.h.

FixedImageType

template<class TElastix >

typedef Superclass1::FixedImageType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::FixedImageType

Definition at line 80 of file elxAdvancedNormalizedCorrelationMetric.h.

GradientImageFilterPointer

template<class TElastix >

typedef Superclass1::GradientImageFilterPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::GradientImageFilterPointer

Definition at line 96 of file elxAdvancedNormalizedCorrelationMetric.h.

GradientImageFilterType

template<class TElastix >

typedef Superclass1::GradientImageFilterType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::GradientImageFilterType

Definition at line 95 of file elxAdvancedNormalizedCorrelationMetric.h.

GradientImagePointer

template<class TElastix >

typedef Superclass1::GradientImagePointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::GradientImagePointer

Definition at line 94 of file elxAdvancedNormalizedCorrelationMetric.h.

GradientImageType

template<class TElastix >

typedef Superclass1::GradientImageType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::GradientImageType

Definition at line 93 of file elxAdvancedNormalizedCorrelationMetric.h.

GradientPixelType

template<class TElastix >

typedef Superclass1::GradientPixelType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::GradientPixelType

Definition at line 92 of file elxAdvancedNormalizedCorrelationMetric.h.

ImageSampleContainerPointer

template<class TElastix >

typedef Superclass1::ImageSampleContainerPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ImageSampleContainerPointer

Definition at line 110 of file elxAdvancedNormalizedCorrelationMetric.h.

ImageSampleContainerType

template<class TElastix >

typedef Superclass1::ImageSampleContainerType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ImageSampleContainerType

Definition at line 108 of file elxAdvancedNormalizedCorrelationMetric.h.

ImageSamplerPointer

template<class TElastix >

typedef Superclass1::ImageSamplerPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ImageSamplerPointer

Definition at line 107 of file elxAdvancedNormalizedCorrelationMetric.h.

ImageSamplerType

template<class TElastix >

typedef Superclass1::ImageSamplerType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ImageSamplerType

Definition at line 106 of file elxAdvancedNormalizedCorrelationMetric.h.

InputPointType

template<class TElastix >

typedef Superclass1::InputPointType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::InputPointType

Definition at line 85 of file elxAdvancedNormalizedCorrelationMetric.h.

InterpolatorPointer

template<class TElastix >

typedef Superclass1::InterpolatorPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::InterpolatorPointer

Definition at line 90 of file elxAdvancedNormalizedCorrelationMetric.h.

InterpolatorType

template<class TElastix >

typedef Superclass1::InterpolatorType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::InterpolatorType

Definition at line 89 of file elxAdvancedNormalizedCorrelationMetric.h.

ITKBaseType

template<class TElastix >

typedef Superclass2::ITKBaseType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ITKBaseType

Definition at line 135 of file elxAdvancedNormalizedCorrelationMetric.h.

MeasureType

template<class TElastix >

typedef Superclass1::MeasureType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MeasureType

Definition at line 101 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageConstPointer

template<class TElastix >

typedef Superclass1::MovingImageConstPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageConstPointer

Definition at line 79 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageDerivativeScalesType

template<class TElastix >

typedef Superclass1::MovingImageDerivativeScalesType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageDerivativeScalesType

Definition at line 118 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageLimiterOutputType

template<class TElastix >

typedef Superclass1::MovingImageLimiterOutputType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageLimiterOutputType

Definition at line 116 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageLimiterType

template<class TElastix >

typedef Superclass1::MovingImageLimiterType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageLimiterType

Definition at line 112 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageMaskPointer

template<class TElastix >

typedef Superclass1::MovingImageMaskPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageMaskPointer

Definition at line 100 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageMaskType

template<class TElastix >

typedef Superclass1::MovingImageMaskType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageMaskType

Definition at line 99 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImagePixelType

template<class TElastix >

typedef Superclass1::MovingImagePixelType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImagePixelType

Definition at line 78 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageRegionType

template<class TElastix >

typedef Superclass1::MovingImageRegionType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageRegionType

Definition at line 105 of file elxAdvancedNormalizedCorrelationMetric.h.

MovingImageType

template<class TElastix >

typedef Superclass1::MovingImageType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::MovingImageType

Definition at line 77 of file elxAdvancedNormalizedCorrelationMetric.h.

OutputPointType

template<class TElastix >

typedef Superclass1::OutputPointType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::OutputPointType

Definition at line 86 of file elxAdvancedNormalizedCorrelationMetric.h.

ParametersType

template<class TElastix >

typedef Superclass1::ParametersType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::ParametersType

Definition at line 103 of file elxAdvancedNormalizedCorrelationMetric.h.

Pointer

template<class TElastix >

typedef itk::SmartPointer< Self > elastix::AdvancedNormalizedCorrelationMetric< TElastix >::Pointer

Definition at line 59 of file elxAdvancedNormalizedCorrelationMetric.h.

RealType

template<class TElastix >

typedef Superclass1::RealType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::RealType

Definition at line 91 of file elxAdvancedNormalizedCorrelationMetric.h.

RegistrationPointer

template<class TElastix >

typedef Superclass2::RegistrationPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::RegistrationPointer

Definition at line 134 of file elxAdvancedNormalizedCorrelationMetric.h.

RegistrationType

template<class TElastix >

typedef Superclass2::RegistrationType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::RegistrationType

Definition at line 133 of file elxAdvancedNormalizedCorrelationMetric.h.

Self

template<class TElastix >

typedef AdvancedNormalizedCorrelationMetric elastix::AdvancedNormalizedCorrelationMetric< TElastix >::Self

Standard ITK-stuff.

Definition at line 54 of file elxAdvancedNormalizedCorrelationMetric.h.

Superclass1

template<class TElastix >

typedef itk::AdvancedNormalizedCorrelationImageToImageMetric< typename MetricBase< TElastix >::FixedImageType, typename MetricBase< TElastix >::MovingImageType > elastix::AdvancedNormalizedCorrelationMetric< TElastix >::Superclass1

Definition at line 57 of file elxAdvancedNormalizedCorrelationMetric.h.

Superclass2

template<class TElastix >

typedef MetricBase< TElastix > elastix::AdvancedNormalizedCorrelationMetric< TElastix >::Superclass2

Definition at line 58 of file elxAdvancedNormalizedCorrelationMetric.h.

TransformJacobianType

template<class TElastix >

typedef Superclass1::TransformJacobianType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::TransformJacobianType

Definition at line 88 of file elxAdvancedNormalizedCorrelationMetric.h.

TransformParametersType

template<class TElastix >

typedef Superclass1::TransformParametersType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::TransformParametersType

Definition at line 87 of file elxAdvancedNormalizedCorrelationMetric.h.

TransformPointer

template<class TElastix >

typedef Superclass1::TransformPointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::TransformPointer

Definition at line 84 of file elxAdvancedNormalizedCorrelationMetric.h.

TransformType

template<class TElastix >

typedef Superclass1::TransformType elastix::AdvancedNormalizedCorrelationMetric< TElastix >::TransformType

Definition at line 83 of file elxAdvancedNormalizedCorrelationMetric.h.

Constructor & Destructor Documentation

AdvancedNormalizedCorrelationMetric() [1/2]

template<class TElastix >

elastix::AdvancedNormalizedCorrelationMetric< TElastix >::AdvancedNormalizedCorrelationMetric ( )

inlineprotected

The constructor.

Definition at line 151 of file elxAdvancedNormalizedCorrelationMetric.h.

~AdvancedNormalizedCorrelationMetric()

template<class TElastix >

elastix::AdvancedNormalizedCorrelationMetric< TElastix >::~AdvancedNormalizedCorrelationMetric ( )

inlineoverrideprotected

The destructor.

Definition at line 153 of file elxAdvancedNormalizedCorrelationMetric.h.

AdvancedNormalizedCorrelationMetric() [2/2]

template<class TElastix >

elastix::AdvancedNormalizedCorrelationMetric< TElastix >::AdvancedNormalizedCorrelationMetric ( const Self &  )

private

The private constructor.

Member Function Documentation

BeforeEachResolution()

template<class TElastix >

void elastix::AdvancedNormalizedCorrelationMetric< TElastix >::BeforeEachResolution ( void  )

overridevirtual

Execute stuff before each new pyramid resolution:

• Set the flag to subtract the mean.
• Set the CheckNumberOfSamples setting.

Reimplemented from elastix::BaseComponent.

elxClassNameMacro()

template<class TElastix >

elastix::AdvancedNormalizedCorrelationMetric< TElastix >::elxClassNameMacro

(

"AdvancedNormalizedCorrelation"

)

Name of this class. Use this name in the parameter file to select this specific metric.
example: (Metric "AdvancedNormalizedCorrelation")

GetClassName()

template<class TElastix >

virtual const char * elastix::AdvancedNormalizedCorrelationMetric< TElastix >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from elastix::MetricBase< TElastix >.

Initialize()

template<class TElastix >

void elastix::AdvancedNormalizedCorrelationMetric< TElastix >::Initialize ( void  )

override

Sets up a timer to measure the initialization time and calls the Superclass' implementation.

itkStaticConstMacro() [1/2]

template<class TElastix >

elastix::AdvancedNormalizedCorrelationMetric< TElastix >::itkStaticConstMacro	(	FixedImageDimension	,
		unsigned int	,
		FixedImageType::ImageDimension
	)

The fixed image dimension.

itkStaticConstMacro() [2/2]

template<class TElastix >

elastix::AdvancedNormalizedCorrelationMetric< TElastix >::itkStaticConstMacro	(	MovingImageDimension	,
		unsigned int	,
		MovingImageType::ImageDimension
	)

The moving image dimension.

New()

template<class TElastix >

static Pointer elastix::AdvancedNormalizedCorrelationMetric< TElastix >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TElastix >

void elastix::AdvancedNormalizedCorrelationMetric< TElastix >::operator= ( const Self &  )

private

The private copy constructor.