#include <itkAdvancedImageToImageMetric.h>

Detailed Description

template<class TFixedImage, class TMovingImage>
class itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >

An extension of the ITK ImageToImageMetric. It is the intended base class for all elastix metrics.

This class inherits from the itk::ImageToImageMetric. The additional features of this class that makes it an AdvancedImageToImageMetric are:

The use of an ImageSampler, which selects the fixed image samples over which the metric is evaluated. In the derived metric you simply need to loop over the image sample container, instead over the fixed image. This way it is easy to create different samplers, without the derived metric needing to know.
Gray value limiters: for some metrics it is important to know the range of expected gray values in the fixed and moving image, beforehand. However, when a third order B-spline interpolator is used to interpolate the images, the interpolated values may be larger than the range of voxel values, because of so-called overshoot. The gray-value limiters make sure this doesn't happen.
Fast implementation when a B-spline transform is used. The B-spline transform has a sparse Jacobian. The AdvancedImageToImageMetric provides functions that make it easier for inheriting metrics to exploit this fact.
MovingImageDerivativeScales: an experimental option, which allows scaling of the moving image derivatives. This is a kind of fast hack, which makes it possible to avoid transformation in one direction (x, y, or z). Do not use this functionality unless you have a good reason for it...
Some convenience functions are provided, such as the IsInsideMovingMask and CheckNumberOfSamples.

The parameters used in this class are:

Parameters:: MovingImageDerivativeScales: scale the moving image derivatives. Use
(MovingImageDerivativeScales 1 1 0)
to penalize deformations in the z-direction. The default value is that this feature is not used.

Definition at line 81 of file itkAdvancedImageToImageMetric.h.

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

Data Structures
struct	GetValueAndDerivativePerThreadStruct

struct	GetValuePerThreadStruct

struct	MultiThreaderParameterType

Public Types
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< TFixedImage, TMovingImage >	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 Member Functions
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 ()

Protected Types
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 Member Functions
	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

Static Protected Member Functions
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
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

Private Member Functions
	AdvancedImageToImageMetric (const Self &)

void	operator= (const Self &)

Private Attributes
MovingImageDerivativeScalesType	m_MovingImageDerivativeScales

double	m_RequiredRatioOfValidSamples

bool	m_ScaleGradientWithRespectToMovingImageOrientation

bool	m_UseFixedImageLimiter

bool	m_UseImageSampler

bool	m_UseMovingImageDerivativeScales

bool	m_UseMovingImageLimiter

Member Typedef Documentation

◆ AdvancedTransformType

template<class TFixedImage , class TMovingImage >

typedef AdvancedTransform< ScalarType, FixedImageDimension, MovingImageDimension > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::AdvancedTransformType

Definition at line 159 of file itkAdvancedImageToImageMetric.h.

◆ BSplineInterpolatorFloatPointer

template<class TFixedImage , class TMovingImage >

typedef BSplineInterpolatorFloatType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineInterpolatorFloatPointer

protected

Definition at line 321 of file itkAdvancedImageToImageMetric.h.

◆ BSplineInterpolatorFloatType

template<class TFixedImage , class TMovingImage >

typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, float > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineInterpolatorFloatType

protected

Definition at line 320 of file itkAdvancedImageToImageMetric.h.

◆ BSplineInterpolatorPointer

template<class TFixedImage , class TMovingImage >

typedef BSplineInterpolatorType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineInterpolatorPointer

protected

Definition at line 318 of file itkAdvancedImageToImageMetric.h.

◆ BSplineInterpolatorType

template<class TFixedImage , class TMovingImage >

typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineInterpolatorType

protected

Typedefs used for computing image derivatives.

Definition at line 317 of file itkAdvancedImageToImageMetric.h.

◆ BSplineOrder1TransformPointer

template<class TFixedImage , class TMovingImage >

typedef BSplineOrder1TransformType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineOrder1TransformPointer

Definition at line 167 of file itkAdvancedImageToImageMetric.h.

◆ BSplineOrder1TransformType

template<class TFixedImage , class TMovingImage >

typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 1 > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineOrder1TransformType

Definition at line 164 of file itkAdvancedImageToImageMetric.h.

◆ BSplineOrder2TransformPointer

template<class TFixedImage , class TMovingImage >

typedef BSplineOrder2TransformType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineOrder2TransformPointer

Definition at line 168 of file itkAdvancedImageToImageMetric.h.

◆ BSplineOrder2TransformType

template<class TFixedImage , class TMovingImage >

typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 2 > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineOrder2TransformType

Definition at line 165 of file itkAdvancedImageToImageMetric.h.

◆ BSplineOrder3TransformPointer

template<class TFixedImage , class TMovingImage >

typedef BSplineOrder3TransformType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineOrder3TransformPointer

