elastix::PCAMetric< TElastix > Class Template Reference

#include <elxPCAMetric.h>

Detailed Description

template<class TElastix>
class elastix::PCAMetric< TElastix >

• This metric is based on the AdvancedImageToImageMetric. It is templated over the type of the fixed and moving images to be compared.

This metric computes the sum of variances over the slowest varying dimension in the moving image. The spatial positions of the moving image are established through a Transform. Pixel values are taken from the Moving image.

This implementation is based on the AdvancedImageToImageMetric, which means that:

• It uses the ImageSampler-framework
• It makes use of the compact support of B-splines, in case of B-spline transforms.
• Image derivatives are computed using either the B-spline interpolator's implementation or by nearest neighbor interpolation of a precomputed central difference image.
• A minimum number of samples that should map within the moving image (mask) can be specified.

Parameters:

SampleLastDimensionRandomly: randomly sample a number of time points to to compute the variance from. When set to "false", all time points are taken into account. When set to "true", a random number of time points is selected, which can be set with parameter NumSamplesLastDimension.

NumSamplesLastDimension: the number of random samples to take in the time time direction of the data when SampleLastDimensionRandomly is set to true.

SubtractMean: subtract the over time computed mean parameter value from each parameter. This should be used when registration is performed directly on the moving image, without using a fixed image. Possible values are "true" or "false".

NumEigenValues: number of eigenvalues used in the metric: sum(e) - e, where sum(e) is the sum of all eigenvalues and e is the sum of the first highest NumEigenValues eigenvalues.

Definition at line 63 of file elxPCAMetric.h.

Inheritance diagram for elastix::PCAMetric< TElastix >:

