#include <elxTransformRigidityPenaltyTerm.h>

Detailed Description

template<class TElastix>
class elastix::TransformRigidityPenalty< TElastix >

A penalty term based on non-rigidity.

For more information check the paper:
M. Staring, S. Klein and J.P.W. Pluim, "A Rigidity Penalty Term for Nonrigid Registration," Medical Physics, vol. 34, no. 11, pp. 4098 - 4108, November 2007.

The parameters used in this class are:

Parameters:: Metric: Select this metric as follows:
(Metric "TransformRigidityPenalty")

Parameters:

LinearityConditionWeight: A parameter to weigh the linearity condition term of the rigidity term.
example: (LinearityConditionWeight 2.0)
Default is 1.0.

OrthonormalityConditionWeight: A parameter to weigh the orthonormality condition term of the rigidity term.
example: (OrthonormalityConditionWeight 2.0)
Default is 1.0.

PropernessConditionWeight: A parameter to weigh the properness condition term of the rigidity term.
example: (PropernessConditionWeight 2.0)
Default is 1.0.

UseLinearityCondition: A flag to specify the usage of the linearity condition term for optimisation.
example: (UseLinearityCondition "false")
Default is "true".

UseOrthonormalityCondition: A flag to specify the usage of the orthonormality condition term for optimisation.
example: (UseOrthonormalityCondition "false")
Default is "true".

UsePropernessCondition: A flag to specify the usage of the properness condition term for optimisation.
example: (UsePropernessCondition "false")
Default is "true".

CalculateLinearityCondition: A flag to specify if the linearity condition should still be calculated, even if it is not used for optimisation.
example: (CalculateLinearityCondition "false")
Default is "true".

CalculateOrthonormalityCondition: A flag to specify if the orthonormality condition should still be calculated, even if it is not used for optimisation.
example: (CalculateOrthonormalityCondition "false")
Default is "true".

CalculatePropernessCondition: A flag to specify if the properness condition should still be calculated, even if it is not used for optimisation.
example: (CalculatePropernessCondition "false")
Default is "true".

FixedRigidityImageName: the name of a coefficient image to specify the rigidity index of voxels in the fixed image.
example: (FixedRigidityImageName "fixedRigidityImage.mhd")
If not supplied the rigidity coefficient is not based on the fixed image, which is recommended.
If neither FixedRigidityImageName nor MovingRigidityImageName are supplied, the rigidity penalty term is evaluated on the whole transform input domain.

MovingRigidityImageName: the name of a coefficient image to specify the rigidity index of voxels in the moving image.
example: (MovingRigidityImageName "movingRigidityImage.mhd")
If not supplied the rigidity coefficient is not based on the moving image, which is NOT recommended.
If neither FixedRigidityImageName nor MovingRigidityImageName are supplied, the rigidity penalty term is evaluated on the whole transform input domain.

DilateRigidityImages: flag to specify the dilation of the rigidity coefficient images. With this the region of rigidity can be extended to force rigidity of the inner region.
example: (DilateRigidityImages "false" "false" "true")
Default is "true".

DilationRadiusMultiplier: the dilation radius is a multiplier times the grid spacing of the B-spline transform.
example: (DilationRadiusMultiplier 1.0 1.0 2.0)
Default is 1.0.

Definition at line 110 of file elxTransformRigidityPenaltyTerm.h.

Inheritance diagram for elastix::TransformRigidityPenalty< TElastix >:

[legend]

Public Types
using	CoefficientImageType = typename BSplineTransformType::ImageType

using	ConstPointer = itk::SmartPointer< const Self >

using	ITKBaseType = typename Superclass2::ITKBaseType

using	Pointer = itk::SmartPointer< Self >

using	Self = TransformRigidityPenalty

using	Superclass1 = itk::TransformRigidityPenaltyTerm< typename MetricBase< TElastix >::FixedImageType, double >

using	Superclass2 = MetricBase< TElastix >

Public Types inherited from itk::TransformRigidityPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >
using	BSplineTransformPointer = typename BSplineTransformType::Pointer

using	BSplineTransformType = BSplineOrder3TransformType

using	CoefficientImageIteratorType = ImageRegionIterator< CoefficientImageType >

