#include <itkComputePreconditionerUsingDisplacementDistribution.h>

Detailed Description

template<class TFixedImage, class TTransform>
class itk::ComputePreconditionerUsingDisplacementDistribution< TFixedImage, TTransform >

This is a helper class for the automatic estimation of a preconditioner for the FPSGD optimizer. // update below 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, 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://dx.doi.org/10.1109/TMI.2015.2476354

Definition at line 40 of file itkComputePreconditionerUsingDisplacementDistribution.h.

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

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::FixedImageMaskConstPointer	FixedImageMaskConstPointer

typedef Superclass::FixedImageMaskPointer	FixedImageMaskPointer

typedef Superclass::FixedImageMaskType	FixedImageMaskType

typedef Superclass::FixedImagePixelType	FixedImagePixelType

typedef Superclass::FixedImageRegionType	FixedImageRegionType

typedef Superclass::FixedImageType	FixedImageType

typedef Superclass::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef ComputePreconditionerUsingDisplacementDistribution	Self

typedef ComputeDisplacementDistribution< TFixedImage, TTransform >	Superclass

typedef Superclass::TransformPointer	TransformPointer

typedef Superclass::TransformType	TransformType

Public Types inherited from itk::ComputeDisplacementDistribution< TFixedImage, TTransform >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef FixedImageMaskType::ConstPointer	FixedImageMaskConstPointer

typedef FixedImageMaskType::Pointer	FixedImageMaskPointer

typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension) >	FixedImageMaskType

typedef FixedImageType::PixelType	FixedImagePixelType

typedef FixedImageType::RegionType	FixedImageRegionType

typedef TFixedImage	FixedImageType

typedef TransformType::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalesType	ScalesType

typedef ComputeDisplacementDistribution	Self

typedef ScaledSingleValuedNonLinearOptimizer	Superclass

typedef TransformType::Pointer	TransformPointer

typedef TTransform	TransformType

Public Types inherited from itk::ScaledSingleValuedNonLinearOptimizer
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::CostFunctionType	CostFunctionType

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::MeasureType	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef ScaledCostFunctionType::Pointer	ScaledCostFunctionPointer

typedef ScaledSingleValuedCostFunction	ScaledCostFunctionType

typedef NonLinearOptimizer::ScalesType	ScalesType

typedef ScaledSingleValuedNonLinearOptimizer	Self

typedef SingleValuedNonLinearOptimizer	Superclass

Public Member Functions
void	Compute (const ParametersType &mu, double &jacg, double &maxJJ, std::string method) override

virtual void	Compute (const ParametersType &mu, double &maxJJ, ParametersType &preconditioner)

virtual void	ComputeDistributionTermsUsingSearchDir (const ParametersType &mu, double &jacg, double &maxJJ, std::string methods)

virtual void	ComputeForBSplineOnly (const ParametersType &mu, const double &delta, double &maxJJ, ParametersType &preconditioner)

virtual void	ComputeJacobiTypePreconditioner (const ParametersType &mu, double &maxJJ, ParametersType &preconditioner)

virtual const char *	GetClassName () const

virtual const double &	GetConditionNumber ()

virtual const double &	GetMaximumStepLength ()

virtual const double &	GetRegularizationKappa ()

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

virtual void	PreconditionerInterpolation (ParametersType &preconditioner)

virtual void	SetConditionNumber (double _arg)

virtual void	SetMaximumStepLength (double _arg)

virtual void	SetRegularizationKappa (double _arg)

Public Member Functions inherited from itk::ComputeDisplacementDistribution< TFixedImage, TTransform >
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 char *	GetClassName () const

virtual const FixedImageMaskType *	GetFixedImageMask ()

virtual const FixedImageRegionType &	GetFixedImageRegion ()

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