Definition at line 169 of file itkAdvancedImageToImageMetric.h.

◆ BSplineOrder3TransformType

template<class TFixedImage , class TMovingImage >

typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 3 > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineOrder3TransformType

Definition at line 166 of file itkAdvancedImageToImageMetric.h.

◆ CentralDifferenceGradientFilterPointer

template<class TFixedImage , class TMovingImage >

typedef CentralDifferenceGradientFilterType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CentralDifferenceGradientFilterPointer

protected

Definition at line 331 of file itkAdvancedImageToImageMetric.h.

◆ CentralDifferenceGradientFilterType

template<class TFixedImage , class TMovingImage >

typedef GradientImageFilter< MovingImageType, RealType, RealType > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CentralDifferenceGradientFilterType

protected

Definition at line 330 of file itkAdvancedImageToImageMetric.h.

◆ CombinationTransformType

template<class TFixedImage , class TMovingImage >

typedef AdvancedCombinationTransform< ScalarType, FixedImageDimension > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CombinationTransformType

Typedef's for the B-spline transform.

Definition at line 163 of file itkAdvancedImageToImageMetric.h.

◆ ConstPointer

template<class TFixedImage , class TMovingImage >

typedef SmartPointer< const Self > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer

Definition at line 90 of file itkAdvancedImageToImageMetric.h.

◆ CoordinateRepresentationType

template<class TFixedImage , class TMovingImage >

typedef Superclass::CoordinateRepresentationType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType

Typedefs from the superclass.

Definition at line 102 of file itkAdvancedImageToImageMetric.h.

◆ DerivativeType

template<class TFixedImage , class TMovingImage >

typedef Superclass::DerivativeType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Definition at line 130 of file itkAdvancedImageToImageMetric.h.

◆ DerivativeValueType

template<class TFixedImage , class TMovingImage >

typedef DerivativeType::ValueType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::DerivativeValueType

Definition at line 131 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageConstPointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageConstPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 109 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageIndexType

template<class TFixedImage , class TMovingImage >

typedef FixedImageType::IndexType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexType

protected

Protected Typedefs Typedefs for indices and points.

Definition at line 308 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageIndexValueType

template<class TFixedImage , class TMovingImage >

typedef FixedImageIndexType::IndexValueType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexValueType

protected

Definition at line 309 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageLimiterOutputType

template<class TFixedImage , class TMovingImage >

typedef FixedImageLimiterType::OutputType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageLimiterOutputType

Definition at line 151 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageLimiterPointer

template<class TFixedImage , class TMovingImage >

typedef FixedImageLimiterType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageLimiterPointer

Definition at line 150 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageLimiterType

template<class TFixedImage , class TMovingImage >

typedef LimiterFunctionBase< RealType, FixedImageDimension > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageLimiterType

Typedefs for Limiter support.

Definition at line 149 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageMaskPointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageMaskPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskPointer

Definition at line 126 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageMaskSpatialObject2Type

template<class TFixedImage , class TMovingImage >

typedef ImageMaskSpatialObject< itkGetStaticConstMacro( FixedImageDimension ) > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskSpatialObject2Type

Definition at line 134 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageMaskType

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageMaskType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskType

Definition at line 125 of file itkAdvancedImageToImageMetric.h.

◆ FixedImagePixelType

template<class TFixedImage , class TMovingImage >

typedef FixedImageType::PixelType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType

Some useful extra typedefs.

Definition at line 138 of file itkAdvancedImageToImageMetric.h.

◆ FixedImagePointer

template<class TFixedImage , class TMovingImage >

typedef FixedImageType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePointer

Definition at line 108 of file itkAdvancedImageToImageMetric.h.

◆ FixedImagePointType

template<class TFixedImage , class TMovingImage >

typedef TransformType::InputPointType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePointType

protected

Definition at line 311 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageRegionType

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageRegionType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageRegionType

Definition at line 110 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageType

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Definition at line 107 of file itkAdvancedImageToImageMetric.h.

◆ GradientImageFilterPointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::GradientImageFilterPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterPointer

Definition at line 124 of file itkAdvancedImageToImageMetric.h.

◆ GradientImageFilterType

template<class TFixedImage , class TMovingImage >

typedef Superclass::GradientImageFilterType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterType

Definition at line 123 of file itkAdvancedImageToImageMetric.h.

◆ GradientImagePointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::GradientImagePointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GradientImagePointer

Definition at line 122 of file itkAdvancedImageToImageMetric.h.

◆ GradientImageType

template<class TFixedImage , class TMovingImage >

typedef Superclass::GradientImageType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GradientImageType

Definition at line 121 of file itkAdvancedImageToImageMetric.h.

