#include <itkRegularStepGradientDescentOptimizerv4.h>

Inheritance diagram for itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >:

Collaboration diagram for itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >:

Detailed Description

template<typename TInternalComputationValueType>
class itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >

Regular Step Gradient descent optimizer.

This optimizer is a variant of gradient descent that attempts to prevent it from taking steps that are too large. At each iteration, this optimizer will take a step along the direction of the metric derivative. Each time the direction of the derivative abruptly changes, the optimizer assumes that a local extrema has been passed and reacts by reducing the step length by a relaxation factor that is set to 0.5 by default. The default value for the initial step length is 1, and this value can only be changed manually via SetLearningRate() since this optimizer does not use the ScaleEstimator to automatically estimate the learning rate. Also note that unlike the previous version of ReuglarStepGradientDescentOptimizer, ITKv4 does not have a "maximize/minimize" option to modify the effect of the metric derivative. The assigned metric is assumed to return a parameter derivative result that "improves" the optimization.

Examples:: Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration12.cxx, Examples/RegistrationITKv4/ImageRegistration13.cxx, Examples/RegistrationITKv4/ImageRegistration3.cxx, Examples/RegistrationITKv4/ImageRegistration4.cxx, Examples/RegistrationITKv4/ImageRegistration5.cxx, Examples/RegistrationITKv4/ImageRegistration6.cxx, Examples/RegistrationITKv4/ImageRegistration7.cxx, Examples/RegistrationITKv4/ImageRegistration8.cxx, Examples/RegistrationITKv4/ImageRegistration9.cxx, Examples/RegistrationITKv4/MultiResImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, and SphinxExamples/src/Registration/Common/Perform2DTranslationRegistrationWithMeanSquares/Code.cxx.

Definition at line 46 of file itkRegularStepGradientDescentOptimizerv4.h.

Public Types
using	CompensatedSummationType = CompensatedSummation< InternalComputationValueType >

using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename Superclass::DerivativeType

using	IndexRangeType = typename Superclass::IndexRangeType

using	InternalComputationValueType = TInternalComputationValueType

using	MeasureType = typename Superclass::MeasureType

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = typename Superclass::ScalesType

using	Self = RegularStepGradientDescentOptimizerv4

using	StopConditionType = typename Superclass::StopConditionType

using	Superclass = GradientDescentOptimizerv4Template< TInternalComputationValueType >

Public Types inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename Superclass::DerivativeType

using	IndexRangeType = typename Superclass::IndexRangeType

using	InternalComputationValueType = TInternalComputationValueType

using	MeasureType = typename Superclass::MeasureType

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = typename Superclass::ScalesType

using	Self = GradientDescentOptimizerv4Template

using	StopConditionType = typename Superclass::StopConditionType

using	Superclass = GradientDescentOptimizerBasev4Template< TInternalComputationValueType >

Public Types inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >

using	ConvergenceMonitoringType = itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >

using	DerivativeType = typename Superclass::DerivativeType

using	IndexRangeType = ThreadedIndexedContainerPartitioner::IndexRangeType

using	InternalComputationValueType = TInternalComputationValueType

using	MeasureType = typename Superclass::MeasureType

using	MetricType = typename Superclass::MetricType

using	MetricTypePointer = typename MetricType::Pointer

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = typename Superclass::ScalesType

using	Self = GradientDescentOptimizerBasev4Template

using	StopConditionDescriptionType = typename Superclass::StopConditionDescriptionType

using	StopConditionReturnStringType = typename Superclass::StopConditionReturnStringType

enum	StopConditionType { MAXIMUM_NUMBER_OF_ITERATIONS, COSTFUNCTION_ERROR, UPDATE_PARAMETERS_ERROR, STEP_TOO_SMALL, CONVERGENCE_CHECKER_PASSED, GRADIENT_MAGNITUDE_TOLEARANCE, OTHER_ERROR }

using	Superclass = ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >

Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename MetricType::DerivativeType

using	MeasureType = typename MetricType::MeasureType

using	MetricType = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >

using	MetricTypePointer = typename MetricType::Pointer

using	NumberOfParametersType = typename MetricType::NumberOfParametersType

using	ParametersType = OptimizerParameters< TInternalComputationValueType >

using	Pointer = SmartPointer< Self >

using	ScalesEstimatorType = OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >

using	ScalesType = OptimizerParameters< TInternalComputationValueType >

using	Self = ObjectToObjectOptimizerBaseTemplate

using	StopConditionDescriptionType = std::ostringstream

using	StopConditionReturnStringType = std::string

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

void	EstimateLearningRate () override

double	GetCurrentStepLength () const

virtual const char *	GetNameOfClass () const

void	StartOptimization (bool doOnlyInitialization=false) override


virtual void	SetMinimumStepLength (TInternalComputationValueType _arg)

virtual const TInternalComputationValueType &	GetMinimumStepLength () const


virtual void	SetRelaxationFactor (TInternalComputationValueType _arg)

virtual const TInternalComputationValueType &	GetRelaxationFactor () const


virtual void	SetGradientMagnitudeTolerance (TInternalComputationValueType _arg)

virtual const TInternalComputationValueType &	GetGradientMagnitudeTolerance () const


virtual void	SetCurrentLearningRateRelaxation (MeasureType _arg)

virtual const MeasureType &	GetCurrentLearningRateRelaxation () const

Public Member Functions inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
virtual const TInternalComputationValueType &	GetConvergenceValue () const

