#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 39 of file itkImageToImageMetricWithFeatures.h.

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

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType

typedef Superclass::DerivativeType	DerivativeType

typedef FixedFeatureImageType::Pointer	FixedFeatureImagePointer

typedef TFixedFeatureImage	FixedFeatureImageType

typedef std::vector< FixedFeatureImagePointer >	FixedFeatureImageVectorType

typedef FixedFeatureInterpolatorType::Pointer	FixedFeatureInterpolatorPointer

typedef InterpolateImageFunction< FixedFeatureImageType, double >	FixedFeatureInterpolatorType

typedef std::vector< FixedFeatureInterpolatorPointer >	FixedFeatureInterpolatorVectorType

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::InternalMaskPixelType	InternalMaskPixelType

typedef Superclass::InternalMovingImageMaskType	InternalMovingImageMaskType

typedef Superclass::InterpolatorPointer	InterpolatorPointer

typedef Superclass::InterpolatorType	InterpolatorType

typedef Superclass::MeasureType	MeasureType

typedef MovingFeatureImageType::Pointer	MovingFeatureImagePointer

typedef TMovingFeatureImage	MovingFeatureImageType

typedef std::vector< MovingFeatureImagePointer >	MovingFeatureImageVectorType

typedef MovingFeatureInterpolatorType::Pointer	MovingFeatureInterpolatorPointer

typedef InterpolateImageFunction< MovingFeatureImageType, double >	MovingFeatureInterpolatorType

typedef std::vector< MovingFeatureInterpolatorPointer >	MovingFeatureInterpolatorVectorType

typedef Superclass::MovingImageConstPointer	MovingImageConstPointer

typedef Superclass::MovingImageLimiterOutputType	MovingImageLimiterOutputType

typedef Superclass::MovingImageLimiterType	MovingImageLimiterType

typedef Superclass::MovingImageMaskInterpolatorType	MovingImageMaskInterpolatorType

typedef Superclass::MovingImageMaskPointer	MovingImageMaskPointer

typedef Superclass::MovingImageMaskType	MovingImageMaskType

typedef Superclass::MovingImagePixelType	MovingImagePixelType

typedef Superclass::MovingImageRegionType	MovingImageRegionType

typedef Superclass::MovingImageType	MovingImageType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RealType	RealType

typedef ImageToImageMetricWithFeatures	Self

typedef AdvancedImageToImageMetric< TFixedImage, TMovingImage >	Superclass

typedef Superclass::TransformJacobianType	TransformJacobianType

typedef Superclass::TransformParametersType	TransformParametersType

typedef Superclass::TransformPointer	TransformPointer

typedef Superclass::TransformType	TransformType

Public Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
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 const char *	GetClassName () const

const FixedFeatureImageType *	GetFixedFeatureImage (unsigned int i) const

const FixedFeatureImageType *	GetFixedFeatureImage (void) const

const FixedFeatureInterpolatorType *	GetFixedFeatureInterpolator (unsigned int i) const

const FixedFeatureInterpolatorType *	GetFixedFeatureInterpolator (void) const

const MovingFeatureImageType *	GetMovingFeatureImage (unsigned int i) const

const MovingFeatureImageType *	GetMovingFeatureImage (void) const

const MovingFeatureInterpolatorType *	GetMovingFeatureInterpolator (unsigned int i) const

const MovingFeatureInterpolatorType *	GetMovingFeatureInterpolator (void) const

virtual unsigned int	GetNumberOfFixedFeatureImages () const

virtual unsigned int	GetNumberOfMovingFeatureImages () const

virtual void	Initialize (void)

	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 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 std::vector< BSplineInterpolatorPointer >	BSplineFeatureInterpolatorVectorType

typedef BSplineInterpolatorType::Pointer	BSplineInterpolatorPointer

typedef Superclass::BSplineInterpolatorType	BSplineInterpolatorType

typedef Superclass::FixedImagePointType	FixedImagePointType

typedef Superclass::MovingImageContinuousIndexType	MovingImageContinuousIndexType

typedef Superclass::MovingImageDerivativeType	MovingImageDerivativeType

typedef Superclass::MovingImagePointType	MovingImagePointType

Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
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
virtual void	CheckForBSplineFeatureInterpolators (void)

	ImageToImageMetricWithFeatures ()

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

virtual	~ImageToImageMetricWithFeatures ()

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

virtual void	AfterThreadedGetValue (MeasureType &value) const

virtual void	AfterThreadedGetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const

virtual void	CheckForAdvancedTransform (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 Attributes
bool	m_FeatureInterpolatorsAreBSpline

std::vector< bool >	m_FeatureInterpolatorsIsBSpline

FixedFeatureImageVectorType	m_FixedFeatureImages

FixedFeatureInterpolatorVectorType	m_FixedFeatureInterpolators

BSplineFeatureInterpolatorVectorType	m_MovingFeatureBSplineInterpolators

MovingFeatureImageVectorType	m_MovingFeatureImages

MovingFeatureInterpolatorVectorType	m_MovingFeatureInterpolators

unsigned int	m_NumberOfFixedFeatureImages

unsigned int	m_NumberOfMovingFeatureImages

Protected Attributes inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
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
	ImageToImageMetricWithFeatures (const Self &)

void	operator= (const Self &)

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)