#include <itkCombinationImageToImageMetric.h>

Detailed Description

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

Combines multiple metrics.

This metric is meant to be used in the MultiMetricMultiResolutionImageRegistrationMethod.

NB: while it may seem not logical that the SetInterpolator(arg) sets the interpolator in all submetrics whereas the GetInterpolator() returns GetInterpolator(0) it is logical. If you set the interpolator the same in all metrics, you will receive the correct interpolator with GetInterpolator(0). If you set the interpolator differently in all metrics, the most logical action is to return GetInterpolator(0) when GetInterpolator() is invoked.

Note: If you use Set{Transform,Interpolator etc}(0) or Set{Transform,Interpolator}(), the member variables of the superclass m_{Transform,Interpolator} are set as well. So, it is not strictly necessary to reimplement the functions Get{Transform,Interpolator}(), which return Get{Transform,Interpolator}(0), which would result in the same as returning m_{Transform,Interpolator} anyway. However, if Metric[0] is changed externally the m_{Transform, Interpolator} are not up to date anymore. That's why we chose to reimplement the Get{Transform,Interpolator}() methods.

Definition at line 59 of file itkCombinationImageToImageMetric.h.

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

[legend]

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DerivativeValueType = typename DerivativeType::ValueType

using	FixedImagePixelType = typename FixedImageType::PixelType

using	FixedPointSetType = PointSet< CoordinateRepresentationType, TFixedImage::ImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, TFixedImage::ImageDimension, TFixedImage::ImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >

using	HessianType = vnl_sparse_matrix< HessianValueType >

using	HessianValueType = typename DerivativeType::ValueType

using	ImageMetricPointer = typename ImageMetricType::Pointer

using	ImageMetricType = Superclass

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

using	MovingImageRegionType = typename MovingImageType::RegionType

using	MovingPointSetType = PointSet< CoordinateRepresentationType, TMovingImage::ImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, TMovingImage::ImageDimension, TMovingImage::ImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >

using	Pointer = SmartPointer< Self >

using	PointSetMetricType = SingleValuedPointSetToPointSetMetric< FixedPointSetType, MovingPointSetType >

using	Self = CombinationImageToImageMetric

using	SingleValuedCostFunctionPointer = typename SingleValuedCostFunctionType::Pointer

using	SingleValuedCostFunctionType = SingleValuedCostFunction

using	Superclass = AdvancedImageToImageMetric< TFixedImage, TMovingImage >

using	ThreaderType = itk::PlatformMultiThreader

using	ThreadInfoType = typename ThreaderType::WorkUnitInfo

using	TransformPointer = typename TransformType::Pointer

using	TransformType = typename Superclass::AdvancedTransformType

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	FixedImageMaskSpatialObject2Type = ImageMaskSpatialObject< Self::FixedImageDimension >

using	FixedImagePixelType = typename FixedImageType::PixelType

using	FixedImagePointer = typename FixedImageType::Pointer

using	HessianType = vnl_sparse_matrix< HessianValueType >

using	HessianValueType = typename DerivativeType::ValueType

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	MovingImageMaskSpatialObject2Type = 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	ThreaderType = itk::PlatformMultiThreader

using	ThreadInfoType = typename ThreaderType::WorkUnitInfo

Public Member Functions
virtual const char *	GetClassName () const

void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override

const FixedImageType *	GetFixedImage () const override

virtual const FixedImageType *	GetFixedImage (unsigned int pos) const

const FixedImageMaskType *	GetFixedImageMask () const override

virtual const FixedImageMaskType *	GetFixedImageMask (unsigned int pos) const

const FixedImageRegionType &	GetFixedImageRegion () const override

virtual const FixedImageRegionType &	GetFixedImageRegion (unsigned int pos) const

const InterpolatorType *	GetInterpolator () const override

virtual const InterpolatorType *	GetInterpolator (unsigned int pos) const

SingleValuedCostFunctionType *	GetMetric (unsigned int count) const

double	GetMetricComputationTime (unsigned int pos) const

const DerivativeType &	GetMetricDerivative (unsigned int pos) const

double	GetMetricDerivativeMagnitude (unsigned int pos) const

double	GetMetricRelativeWeight (unsigned int pos) const

MeasureType	GetMetricValue (unsigned int pos) const

double	GetMetricWeight (unsigned int pos) const

const MovingImageType *	GetMovingImage () const override

virtual const MovingImageType *	GetMovingImage (unsigned int pos) const

const MovingImageMaskType *	GetMovingImageMask () const override

virtual const MovingImageMaskType *	GetMovingImageMask (unsigned int pos) const

ModifiedTimeType	GetMTime () const override

virtual unsigned int	GetNumberOfMetrics () const

const SizeValueType &	GetNumberOfPixelsCounted () const override

void	GetSelfHessian (const TransformParametersType &parameters, HessianType &H) const override

const TransformType *	GetTransform () const override

virtual const TransformType *	GetTransform (unsigned int pos) const

bool	GetUseMetric (const unsigned int pos) const

virtual bool	GetUseRelativeWeights () const