virtual void	SetFixedImage (const FixedImageType *_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 (TransformType *_arg)

Public Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
virtual const char *	GetClassName () const

const ParametersType &	GetCurrentPosition (void) const override

virtual bool	GetMaximize () const

virtual const ScaledCostFunctionType *	GetScaledCostFunction ()

virtual const ParametersType &	GetScaledCurrentPosition ()

bool	GetUseScales (void) const

virtual void	InitializeScales (void)

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::ComputeDisplacementDistribution< TFixedImage, TTransform >
static Pointer	New ()

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

Protected Types
typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType

typedef Superclass::FixedImageIndexType	FixedImageIndexType

typedef Superclass::FixedImagePointType	FixedImagePointType

typedef Superclass::ImageFullSamplerPointer	ImageFullSamplerPointer

typedef Superclass::ImageFullSamplerType	ImageFullSamplerType

typedef Superclass::ImageGridSamplerPointer	ImageGridSamplerPointer

typedef Superclass::ImageGridSamplerType	ImageGridSamplerType

typedef Superclass::ImageRandomSamplerBasePointer	ImageRandomSamplerBasePointer

typedef Superclass::ImageRandomSamplerBaseType	ImageRandomSamplerBaseType

typedef Superclass::ImageSampleContainerPointer	ImageSampleContainerPointer

typedef Superclass::ImageSampleContainerType	ImageSampleContainerType

typedef Superclass::ImageSamplerBasePointer	ImageSamplerBasePointer

typedef Superclass::ImageSamplerBaseType	ImageSamplerBaseType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::JacobianValueType	JacobianValueType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::TransformJacobianType	TransformJacobianType

Protected Types inherited from itk::ComputeDisplacementDistribution< TFixedImage, TTransform >
typedef TransformType::ScalarType	CoordinateRepresentationType

typedef FixedImageType::IndexType	FixedImageIndexType

typedef FixedImageType::PointType	FixedImagePointType

typedef ImageFullSamplerType::Pointer	ImageFullSamplerPointer

typedef ImageFullSampler< FixedImageType >	ImageFullSamplerType

typedef ImageGridSamplerType::Pointer	ImageGridSamplerPointer

typedef ImageGridSampler< FixedImageType >	ImageGridSamplerType

typedef ImageRandomSamplerBaseType::Pointer	ImageRandomSamplerBasePointer

typedef ImageRandomSamplerBase< FixedImageType >	ImageRandomSamplerBaseType

typedef ImageSampleContainerType::Pointer	ImageSampleContainerPointer

typedef ImageGridSamplerType::ImageSampleContainerType	ImageSampleContainerType

typedef ImageSamplerBaseType::Pointer	ImageSamplerBasePointer

typedef ImageSamplerBase< FixedImageType >	ImageSamplerBaseType

typedef TransformType::JacobianType	JacobianType

typedef JacobianType::ValueType	JacobianValueType

typedef TransformType::NumberOfParametersType	NumberOfParametersType

typedef itk::PlatformMultiThreader	ThreaderType

typedef ThreaderType::WorkUnitInfo	ThreadInfoType

typedef JacobianType	TransformJacobianType

Protected Member Functions
	ComputePreconditionerUsingDisplacementDistribution ()

	~ComputePreconditionerUsingDisplacementDistribution () override

Protected Member Functions inherited from itk::ComputeDisplacementDistribution< TFixedImage, TTransform >
	ComputeDisplacementDistribution ()

virtual void	InitializeThreadingParameters (void)

	itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedComputePerThreadStruct, AlignedComputePerThreadStruct)

	itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, ComputePerThreadStruct, PaddedComputePerThreadStruct)

void	LaunchComputeThreaderCallback (void) const

virtual void	SampleFixedImageForJacobianTerms (ImageSampleContainerPointer &sampleContainer)

virtual void	ThreadedCompute (ThreadIdType threadID)

	~ComputeDisplacementDistribution () override

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

Protected Attributes
double	m_ConditionNumber

double	m_MaximumStepLength

double	m_RegularizationKappa

Protected Attributes inherited from itk::ComputeDisplacementDistribution< TFixedImage, TTransform >
AlignedComputePerThreadStruct *	m_ComputePerThreadVariables

ThreadIdType	m_ComputePerThreadVariablesSize

ScaledSingleValuedCostFunction::Pointer	m_CostFunction

DerivativeType	m_ExactGradient

FixedImageType::ConstPointer	m_FixedImage

FixedImageMaskConstPointer	m_FixedImageMask

FixedImageRegionType	m_FixedImageRegion

SizeValueType	m_NumberOfJacobianMeasurements

SizeValueType	m_NumberOfParameters

SizeValueType	m_NumberOfPixelsCounted

ImageSampleContainerPointer	m_SampleContainer

ThreaderType::Pointer	m_Threader

MultiThreaderParameterType	m_ThreaderParameters

TransformPointer	m_Transform

bool	m_UseMultiThread

Protected Attributes inherited from itk::ScaledSingleValuedNonLinearOptimizer
ScaledCostFunctionPointer	m_ScaledCostFunction

ParametersType	m_ScaledCurrentPosition

Private Member Functions
	ComputePreconditionerUsingDisplacementDistribution (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Static Protected Member Functions inherited from itk::ComputeDisplacementDistribution< TFixedImage, TTransform >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ComputeThreaderCallback (void *arg)