Public Types
using	BSplineTransformBaseType = itk::AdvancedBSplineDeformableTransformBase< ScalarType, FixedImageDimension >
using	CombinationTransformType = itk::AdvancedCombinationTransform< ScalarType, FixedImageDimension >
using	ConstPointer = itk::SmartPointer< const Self >
using	FixedImageSizeType = typename FixedImageRegionType::SizeType
using	FixedImageSizeType = typename FixedImageRegionType::SizeType
using	ITKBaseType = typename Superclass2::ITKBaseType
using	Pointer = itk::SmartPointer< Self >
using	ReducedDimensionBSplineTransformBaseType = itk::AdvancedBSplineDeformableTransformBase< ScalarType, FixedImageDimension - 1 >
using	Self = PCAMetric
using	StackTransformType = itk::StackTransform< ScalarType, FixedImageDimension, MovingImageDimension >
using	Superclass1 = itk::PCAMetric< typename MetricBase< TElastix >::FixedImageType, typename MetricBase< TElastix >::MovingImageType >
using	Superclass2 = MetricBase< TElastix >
Public Types inherited from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
using	ConstPointer = SmartPointer< const Self >
using	ConstPointer = SmartPointer< const Self >
using	DerivativeMatrixType = vnl_matrix< DerivativeValueType >
using	DerivativeValueType = typename DerivativeType::ValueType
using	FixedImageLimiterOutputType = typename FixedImageLimiterType::OutputType
using	FixedImageLimiterOutputType = typename FixedImageLimiterType::OutputType
using	FixedImageLimiterType = LimiterFunctionBase< RealType, FixedImageDimension >
using	FixedImageLimiterType = LimiterFunctionBase< RealType, FixedImageDimension >
using	FixedImagePixelType = typename FixedImageType::PixelType
using	FixedImagePixelType = typename FixedImageType::PixelType
using	FixedImageSizeType = typename FixedImageRegionType::SizeType
using	FixedImageSizeType = typename FixedImageRegionType::SizeType
using	ImageSampleContainerPointer = typename ImageSamplerType::OutputVectorContainerPointer
using	ImageSampleContainerPointer = typename ImageSamplerType::OutputVectorContainerPointer
using	ImageSampleContainerType = typename ImageSamplerType::OutputVectorContainerType
using	ImageSampleContainerType = typename ImageSamplerType::OutputVectorContainerType
using	ImageSamplerPointer = typename ImageSamplerType::Pointer
using	ImageSamplerPointer = typename ImageSamplerType::Pointer
using	ImageSamplerType = ImageSamplerBase< FixedImageType >
using	ImageSamplerType = ImageSamplerBase< FixedImageType >
using	MatrixType = vnl_matrix< RealType >
using	MovingImageDerivativeScalesType = FixedArray< double, Self::MovingImageDimension >
using	MovingImageDerivativeScalesType = FixedArray< double, Self::MovingImageDimension >
using	MovingImageLimiterOutputType = typename MovingImageLimiterType::OutputType
using	MovingImageLimiterOutputType = typename MovingImageLimiterType::OutputType
using	MovingImageLimiterType = LimiterFunctionBase< RealType, MovingImageDimension >
using	MovingImageLimiterType = LimiterFunctionBase< RealType, MovingImageDimension >
using	MovingImageRegionType = typename MovingImageType::RegionType
using	MovingImageRegionType = typename MovingImageType::RegionType
using	Pointer = SmartPointer< Self >
using	Pointer = SmartPointer< Self >
using	Self = PCAMetric
using	Self = PCAMetric
using	Superclass = AdvancedImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
using	Superclass = AdvancedImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
using	ThreaderType = itk::PlatformMultiThreader
using	ThreadInfoType = typename ThreaderType::WorkUnitInfo
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 Types inherited from elastix::MetricBase< TElastix >
using	AdvancedMetricType = itk::AdvancedImageToImageMetric< FixedImageType, MovingImageType >
using	CoordinateRepresentationType = typename ITKBaseType::ParametersValueType
using	ElastixType = TElastix
using	FixedImageType = typename ElastixType::FixedImageType
using	FixedPointSetType = itk::PointSet< CoordinateRepresentationType, FixedImageDimension, itk::DefaultStaticMeshTraits< CoordinateRepresentationType, FixedImageDimension, FixedImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >
using	FixedPointType = typename FixedImageType::PointType
using	FixedPointValueType = typename FixedPointType::ValueType
using	ImageSamplerBaseType = typename AdvancedMetricType::ImageSamplerType
using	ITKBaseType = itk::SingleValuedCostFunction
using	MeasureType = typename ITKBaseType::MeasureType
using	MovingImageDerivativeScalesType = typename AdvancedMetricType::MovingImageDerivativeScalesType
using	MovingImageType = typename ElastixType::MovingImageType
using	MovingPointSetType = itk::PointSet< CoordinateRepresentationType, MovingImageDimension, itk::DefaultStaticMeshTraits< CoordinateRepresentationType, MovingImageDimension, MovingImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >
using	MovingPointType = typename MovingImageType::PointType
using	MovingPointValueType = typename MovingPointType::ValueType
using	RegistrationType = typename ElastixType::RegistrationBaseType
using	Self = MetricBase
using	Superclass = BaseComponentSE< TElastix >
Public Types inherited from elastix::BaseComponentSE< TElastix >
using	ConfigurationPointer = Configuration::Pointer
using	ElastixType = TElastix
using	RegistrationType = typename ElastixType::RegistrationBaseType
using	Self = BaseComponentSE
using	Superclass = BaseComponent

Public Member Functions
void	BeforeEachResolution () override
	elxClassNameMacro ("PCAMetric")
virtual const char *	GetClassName () const
void	Initialize () override
	ITK_DISALLOW_COPY_AND_MOVE (PCAMetric)
	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