◆ GradientPixelType

template<class TFixedImage , class TMovingImage >

typedef Superclass::GradientPixelType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType

Definition at line 120 of file itkAdvancedImageToImageMetric.h.

◆ HessianType

template<class TFixedImage , class TMovingImage >

typedef vnl_sparse_matrix< HessianValueType > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::HessianType

Definition at line 173 of file itkAdvancedImageToImageMetric.h.

◆ HessianValueType

template<class TFixedImage , class TMovingImage >

typedef DerivativeType::ValueType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::HessianValueType

Hessian type; for SelfHessian (experimental feature)

Definition at line 172 of file itkAdvancedImageToImageMetric.h.

◆ ImageSampleContainerPointer

template<class TFixedImage , class TMovingImage >

typedef ImageSamplerType::OutputVectorContainerPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSampleContainerPointer

Definition at line 146 of file itkAdvancedImageToImageMetric.h.

◆ ImageSampleContainerType

template<class TFixedImage , class TMovingImage >

typedef ImageSamplerType::OutputVectorContainerType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSampleContainerType

Definition at line 145 of file itkAdvancedImageToImageMetric.h.

◆ ImageSamplerPointer

template<class TFixedImage , class TMovingImage >

typedef ImageSamplerType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSamplerPointer

Definition at line 144 of file itkAdvancedImageToImageMetric.h.

◆ ImageSamplerType

template<class TFixedImage , class TMovingImage >

typedef ImageSamplerBase< FixedImageType > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ImageSamplerType

Typedefs for the ImageSampler.

Definition at line 143 of file itkAdvancedImageToImageMetric.h.

◆ InputPointType

template<class TFixedImage , class TMovingImage >

typedef Superclass::InputPointType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::InputPointType

Definition at line 113 of file itkAdvancedImageToImageMetric.h.

◆ InterpolatorPointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::InterpolatorPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorPointer

Definition at line 118 of file itkAdvancedImageToImageMetric.h.

◆ InterpolatorType

template<class TFixedImage , class TMovingImage >

typedef Superclass::InterpolatorType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType

Definition at line 117 of file itkAdvancedImageToImageMetric.h.

◆ LinearInterpolatorPointer

template<class TFixedImage , class TMovingImage >

typedef LinearInterpolatorType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::LinearInterpolatorPointer

protected

Definition at line 327 of file itkAdvancedImageToImageMetric.h.

◆ LinearInterpolatorType

template<class TFixedImage , class TMovingImage >

typedef AdvancedLinearInterpolateImageFunction< MovingImageType, CoordinateRepresentationType > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::LinearInterpolatorType

protected

Definition at line 326 of file itkAdvancedImageToImageMetric.h.

◆ MeasureType

template<class TFixedImage , class TMovingImage >

typedef Superclass::MeasureType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Definition at line 129 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageConstPointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageConstPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Definition at line 106 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageContinuousIndexType

template<class TFixedImage , class TMovingImage >

typedef InterpolatorType::ContinuousIndexType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageContinuousIndexType

protected

Definition at line 313 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageDerivativeScalesType

template<class TFixedImage , class TMovingImage >

typedef FixedArray< double, Self::MovingImageDimension > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeScalesType

Definition at line 140 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageDerivativeType

template<class TFixedImage , class TMovingImage >

typedef BSplineInterpolatorType::CovariantVectorType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeType

protected

Definition at line 328 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageIndexType

template<class TFixedImage , class TMovingImage >

typedef MovingImageType::IndexType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageIndexType

protected

Definition at line 310 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageLimiterOutputType

template<class TFixedImage , class TMovingImage >

typedef MovingImageLimiterType::OutputType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageLimiterOutputType

Definition at line 154 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageLimiterPointer

template<class TFixedImage , class TMovingImage >

typedef MovingImageLimiterType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageLimiterPointer

Definition at line 153 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageLimiterType

template<class TFixedImage , class TMovingImage >

typedef LimiterFunctionBase< RealType, MovingImageDimension > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageLimiterType

Definition at line 152 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageMaskPointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageMaskPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskPointer

Definition at line 128 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageMaskSpatialObject2Type

template<class TFixedImage , class TMovingImage >

typedef ImageMaskSpatialObject< itkGetStaticConstMacro( MovingImageDimension ) > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskSpatialObject2Type

Definition at line 135 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageMaskType

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageMaskType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskType

Definition at line 127 of file itkAdvancedImageToImageMetric.h.

◆ MovingImagePixelType

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImagePixelType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType

Definition at line 104 of file itkAdvancedImageToImageMetric.h.

◆ MovingImagePointer

template<class TFixedImage , class TMovingImage >

typedef MovingImageType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointer

