#include <itkTransformRigidityPenaltyTerm.h>

Detailed Description

template<typename TFixedImage, typename TScalarType>
class itk::TransformRigidityPenaltyTerm< TFixedImage, TScalarType >

A cost function that calculates a rigidity penalty term.

A cost function that calculates a rigidity penalty term based on the B-spline coefficients of a B-spline transformation. This penalty term is a function of the 1st and 2nd order spatial derivatives of a transformation.

The intended use for this metric is to filter a B-spline coefficient image in order to calculate a rigidity penalty term on a B-spline transform.

The RigidityPenaltyTermValueImageFilter at each pixel location is computed by convolution with some separable 1D kernels.

The rigid penalty term penalizes deviations from a rigid transformation at regions specified by the so-called rigidity images.

This metric only works with B-splines as a transformation model.

References:
[1] 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.

See also: BSplineTransform

Definition at line 71 of file itkTransformRigidityPenaltyTerm.h.

Inheritance diagram for itk::TransformRigidityPenaltyTerm< TFixedImage, TScalarType >:

[legend]

Public Types
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<TFixedImage, TScalarType>
Public Types inherited from itk::TransformPenaltyTerm< TFixedImage, TScalarType >
using	ConstPointer
using	InternalMatrixType
using	JacobianOfSpatialHessianType
using	JacobianOfSpatialJacobianType
using	Pointer
using	ScalarType
using	Self
using	SpatialHessianType
using	SpatialJacobianType
using	Superclass
using	TransformType
Public Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
using	AdvancedTransformType
using	BSplineOrder1TransformPointer
using	BSplineOrder1TransformType
using	BSplineOrder2TransformPointer
using	BSplineOrder2TransformType
using	BSplineOrder3TransformPointer
using	BSplineOrder3TransformType
using	CombinationTransformType
using	ConstPointer
using	DerivativeValueType
using	FixedImageLimiterOutputType
using	FixedImageLimiterPointer
using	FixedImageLimiterType
using	FixedImageMaskConstPointer
using	FixedImageMaskPointer
using	FixedImageMaskType
using	FixedImagePixelType
using	FixedImagePointer
using	ImageSampleContainerPointer
using	ImageSampleContainerType
using	ImageSamplerPointer
using	ImageSamplerType
using	MovingImageDerivativeScalesType
using	MovingImageLimiterOutputType
using	MovingImageLimiterPointer
using	MovingImageLimiterType
using	MovingImageMaskConstPointer
using	MovingImageMaskPointer
using	MovingImageMaskType
using	MovingImagePointer
using	MovingImageRegionType
using	NumberOfParametersType
using	Pointer
using	ScalarType
using	Self
using	Superclass
using	ThreadInfoType

Public Member Functions
void	BeforeThreadedGetValueAndDerivative (const ParametersType &parameters) const override
void	CheckUseAndCalculationBooleans ()
void	FillRigidityCoefficientImage (const ParametersType &parameters) 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)
	itkOverrideGetNameOfClassMacro (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 >
	ITK_DISALLOW_COPY_AND_MOVE (TransformPenaltyTerm)
	itkOverrideGetNameOfClassMacro (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 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)
	itkOverrideGetNameOfClassMacro (AdvancedImageToImageMetric)
	itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, TFixedImage::ImageDimension)
virtual void	SetFixedImageLimiter (FixedImageLimiterType *_arg)
virtual void	SetFixedImageMask (const FixedImageMaskType *const arg)
virtual void	SetFixedLimitRangeRatio (double _arg)
virtual void	SetImageSampler (ImageSamplerType *_arg)
virtual void	SetMovingImageDerivativeScales (MovingImageDerivativeScalesType _arg)
virtual void	SetMovingImageLimiter (MovingImageLimiterType *_arg)
virtual void	SetMovingImageMask (const MovingImageMaskType *const arg)
virtual void	SetMovingLimitRangeRatio (double _arg)
void	SetRandomVariateGenerator (Statistics::MersenneTwisterRandomVariateGenerator &randomVariateGenerator)
virtual void	SetRequiredRatioOfValidSamples (double _arg)
virtual void	SetScaleGradientWithRespectToMovingImageOrientation (bool _arg)
virtual void	SetTransform (AdvancedTransformType *arg)
virtual void	SetUseMetricSingleThreaded (bool _arg)
virtual void	SetUseMovingImageDerivativeScales (bool _arg)
virtual void	SetUseMultiThread (bool _arg)
virtual void	UseMetricSingleThreadedOff ()
virtual void	UseMetricSingleThreadedOn ()
virtual void	UseMultiThreadOff ()
virtual void	UseMultiThreadOn ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
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 &) const
virtual void	AfterThreadedGetValueAndDerivative (MeasureType &, DerivativeType &) const
void	CheckForAdvancedTransform ()
void	CheckForBSplineInterpolator ()
void	CheckForBSplineTransform () const
void	CheckNumberOfSamples () const
virtual bool	EvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient) 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
Statistics::MersenneTwisterRandomVariateGenerator &	GetMutableRandomVariateGenerator () const
Statistics::MersenneTwisterRandomVariateGenerator &	GetRandomVariateGenerator ()
virtual void	InitializeImageSampler ()
void	InitializeLimiters ()
virtual void	InitializeThreadingParameters () const
virtual bool	IsInsideMovingMask (const MovingImagePointType &point) 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

