itk::RegularStepGradientDescentOptimizer Class Reference

#include <itkRegularStepGradientDescentOptimizer.h>

Inheritance diagram for itk::RegularStepGradientDescentOptimizer:

Collaboration diagram for itk::RegularStepGradientDescentOptimizer:

Detailed Description

Implement a gradient descent optimizer.

Examples:

Examples/RegistrationITKv3/DeformableRegistration13.cxx, Examples/RegistrationITKv3/DeformableRegistration14.cxx, Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/ImageRegistration1.cxx, Examples/RegistrationITKv3/ImageRegistration12.cxx, Examples/RegistrationITKv3/ImageRegistration13.cxx, Examples/RegistrationITKv3/ImageRegistration18.cxx, Examples/RegistrationITKv3/ImageRegistration20.cxx, Examples/RegistrationITKv3/ImageRegistration3.cxx, Examples/RegistrationITKv3/ImageRegistration4.cxx, Examples/RegistrationITKv3/ImageRegistration5.cxx, Examples/RegistrationITKv3/ImageRegistration6.cxx, Examples/RegistrationITKv3/ImageRegistration7.cxx, Examples/RegistrationITKv3/ImageRegistration9.cxx, Examples/RegistrationITKv3/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv3/ModelToImageRegistration2.cxx, Examples/RegistrationITKv3/MultiResImageRegistration1.cxx, Examples/RegistrationITKv3/MultiResImageRegistration2.cxx, Examples/RegistrationITKv3/MultiResImageRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, WikiExamples/Registration/ImageRegistrationMethod.cxx, WikiExamples/Registration/ImageRegistrationMethodAffine.cxx, and WikiExamples/Registration/WatchRegistration.cxx.

Definition at line 33 of file itkRegularStepGradientDescentOptimizer.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	CostFunctionPointer = CostFunctionType::Pointer
using	CostFunctionType = Superclass::CostFunctionType
using	Pointer = SmartPointer< Self >
using	Self = RegularStepGradientDescentOptimizer
using	Superclass = RegularStepGradientDescentBaseOptimizer
Public Types inherited from itk::RegularStepGradientDescentBaseOptimizer
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = RegularStepGradientDescentBaseOptimizer
enum	StopConditionType {   GradientMagnitudeTolerance = 1,   StepTooSmall = 2,   ImageNotAvailable = 3,   CostFunctionError = 4,   MaximumNumberOfIterations = 5,   Unknown = 6 }
using	Superclass = SingleValuedNonLinearOptimizer
Public Types inherited from itk::SingleValuedNonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >
using	CostFunctionPointer = CostFunctionType::Pointer
using	CostFunctionType = SingleValuedCostFunction
using	DerivativeType = CostFunctionType::DerivativeType
using	MeasureType = CostFunctionType::MeasureType
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	Self = SingleValuedNonLinearOptimizer
using	Superclass = NonLinearOptimizer
Public Types inherited from itk::NonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	ScalesType = Superclass::ScalesType
using	Self = NonLinearOptimizer
using	Superclass = Optimizer
Public Types inherited from itk::Optimizer
using	ConstPointer = SmartPointer< const Self >
using	ParametersType = OptimizerParameters< double >
using	Pointer = SmartPointer< Self >
using	ScalesType = Array< double >
using	Self = Optimizer
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
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
const std::string	GetStopConditionDescription () const override
void	ResumeOptimization ()
void	StartOptimization () override
void	StopOptimization ()
virtual void	SetMaximize (bool _arg)
virtual const bool &	GetMaximize () const
virtual void	MaximizeOn ()
virtual void	MaximizeOff ()
bool	GetMinimize () const
void	SetMinimize (bool v)
void	MinimizeOn ()
void	MinimizeOff ()
virtual void	SetMaximumStepLength (double _arg)
virtual void	SetMinimumStepLength (double _arg)
virtual void	SetRelaxationFactor (double _arg)
virtual void	SetNumberOfIterations (SizeValueType _arg)
virtual void	SetGradientMagnitudeTolerance (double _arg)
virtual const double &	GetCurrentStepLength () const
virtual const double &	GetMaximumStepLength () const
virtual const double &	GetMinimumStepLength () const
virtual const double &	GetRelaxationFactor () const
virtual const SizeValueType &	GetNumberOfIterations () const
virtual const double &	GetGradientMagnitudeTolerance () const
virtual unsigned int	GetCurrentIteration () const
virtual const StopConditionType &	GetStopCondition () const
virtual const MeasureType &	GetValue () const
virtual const DerivativeType &	GetGradient () const
Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const CostFunctionType *	GetCostFunction () const
virtual CostFunctionType *	GetModifiableCostFunction ()
MeasureType	GetValue (const ParametersType &parameters) const
virtual void	SetCostFunction (CostFunctionType *costFunction)
Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetCurrentPosition () const
virtual const ParametersType &	GetInitialPosition () const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetScales (const ScalesType &scales)
virtual const ScalesType &	GetScales () const
virtual const ScalesType &	GetInverseScales () const
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::RegularStepGradientDescentBaseOptimizer
static Pointer	New ()
Static Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
static Pointer	New ()
Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer	New ()
Static Public Member Functions inherited from itk::Optimizer
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
	RegularStepGradientDescentOptimizer ()=default