using	CoefficientImagePointer = typename CoefficientImageType::Pointer

using	CoefficientImageSpacingType = typename CoefficientImageType::SpacingType

using	CoefficientImageType = typename BSplineTransformType::ImageType

using	ConstPointer = SmartPointer< const Self >

using	DilateFilterPointer = typename DilateFilterType::Pointer

using	DilateFilterType = GrayscaleDilateImageFilter< RigidityImageType, RigidityImageType, StructuringElementType >

using	GridSpacingType = typename BSplineTransformType::SpacingType

using	NeighborhoodIteratorType = NeighborhoodIterator< CoefficientImageType >

using	NeighborhoodSizeType = typename NeighborhoodType::SizeType

using	NeighborhoodType = Neighborhood< ScalarType, Self::FixedImageDimension >

using	NOIFType = NeighborhoodOperatorImageFilter< CoefficientImageType, CoefficientImageType >

using	Pointer = SmartPointer< Self >

using	RadiusType = typename NeighborhoodIteratorType::RadiusType

using	RigidityImageIndexType = typename RigidityImageType::IndexType

using	RigidityImageIteratorType = ImageRegionIterator< RigidityImageType >

using	RigidityImagePointer = typename RigidityImageType::Pointer

using	RigidityImagePointType = typename RigidityImageType::PointType

using	RigidityImageRegionType = typename RigidityImageType::RegionType

using	RigidityImageType = CoefficientImageType

using	RigidityPixelType = typename RigidityImageType::PixelType

using	Self = TransformRigidityPenaltyTerm

using	SERadiusType = typename StructuringElementType::RadiusType

using	StructuringElementType = BinaryBallStructuringElement< RigidityPixelType, Self::FixedImageDimension >

using	Superclass = TransformPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >

Public Types inherited from itk::TransformPenaltyTerm< TFixedImage, TScalarType >
using	ConstPointer = SmartPointer< const Self >

using	InternalMatrixType = typename TransformType::InternalMatrixType

using	JacobianOfSpatialHessianType = typename TransformType::JacobianOfSpatialHessianType

using	JacobianOfSpatialJacobianType = typename TransformType::JacobianOfSpatialJacobianType

using	Pointer = SmartPointer< Self >

using	ScalarType = TScalarType

using	Self = TransformPenaltyTerm

using	SpatialHessianType = typename TransformType::SpatialHessianType

using	SpatialJacobianType = typename TransformType::SpatialJacobianType

using	Superclass = AdvancedImageToImageMetric< TFixedImage, TFixedImage >

using	TransformType = typename Superclass::AdvancedTransformType

Public Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
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, TFixedImage >

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

void	BeforeEachResolution () override

void	BeforeRegistration () override

	elxClassNameMacro ("TransformRigidityPenalty")

virtual const char *	GetClassName () const

void	Initialize () override

	ITK_DISALLOW_COPY_AND_MOVE (TransformRigidityPenalty)

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

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

void	SelectNewSamples () override

Public Member Functions inherited from itk::TransformRigidityPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >
void	BeforeThreadedGetValueAndDerivative (const TransformParametersType &parameters) const override

void	CheckUseAndCalculationBooleans ()

void	FillRigidityCoefficientImage (const ParametersType &parameters) const

virtual const char *	GetClassName () const

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

virtual const MeasureType &	GetLinearityConditionGradientMagnitude ()

virtual const MeasureType &	GetLinearityConditionValue ()

virtual ScalarType	GetLinearityConditionWeight () const

virtual const MeasureType &	GetOrthonormalityConditionGradientMagnitude ()

virtual const MeasureType &	GetOrthonormalityConditionValue ()

virtual ScalarType	GetOrthonormalityConditionWeight () const

virtual const MeasureType &	GetPropernessConditionGradientMagnitude ()

virtual const MeasureType &	GetPropernessConditionValue ()

virtual ScalarType	GetPropernessConditionWeight () 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 (TransformRigidityPenaltyTerm)

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

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

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

virtual void	SetBSplineTransform (BSplineTransformType *_arg)

virtual void	SetCalculateLinearityCondition (bool _arg)

virtual void	SetCalculateOrthonormalityCondition (bool _arg)