Private Member Functions
void	Create1DOperator (NeighborhoodType &F, const std::string &whichF, const unsigned int WhichDimension, const CoefficientImageSpacingType &spacing) const
void	CreateNDOperator (NeighborhoodType &F, const std::string &whichF, const CoefficientImageSpacingType &spacing) const
virtual void	DilateRigidityImages ()
CoefficientImagePointer	FilterSeparable (const CoefficientImageType *, const std::vector< NeighborhoodType > &Operators) const

Private Attributes
BSplineTransformPointer	m_BSplineTransform {}
bool	m_CalculateLinearityCondition {}
bool	m_CalculateOrthonormalityCondition {}
bool	m_CalculatePropernessCondition {}
bool	m_DilateRigidityImages {}
CoordinateRepresentationType	m_DilationRadiusMultiplier {}
RigidityImagePointer	m_FixedRigidityImage {}
RigidityImagePointer	m_FixedRigidityImageDilated {}
std::vector< DilateFilterPointer >	m_FixedRigidityImageDilation {}
MeasureType	m_LinearityConditionGradientMagnitude {}
MeasureType	m_LinearityConditionValue {}
ScalarType	m_LinearityConditionWeight {}
RigidityImagePointer	m_MovingRigidityImage {}
RigidityImagePointer	m_MovingRigidityImageDilated {}
std::vector< DilateFilterPointer >	m_MovingRigidityImageDilation {}
MeasureType	m_OrthonormalityConditionGradientMagnitude {}
MeasureType	m_OrthonormalityConditionValue {}
ScalarType	m_OrthonormalityConditionWeight {}
MeasureType	m_PropernessConditionGradientMagnitude {}
MeasureType	m_PropernessConditionValue {}
ScalarType	m_PropernessConditionWeight {}
RigidityImagePointer	m_RigidityCoefficientImage {}
bool	m_RigidityCoefficientImageIsFilled {}
MeasureType	m_RigidityPenaltyTermValue {}
bool	m_UseFixedRigidityImage {}
bool	m_UseLinearityCondition {}
bool	m_UseMovingRigidityImage {}
bool	m_UseOrthonormalityCondition {}
bool	m_UsePropernessCondition {}

Additional Inherited Members
Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TFixedImage >
using	BSplineInterpolatorFloatPointer
using	BSplineInterpolatorFloatType
using	BSplineInterpolatorPointer
using	BSplineInterpolatorType
using	FixedImageIndexType
using	FixedImageIndexValueType
using	FixedImagePointType
using	LinearInterpolatorPointer
using	LinearInterpolatorType
using	MovingImageContinuousIndexType
using	MovingImageDerivativeType
using	MovingImageIndexType
using	MovingImagePointType
using	NonZeroJacobianIndicesType
using	ReducedBSplineInterpolatorPointer
using	ReducedBSplineInterpolatorType
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
FixedImageLimiterOutputType	m_FixedImageMaxLimit
FixedImageLimiterOutputType	m_FixedImageMinLimit
FixedImagePixelType	m_FixedImageTrueMax
FixedImagePixelType	m_FixedImageTrueMin
double	m_FixedLimitRangeRatio
std::unique_ptr< AlignedGetValueAndDerivativePerThreadStruct[]>	m_GetValueAndDerivativePerThreadVariables
ThreadIdType	m_GetValueAndDerivativePerThreadVariablesSize
ImageSamplerPointer	m_ImageSampler
MovingImageLimiterOutputType	m_MovingImageMaxLimit
MovingImageLimiterOutputType	m_MovingImageMinLimit
MovingImagePixelType	m_MovingImageTrueMax
MovingImagePixelType	m_MovingImageTrueMin
double	m_MovingLimitRangeRatio
MultiThreaderParameterType	m_ThreaderMetricParameters
bool	m_TransformIsBSpline
bool	m_UseMetricSingleThreaded
bool	m_UseMultiThread