#include <itkImageToImageMetricWithFeatures.h>

Detailed Description

template<class TFixedImage, class TMovingImage, class TFixedFeatureImage = TFixedImage, class TMovingFeatureImage = TMovingImage>
class itk::ImageToImageMetricWithFeatures< TFixedImage, TMovingImage, TFixedFeatureImage, TMovingFeatureImage >

Computes similarity between regions of two images.

This base class adds functionality that makes it possible to use fixed and moving image features.

Definition at line 41 of file itkImageToImageMetricWithFeatures.h.

Inheritance diagram for itk::ImageToImageMetricWithFeatures< TFixedImage, TMovingImage, TFixedFeatureImage, TMovingFeatureImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FixedFeatureImagePointer = typename FixedFeatureImageType::Pointer

using	FixedFeatureImageType = TFixedFeatureImage

using	FixedFeatureImageVectorType = std::vector< FixedFeatureImagePointer >

using	FixedFeatureInterpolatorPointer = typename FixedFeatureInterpolatorType::Pointer

using	FixedFeatureInterpolatorType = InterpolateImageFunction< FixedFeatureImageType, double >

using	FixedFeatureInterpolatorVectorType = std::vector< FixedFeatureInterpolatorPointer >

using	FixedImageLimiterOutputType = typename FixedImageLimiterType::OutputType

using	FixedImageLimiterType = LimiterFunctionBase< RealType, FixedImageDimension >

using	FixedImageMaskPointer = SmartPointer< FixedImageMaskType >

using	FixedImageMaskType = ImageMaskSpatialObject< Self::FixedImageDimension >

using	FixedImagePixelType = typename FixedImageType::PixelType

using	ImageSampleContainerPointer = typename ImageSamplerType::OutputVectorContainerPointer

using	ImageSampleContainerType = typename ImageSamplerType::OutputVectorContainerType

using	ImageSamplerPointer = typename ImageSamplerType::Pointer

using	ImageSamplerType = ImageSamplerBase< FixedImageType >

using	MovingFeatureImagePointer = typename MovingFeatureImageType::Pointer

using	MovingFeatureImageType = TMovingFeatureImage

using	MovingFeatureImageVectorType = std::vector< MovingFeatureImagePointer >

using	MovingFeatureInterpolatorPointer = typename MovingFeatureInterpolatorType::Pointer

using	MovingFeatureInterpolatorType = InterpolateImageFunction< MovingFeatureImageType, double >

using	MovingFeatureInterpolatorVectorType = std::vector< MovingFeatureInterpolatorPointer >

using	MovingImageLimiterOutputType = typename MovingImageLimiterType::OutputType

using	MovingImageLimiterType = LimiterFunctionBase< RealType, MovingImageDimension >

using	MovingImageMaskPointer = SmartPointer< MovingImageMaskType >

using	MovingImageMaskType = ImageMaskSpatialObject< Self::MovingImageDimension >

using	MovingImageRegionType = typename MovingImageType::RegionType

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageMetricWithFeatures

using	Superclass = AdvancedImageToImageMetric< TFixedImage, TMovingImage >

Public Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
using	AdvancedTransformType = AdvancedTransform< ScalarType, FixedImageDimension, MovingImageDimension >

using	BSplineOrder1TransformPointer = typename BSplineOrder1TransformType::Pointer

using	BSplineOrder1TransformType = AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 1 >

using	BSplineOrder2TransformPointer = typename BSplineOrder2TransformType::Pointer

using	BSplineOrder2TransformType = AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 2 >

using	BSplineOrder3TransformPointer = typename BSplineOrder3TransformType::Pointer

using	BSplineOrder3TransformType = AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 3 >

using	CombinationTransformType = AdvancedCombinationTransform< ScalarType, FixedImageDimension >

using	ConstPointer = SmartPointer< const Self >

using	DerivativeValueType = typename DerivativeType::ValueType

using	FixedImageLimiterOutputType = typename FixedImageLimiterType::OutputType

using	FixedImageLimiterPointer = typename FixedImageLimiterType::Pointer

using	FixedImageLimiterType = LimiterFunctionBase< RealType, FixedImageDimension >