virtual void	SetCalculatePropernessCondition (bool _arg)

virtual void	SetDilateRigidityImages (bool _arg)

virtual void	SetDilationRadiusMultiplier (CoordinateRepresentationType _arg)

virtual void	SetFixedRigidityImage (RigidityImageType *_arg)

virtual void	SetLinearityConditionWeight (ScalarType _arg)

virtual void	SetMovingRigidityImage (RigidityImageType *_arg)

virtual void	SetOrthonormalityConditionWeight (ScalarType _arg)

virtual void	SetPropernessConditionWeight (ScalarType _arg)

virtual void	SetUseFixedRigidityImage (bool _arg)

virtual void	SetUseLinearityCondition (bool _arg)

virtual void	SetUseMovingRigidityImage (bool _arg)

virtual void	SetUseOrthonormalityCondition (bool _arg)

virtual void	SetUsePropernessCondition (bool _arg)

Public Member Functions inherited from itk::TransformPenaltyTerm< TFixedImage, TScalarType >
virtual const char *	GetClassName () const

	ITK_DISALLOW_COPY_AND_MOVE (TransformPenaltyTerm)

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

Public Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
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::TransformRigidityPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >
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
	TransformRigidityPenalty ()=default

	~TransformRigidityPenalty () override=default

Protected Member Functions inherited from itk::TransformRigidityPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >
void	PrintSelf (std::ostream &os, Indent indent) const override

	TransformRigidityPenaltyTerm ()

	~TransformRigidityPenaltyTerm () override=default

Protected Member Functions inherited from itk::TransformPenaltyTerm< TFixedImage, TScalarType >
virtual bool	CheckForBSplineTransform2 (BSplineOrder3TransformPointer &bspline) const

	TransformPenaltyTerm ()=default

	~TransformPenaltyTerm () override=default

Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
	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::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
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::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
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::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
AdvancedTransformType::Pointer	m_AdvancedTransform

BSplineInterpolatorPointer	m_BSplineInterpolator

BSplineInterpolatorFloatPointer	m_BSplineInterpolatorFloat

CentralDifferenceGradientFilterPointer	m_CentralDifferenceGradientFilter

FixedImageLimiterPointer	m_FixedImageLimiter

FixedImageLimiterOutputType	m_FixedImageMaxLimit

FixedImageLimiterOutputType	m_FixedImageMinLimit

FixedImagePixelType	m_FixedImageTrueMax

FixedImagePixelType	m_FixedImageTrueMin

double	m_FixedLimitRangeRatio

std::unique_ptr< AlignedGetValueAndDerivativePerThreadStruct[]>	m_GetValueAndDerivativePerThreadVariables

ThreadIdType	m_GetValueAndDerivativePerThreadVariablesSize

std::unique_ptr< AlignedGetValuePerThreadStruct[]>	m_GetValuePerThreadVariables

ThreadIdType	m_GetValuePerThreadVariablesSize

ImageSamplerPointer	m_ImageSampler

bool	m_InterpolatorIsBSpline

bool	m_InterpolatorIsBSplineFloat

bool	m_InterpolatorIsLinear

bool	m_InterpolatorIsReducedBSpline

LinearInterpolatorPointer	m_LinearInterpolator

MovingImageLimiterPointer	m_MovingImageLimiter

MovingImageLimiterOutputType	m_MovingImageMaxLimit

MovingImageLimiterOutputType	m_MovingImageMinLimit

MovingImagePixelType	m_MovingImageTrueMax

MovingImagePixelType	m_MovingImageTrueMin

double	m_MovingLimitRangeRatio

ReducedBSplineInterpolatorPointer	m_ReducedBSplineInterpolator

MultiThreaderParameterType	m_ThreaderMetricParameters

bool	m_TransformIsAdvanced

bool	m_TransformIsBSpline

bool	m_UseMetricSingleThreaded

bool	m_UseMultiThread

bool	m_UseOpenMP

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

◆ CoefficientImageType

template<class TElastix >

using itk::TransformRigidityPenaltyTerm< TFixedImage, TScalarType >::CoefficientImageType = typename BSplineTransformType::ImageType

Definition at line 154 of file itkTransformRigidityPenaltyTerm.h.

