go home Home | Main Page | Topics | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType > Class Template Reference
Components » Metrics

#include <itkDisplacementMagnitudePenaltyTerm.h>

Detailed Description

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

A cost function that calculates $||T(x)-x||^2$.

Definition at line 34 of file itkDisplacementMagnitudePenaltyTerm.h.

Inheritance diagram for itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >:
Inheritance graph
[legend]

Public Types

using ConstPointer = SmartPointer<const Self>
using Pointer = SmartPointer<Self>
using Self = DisplacementMagnitudePenaltyTerm
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 GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override
MeasureType GetValue (const ParametersType &parameters) const override
void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override
 ITK_DISALLOW_COPY_AND_MOVE (DisplacementMagnitudePenaltyTerm)
 itkOverrideGetNameOfClassMacro (DisplacementMagnitudePenaltyTerm)
 itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
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

 DisplacementMagnitudePenaltyTerm ()
 ~DisplacementMagnitudePenaltyTerm () 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

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

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage, typename TScalarType>
using itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::ConstPointer = SmartPointer<const Self>

Definition at line 43 of file itkDisplacementMagnitudePenaltyTerm.h.

◆ Pointer

template<typename TFixedImage, typename TScalarType>
using itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::Pointer = SmartPointer<Self>

Definition at line 42 of file itkDisplacementMagnitudePenaltyTerm.h.

◆ Self

template<typename TFixedImage, typename TScalarType>
using itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::Self = DisplacementMagnitudePenaltyTerm

Standard ITK stuff.

Definition at line 40 of file itkDisplacementMagnitudePenaltyTerm.h.

◆ Superclass

template<typename TFixedImage, typename TScalarType>
using itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::Superclass = TransformPenaltyTerm<TFixedImage, TScalarType>

Definition at line 41 of file itkDisplacementMagnitudePenaltyTerm.h.

Constructor & Destructor Documentation

◆ DisplacementMagnitudePenaltyTerm()

template<typename TFixedImage, typename TScalarType>
itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::DisplacementMagnitudePenaltyTerm ( )
protected

The constructor.

◆ ~DisplacementMagnitudePenaltyTerm()

template<typename TFixedImage, typename TScalarType>
itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::~DisplacementMagnitudePenaltyTerm ( )
overrideprotecteddefault

The destructor.

Member Function Documentation

◆ GetDerivative()

template<typename TFixedImage, typename TScalarType>
void itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::GetDerivative ( const ParametersType & parameters,
DerivativeType & derivative ) const
override

Get the penalty term derivative. Simply calls GetValueAndDerivative and returns the derivative.

◆ GetValue()

template<typename TFixedImage, typename TScalarType>
MeasureType itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::GetValue ( const ParametersType & parameters) const
override

Get the penalty term value.

\‍[ Value = 1/N sum_x ||T(x) - x||^2 \‍]

◆ GetValueAndDerivative()

template<typename TFixedImage, typename TScalarType>
void itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::GetValueAndDerivative ( const ParametersType & parameters,
MeasureType & value,
DerivativeType & derivative ) const
override

Get the penalty term value and derivative.

\‍[ Value = C(\mu) = 1/N sum_x ||T_{\mu}(x) - x||^2 \‍]

\‍[ Derivative = \frac{\partial C}{\partial\mu} = 2/N sum_x (T_{\mu}(x)-x)' \frac{\partial T}{\partial \mu} \‍]

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TFixedImage, typename TScalarType>
itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::ITK_DISALLOW_COPY_AND_MOVE ( DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType > )

◆ itkOverrideGetNameOfClassMacro()

template<typename TFixedImage, typename TScalarType>
itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::itkOverrideGetNameOfClassMacro ( DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType > )

Run-time type information (and related methods).

◆ itkStaticConstMacro()

template<typename TFixedImage, typename TScalarType>
itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::itkStaticConstMacro ( FixedImageDimension ,
unsigned int ,
FixedImageType::ImageDimension  )

Define the dimension.

◆ New()

template<typename TFixedImage, typename TScalarType>
Pointer itk::DisplacementMagnitudePenaltyTerm< TFixedImage, TScalarType >::New ( )
static

Method for creation through the object factory.


Generated on 26-02-2026 for elastix by doxygen 1.16.1 (669aeeefca743c148e2d935b3d3c69535c7491e6) elastix logo