#include <itkMultiInputImageToImageMetricBase.h>

Detailed Description

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

Implements a metric base class that takes multiple inputs.

Definition at line 49 of file itkMultiInputImageToImageMetricBase.h.

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

Public Types
using	ConstPointer = SmartPointer<const Self>
using	FixedImageInterpolatorPointer = typename FixedImageInterpolatorType::Pointer
using	FixedImageInterpolatorType = InterpolateImageFunction<FixedImageType, CoordinateRepresentationType>
using	FixedImageInterpolatorVectorType = std::vector<FixedImageInterpolatorPointer>
using	FixedImageMaskConstPointer
using	FixedImageMaskPointer
using	FixedImageMaskType
using	FixedImageMaskVectorType = std::vector<FixedImageMaskConstPointer>
using	FixedImagePointer
using	FixedImageRegionVectorType = std::vector<FixedImageRegionType>
using	FixedImageVectorType = std::vector<FixedImageConstPointer>
using	InterpolatorVectorType = std::vector<InterpolatorPointer>
using	MovingImageMaskConstPointer
using	MovingImageMaskPointer
using	MovingImageMaskType
using	MovingImageMaskVectorType = std::vector<MovingImageMaskConstPointer>
using	MovingImagePointer
using	MovingImageVectorType = std::vector<MovingImageConstPointer>
using	Pointer = SmartPointer<Self>
using	Self = MultiInputImageToImageMetricBase
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 FixedImageType *	GetFixedImage () const override
virtual const FixedImageType *	GetFixedImage (unsigned int pos) const
virtual FixedImageInterpolatorType *	GetFixedImageInterpolator () const
virtual FixedImageInterpolatorType *	GetFixedImageInterpolator (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
InterpolatorType *	GetInterpolator () override
virtual InterpolatorType *	GetInterpolator (unsigned int pos) const
virtual bool	GetInterpolatorsAreBSpline () 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
virtual unsigned int	GetNumberOfFixedImageInterpolators () const
virtual unsigned int	GetNumberOfFixedImageMasks () const
virtual unsigned int	GetNumberOfFixedImageRegions () const
virtual unsigned int	GetNumberOfFixedImages () const
virtual unsigned int	GetNumberOfInterpolators () const
virtual unsigned int	GetNumberOfMovingImageMasks () const
virtual unsigned int	GetNumberOfMovingImages () const
void	Initialize () override
	ITK_DISALLOW_COPY_AND_MOVE (MultiInputImageToImageMetricBase)
	itkSetNumberOfMacro (FixedImage)
	itkSetNumberOfMacro (FixedImageInterpolator)
	itkSetNumberOfMacro (FixedImageMask)
	itkSetNumberOfMacro (FixedImageRegion)
	itkSetNumberOfMacro (Interpolator)
	itkSetNumberOfMacro (MovingImage)
	itkSetNumberOfMacro (MovingImageMask)
	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)
virtual void	SetFixedImageInterpolator (FixedImageInterpolatorType *_arg)
virtual void	SetFixedImageInterpolator (FixedImageInterpolatorType *_arg, unsigned int pos)
void	SetFixedImageMask (const FixedImageMaskType *_arg) override
virtual void	SetFixedImageMask (const 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	SetMovingImage (const MovingImageType *_arg) override
virtual void	SetMovingImage (const MovingImageType *_arg, unsigned int pos)
void	SetMovingImageMask (const MovingImageMaskType *_arg) override
virtual void	SetMovingImageMask (const MovingImageMaskType *_arg, unsigned int pos)
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	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	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	BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer
using	BSplineInterpolatorType
using	BSplineInterpolatorVectorType = std::vector<BSplineInterpolatorPointer>
using	MovingImageContinuousIndexType
using	MovingImageDerivativeType
using	MovingImageIndexType
using	MovingImagePointType
Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
using	BSplineInterpolatorFloatPointer = typename BSplineInterpolatorFloatType::Pointer
using	BSplineInterpolatorFloatType
using	BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer
using	BSplineInterpolatorType
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

Protected Member Functions
virtual void	CheckForBSplineInterpolators ()
bool	EvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient) const override
void	InitializeImageSampler () override
bool	IsInsideMovingMask (const MovingImagePointType &mappedPoint) const override
	MultiInputImageToImageMetricBase ()=default
	~MultiInputImageToImageMetricBase () override=default
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
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
void	InitializeLimiters ()
virtual void	InitializeThreadingParameters () 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
BSplineInterpolatorVectorType	m_BSplineInterpolatorVector {}
FixedImageInterpolatorVectorType	m_FixedImageInterpolatorVector {}
FixedImageMaskVectorType	m_FixedImageMaskVector {}
FixedImageRegionVectorType	m_FixedImageRegionVector {}
FixedImageVectorType	m_FixedImageVector {}
bool	m_InterpolatorsAreBSpline { false }
InterpolatorVectorType	m_InterpolatorVector {}
MovingImageMaskVectorType	m_MovingImageMaskVector {}
MovingImageVectorType	m_MovingImageVector {}
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 }