void	ResumeOptimization () override

virtual void	SetConvergenceWindowSize (SizeValueType _arg)

virtual void	SetMinimumConvergenceValue (TInternalComputationValueType _arg)

void	StopOptimization () override

virtual void	SetLearningRate (TInternalComputationValueType _arg)

virtual const TInternalComputationValueType &	GetLearningRate () const

virtual void	SetMaximumStepSizeInPhysicalUnits (TInternalComputationValueType _arg)

virtual const TInternalComputationValueType &	GetMaximumStepSizeInPhysicalUnits () const

virtual void	SetDoEstimateLearningRateAtEachIteration (bool _arg)

virtual const bool &	GetDoEstimateLearningRateAtEachIteration () const

virtual void	DoEstimateLearningRateAtEachIterationOn ()

virtual void	DoEstimateLearningRateAtEachIterationOff ()

virtual void	SetDoEstimateLearningRateOnce (bool _arg)

virtual const bool &	GetDoEstimateLearningRateOnce () const

virtual void	DoEstimateLearningRateOnceOn ()

virtual void	DoEstimateLearningRateOnceOff ()

virtual void	SetReturnBestParametersAndValue (bool _arg)

virtual const bool &	GetReturnBestParametersAndValue () const

virtual void	ReturnBestParametersAndValueOn ()

virtual void	ReturnBestParametersAndValueOff ()

Public Member Functions inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
SizeValueType	GetCurrentIteration () const override

virtual const DerivativeType &	GetGradient () const

SizeValueType	GetNumberOfIterations () const override

virtual const StopConditionType &	GetStopCondition () const

const StopConditionReturnStringType	GetStopConditionDescription () const override

void	SetNumberOfIterations (const SizeValueType numberOfIterations) override

virtual void	ModifyGradientByScales ()

virtual void	ModifyGradientByLearningRate ()

Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
virtual const MeasureType &	GetCurrentMetricValue () const

virtual const ParametersType &	GetCurrentPosition () const

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

virtual const ScalesType &	GetScales () const

virtual const bool &	GetScalesAreIdentity () const

bool	GetScalesInitialized () const

virtual const MeasureType &	GetValue () const

virtual const ScalesType &	GetWeights () const

virtual const bool &	GetWeightsAreIdentity () const

virtual void	SetNumberOfWorkUnits (ThreadIdType number)

virtual void	SetScalesEstimator (ScalesEstimatorType *_arg)

virtual void	SetWeights (ScalesType _arg)

virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual const MetricType *	GetMetric () const

virtual void	SetScales (const ScalesType &scales)

virtual void	SetDoEstimateScales (bool _arg)

virtual const bool &	GetDoEstimateScales () const

virtual void	DoEstimateScalesOn ()

virtual void	DoEstimateScalesOff ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	AdvanceOneStep () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	RegularStepGradientDescentOptimizerv4 ()

	~RegularStepGradientDescentOptimizerv4 () override=default


void	ModifyGradientByScalesOverSubRange (const IndexRangeType &subrange) override

void	ModifyGradientByLearningRateOverSubRange (const IndexRangeType &subrange) override

Protected Member Functions inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
	GradientDescentOptimizerv4Template ()

	~GradientDescentOptimizerv4Template () override=default

Protected Member Functions inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
	GradientDescentOptimizerBasev4Template ()

	~GradientDescentOptimizerBasev4Template () override=default

Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
	ObjectToObjectOptimizerBaseTemplate ()

	~ObjectToObjectOptimizerBaseTemplate () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
MeasureType	m_CurrentLearningRateRelaxation

TInternalComputationValueType	m_GradientMagnitudeTolerance

TInternalComputationValueType	m_MinimumStepLength

TInternalComputationValueType	m_RelaxationFactor

Additional Inherited Members
Protected Attributes inherited from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >
ParametersType	m_BestParameters

TInternalComputationValueType	m_ConvergenceValue

MeasureType	m_CurrentBestValue

TInternalComputationValueType	m_LearningRate

TInternalComputationValueType	m_MinimumConvergenceValue

DerivativeType	m_PreviousGradient

bool	m_ReturnBestParametersAndValue { false }

Protected Attributes inherited from itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
ConvergenceMonitoringType::Pointer	m_ConvergenceMonitoring

SizeValueType	m_ConvergenceWindowSize

bool	m_DoEstimateLearningRateAtEachIteration

bool	m_DoEstimateLearningRateOnce

DerivativeType	m_Gradient

TInternalComputationValueType	m_MaximumStepSizeInPhysicalUnits

DomainThreader < ThreadedIndexedContainerPartitioner, Self >::Pointer	m_ModifyGradientByLearningRateThreader

DomainThreader < ThreadedIndexedContainerPartitioner, Self >::Pointer	m_ModifyGradientByScalesThreader

bool	m_Stop {false}

StopConditionType	m_StopCondition

StopConditionDescriptionType	m_StopConditionDescription

bool	m_UseConvergenceMonitoring

Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
SizeValueType	m_CurrentIteration

MeasureType	m_CurrentMetricValue

bool	m_DoEstimateScales

MetricTypePointer	m_Metric

SizeValueType	m_NumberOfIterations

ThreadIdType	m_NumberOfWorkUnits

ScalesType	m_Scales

bool	m_ScalesAreIdentity

ScalesEstimatorType::Pointer	m_ScalesEstimator

ScalesType	m_Weights

bool	m_WeightsAreIdentity

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount