ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::GradientDescentOptimizer Class Reference

#include <itkGradientDescentOptimizer.h>

+ Inheritance diagram for itk::GradientDescentOptimizer:
+ Collaboration diagram for itk::GradientDescentOptimizer:

Detailed Description

Implement a gradient descent optimizer.

GradientDescentOptimizer implements a simple gradient descent optimizer. At each iteration the current position is updated according to

\[ p_{n+1} = p_n + \mbox{learningRate} \, \frac{\partial f(p_n) }{\partial p_n} \]

The learning rate is a fixed scalar defined via SetLearningRate(). The optimizer steps through a user defined number of iterations; no convergence checking is done.

Additionally, user can scale each component, $ \partial f / \partial p $, by setting a scaling vector using method SetScale().

See Also
RegularStepGradientDescentOptimizer
Examples:
Examples/RegistrationITKv3/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx, WikiExamples/Registration/MutualInformation.cxx, and WikiExamples/Registration/MutualInformationAffine.cxx.

Definition at line 52 of file itkGradientDescentOptimizer.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef GradientDescentOptimizer Self
 
enum  StopConditionType {
  MaximumNumberOfIterations,
  MetricError
}
 
typedef
SingleValuedNonLinearOptimizer 
Superclass
 
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
CostFunctionType::DerivativeType 
DerivativeType
 
typedef
CostFunctionType::MeasureType 
MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
SingleValuedNonLinearOptimizer 
Self
 
typedef NonLinearOptimizer Superclass
 
- Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef NonLinearOptimizer Self
 
typedef Optimizer Superclass
 
- Public Types inherited from itk::Optimizer
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Array< double > ScalesType
 
typedef Optimizer Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void AdvanceOneStep ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual SizeValueType GetCurrentIteration () const
 
virtual const DerivativeTypeGetGradient () const
 
virtual const double & GetLearningRate () const
 
virtual const char * GetNameOfClass () const
 
virtual const SizeValueTypeGetNumberOfIterations () const
 
virtual const double & GetValue () const
 
void ResumeOptimization ()
 
virtual void SetLearningRate (double _arg)
 
virtual void SetNumberOfIterations (SizeValueType _arg)
 
virtual void StartOptimization (void) override
 
void StopOptimization ()
 
virtual const bool & GetMaximize () const
 
virtual void SetMaximize (bool _arg)
 
virtual void MaximizeOn ()
 
virtual void MaximizeOff ()
 
bool GetMinimize () const
 
void SetMinimize (bool v)
 
void MinimizeOn ()
 
void MinimizeOff ()
 
virtual const StopConditionTypeGetStopCondition () const
 
virtual const std::string GetStopConditionDescription () const override
 
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const CostFunctionTypeGetCostFunction () const
 
virtual CostFunctionTypeGetModifiableCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersTypeGetCurrentPosition () const
 
virtual const ParametersTypeGetInitialPosition () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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::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

 GradientDescentOptimizer ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~GradientDescentOptimizer ()
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
 SingleValuedNonLinearOptimizer ()
 
virtual ~SingleValuedNonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()
 
virtual ~NonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
virtual ~Optimizer ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Protected Attributes

DerivativeType m_Gradient
 
double m_LearningRate
 
bool m_Maximize
 
- Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer m_CostFunction
 
- Protected Attributes inherited from itk::Optimizer
ParametersType m_CurrentPosition
 
