#include <itkTransformPenaltyTerm.h>

Detailed Description

template<typename TFixedImage, typename TScalarType = double>
class itk::TransformPenaltyTerm< TFixedImage, TScalarType >

A cost function that calculates a penalty term on a transformation.

We decided to make it an itk::ImageToImageMetric, since possibly all the stuff in there is also needed for penalty terms.

A transformation penalty terms has some extra demands on the transform. Therefore, the transformation is required to be of itk::AdvancedTransform type.

Definition at line 45 of file itkTransformPenaltyTerm.h.

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

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

Protected Member Functions
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

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