Definition at line 105 of file itkAdvancedImageToImageMetric.h.

◆ MovingImagePointType

template<class TFixedImage , class TMovingImage >

typedef TransformType::OutputPointType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType

protected

Definition at line 312 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageRegionType

template<class TFixedImage , class TMovingImage >

typedef MovingImageType::RegionType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageRegionType

Definition at line 139 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageType

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Definition at line 103 of file itkAdvancedImageToImageMetric.h.

◆ NonZeroJacobianIndicesType

template<class TFixedImage , class TMovingImage >

typedef AdvancedTransformType::NonZeroJacobianIndicesType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::NonZeroJacobianIndicesType

protected

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

Definition at line 335 of file itkAdvancedImageToImageMetric.h.

◆ NumberOfParametersType

template<class TFixedImage , class TMovingImage >

typedef AdvancedTransformType::NumberOfParametersType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::NumberOfParametersType

Definition at line 160 of file itkAdvancedImageToImageMetric.h.

◆ OutputPointType

template<class TFixedImage , class TMovingImage >

typedef Superclass::OutputPointType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType

Definition at line 114 of file itkAdvancedImageToImageMetric.h.

◆ ParametersType

template<class TFixedImage , class TMovingImage >

typedef Superclass::ParametersType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ParametersType

Definition at line 132 of file itkAdvancedImageToImageMetric.h.

◆ Pointer

template<class TFixedImage , class TMovingImage >

typedef SmartPointer< Self > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::Pointer

Definition at line 89 of file itkAdvancedImageToImageMetric.h.

◆ RealType

template<class TFixedImage , class TMovingImage >

typedef Superclass::RealType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::RealType

Definition at line 119 of file itkAdvancedImageToImageMetric.h.

◆ ReducedBSplineInterpolatorPointer

template<class TFixedImage , class TMovingImage >

typedef ReducedBSplineInterpolatorType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ReducedBSplineInterpolatorPointer

protected

Definition at line 324 of file itkAdvancedImageToImageMetric.h.

◆ ReducedBSplineInterpolatorType

template<class TFixedImage , class TMovingImage >

typedef ReducedDimensionBSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ReducedBSplineInterpolatorType

protected

Definition at line 323 of file itkAdvancedImageToImageMetric.h.

◆ ScalarType

template<class TFixedImage , class TMovingImage >

typedef TransformType::ScalarType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ScalarType

Advanced transform.

Definition at line 157 of file itkAdvancedImageToImageMetric.h.

◆ Self

template<class TFixedImage , class TMovingImage >

typedef AdvancedImageToImageMetric itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Definition at line 87 of file itkAdvancedImageToImageMetric.h.

◆ Superclass

template<class TFixedImage , class TMovingImage >

typedef ImageToImageMetric< TFixedImage, TMovingImage > itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::Superclass

Definition at line 88 of file itkAdvancedImageToImageMetric.h.

◆ ThreaderType

template<class TFixedImage , class TMovingImage >

typedef itk::PlatformMultiThreader itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ThreaderType

Typedefs for multi-threading.

Definition at line 176 of file itkAdvancedImageToImageMetric.h.

◆ ThreadInfoType

template<class TFixedImage , class TMovingImage >

typedef ThreaderType::WorkUnitInfo itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ThreadInfoType

Definition at line 177 of file itkAdvancedImageToImageMetric.h.

◆ TransformJacobianType

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformJacobianType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Definition at line 116 of file itkAdvancedImageToImageMetric.h.

◆ TransformParametersType

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformParametersType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Definition at line 115 of file itkAdvancedImageToImageMetric.h.

◆ TransformPointer

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Definition at line 112 of file itkAdvancedImageToImageMetric.h.

◆ TransformType

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Definition at line 111 of file itkAdvancedImageToImageMetric.h.

Constructor & Destructor Documentation