◆ ConstPointer

template<class TElastix >

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

Definition at line 122 of file elxTransformRigidityPenaltyTerm.h.

◆ ITKBaseType

template<class TElastix >

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

Definition at line 187 of file elxTransformRigidityPenaltyTerm.h.

◆ Pointer

template<class TElastix >

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

Definition at line 121 of file elxTransformRigidityPenaltyTerm.h.

◆ Self

template<class TElastix >

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

Standard ITK-stuff.

Definition at line 118 of file elxTransformRigidityPenaltyTerm.h.

◆ Superclass1

template<class TElastix >

using elastix::TransformRigidityPenalty< TElastix >::Superclass1 = itk::TransformRigidityPenaltyTerm<typename MetricBase<TElastix>::FixedImageType, double>

Definition at line 119 of file elxTransformRigidityPenaltyTerm.h.

◆ Superclass2

template<class TElastix >

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

Definition at line 120 of file elxTransformRigidityPenaltyTerm.h.

Constructor & Destructor Documentation

◆ TransformRigidityPenalty()

template<class TElastix >

elastix::TransformRigidityPenalty< TElastix >::TransformRigidityPenalty ( )

protecteddefault

The constructor.

◆ ~TransformRigidityPenalty()

template<class TElastix >

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

overrideprotecteddefault

The destructor.

Member Function Documentation

◆ AfterEachIteration()

template<class TElastix >

void elastix::TransformRigidityPenalty< TElastix >::AfterEachIteration ( )

overridevirtual

Do some things after each iteration:

Print the OC, PC, LC parts of the rigidity term.

Reimplemented from elastix::BaseComponent.

◆ BeforeEachResolution()

template<class TElastix >

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

overridevirtual

Do some things before each resolution:

Read all parameters.

Reimplemented from elastix::BaseComponent.

◆ BeforeRegistration()

template<class TElastix >

void elastix::TransformRigidityPenalty< TElastix >::BeforeRegistration ( )

overridevirtual

Do some things before registration:

Read the fixed rigidity image.
Read the moving rigidity image.
Setup some extra target cells.

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

template<class TElastix >

elastix::TransformRigidityPenalty< TElastix >::elxClassNameMacro ( "TransformRigidityPenalty< TElastix >" )

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

◆ GetClassName()

template<class TElastix >

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

virtual

Run-time type information (and related methods).

Reimplemented from elastix::MetricBase< TElastix >.

◆ Initialize()

template<class TElastix >

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

override

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

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TElastix >

elastix::TransformRigidityPenalty< TElastix >::ITK_DISALLOW_COPY_AND_MOVE ( TransformRigidityPenalty< TElastix > )

◆ itkStaticConstMacro() [1/2]

template<class TElastix >

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

The fixed image dimension.

◆ itkStaticConstMacro() [2/2]

template<class TElastix >

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

The moving image dimension.

◆ New()

template<class TElastix >

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

static

Method for creation through the object factory.

◆ SelectNewSamples()

template<class TElastix >

void elastix::TransformRigidityPenalty< TElastix >::SelectNewSamples ( )

inlineoverridevirtual

This metric is advanced (so it has a sampling possibility), but it purposely does not use samplers. The MetricBase class, however, issues a warning if this is the case, so we overwrite that function.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 223 of file elxTransformRigidityPenaltyTerm.h.

Field Documentation

◆ elxOverrideGetSelfMacro

template<class TElastix >

elastix::TransformRigidityPenalty< TElastix >::elxOverrideGetSelfMacro

private

Definition at line 234 of file elxTransformRigidityPenaltyTerm.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CoefficientImageType

◆ ConstPointer

◆ ITKBaseType

◆ Pointer

◆ Self

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ TransformRigidityPenalty()

◆ ~TransformRigidityPenalty()

Member Function Documentation

◆ AfterEachIteration()

◆ BeforeEachResolution()

◆ BeforeRegistration()

◆ elxClassNameMacro()

◆ GetClassName()

◆ Initialize()

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkStaticConstMacro() [1/2]

◆ itkStaticConstMacro() [2/2]

◆ New()

◆ SelectNewSamples()

Field Documentation

◆ elxOverrideGetSelfMacro