MeasureType	GetValue (const ParametersType &parameters) const override

void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override

void	Initialize () override

	ITK_DISALLOW_COPY_AND_MOVE (CombinationImageToImageMetric)

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

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

void	SetFixedImage (const FixedImageType *_arg) override

virtual void	SetFixedImage (const FixedImageType *_arg, unsigned int pos)

void	SetFixedImageMask (FixedImageMaskType *_arg) override

virtual void	SetFixedImageMask (FixedImageMaskType *_arg, unsigned int pos)

void	SetFixedImageRegion (const FixedImageRegionType _arg) override

virtual void	SetFixedImageRegion (const FixedImageRegionType _arg, unsigned int pos)

void	SetInterpolator (InterpolatorType *_arg) override

virtual void	SetInterpolator (InterpolatorType *_arg, unsigned int pos)

void	SetMetric (SingleValuedCostFunctionType *metric, unsigned int pos)

void	SetMetricRelativeWeight (double weight, unsigned int pos)

void	SetMetricWeight (double weight, unsigned int pos)

void	SetMovingImage (const MovingImageType *_arg) override

virtual void	SetMovingImage (const MovingImageType *_arg, unsigned int pos)

void	SetMovingImageMask (MovingImageMaskType *_arg) override

virtual void	SetMovingImageMask (MovingImageMaskType *_arg, unsigned int pos)

void	SetNumberOfMetrics (unsigned int count)

void	SetTransform (TransformType *_arg) override

virtual void	SetTransform (TransformType *_arg, unsigned int pos)

void	SetUseAllMetrics ()

void	SetUseMetric (const bool use, const unsigned int pos)

virtual void	SetUseRelativeWeights (bool _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 () 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 () 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 () 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	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 ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	CombinationImageToImageMetric ()

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

	~CombinationImageToImageMetric () override=default

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 ()

virtual void	CheckForBSplineInterpolator ()

virtual void	CheckForBSplineTransform () 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

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

virtual void	InitializeImageSampler ()

virtual void	InitializeLimiters ()

virtual void	InitializeThreadingParameters () 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 () const

void	LaunchGetValueThreaderCallback () 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)

MovingImagePointType	TransformPoint (const FixedImagePointType &fixedImagePoint) const

	~AdvancedImageToImageMetric () override=default

Protected Attributes
std::vector< double >	m_MetricComputationTime

std::vector< DerivativeType >	m_MetricDerivatives

std::vector< double >	m_MetricDerivativesMagnitude

std::vector< double >	m_MetricRelativeWeights

std::vector< SingleValuedCostFunctionPointer >	m_Metrics

std::vector< MeasureType >	m_MetricValues

std::vector< double >	m_MetricWeights

DerivativeType	m_NullDerivative

FixedImageRegionType	m_NullFixedImageRegion

unsigned int	m_NumberOfMetrics

std::vector< bool >	m_UseMetric

bool	m_UseRelativeWeights

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

BSplineInterpolatorPointer	m_BSplineInterpolator { nullptr }

BSplineInterpolatorFloatPointer	m_BSplineInterpolatorFloat { nullptr }

CentralDifferenceGradientFilterPointer	m_CentralDifferenceGradientFilter { nullptr }

FixedImageLimiterPointer	m_FixedImageLimiter { 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 }

std::unique_ptr< AlignedGetValuePerThreadStruct[]>	m_GetValuePerThreadVariables { nullptr }

ThreadIdType	m_GetValuePerThreadVariablesSize { 0 }

ImageSamplerPointer	m_ImageSampler { nullptr }

bool	m_InterpolatorIsBSpline { false }

bool	m_InterpolatorIsBSplineFloat { false }

bool	m_InterpolatorIsLinear { false }

bool	m_InterpolatorIsReducedBSpline { false }

LinearInterpolatorPointer	m_LinearInterpolator { nullptr }

MovingImageLimiterPointer	m_MovingImageLimiter { nullptr }

MovingImageLimiterOutputType	m_MovingImageMaxLimit { 1 }

MovingImageLimiterOutputType	m_MovingImageMinLimit { 0 }

MovingImagePixelType	m_MovingImageTrueMax { 1 }

MovingImagePixelType	m_MovingImageTrueMin { 0 }

double	m_MovingLimitRangeRatio { 0.01 }

ReducedBSplineInterpolatorPointer	m_ReducedBSplineInterpolator { nullptr }

MultiThreaderParameterType	m_ThreaderMetricParameters

bool	m_TransformIsAdvanced { false }

bool	m_TransformIsBSpline { false }

bool	m_UseMetricSingleThreaded { true }

bool	m_UseMultiThread { false }

bool	m_UseOpenMP

Private Member Functions
double	GetFinalMetricWeight (unsigned int pos) const

void	InitializeThreadingParameters () const override

Additional Inherited Members
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	CentralDifferenceGradientFilterPointer = typename CentralDifferenceGradientFilterType::Pointer

using	CentralDifferenceGradientFilterType = GradientImageFilter< MovingImageType, RealType, RealType >

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 >

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)