Private Member Functions
void	FastEvaluateMovingImageValueAndDerivative (...) const =delete
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

Private Attributes
FixedImageRegionType	m_DummyFixedImageRegion {}
unsigned int	m_NumberOfFixedImageInterpolators { 0 }
unsigned int	m_NumberOfFixedImageMasks { 0 }
unsigned int	m_NumberOfFixedImageRegions { 0 }
unsigned int	m_NumberOfFixedImages { 0 }
unsigned int	m_NumberOfInterpolators { 0 }
unsigned int	m_NumberOfMovingImageMasks { 0 }
unsigned int	m_NumberOfMovingImages { 0 }

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)

Member Typedef Documentation

◆ BSplineInterpolatorPointer

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::BSplineInterpolatorPointer = typename BSplineInterpolatorType::Pointer

protected

Definition at line 371 of file itkMultiInputImageToImageMetricBase.h.

◆ BSplineInterpolatorType

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::BSplineInterpolatorType

protected

Typedefs used for computing image derivatives.

Definition at line 342 of file itkAdvancedImageToImageMetric.h.

◆ BSplineInterpolatorVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::BSplineInterpolatorVectorType = std::vector<BSplineInterpolatorPointer>

protected

Definition at line 372 of file itkMultiInputImageToImageMetricBase.h.

◆ ConstPointer

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 59 of file itkMultiInputImageToImageMetricBase.h.

◆ FixedImageInterpolatorPointer

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::FixedImageInterpolatorPointer = typename FixedImageInterpolatorType::Pointer

Definition at line 101 of file itkMultiInputImageToImageMetricBase.h.

◆ FixedImageInterpolatorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::FixedImageInterpolatorType = InterpolateImageFunction<FixedImageType, CoordinateRepresentationType>

Definition at line 100 of file itkMultiInputImageToImageMetricBase.h.

◆ FixedImageInterpolatorVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::FixedImageInterpolatorVectorType = std::vector<FixedImageInterpolatorPointer>

Definition at line 110 of file itkMultiInputImageToImageMetricBase.h.

◆ FixedImageMaskConstPointer

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskConstPointer

Definition at line 126 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageMaskPointer

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskPointer

Definition at line 125 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageMaskType

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskType

Definition at line 124 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageMaskVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::FixedImageMaskVectorType = std::vector<FixedImageMaskConstPointer>

Definition at line 105 of file itkMultiInputImageToImageMetricBase.h.

◆ FixedImagePointer

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePointer

Definition at line 107 of file itkAdvancedImageToImageMetric.h.

◆ FixedImageRegionVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::FixedImageRegionVectorType = std::vector<FixedImageRegionType>

Definition at line 106 of file itkMultiInputImageToImageMetricBase.h.

◆ FixedImageVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::FixedImageVectorType = std::vector<FixedImageConstPointer>

Typedef's for storing multiple inputs.

Definition at line 104 of file itkMultiInputImageToImageMetricBase.h.

◆ InterpolatorVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::InterpolatorVectorType = std::vector<InterpolatorPointer>

Definition at line 109 of file itkMultiInputImageToImageMetricBase.h.

◆ MovingImageContinuousIndexType

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageContinuousIndexType

protected

Definition at line 339 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageDerivativeType

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeType

protected

Definition at line 353 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageIndexType

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageIndexType

protected

Definition at line 336 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageMaskConstPointer

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskConstPointer

Definition at line 129 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageMaskPointer

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskPointer

Definition at line 128 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageMaskType

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskType

Definition at line 127 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageMaskVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::MovingImageMaskVectorType = std::vector<MovingImageMaskConstPointer>

Definition at line 108 of file itkMultiInputImageToImageMetricBase.h.

◆ MovingImagePointer

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointer

Definition at line 104 of file itkAdvancedImageToImageMetric.h.

◆ MovingImagePointType

template<class TFixedImage, class TMovingImage>

using itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType

protected

Definition at line 338 of file itkAdvancedImageToImageMetric.h.