Public Member Functions inherited from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
virtual const char *	GetClassName () const
virtual const char *	GetClassName () const
virtual void	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const
void	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const override
virtual int	GetNumSamplesLastDimension () const
virtual bool	GetSampleLastDimensionRandomly () const
virtual MeasureType	GetValue (const TransformParametersType &parameters) const
MeasureType	GetValue (const TransformParametersType &parameters) const override
virtual void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override
void	GetValueAndDerivativeSingleThreaded (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
virtual void	Initialize ()
void	Initialize () override
	ITK_DISALLOW_COPY_AND_MOVE (PCAMetric)
	ITK_DISALLOW_COPY_AND_MOVE (PCAMetric)
	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void	SetDeNoise (bool _arg)
virtual void	SetGridSize (FixedImageSizeType _arg)
virtual void	SetGridSize (FixedImageSizeType _arg)
virtual void	SetNumAdditionalSamplesFixed (unsigned int _arg)
virtual void	SetNumEigenValues (unsigned int _arg)
virtual void	SetNumEigenValues (unsigned int _arg)
virtual void	SetNumSamplesLastDimension (unsigned int _arg)
virtual void	SetReducedDimensionIndex (unsigned int _arg)
virtual void	SetSampleLastDimensionRandomly (bool _arg)
virtual void	SetSubtractMean (bool _arg)
virtual void	SetSubtractMean (bool _arg)
virtual void	SetTransformIsStackTransform (bool _arg)
virtual void	SetTransformIsStackTransform (bool _arg)
virtual void	SetUseDerivativeOfMean (bool _arg)
virtual void	SetVarNoise (double _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 ()
Public Member Functions inherited from elastix::MetricBase< TElastix >
void	AfterEachIterationBase () override
void	BeforeEachResolutionBase () override
virtual ImageSamplerBaseType *	GetAdvancedMetricImageSampler () const
virtual bool	GetAdvancedMetricUseImageSampler () const
ITKBaseType *	GetAsITKBaseType ()
const ITKBaseType *	GetAsITKBaseType () const
virtual const char *	GetClassName () const
virtual MeasureType	GetCurrentExactMetricValue () const
virtual bool	GetShowExactMetricValue () const
	ITK_DISALLOW_COPY_AND_MOVE (MetricBase)
	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void	SelectNewSamples ()
virtual void	SetAdvancedMetricImageSampler (ImageSamplerBaseType *sampler)
Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
void	AddTargetCellToIterationInfo (const char *const name)
Configuration *	GetConfiguration () const
ElastixType *	GetElastix () const
xl::xoutbase &	GetIterationInfoAt (const char *const name)
RegistrationType *	GetRegistration () const
	ITK_DISALLOW_COPY_AND_MOVE (BaseComponentSE)
int	RemoveTargetCellFromIterationInfo (const char *const name)
void	SetConfiguration (Configuration *_arg)
void	SetElastix (ElastixType *_arg)
Public Member Functions inherited from elastix::BaseComponent
virtual void	AfterEachIteration ()
virtual void	AfterEachIterationBase ()
virtual void	AfterEachResolution ()
virtual void	AfterEachResolutionBase ()
virtual void	AfterRegistration ()
virtual void	AfterRegistrationBase ()
virtual int	BeforeAll ()
virtual int	BeforeAllBase ()
virtual void	BeforeEachResolution ()
virtual void	BeforeEachResolutionBase ()
virtual void	BeforeRegistration ()
virtual void	BeforeRegistrationBase ()
virtual const char *	elxGetClassName () const
const char *	GetComponentLabel () const
	ITK_DISALLOW_COPY_AND_MOVE (BaseComponent)
	itkTypeMacroNoParent (BaseComponent)
void	SetComponentLabel (const char *label, unsigned int idx)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
static Pointer	New ()
static Pointer	New ()
Static Public Member Functions inherited from elastix::BaseComponent
template<typename TBaseComponent >
static auto	AsITKBaseType (TBaseComponent *const baseComponent) -> decltype(baseComponent->GetAsITKBaseType())
static void	InitializeElastixExecutable ()
static bool	IsElastixLibrary ()

Protected Member Functions
	PCAMetric ()=default
	~PCAMetric () override=default
Protected Member Functions inherited from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
void	AfterThreadedComputeDerivative (DerivativeType &derivative) const
void	AfterThreadedGetSamples (MeasureType &value) const
void	EvaluateTransformJacobianInnerProduct (const TransformJacobianType &jacobian, const MovingImageDerivativeType &movingImageDerivative, DerivativeType &imageJacobian) const
void	EvaluateTransformJacobianInnerProduct (const TransformJacobianType &jacobian, const MovingImageDerivativeType &movingImageDerivative, DerivativeType &imageJacobian) const override
void	InitializeThreadingParameters () const override
void	LaunchComputeDerivativeThreaderCallback () const
void	LaunchGetSamplesThreaderCallback () const
	PCAMetric ()
	PCAMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
void	ThreadedComputeDerivative (ThreadIdType threadID)
void	ThreadedGetSamples (ThreadIdType threadID)
virtual	~PCAMetric ()
	~PCAMetric () 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 Member Functions inherited from elastix::MetricBase< TElastix >
virtual MeasureType	GetExactValue (const ParametersType &parameters)
	MetricBase ()=default
	~MetricBase () override=default
Protected Member Functions inherited from elastix::BaseComponentSE< TElastix >
	BaseComponentSE ()=default
	~BaseComponentSE () override=default
Protected Member Functions inherited from elastix::BaseComponent
	BaseComponent ()=default
virtual	~BaseComponent ()=default

Private Attributes
	elxOverrideGetSelfMacro

Additional Inherited Members
Protected Types inherited from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
using	BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >
using	BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, double >
using	CentralDifferenceGradientFilterType = GradientImageFilter< MovingImageType, RealType, RealType >
using	CentralDifferenceGradientFilterType = GradientImageFilter< MovingImageType, RealType, RealType >
using	FixedImageContinuousIndexType = typename itk::ContinuousIndex< CoordinateRepresentationType, FixedImageDimension >
using	FixedImageContinuousIndexType = typename itk::ContinuousIndex< CoordinateRepresentationType, FixedImageDimension >
using	FixedImageIndexType = typename FixedImageType::IndexType
using	FixedImageIndexType = typename FixedImageType::IndexType
using	FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
using	FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
using	FixedImagePointType = typename TransformType::InputPointType
using	FixedImagePointType = typename TransformType::InputPointType
using	MovingImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType
using	MovingImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType
using	MovingImageDerivativeType = typename BSplineInterpolatorType::CovariantVectorType
using	MovingImageDerivativeType = typename BSplineInterpolatorType::CovariantVectorType
using	MovingImageIndexType = typename MovingImageType::IndexType
using	MovingImageIndexType = typename MovingImageType::IndexType
using	MovingImagePointType = typename TransformType::OutputPointType
using	MovingImagePointType = typename TransformType::OutputPointType
using	NonZeroJacobianIndicesType = typename AdvancedTransformType::NonZeroJacobianIndicesType
using	NonZeroJacobianIndicesType = typename AdvancedTransformType::NonZeroJacobianIndicesType
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 >
Protected Types inherited from elastix::MetricBase< TElastix >
using	ExactMetricImageSamplerPointer = typename ExactMetricImageSamplerType::Pointer
using	ExactMetricImageSamplerType = itk::ImageGridSampler< FixedImageType >
using	ExactMetricSampleGridSpacingType = typename ExactMetricImageSamplerType::SampleGridSpacingType
using	ParametersType = typename ITKBaseType::ParametersType
Static Protected Member Functions inherited from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ComputeDerivativeThreaderCallback (void *arg)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetSamplesThreaderCallback (void *arg)
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)
Protected Attributes inherited from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >
vnl_vector< double >	m_eigenValues
vnl_vector< double >	m_fifthEigenVector
vnl_vector< double >	m_firstEigenVector
vnl_vector< double >	m_fourthEigenVector
vnl_vector< double >	m_normdCdmu
int	m_NumberOfSamples
vnl_vector< double >	m_secondEigenVector
vnl_vector< double >	m_seventhEigenVector
vnl_vector< double >	m_sixthEigenVector
vnl_vector< double >	m_thirdEigenVector
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
Protected Attributes inherited from elastix::MetricBase< TElastix >
MeasureType	m_CurrentExactMetricValue { 0.0 }
unsigned int	m_ExactMetricEachXNumberOfIterations { 1 }
ExactMetricSampleGridSpacingType	m_ExactMetricSampleGridSpacing
ExactMetricImageSamplerPointer	m_ExactMetricSampler { nullptr }
bool	m_ShowExactMetricValue { false }
Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer	m_Configuration {}
itk::WeakPointer< TElastix >	m_Elastix {}
RegistrationType *	m_Registration {}

Member Typedef Documentation

BSplineTransformBaseType

template<class TElastix >

using elastix::PCAMetric< TElastix >::BSplineTransformBaseType = itk::AdvancedBSplineDeformableTransformBase<ScalarType, FixedImageDimension>

Typedef's for the B-spline transform.

Definition at line 145 of file elxPCAMetric.h.

CombinationTransformType

template<class TElastix >

using elastix::PCAMetric< TElastix >::CombinationTransformType = itk::AdvancedCombinationTransform<ScalarType, FixedImageDimension>

Definition at line 146 of file elxPCAMetric.h.

ConstPointer

template<class TElastix >

using elastix::PCAMetric< TElastix >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 76 of file elxPCAMetric.h.

FixedImageSizeType [1/2]

template<class TElastix >

using itk::PCAMetric< TFixedImage, TMovingImage >::FixedImageSizeType = typename FixedImageRegionType::SizeType

Definition at line 45 of file itkPCAMetric.h.

FixedImageSizeType [2/2]

template<class TElastix >

using itk::PCAMetric< TFixedImage, TMovingImage >::FixedImageSizeType = typename FixedImageRegionType::SizeType

Definition at line 44 of file itkPCAMetric_F_multithreaded.h.

ITKBaseType

template<class TElastix >

using elastix::PCAMetric< TElastix >::ITKBaseType = typename Superclass2::ITKBaseType

Definition at line 142 of file elxPCAMetric.h.

Pointer

template<class TElastix >

using elastix::PCAMetric< TElastix >::Pointer = itk::SmartPointer<Self>

Definition at line 75 of file elxPCAMetric.h.

ReducedDimensionBSplineTransformBaseType

template<class TElastix >

using elastix::PCAMetric< TElastix >::ReducedDimensionBSplineTransformBaseType = itk::AdvancedBSplineDeformableTransformBase<ScalarType, FixedImageDimension - 1>

Definition at line 148 of file elxPCAMetric.h.

Self

template<class TElastix >

using elastix::PCAMetric< TElastix >::Self = PCAMetric

Standard ITK-stuff.

Definition at line 71 of file elxPCAMetric.h.

StackTransformType

template<class TElastix >

using elastix::PCAMetric< TElastix >::StackTransformType = itk::StackTransform<ScalarType, FixedImageDimension, MovingImageDimension>

Definition at line 147 of file elxPCAMetric.h.

Superclass1

template<class TElastix >

using elastix::PCAMetric< TElastix >::Superclass1 = itk::PCAMetric<typename MetricBase<TElastix>::FixedImageType, typename MetricBase<TElastix>::MovingImageType>

Definition at line 72 of file elxPCAMetric.h.

Superclass2

template<class TElastix >

using elastix::PCAMetric< TElastix >::Superclass2 = MetricBase<TElastix>

Definition at line 74 of file elxPCAMetric.h.

Constructor & Destructor Documentation

PCAMetric()

template<class TElastix >

elastix::PCAMetric< TElastix >::PCAMetric ( )

protecteddefault

The constructor.

~PCAMetric()

template<class TElastix >

elastix::PCAMetric< TElastix >::~PCAMetric ( )

overrideprotectedvirtualdefault

The destructor.

Reimplemented from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

Member Function Documentation

BeforeEachResolution()

template<class TElastix >

void elastix::PCAMetric< TElastix >::BeforeEachResolution ( )

overridevirtual

Do some things before each resolution:

• Set CheckNumberOfSamples setting
• Set UseNormalization setting

Reimplemented from elastix::BaseComponent.

elxClassNameMacro()

template<class TElastix >

elastix::PCAMetric< TElastix >::elxClassNameMacro

(

"PCAMetric< TElastix >"

)

Name of this class. Use this name in the parameter file to select this specific metric.
example: (Metric "PCAMetric")

GetClassName()

template<class TElastix >

virtual const char * elastix::PCAMetric< TElastix >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from elastix::MetricBase< TElastix >.

Initialize()

template<class TElastix >

void elastix::PCAMetric< TElastix >::Initialize ( )

overridevirtual

Sets up a timer to measure the initialization time and calls the Superclass' implementation.

Reimplemented from itk::PCAMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

ITK_DISALLOW_COPY_AND_MOVE()

template<class TElastix >

elastix::PCAMetric< TElastix >::ITK_DISALLOW_COPY_AND_MOVE

(

PCAMetric< TElastix >

)

itkStaticConstMacro() [1/2]

template<class TElastix >

elastix::PCAMetric< TElastix >::itkStaticConstMacro	(	FixedImageDimension	,
		unsigned int	,
		FixedImageType::ImageDimension
	)

The fixed image dimension.

itkStaticConstMacro() [2/2]

template<class TElastix >

elastix::PCAMetric< TElastix >::itkStaticConstMacro	(	MovingImageDimension	,
		unsigned int	,
		MovingImageType::ImageDimension
	)

The moving image dimension.

New()

template<class TElastix >

static Pointer elastix::PCAMetric< TElastix >::New ( )

static

Method for creation through the object factory.

Field Documentation

elxOverrideGetSelfMacro

template<class TElastix >

elastix::PCAMetric< TElastix >::elxOverrideGetSelfMacro

private

Definition at line 172 of file elxPCAMetric.h.