using	FixedImageMaskConstPointer = SmartPointer< const FixedImageMaskType >

using	FixedImageMaskPointer = SmartPointer< FixedImageMaskType >

using	FixedImageMaskType = ImageMaskSpatialObject< Self::FixedImageDimension >

using	FixedImagePixelType = typename FixedImageType::PixelType

using	FixedImagePointer = typename FixedImageType::Pointer

using	ImageSampleContainerPointer = typename ImageSamplerType::OutputVectorContainerPointer

using	ImageSampleContainerType = typename ImageSamplerType::OutputVectorContainerType

using	ImageSamplerPointer = typename ImageSamplerType::Pointer

using	ImageSamplerType = ImageSamplerBase< FixedImageType >

using	MovingImageDerivativeScalesType = FixedArray< double, Self::MovingImageDimension >

using	MovingImageLimiterOutputType = typename MovingImageLimiterType::OutputType

using	MovingImageLimiterPointer = typename MovingImageLimiterType::Pointer

using	MovingImageLimiterType = LimiterFunctionBase< RealType, MovingImageDimension >

using	MovingImageMaskConstPointer = SmartPointer< const MovingImageMaskType >

using	MovingImageMaskPointer = SmartPointer< MovingImageMaskType >

using	MovingImageMaskType = ImageMaskSpatialObject< Self::MovingImageDimension >

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImageRegionType = typename MovingImageType::RegionType

using	NumberOfParametersType = typename AdvancedTransformType::NumberOfParametersType

using	Pointer = SmartPointer< Self >

using	ScalarType = typename TransformType::ScalarType

using	Self = AdvancedImageToImageMetric

using	Superclass = ImageToImageMetric< TFixedImage, TMovingImage >

using	ThreadInfoType = MultiThreaderBase::WorkUnitInfo

Public Member Functions
virtual const char *	GetClassName () const

const FixedFeatureImageType *	GetFixedFeatureImage () const

const FixedFeatureImageType *	GetFixedFeatureImage (unsigned int i) const

const FixedFeatureInterpolatorType *	GetFixedFeatureInterpolator () const

const FixedFeatureInterpolatorType *	GetFixedFeatureInterpolator (unsigned int i) const

const MovingFeatureImageType *	GetMovingFeatureImage () const

const MovingFeatureImageType *	GetMovingFeatureImage (unsigned int i) const

const MovingFeatureInterpolatorType *	GetMovingFeatureInterpolator () const

const MovingFeatureInterpolatorType *	GetMovingFeatureInterpolator (unsigned int i) const

virtual unsigned int	GetNumberOfFixedFeatureImages () const

virtual unsigned int	GetNumberOfMovingFeatureImages () const

virtual void	Initialize ()

	ITK_DISALLOW_COPY_AND_MOVE (ImageToImageMetricWithFeatures)

	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)

	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)

void	SetFixedFeatureImage (FixedFeatureImageType *im)

void	SetFixedFeatureImage (unsigned int i, FixedFeatureImageType *im)

void	SetFixedFeatureInterpolator (FixedFeatureInterpolatorType *interpolator)

void	SetFixedFeatureInterpolator (unsigned int i, FixedFeatureInterpolatorType *interpolator)

void	SetMovingFeatureImage (MovingFeatureImageType *im)

void	SetMovingFeatureImage (unsigned int i, MovingFeatureImageType *im)

void	SetMovingFeatureInterpolator (MovingFeatureInterpolatorType *interpolator)

void	SetMovingFeatureInterpolator (unsigned int i, MovingFeatureInterpolatorType *interpolator)

void	SetNumberOfFixedFeatureImages (unsigned int arg)

void	SetNumberOfMovingFeatureImages (unsigned int arg)

Public Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
virtual void	BeforeThreadedGetValueAndDerivative (const TransformParametersType &parameters) const

virtual const FixedImageLimiterType *	GetFixedImageLimiter ()

const FixedImageMaskType *	GetFixedImageMask () const override

virtual double	GetFixedLimitRangeRatio () const

ImageSamplerType *	GetImageSampler () const

virtual const MovingImageDerivativeScalesType &	GetMovingImageDerivativeScales ()