void	StepAlongGradient (double factor, const DerivativeType &transformedGradient) override
	~RegularStepGradientDescentOptimizer () override=default
Protected Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
virtual void	AdvanceOneStep ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	RegularStepGradientDescentBaseOptimizer ()
virtual void	StepAlongGradient (double, const DerivativeType &)
	~RegularStepGradientDescentBaseOptimizer () override=default
Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
void	PrintSelf (std::ostream &os, Indent indent) const override
	SingleValuedNonLinearOptimizer ()
	~SingleValuedNonLinearOptimizer () override=default
Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()=default
	~NonLinearOptimizer () override
Protected Member Functions inherited from itk::Optimizer
	Optimizer ()
virtual void	SetCurrentPosition (const ParametersType &param)
	~Optimizer () override=default
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 ()

Additional Inherited Members
Protected Attributes inherited from itk::RegularStepGradientDescentBaseOptimizer
SizeValueType	m_CurrentIteration
double	m_CurrentStepLength
DerivativeType	m_Gradient
double	m_GradientMagnitudeTolerance
bool	m_Maximize
double	m_MaximumStepLength
double	m_MinimumStepLength
SizeValueType	m_NumberOfIterations
DerivativeType	m_PreviousGradient
double	m_RelaxationFactor
bool	m_Stop {false}
StopConditionType	m_StopCondition
std::ostringstream	m_StopConditionDescription
MeasureType	m_Value
Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction
Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition
bool	m_ScalesInitialized { false }
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::RegularStepGradientDescentOptimizer::ConstPointer = SmartPointer< const Self >

Definition at line 43 of file itkRegularStepGradientDescentOptimizer.h.

using itk::RegularStepGradientDescentOptimizer::CostFunctionPointer = CostFunctionType::Pointer

Definition at line 54 of file itkRegularStepGradientDescentOptimizer.h.

using itk::RegularStepGradientDescentOptimizer::CostFunctionType = Superclass::CostFunctionType

Cost function type alias.

Definition at line 53 of file itkRegularStepGradientDescentOptimizer.h.

using itk::RegularStepGradientDescentOptimizer::Pointer = SmartPointer< Self >

Definition at line 42 of file itkRegularStepGradientDescentOptimizer.h.

using itk::RegularStepGradientDescentOptimizer::Self = RegularStepGradientDescentOptimizer

Standard class type aliases.

Definition at line 40 of file itkRegularStepGradientDescentOptimizer.h.

using itk::RegularStepGradientDescentOptimizer::Superclass = RegularStepGradientDescentBaseOptimizer

Definition at line 41 of file itkRegularStepGradientDescentOptimizer.h.

Constructor & Destructor Documentation

itk::RegularStepGradientDescentOptimizer::RegularStepGradientDescentOptimizer ( )

protecteddefault

itk::RegularStepGradientDescentOptimizer::~RegularStepGradientDescentOptimizer ( )

overrideprotecteddefault

Member Function Documentation

virtual::itk::LightObject::Pointer itk::RegularStepGradientDescentOptimizer::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

virtual const char* itk::RegularStepGradientDescentOptimizer::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

static Pointer itk::RegularStepGradientDescentOptimizer::New ( )

static

Method for creation through the object factory.

void itk::RegularStepGradientDescentOptimizer::StepAlongGradient ( double  factor, const DerivativeType &  transformedGradient  )

overrideprotected

Advance one step along the corrected gradient taking into account the steplength represented by factor. This method is invoked by AdvanceOneStep. It is expected to be overrided by optimization methods in non-vector spaces

See Also

AdvanceOneStep

---

The documentation for this class was generated from the following file:

• itkRegularStepGradientDescentOptimizer.h