#include <itkComputeDisplacementDistribution.h>

Detailed Description

template<typename TFixedImage, typename TTransform>
class itk::ComputeDisplacementDistribution< TFixedImage, TTransform >

This is a helper class for the automatic parameter estimation of the ASGD optimizer.

More specifically this class computes the Jacobian terms related to the automatic parameter estimation for the adaptive stochastic gradient descent optimizer. Details can be found in the TMI paper

[1] Y. Qiao, B. van Lew, B.P.F. Lelieveldt and M. Staring "Fast Automatic Step Size Estimation for Gradient Descent Optimization of Image Registration," IEEE Transactions on Medical Imaging, vol. 35, no. 2, pp. 391 - 403, February 2016. http://elastix.dev/marius/publications/2016_j_TMIa.php

Definition at line 48 of file itkComputeDisplacementDistribution.h.

Inheritance diagram for itk::ComputeDisplacementDistribution< TFixedImage, TTransform >:

Classes
struct	ComputePerThreadStruct
struct	MultiThreaderParameterType

Public Types
using	ConstPointer = SmartPointer<const Self>
using	FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer
using	FixedImageMaskPointer = typename FixedImageMaskType::Pointer
using	FixedImageMaskType = ImageMaskSpatialObject<Self::FixedImageDimension>
using	FixedImagePixelType = typename TFixedImage::PixelType
using	FixedImageRegionType = typename TFixedImage::RegionType
using	FixedImageType = TFixedImage
using	NonZeroJacobianIndicesType = typename TTransform::NonZeroJacobianIndicesType
using	Pointer = SmartPointer<Self>
using	ScalesType
using	Self = ComputeDisplacementDistribution
using	Superclass = ScaledSingleValuedNonLinearOptimizer
using	TransformPointer = typename TTransform::Pointer
using	TransformType = TTransform
Public Types inherited from itk::ScaledSingleValuedNonLinearOptimizer
using	ConstPointer = SmartPointer<const Self>
using	Pointer = SmartPointer<Self>
using	ScaledCostFunctionPointer = ScaledCostFunctionType::Pointer
using	ScaledCostFunctionType = ScaledSingleValuedCostFunction
using	ScalesType = NonLinearOptimizer::ScalesType
using	Self = ScaledSingleValuedNonLinearOptimizer
using	Superclass = SingleValuedNonLinearOptimizer

Public Member Functions
virtual void	AfterThreadedCompute (double &jacg, double &maxJJ)
virtual void	BeforeThreadedCompute (const ParametersType &mu)
virtual void	Compute (const ParametersType &mu, double &jacg, double &maxJJ, std::string method)
virtual void	ComputeSingleThreaded (const ParametersType &mu, double &jacg, double &maxJJ, std::string method)
virtual void	ComputeUsingSearchDirection (const ParametersType &mu, double &jacg, double &maxJJ, std::string methods)
virtual const FixedImageMaskType *	GetFixedImageMask ()
virtual const FixedImageRegionType &	GetFixedImageRegion ()
	ITK_DISALLOW_COPY_AND_MOVE (ComputeDisplacementDistribution)
	itkOverrideGetNameOfClassMacro (ComputeDisplacementDistribution)
	itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
virtual void	SetFixedImage (const TFixedImage *_arg)
virtual void	SetFixedImageMask (const FixedImageMaskType *_arg)
virtual void	SetFixedImageMask (FixedImageMaskType *_arg)
void	SetFixedImageRegion (const FixedImageRegionType &region)
virtual void	SetNumberOfJacobianMeasurements (SizeValueType _arg)
void	SetNumberOfWorkUnits (ThreadIdType numberOfThreads)
virtual void	SetTransform (TTransform *_arg)
Public Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
const ParametersType &	GetCurrentPosition () const override
virtual bool	GetMaximize () const
virtual const ScaledCostFunctionType *	GetScaledCostFunction ()
virtual const ParametersType &	GetScaledCurrentPosition ()
bool	GetUseScales () const
virtual void	InitializeScales ()
	ITK_DISALLOW_COPY_AND_MOVE (ScaledSingleValuedNonLinearOptimizer)
	itkOverrideGetNameOfClassMacro (ScaledSingleValuedNonLinearOptimizer)
virtual void	MaximizeOff ()
virtual void	MaximizeOn ()
void	SetCostFunction (CostFunctionType *costFunction) override
virtual void	SetMaximize (bool _arg)
virtual void	SetUseScales (bool arg)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
static Pointer	New ()

Protected Types
using	CoordinateRepresentationType = typename TTransform::ScalarType
using	FixedImageIndexType = typename TFixedImage::IndexType
using	FixedImagePointType = typename TFixedImage::PointType
using	ImageSampleType = ImageSample<TFixedImage>
using	JacobianType = typename TTransform::JacobianType
using	JacobianValueType = typename JacobianType::ValueType
using	NumberOfParametersType = typename TTransform::NumberOfParametersType
using	ThreadInfoType = MultiThreaderBase::WorkUnitInfo
using	TransformJacobianType = JacobianType

Protected Member Functions
	ComputeDisplacementDistribution ()
virtual void	InitializeThreadingParameters ()
	itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedComputePerThreadStruct, AlignedComputePerThreadStruct)
	itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, ComputePerThreadStruct, PaddedComputePerThreadStruct)
void	LaunchComputeThreaderCallback () const
std::vector< ImageSampleType >	SampleFixedImageForJacobianTerms () const
virtual void	ThreadedCompute (ThreadIdType threadID)
	~ComputeDisplacementDistribution () override=default
Protected Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
virtual void	GetScaledDerivative (const ParametersType &parameters, DerivativeType &derivative) const
virtual MeasureType	GetScaledValue (const ParametersType &parameters) const
virtual void	GetScaledValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
void	PrintSelf (std::ostream &os, Indent indent) const override
	ScaledSingleValuedNonLinearOptimizer ()
void	SetCurrentPosition (const ParametersType &param) override
virtual void	SetScaledCurrentPosition (const ParametersType &parameters)
	~ScaledSingleValuedNonLinearOptimizer () override=default

Static Protected Member Functions
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ComputeThreaderCallback (void *arg)

Protected Attributes
ScaledSingleValuedCostFunction::Pointer	m_CostFunction {}
DerivativeType	m_ExactGradient {}
TFixedImage::ConstPointer	m_FixedImage { nullptr }
FixedImageMaskConstPointer	m_FixedImageMask { nullptr }
FixedImageRegionType	m_FixedImageRegion {}
SizeValueType	m_NumberOfJacobianMeasurements { 0 }
SizeValueType	m_NumberOfParameters {}
MultiThreaderBase::Pointer	m_Threader { MultiThreaderBase::New() }
TransformPointer	m_Transform { nullptr }
Protected Attributes inherited from itk::ScaledSingleValuedNonLinearOptimizer
ScaledCostFunctionPointer	m_ScaledCostFunction {}
ParametersType	m_ScaledCurrentPosition {}

Private Attributes
std::vector< AlignedComputePerThreadStruct >	m_ComputePerThreadVariables {}
std::vector< ImageSampleType >	m_Samples {}
MultiThreaderParameterType	m_ThreaderParameters {}
bool	m_UseMultiThread { true }