◆ AdvancedImageToImageMetric() [1/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::AdvancedImageToImageMetric ( )

protected

Constructor.

◆ ~AdvancedImageToImageMetric()

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::~AdvancedImageToImageMetric ( )

overrideprotected

Destructor.

◆ AdvancedImageToImageMetric() [2/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::AdvancedImageToImageMetric ( const Self & )

private

Member Function Documentation

◆ AccumulateDerivativesThreaderCallback()

template<class TFixedImage , class TMovingImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::AccumulateDerivativesThreaderCallback ( void * arg )

staticprotected

AccumulateDerivatives threader callback function.

◆ AfterThreadedGetValue()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::AfterThreadedGetValue ( MeasureType & value ) const

inlineprotectedvirtual

Finalize multi-threaded metric computation.

Reimplemented in itk::AdvancedMeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::AdvancedMeanSquaresImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >, itk::SumSquaredTissueVolumeDifferenceImageToImageMetric< TFixedImage, TMovingImage >, and itk::SumSquaredTissueVolumeDifferenceImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

Definition at line 379 of file itkAdvancedImageToImageMetric.h.

◆ AfterThreadedGetValueAndDerivative()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::AfterThreadedGetValueAndDerivative	(	MeasureType &	value,
		DerivativeType &	derivative
	)		const

inlineprotectedvirtual

Finalize multi-threaded metric computation.

Definition at line 392 of file itkAdvancedImageToImageMetric.h.

◆ BeforeThreadedGetValueAndDerivative()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BeforeThreadedGetValueAndDerivative ( const TransformParametersType & parameters ) const

virtual

Contains calls from GetValueAndDerivative that are thread-unsafe, together with preparation for multi-threading. Note that the only reason why this function is not protected, is because the ComboMetric needs to call it.

Reimplemented in itk::TransformRigidityPenaltyTerm< TFixedImage, TScalarType >, and itk::TransformRigidityPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >.

◆ CheckForAdvancedTransform()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CheckForAdvancedTransform ( void )

protectedvirtual

Methods to support transforms with sparse Jacobians, like the BSplineTransform Check if the transform is an AdvancedTransform. Called by Initialize. If so, we can speed up derivative calculations by only inspecting the parameters in the support region of a point.

◆ CheckForBSplineInterpolator()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CheckForBSplineInterpolator ( void )

protectedvirtual

Methods for image derivative evaluation support Initialize variables for image derivative computation; this method is called by Initialize.

◆ CheckForBSplineTransform()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CheckForBSplineTransform ( void ) const

protectedvirtual

Check if the transform is a B-spline. Called by Initialize.

◆ CheckNumberOfSamples()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::CheckNumberOfSamples	(	unsigned long	wanted,
		unsigned long	found
	)		const

protectedvirtual

Check if enough samples have been found to compute a reliable estimate of the value/derivative; throws an exception if not.

◆ EvaluateMovingImageValueAndDerivative()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::EvaluateMovingImageValueAndDerivative	(	const MovingImagePointType &	mappedPoint,
		RealType &	movingImageValue,
		MovingImageDerivativeType *	gradient
	)		const

protectedvirtual

Compute the image value (and possibly derivative) at a transformed point. Checks if the point lies within the moving image buffer (bool return). If no gradient is wanted, set the gradient argument to 0. If a BSplineInterpolationFunction or AdvacnedLinearInterpolationFunction is used, this class obtains image derivatives from the B-spline or linear interpolator. Otherwise, image derivatives are computed using nearest neighbor interpolation of a precomputed (central difference) gradient image.

Reimplemented in itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >, and itk::MultiInputImageToImageMetricBase< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

◆ EvaluateTransformJacobian()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::EvaluateTransformJacobian	(	const FixedImagePointType &	fixedImagePoint,
		TransformJacobianType &	jacobian,
		NonZeroJacobianIndicesType &	nzji
	)		const

protectedvirtual

This function returns a reference to the transform Jacobians. This is either a reference to the full TransformJacobian or a reference to a sparse Jacobians. The m_NonZeroJacobianIndices contains the indices that are nonzero. The length of NonZeroJacobianIndices is set in the CheckForAdvancedTransform function.

◆ EvaluateTransformJacobianInnerProduct()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::EvaluateTransformJacobianInnerProduct	(	const TransformJacobianType &	jacobian,
		const MovingImageDerivativeType &	movingImageDerivative,
		DerivativeType &	imageJacobian
	)		const

protectedvirtual

Computes the inner product of transform Jacobian with moving image gradient. The results are stored in imageJacobian, which is supposed to have the right size (same length as Jacobian's number of columns).

◆ GetClassName()

template<class TFixedImage , class TMovingImage >

virtual const char * itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

◆ GetFixedImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual const FixedImageLimiterType * itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageLimiter ( )

virtual

◆ GetFixedLimitRangeRatio()

template<class TFixedImage , class TMovingImage >

virtual double itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetFixedLimitRangeRatio ( ) const

virtual

◆ GetImageSampler()

template<class TFixedImage , class TMovingImage >

virtual ImageSamplerType * itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetImageSampler ( void ) const

inlinevirtual

Definition at line 202 of file itkAdvancedImageToImageMetric.h.

◆ GetMovingImageDerivativeScales()

template<class TFixedImage , class TMovingImage >

virtual const MovingImageDerivativeScalesType & itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageDerivativeScales ( )

virtual

◆ GetMovingImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual const MovingImageLimiterType * itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageLimiter ( )

virtual

◆ GetMovingLimitRangeRatio()

template<class TFixedImage , class TMovingImage >

virtual double itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetMovingLimitRangeRatio ( ) const

virtual

◆ GetRequiredRatioOfValidSamples()

template<class TFixedImage , class TMovingImage >

virtual double itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetRequiredRatioOfValidSamples ( ) const

virtual

◆ GetScaleGradientWithRespectToMovingImageOrientation()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetScaleGradientWithRespectToMovingImageOrientation ( ) const

virtual

◆ GetSelfHessian()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetSelfHessian	(	const TransformParametersType &	parameters,
		HessianType &	H
	)		const

virtual

Experimental feature: compute SelfHessian. This base class just returns an identity matrix of the right size.

Reimplemented in itk::AdvancedMeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::AdvancedMeanSquaresImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >, itk::TransformBendingEnergyPenaltyTerm< TFixedImage, TScalarType >, itk::TransformBendingEnergyPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >, and itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >.

◆ GetTransform()

template<class TFixedImage , class TMovingImage >

const AdvancedTransformType * itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetTransform ( void ) const

inlineoverride

Get the advanced transform.

Definition at line 194 of file itkAdvancedImageToImageMetric.h.

◆ GetUseFixedImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetUseFixedImageLimiter ( ) const

virtual

Inheriting classes can specify whether they use the image limiter functionality. This method allows the user to inspect this setting.

◆ GetUseImageSampler()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetUseImageSampler ( ) const

virtual

Inheriting classes can specify whether they use the image sampler functionality; This method allows the user to inspect this setting.

◆ GetUseMetricSingleThreaded()

template<class TFixedImage , class TMovingImage >

virtual const bool & itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetUseMetricSingleThreaded ( )

virtual

◆ GetUseMovingImageDerivativeScales()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetUseMovingImageDerivativeScales ( ) const

virtual

◆ GetUseMovingImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetUseMovingImageLimiter ( ) const

virtual

◆ GetUseMultiThread()

template<class TFixedImage , class TMovingImage >

virtual const bool & itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetUseMultiThread ( )

virtual

◆ GetValueAndDerivativeThreaderCallback()

template<class TFixedImage , class TMovingImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreaderCallback ( void * arg )

staticprotected

GetValueAndDerivative threader callback function.

◆ GetValueThreaderCallback()

template<class TFixedImage , class TMovingImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreaderCallback ( void * arg )

staticprotected

GetValue threader callback function.

◆ Initialize()

template<class TFixedImage , class TMovingImage >

void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::Initialize ( void )

override

Initialize the Metric by making sure that all the components are present and plugged together correctly.

Call the superclass' implementation
Cache the number of transform parameters
Initialize the image sampler, if used.
Check if a B-spline interpolator has been set
Check if an AdvancedTransform has been set

◆ InitializeImageSampler()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::InitializeImageSampler ( void )

protectedvirtual

Protected methods ************** Methods for image sampler support Initialize variables related to the image sampler; called by Initialize.

Reimplemented in itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >, and itk::MultiInputImageToImageMetricBase< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

◆ InitializeLimiters()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::InitializeLimiters ( void )

protectedvirtual

Initialize the {Fixed,Moving}[True]{Max,Min}[Limit] and the {Fixed,Moving}ImageLimiter Only does something when Use{Fixed,Moving}Limiter is set to true;

◆ InitializeThreadingParameters()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::InitializeThreadingParameters ( void ) const

protectedvirtual

Initialize some multi-threading related parameters.

◆ IsInsideMovingMask()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::IsInsideMovingMask ( const MovingImagePointType & point ) const

protectedvirtual

Convenience method: check if point is inside the moving mask.

Reimplemented in itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >, and itk::MultiInputImageToImageMetricBase< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

◆ itkAlignedTypedef() [1/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::itkAlignedTypedef	(	ITK_CACHE_LINE_ALIGNMENT	,
		PaddedGetValueAndDerivativePerThreadStruct	,
		AlignedGetValueAndDerivativePerThreadStruct
	)

protected

◆ itkAlignedTypedef() [2/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::itkAlignedTypedef	(	ITK_CACHE_LINE_ALIGNMENT	,
		PaddedGetValuePerThreadStruct	,
		AlignedGetValuePerThreadStruct
	)

protected

◆ itkPadStruct() [1/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::itkPadStruct	(	ITK_CACHE_LINE_ALIGNMENT	,
		GetValueAndDerivativePerThreadStruct	,
		PaddedGetValueAndDerivativePerThreadStruct
	)

protected

◆ itkPadStruct() [2/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::itkPadStruct	(	ITK_CACHE_LINE_ALIGNMENT	,
		GetValuePerThreadStruct	,
		PaddedGetValuePerThreadStruct
	)

protected

◆ itkStaticConstMacro() [1/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro	(	FixedImageDimension	,
		unsigned int	,
		TFixedImage::ImageDimension
	)

◆ itkStaticConstMacro() [2/2]

template<class TFixedImage , class TMovingImage >

itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro	(	MovingImageDimension	,
		unsigned int	,
		TMovingImage::ImageDimension
	)

Constants for the image dimensions.

◆ LaunchGetValueAndDerivativeThreaderCallback()

template<class TFixedImage , class TMovingImage >

void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::LaunchGetValueAndDerivativeThreaderCallback ( void ) const

protected

Launch MultiThread GetValueAndDerivative.

◆ LaunchGetValueThreaderCallback()

template<class TFixedImage , class TMovingImage >

void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::LaunchGetValueThreaderCallback ( void ) const

protected

Launch MultiThread GetValue.

◆ operator=()

template<class TFixedImage , class TMovingImage >

void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::operator= ( const Self & )

private

◆ PrintSelf()

template<class TFixedImage , class TMovingImage >

void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotected

PrintSelf.

◆ SetFixedImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageLimiter ( FixedImageLimiterType * _arg )

virtual

◆ SetFixedLimitRangeRatio()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetFixedLimitRangeRatio ( double _arg )

virtual

◆ SetImageSampler()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetImageSampler ( ImageSamplerType * _arg )

virtual

Set/Get the image sampler.

◆ SetMovingImageDerivativeScales()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageDerivativeScales ( MovingImageDerivativeScalesType _arg )

virtual

◆ SetMovingImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageLimiter ( MovingImageLimiterType * _arg )

virtual

Set/Get the Moving/Fixed limiter. Its thresholds and bounds are set by the metric. Setting a limiter is only mandatory if GetUse{Fixed,Moving}Limiter() returns true.

◆ SetMovingLimitRangeRatio()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetMovingLimitRangeRatio ( double _arg )

virtual

A percentage that defines how much the gray value range is extended maxlimit = max + LimitRangeRatio * (max - min) minlimit = min - LimitRangeRatio * (max - min) Default: 0.01; If you use a nearest neighbor or linear interpolator, set it to zero and use a hard limiter.

◆ SetNumberOfWorkUnits()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetNumberOfWorkUnits ( ThreadIdType numberOfThreads )

virtual

Set number of threads to use for computations.

◆ SetRequiredRatioOfValidSamples()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetRequiredRatioOfValidSamples ( double _arg )

virtual

Set/Get the required ratio of valid samples; default 0.25. When less than this ratio*numberOfSamplesTried samples map inside the moving image buffer, an exception will be thrown.

◆ SetScaleGradientWithRespectToMovingImageOrientation()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetScaleGradientWithRespectToMovingImageOrientation ( bool _arg )

virtual

◆ SetTransform()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetTransform ( AdvancedTransformType * arg )

inlinevirtual

Public methods Set the transform, of advanced type.

Definition at line 182 of file itkAdvancedImageToImageMetric.h.

◆ SetUseFixedImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetUseFixedImageLimiter ( bool _arg )

protectedvirtual

Inheriting classes can specify whether they use the image limiter functionality Make sure to set it before calling Initialize; default: false.

◆ SetUseImageSampler()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetUseImageSampler ( bool _arg )

protectedvirtual

Inheriting classes can specify whether they use the image sampler functionality Make sure to set it before calling Initialize; default: false.

◆ SetUseMetricSingleThreaded()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetUseMetricSingleThreaded ( bool _arg )

virtual

Switch the function BeforeThreadedGetValueAndDerivative on or off.

◆ SetUseMovingImageDerivativeScales()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetUseMovingImageDerivativeScales ( bool _arg )

virtual

You may specify a scaling vector for the moving image derivatives. If the UseMovingImageDerivativeScales is true, the moving image derivatives are multiplied by the moving image derivative scales (element-wise) You may use this to avoid deformations in the z-dimension, for example, by setting the moving image derivative scales to (1,1,0). This is a rather experimental feature. In most cases you do not need it.

◆ SetUseMovingImageLimiter()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetUseMovingImageLimiter ( bool _arg )

protectedvirtual

◆ SetUseMultiThread()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetUseMultiThread ( bool _arg )

virtual

Select the use of multi-threading

◆ ThreadedGetValue()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ThreadedGetValue ( ThreadIdType threadID )

inlineprotectedvirtual

Multi-threaded metric computation. Multi-threaded version of GetValue().

Reimplemented in itk::AdvancedMeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::AdvancedMeanSquaresImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >, itk::SumSquaredTissueVolumeDifferenceImageToImageMetric< TFixedImage, TMovingImage >, and itk::SumSquaredTissueVolumeDifferenceImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

Definition at line 376 of file itkAdvancedImageToImageMetric.h.

◆ ThreadedGetValueAndDerivative()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::ThreadedGetValueAndDerivative ( ThreadIdType threadID )

inlineprotectedvirtual

Multi-threaded version of GetValueAndDerivative().

Definition at line 388 of file itkAdvancedImageToImageMetric.h.

◆ TransformPoint()

template<class TFixedImage , class TMovingImage >

virtual bool itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::TransformPoint	(	const FixedImagePointType &	fixedImagePoint,
		MovingImagePointType &	mappedPoint
	)		const

protectedvirtual

Transform a point from FixedImage domain to MovingImage domain. This function also checks if mapped point is within support region of the transform. It returns true if so, and false otherwise.

◆ UseMetricSingleThreadedOff()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::UseMetricSingleThreadedOff ( )

virtual

◆ UseMetricSingleThreadedOn()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::UseMetricSingleThreadedOn ( )

virtual

◆ UseMultiThreadOff()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::UseMultiThreadOff ( )

virtual

◆ UseMultiThreadOn()

template<class TFixedImage , class TMovingImage >

virtual void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::UseMultiThreadOn ( )

virtual

Field Documentation

◆ m_AdvancedTransform

template<class TFixedImage , class TMovingImage >

AdvancedTransformType::Pointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_AdvancedTransform

protected

Definition at line 358 of file itkAdvancedImageToImageMetric.h.

◆ m_BSplineInterpolator

template<class TFixedImage , class TMovingImage >

BSplineInterpolatorPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_BSplineInterpolator

protected

Definition at line 350 of file itkAdvancedImageToImageMetric.h.

◆ m_BSplineInterpolatorFloat

template<class TFixedImage , class TMovingImage >

BSplineInterpolatorFloatPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_BSplineInterpolatorFloat

protected

Definition at line 351 of file itkAdvancedImageToImageMetric.h.

◆ m_CentralDifferenceGradientFilter

template<class TFixedImage , class TMovingImage >

CentralDifferenceGradientFilterPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_CentralDifferenceGradientFilter

protected

Definition at line 354 of file itkAdvancedImageToImageMetric.h.

◆ m_FixedImageLimiter

template<class TFixedImage , class TMovingImage >

FixedImageLimiterPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageLimiter

protected

Variables for the Limiters.

Definition at line 362 of file itkAdvancedImageToImageMetric.h.

◆ m_FixedImageMaxLimit

template<class TFixedImage , class TMovingImage >

FixedImageLimiterOutputType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageMaxLimit

protected

Definition at line 369 of file itkAdvancedImageToImageMetric.h.

◆ m_FixedImageMinLimit

template<class TFixedImage , class TMovingImage >

FixedImageLimiterOutputType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageMinLimit

protected

Definition at line 368 of file itkAdvancedImageToImageMetric.h.

◆ m_FixedImageTrueMax

template<class TFixedImage , class TMovingImage >

FixedImagePixelType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageTrueMax

protected

Definition at line 365 of file itkAdvancedImageToImageMetric.h.

◆ m_FixedImageTrueMin

template<class TFixedImage , class TMovingImage >

FixedImagePixelType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_FixedImageTrueMin

protected

Definition at line 364 of file itkAdvancedImageToImageMetric.h.

◆ m_FixedLimitRangeRatio

template<class TFixedImage , class TMovingImage >

double itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_FixedLimitRangeRatio

protected

Definition at line 547 of file itkAdvancedImageToImageMetric.h.

◆ m_GetValueAndDerivativePerThreadVariables

template<class TFixedImage , class TMovingImage >

AlignedGetValueAndDerivativePerThreadStruct* itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_GetValueAndDerivativePerThreadVariables

mutableprotected

Definition at line 455 of file itkAdvancedImageToImageMetric.h.

◆ m_GetValueAndDerivativePerThreadVariablesSize

template<class TFixedImage , class TMovingImage >

ThreadIdType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_GetValueAndDerivativePerThreadVariablesSize

mutableprotected

Definition at line 456 of file itkAdvancedImageToImageMetric.h.

◆ m_GetValuePerThreadVariables

template<class TFixedImage , class TMovingImage >

AlignedGetValuePerThreadStruct* itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_GetValuePerThreadVariables

mutableprotected

Definition at line 441 of file itkAdvancedImageToImageMetric.h.

◆ m_GetValuePerThreadVariablesSize

template<class TFixedImage , class TMovingImage >

ThreadIdType itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_GetValuePerThreadVariablesSize

mutableprotected

Definition at line 442 of file itkAdvancedImageToImageMetric.h.

◆ m_ImageSampler

template<class TFixedImage , class TMovingImage >

ImageSamplerPointer itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::m_ImageSampler

mutableprotected

Protected Variables Variables for ImageSampler support. m_ImageSampler is mutable, because it is changed in the GetValue(), etc, which are const functions.

Definition at line 342 of file itkAdvancedImageToImageMetric.h.