◆ MovingImageVectorType

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::MovingImageVectorType = std::vector<MovingImageConstPointer>

Definition at line 107 of file itkMultiInputImageToImageMetricBase.h.

◆ Pointer

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 58 of file itkMultiInputImageToImageMetricBase.h.

◆ Self

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::Self = MultiInputImageToImageMetricBase

Standard class typedefs.

Definition at line 56 of file itkMultiInputImageToImageMetricBase.h.

◆ Superclass

template<class TFixedImage, class TMovingImage>

using itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::Superclass = AdvancedImageToImageMetric<TFixedImage, TMovingImage>

Definition at line 57 of file itkMultiInputImageToImageMetricBase.h.

Constructor & Destructor Documentation

◆ MultiInputImageToImageMetricBase()

template<class TFixedImage, class TMovingImage>

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

protecteddefault

Constructor.

◆ ~MultiInputImageToImageMetricBase()

template<class TFixedImage, class TMovingImage>

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

overrideprotecteddefault

Destructor.

Member Function Documentation

◆ CheckForBSplineInterpolators()

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::CheckForBSplineInterpolators ( )

protectedvirtual

Check if all interpolators (for the moving image) are of type BSplineInterpolateImageFunction.

◆ EvaluateMovingImageValueAndDerivative()

template<class TFixedImage, class TMovingImage>

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

overrideprotectedvirtual

Check if mappedPoint is inside all moving images. If so, the moving image value and possibly derivative are computed.

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

◆ FastEvaluateMovingImageValueAndDerivative()

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::FastEvaluateMovingImageValueAndDerivative ( ... ) const

privatedelete

Avoids accidentally calling this->FastEvaluateMovingImageValueAndDerivative(mappedPoint, ..., threadId), when *this is derived from MultiInputImageToImageMetricBase. (The non-virtual member function AdvancedImageToImageMetric::FastEvaluateMovingImageValueAndDerivative does not entirely replace the MultiInputImageToImageMetricBase::EvaluateMovingImageValueAndDerivative override.)

◆ GetClassName()

template<class TFixedImage, class TMovingImage>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

Reimplemented in elastix::KNNGraphAlphaMutualInformationMetric< TElastix >, itk::KNNGraphAlphaMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::KNNGraphAlphaMutualInformationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >, and itk::KNNGraphAlphaMutualInformationImageToImageMetric< typename MetricBase< TElastix >::FixedImageType, typename MetricBase< TElastix >::MovingImageType >.

◆ GetFixedImage() [1/2]

template<class TFixedImage, class TMovingImage>

const FixedImageType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImage ( ) const

inlineoverride

Get the first fixed image.

Definition at line 132 of file itkMultiInputImageToImageMetricBase.h.

◆ GetFixedImage() [2/2]

template<class TFixedImage, class TMovingImage>

virtual const FixedImageType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImage ( unsigned int pos ) const

virtual

Get the fixed images.

◆ GetFixedImageInterpolator() [1/2]

template<class TFixedImage, class TMovingImage>

virtual FixedImageInterpolatorType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImageInterpolator ( ) const

inlinevirtual

Get the first fixed image interpolator.

Definition at line 338 of file itkMultiInputImageToImageMetricBase.h.

◆ GetFixedImageInterpolator() [2/2]

template<class TFixedImage, class TMovingImage>

virtual FixedImageInterpolatorType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImageInterpolator ( unsigned int pos ) const

virtual

Get the fixed image interpolators.

◆ GetFixedImageMask() [1/2]

template<class TFixedImage, class TMovingImage>

const FixedImageMaskType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImageMask ( ) const

inlineoverride

Get the first fixed image mask.

Definition at line 164 of file itkMultiInputImageToImageMetricBase.h.

◆ GetFixedImageMask() [2/2]

template<class TFixedImage, class TMovingImage>

virtual const FixedImageMaskType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImageMask ( unsigned int pos ) const

virtual

Get the fixed image masks.

◆ GetFixedImageRegion() [1/2]

template<class TFixedImage, class TMovingImage>

const FixedImageRegionType & itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImageRegion ( ) const

inlineoverride

Get the first fixed image region.

Definition at line 196 of file itkMultiInputImageToImageMetricBase.h.

◆ GetFixedImageRegion() [2/2]

template<class TFixedImage, class TMovingImage>

virtual const FixedImageRegionType & itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetFixedImageRegion ( unsigned int pos ) const

virtual

Get the fixed image regions.

◆ GetInterpolator() [1/3]

template<class TFixedImage, class TMovingImage>