bool m_ScalesInitialized
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 GradientDescentOptimizer (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

SizeValueType m_CurrentIteration
 
SizeValueType m_NumberOfIterations
 
bool m_Stop
 
StopConditionType m_StopCondition
 
std::ostringstream m_StopConditionDescription
 
double m_Value
 

Member Typedef Documentation

Definition at line 60 of file itkGradientDescentOptimizer.h.

Definition at line 59 of file itkGradientDescentOptimizer.h.

Standard class typedefs.

Definition at line 57 of file itkGradientDescentOptimizer.h.

Definition at line 58 of file itkGradientDescentOptimizer.h.

Member Enumeration Documentation

Codes of stopping conditions

Enumerator
MaximumNumberOfIterations 
MetricError 

Definition at line 69 of file itkGradientDescentOptimizer.h.

Constructor & Destructor Documentation

itk::GradientDescentOptimizer::GradientDescentOptimizer ( )
protected
virtual itk::GradientDescentOptimizer::~GradientDescentOptimizer ( )
inlineprotectedvirtual

Definition at line 130 of file itkGradientDescentOptimizer.h.

itk::GradientDescentOptimizer::GradientDescentOptimizer ( const Self )
private

Member Function Documentation

virtual void itk::GradientDescentOptimizer::AdvanceOneStep ( )
virtual

Advance one step following the gradient direction.

Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.

virtual::itk::LightObject::Pointer itk::GradientDescentOptimizer::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::Object.

Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.

virtual SizeValueType itk::GradientDescentOptimizer::GetCurrentIteration ( ) const
virtual

Get the current iteration number.

virtual const DerivativeType& itk::GradientDescentOptimizer::GetGradient ( ) const
virtual

Get Gradient condition.

virtual const double& itk::GradientDescentOptimizer::GetLearningRate ( ) const
virtual

Get the learning rate.

virtual const bool& itk::GradientDescentOptimizer::GetMaximize ( ) const
virtual

Methods to configure the cost function.

bool itk::GradientDescentOptimizer::GetMinimize ( ) const
inline

Methods to configure the cost function.

Definition at line 78 of file itkGradientDescentOptimizer.h.

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

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.

virtual const SizeValueType& itk::GradientDescentOptimizer::GetNumberOfIterations ( ) const
virtual

Get the number of iterations.

virtual const StopConditionType& itk::GradientDescentOptimizer::GetStopCondition ( ) const
virtual

Get Stop condition.

virtual const std::string itk::GradientDescentOptimizer::GetStopConditionDescription ( ) const
overridevirtual

Get Stop condition.

Reimplemented from itk::Optimizer.

virtual const double& itk::GradientDescentOptimizer::GetValue ( ) const
virtual

Get the current value.

virtual void itk::GradientDescentOptimizer::MaximizeOff ( )
virtual

Methods to configure the cost function.

virtual void itk::GradientDescentOptimizer::MaximizeOn ( )
virtual

Methods to configure the cost function.

void itk::GradientDescentOptimizer::MinimizeOff ( )
inline

Methods to configure the cost function.

Definition at line 84 of file itkGradientDescentOptimizer.h.

void itk::GradientDescentOptimizer::MinimizeOn ( )
inline

Methods to configure the cost function.

Definition at line 82 of file itkGradientDescentOptimizer.h.

static Pointer itk::GradientDescentOptimizer::New ( )
static

Method for creation through the object factory.

void itk::GradientDescentOptimizer::operator= ( const Self )
private
virtual void itk::GradientDescentOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

void itk::GradientDescentOptimizer::ResumeOptimization ( )

Resume previously stopped optimization with current parameters

See Also
StopOptimization.
virtual void itk::GradientDescentOptimizer::SetLearningRate ( double  _arg)
virtual

Set the learning rate.

virtual void itk::GradientDescentOptimizer::SetMaximize ( bool  _arg)
virtual

Methods to configure the cost function.

void itk::GradientDescentOptimizer::SetMinimize ( bool  v)
inline

Methods to configure the cost function.

Definition at line 80 of file itkGradientDescentOptimizer.h.

virtual void itk::GradientDescentOptimizer::SetNumberOfIterations ( SizeValueType  _arg)
virtual

Set the number of iterations.

virtual void itk::GradientDescentOptimizer::StartOptimization ( void  )
overridevirtual

Start optimization.

Reimplemented from itk::Optimizer.

void itk::GradientDescentOptimizer::StopOptimization ( )

Stop optimization.

See Also
ResumeOptimization

Member Data Documentation

SizeValueType itk::GradientDescentOptimizer::m_CurrentIteration
private

Definition at line 148 of file itkGradientDescentOptimizer.h.

DerivativeType itk::GradientDescentOptimizer::m_Gradient
protected

Definition at line 134 of file itkGradientDescentOptimizer.h.

double itk::GradientDescentOptimizer::m_LearningRate
protected

Definition at line 138 of file itkGradientDescentOptimizer.h.

bool itk::GradientDescentOptimizer::m_Maximize
protected

Definition at line 136 of file itkGradientDescentOptimizer.h.

SizeValueType itk::GradientDescentOptimizer::m_NumberOfIterations
private

Definition at line 147 of file itkGradientDescentOptimizer.h.

bool itk::GradientDescentOptimizer::m_Stop
private

Definition at line 144 of file itkGradientDescentOptimizer.h.

StopConditionType itk::GradientDescentOptimizer::m_StopCondition
private

Definition at line 146 of file itkGradientDescentOptimizer.h.

std::ostringstream itk::GradientDescentOptimizer::m_StopConditionDescription
private

Definition at line 149 of file itkGradientDescentOptimizer.h.

double itk::GradientDescentOptimizer::m_Value
private

Definition at line 145 of file itkGradientDescentOptimizer.h.


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