virtual const MovingImageLimiterType *	GetMovingImageLimiter ()

const MovingImageMaskType *	GetMovingImageMask () const override

virtual double	GetMovingLimitRangeRatio () const

virtual double	GetRequiredRatioOfValidSamples () const

virtual bool	GetScaleGradientWithRespectToMovingImageOrientation () const

const AdvancedTransformType *	GetTransform () const override

AdvancedTransformType *	GetTransform () override

virtual bool	GetUseFixedImageLimiter () const

virtual bool	GetUseImageSampler () const

virtual const bool &	GetUseMetricSingleThreaded ()

virtual bool	GetUseMovingImageDerivativeScales () const

virtual bool	GetUseMovingImageLimiter () const

virtual const bool &	GetUseMultiThread ()

void	Initialize () override

	ITK_DISALLOW_COPY_AND_MOVE (AdvancedImageToImageMetric)

	itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)

	itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)

virtual void	SetFixedImageLimiter (FixedImageLimiterType *_arg)

virtual void	SetFixedImageMask (const FixedImageMaskType *const arg)

virtual void	SetFixedLimitRangeRatio (double _arg)

virtual void	SetImageSampler (ImageSamplerType *_arg)

virtual void	SetMovingImageDerivativeScales (MovingImageDerivativeScalesType _arg)

virtual void	SetMovingImageLimiter (MovingImageLimiterType *_arg)

virtual void	SetMovingImageMask (const MovingImageMaskType *const arg)

virtual void	SetMovingLimitRangeRatio (double _arg)

virtual void	SetRequiredRatioOfValidSamples (double _arg)

virtual void	SetScaleGradientWithRespectToMovingImageOrientation (bool _arg)

virtual void	SetTransform (AdvancedTransformType *arg)

virtual void	SetUseMetricSingleThreaded (bool _arg)

virtual void	SetUseMovingImageDerivativeScales (bool _arg)

virtual void	SetUseMultiThread (bool _arg)

virtual void	UseMetricSingleThreadedOff ()

virtual void	UseMetricSingleThreadedOn ()

virtual void	UseMultiThreadOff ()

virtual void	UseMultiThreadOn ()

Protected Types
using	BSplineFeatureInterpolatorVectorType = std::vector< BSplineInterpolatorPointer >

using	BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer

using	BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >

using	FixedImagePointType = typename TransformType::InputPointType

using	MovingImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType

using	MovingImageDerivativeType = typename BSplineInterpolatorType::CovariantVectorType

using	MovingImagePointType = typename TransformType::OutputPointType

Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
using	BSplineInterpolatorFloatPointer = typename BSplineInterpolatorFloatType::Pointer

using	BSplineInterpolatorFloatType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, float >

using	BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer

using	BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >

using	FixedImageIndexType = typename FixedImageType::IndexType

using	FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType

using	FixedImagePointType = typename TransformType::InputPointType

using	LinearInterpolatorPointer = typename LinearInterpolatorType::Pointer

using	LinearInterpolatorType = AdvancedLinearInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >

using	MovingImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType

using	MovingImageDerivativeType = typename BSplineInterpolatorType::CovariantVectorType

using	MovingImageIndexType = typename MovingImageType::IndexType

using	MovingImagePointType = typename TransformType::OutputPointType

using	NonZeroJacobianIndicesType = typename AdvancedTransformType::NonZeroJacobianIndicesType

using	ReducedBSplineInterpolatorPointer = typename ReducedBSplineInterpolatorType::Pointer

using	ReducedBSplineInterpolatorType = ReducedDimensionBSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >

Protected Member Functions
virtual void	CheckForBSplineFeatureInterpolators ()

	ImageToImageMetricWithFeatures ()=default

void	PrintSelf (std::ostream &os, Indent indent) const

virtual	~ImageToImageMetricWithFeatures ()

Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
	AdvancedImageToImageMetric ()

virtual void	AfterThreadedGetValue (MeasureType &) const

virtual void	AfterThreadedGetValueAndDerivative (MeasureType &, DerivativeType &) const

void	CheckForAdvancedTransform ()

void	CheckForBSplineInterpolator ()