const InterpolatorType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetInterpolator ( ) const

inlineoverride

Get the first interpolator. Const overload.

Definition at line 301 of file itkMultiInputImageToImageMetricBase.h.

◆ GetInterpolator() [2/3]

template<class TFixedImage, class TMovingImage>

InterpolatorType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetInterpolator ( )

inlineoverride

Get the first interpolator.

Definition at line 294 of file itkMultiInputImageToImageMetricBase.h.

◆ GetInterpolator() [3/3]

template<class TFixedImage, class TMovingImage>

virtual InterpolatorType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetInterpolator ( unsigned int pos ) const

virtual

Get the interpolators.

◆ GetInterpolatorsAreBSpline()

template<class TFixedImage, class TMovingImage>

virtual bool itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetInterpolatorsAreBSpline ( ) const

virtual

A function to check if all moving image interpolators are of type B-spline.

◆ GetMovingImage() [1/2]

template<class TFixedImage, class TMovingImage>

const MovingImageType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetMovingImage ( ) const

inlineoverride

Get the first moving image.

Definition at line 228 of file itkMultiInputImageToImageMetricBase.h.

◆ GetMovingImage() [2/2]

template<class TFixedImage, class TMovingImage>

virtual const MovingImageType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetMovingImage ( unsigned int pos ) const

virtual

Get the moving images.

◆ GetMovingImageMask() [1/2]

template<class TFixedImage, class TMovingImage>

const MovingImageMaskType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetMovingImageMask ( ) const

inlineoverride

Get the first moving image mask.

Definition at line 260 of file itkMultiInputImageToImageMetricBase.h.

◆ GetMovingImageMask() [2/2]

template<class TFixedImage, class TMovingImage>

virtual const MovingImageMaskType * itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetMovingImageMask ( unsigned int pos ) const

virtual

Get the moving image masks.

◆ GetNumberOfFixedImageInterpolators()

template<class TFixedImage, class TMovingImage>

virtual unsigned int itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetNumberOfFixedImageInterpolators ( ) const

virtual

Get the number of fixed image interpolators.

◆ GetNumberOfFixedImageMasks()

template<class TFixedImage, class TMovingImage>

virtual unsigned int itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetNumberOfFixedImageMasks ( ) const

virtual

Get the number of fixed image masks.

◆ GetNumberOfFixedImageRegions()

template<class TFixedImage, class TMovingImage>

virtual unsigned int itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetNumberOfFixedImageRegions ( ) const

virtual

Get the number of fixed image regions.

◆ GetNumberOfFixedImages()

template<class TFixedImage, class TMovingImage>

virtual unsigned int itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetNumberOfFixedImages ( ) const

virtual

Get the number of fixed images.

◆ GetNumberOfInterpolators()

template<class TFixedImage, class TMovingImage>

virtual unsigned int itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetNumberOfInterpolators ( ) const

virtual

Get the number of interpolators.

◆ GetNumberOfMovingImageMasks()

template<class TFixedImage, class TMovingImage>

virtual unsigned int itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetNumberOfMovingImageMasks ( ) const

virtual

Get the number of moving image masks.

◆ GetNumberOfMovingImages()

template<class TFixedImage, class TMovingImage>

virtual unsigned int itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::GetNumberOfMovingImages ( ) const

virtual

Get the number of moving images.

◆ Initialize()

template<class TFixedImage, class TMovingImage>

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

override

******************** Other public functions ******************** Initialisation.

◆ InitializeImageSampler()

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::InitializeImageSampler ( )

overrideprotectedvirtual

Initialize variables related to the image sampler; called by Initialize.

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

◆ IsInsideMovingMask()

template<class TFixedImage, class TMovingImage>

bool itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::IsInsideMovingMask ( const MovingImagePointType & mappedPoint ) const

overrideprotectedvirtual

IsInsideMovingMask: Returns the AND of all moving image masks.

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::ITK_DISALLOW_COPY_AND_MOVE ( MultiInputImageToImageMetricBase< TFixedImage, TMovingImage > )

◆ itkSetNumberOfMacro() [1/7]

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::itkSetNumberOfMacro ( FixedImage )

Set the number of fixed images.

◆ itkSetNumberOfMacro() [2/7]

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::itkSetNumberOfMacro ( FixedImageInterpolator )

Set the number of fixed image interpolators.

◆ itkSetNumberOfMacro() [3/7]

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::itkSetNumberOfMacro ( FixedImageMask )

Set the number of fixed image masks.

◆ itkSetNumberOfMacro() [4/7]

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::itkSetNumberOfMacro ( FixedImageRegion )

Set the number of fixed image regions.

◆ itkSetNumberOfMacro() [5/7]

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::itkSetNumberOfMacro ( Interpolator )

Set the number of interpolators.

◆ itkSetNumberOfMacro() [6/7]

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::itkSetNumberOfMacro ( MovingImage )

Set the number of moving images.

◆ itkSetNumberOfMacro() [7/7]

template<class TFixedImage, class TMovingImage>

itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::itkSetNumberOfMacro ( MovingImageMask )

Set the number of moving image masks.

◆ itkStaticConstMacro() [1/2]

template<class TFixedImage, class TMovingImage>

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

◆ itkStaticConstMacro() [2/2]

template<class TFixedImage, class TMovingImage>

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

Constants for the image dimensions

◆ SetFixedImage() [1/2]

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImage ( const FixedImageType * _arg )

inlineoverride

Set the first fixed image.

Definition at line 120 of file itkMultiInputImageToImageMetricBase.h.

◆ SetFixedImage() [2/2]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImage	(	const FixedImageType *	_arg,
		unsigned int	pos )

virtual

******************** Fixed images ******************** Set the fixed images.

◆ SetFixedImageInterpolator() [1/2]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImageInterpolator ( FixedImageInterpolatorType * _arg )

inlinevirtual

Set the first fixed image interpolator.

Definition at line 326 of file itkMultiInputImageToImageMetricBase.h.

◆ SetFixedImageInterpolator() [2/2]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImageInterpolator	(	FixedImageInterpolatorType *	_arg,
		unsigned int	pos )

virtual

******************** FixedImageInterpolators ******************** These interpolators are used for the fixed images. Set the fixed image interpolators.

◆ SetFixedImageMask() [1/4]

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImageMask ( const FixedImageMaskType * _arg )

inlineoverridevirtual

Set the first fixed image mask.

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 152 of file itkMultiInputImageToImageMetricBase.h.

◆ SetFixedImageMask() [2/4]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImageMask	(	const FixedImageMaskType *	_arg,
		unsigned int	pos )

virtual

******************** Fixed image masks ******************** Set the fixed image masks.

◆ SetFixedImageMask() [3/4]

template<class TFixedImage, class TMovingImage>

void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageMask ( const typename Superclass::FixedImageMaskType * )

inlinefinalprivate

Definition at line 580 of file itkAdvancedImageToImageMetric.h.

◆ SetFixedImageMask() [4/4]

template<class TFixedImage, class TMovingImage>

void itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageMask ( typename Superclass::FixedImageMaskType * )

inlinefinalprivate

Definition at line 574 of file itkAdvancedImageToImageMetric.h.

◆ SetFixedImageRegion() [1/2]

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImageRegion ( const FixedImageRegionType _arg )

inlineoverride

Set the first fixed image region.

Definition at line 184 of file itkMultiInputImageToImageMetricBase.h.

◆ SetFixedImageRegion() [2/2]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetFixedImageRegion	(	const FixedImageRegionType	_arg,
		unsigned int	pos )

virtual

******************** Fixed image regions ******************** Set the fixed image regions.

◆ SetInterpolator() [1/2]

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetInterpolator ( InterpolatorType * _arg )

inlineoverride

Set the first interpolator.

Definition at line 282 of file itkMultiInputImageToImageMetricBase.h.

◆ SetInterpolator() [2/2]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetInterpolator	(	InterpolatorType *	_arg,
		unsigned int	pos )

virtual

******************** Interpolators ******************** These interpolators are used for the moving images. Set the interpolators.

◆ SetMovingImage() [1/2]

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetMovingImage ( const MovingImageType * _arg )

inlineoverride

Set the first moving image.

Definition at line 216 of file itkMultiInputImageToImageMetricBase.h.

◆ SetMovingImage() [2/2]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetMovingImage	(	const MovingImageType *	_arg,
		unsigned int	pos )

virtual

******************** Moving images ******************** Set the moving images.

◆ SetMovingImageMask() [1/4]

template<class TFixedImage, class TMovingImage>

void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetMovingImageMask ( const MovingImageMaskType * _arg )

inlineoverridevirtual

Set the first moving image mask.

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 248 of file itkMultiInputImageToImageMetricBase.h.

◆ SetMovingImageMask() [2/4]

template<class TFixedImage, class TMovingImage>

virtual void itk::MultiInputImageToImageMetricBase< TFixedImage, TMovingImage >::SetMovingImageMask	(	const MovingImageMaskType *	_arg,
		unsigned int	pos )