void	CheckForBSplineTransform () const

void	CheckNumberOfSamples (unsigned long wanted, unsigned long found) const

virtual bool	EvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient) const

bool	EvaluateTransformJacobian (const FixedImagePointType &fixedImagePoint, TransformJacobianType &jacobian, NonZeroJacobianIndicesType &nzji) const

virtual void	EvaluateTransformJacobianInnerProduct (const TransformJacobianType &jacobian, const MovingImageDerivativeType &movingImageDerivative, DerivativeType &imageJacobian) const

bool	FastEvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient, const ThreadIdType threadId) const

virtual void	InitializeImageSampler ()

void	InitializeLimiters ()

virtual void	InitializeThreadingParameters () const

virtual bool	IsInsideMovingMask (const MovingImagePointType &point) const

	itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedGetValueAndDerivativePerThreadStruct, AlignedGetValueAndDerivativePerThreadStruct)

	itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, GetValueAndDerivativePerThreadStruct, PaddedGetValueAndDerivativePerThreadStruct)

void	LaunchGetValueAndDerivativeThreaderCallback () const

void	LaunchGetValueThreaderCallback () const

void	PrintSelf (std::ostream &os, Indent indent) const override

void	SetFixedImageMask (const typename Superclass::FixedImageMaskType *) final

void	SetFixedImageMask (typename Superclass::FixedImageMaskType *) final

void	SetMovingImageMask (const typename Superclass::MovingImageMaskType *) final

void	SetMovingImageMask (typename Superclass::MovingImageMaskType *) final

virtual void	SetUseFixedImageLimiter (bool _arg)

virtual void	SetUseImageSampler (bool _arg)

virtual void	SetUseMovingImageLimiter (bool _arg)

virtual void	ThreadedGetValue (ThreadIdType) const

virtual void	ThreadedGetValueAndDerivative (ThreadIdType) const

MovingImagePointType	TransformPoint (const FixedImagePointType &fixedImagePoint) const

	~AdvancedImageToImageMetric () override=default

Protected Attributes
std::vector< bool >	m_FeatureInterpolatorsIsBSpline {}

FixedFeatureImageVectorType	m_FixedFeatureImages {}

FixedFeatureInterpolatorVectorType	m_FixedFeatureInterpolators {}

BSplineFeatureInterpolatorVectorType	m_MovingFeatureBSplineInterpolators {}

MovingFeatureImageVectorType	m_MovingFeatureImages {}

MovingFeatureInterpolatorVectorType	m_MovingFeatureInterpolators {}

unsigned int	m_NumberOfFixedFeatureImages { 0 }

unsigned int	m_NumberOfMovingFeatureImages { 0 }

Protected Attributes inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
AdvancedTransformType::Pointer	m_AdvancedTransform { nullptr }

FixedImageLimiterOutputType	m_FixedImageMaxLimit { 1 }

FixedImageLimiterOutputType	m_FixedImageMinLimit { 0 }

FixedImagePixelType	m_FixedImageTrueMax { 1 }

FixedImagePixelType	m_FixedImageTrueMin { 0 }

double	m_FixedLimitRangeRatio { 0.01 }

std::unique_ptr< AlignedGetValueAndDerivativePerThreadStruct[]>	m_GetValueAndDerivativePerThreadVariables

ThreadIdType	m_GetValueAndDerivativePerThreadVariablesSize { 0 }

ImageSamplerPointer	m_ImageSampler { nullptr }

MovingImageLimiterOutputType	m_MovingImageMaxLimit { 1 }

MovingImageLimiterOutputType	m_MovingImageMinLimit { 0 }

MovingImagePixelType	m_MovingImageTrueMax { 1 }

MovingImagePixelType	m_MovingImageTrueMin { 0 }

double	m_MovingLimitRangeRatio { 0.01 }

MultiThreaderParameterType	m_ThreaderMetricParameters {}

bool	m_TransformIsBSpline { false }

bool	m_UseMetricSingleThreaded { true }

bool	m_UseMultiThread { false }

Additional Inherited Members
Static Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	AccumulateDerivativesThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueThreaderCallback (void *arg)