ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkGradientDescentOptimizer.h>
Implement a gradient descent optimizer.
GradientDescentOptimizer implements a simple gradient descent optimizer. At each iteration the current position is updated according to
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, , by setting a scaling vector using method SetScale().
Definition at line 51 of file itkGradientDescentOptimizer.h.
Public Member Functions | |
virtual void | AdvanceOneStep (void) |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual SizeValueType | GetCurrentIteration () const |
virtual const DerivativeType & | GetGradient () const |
virtual const double & | GetLearningRate () const |
virtual const char * | GetNameOfClass () const |
virtual const SizeValueType & | GetNumberOfIterations () const |
virtual const double & | GetValue () const |
void | ResumeOptimization (void) |
virtual void | SetLearningRate (double _arg) |
virtual void | SetNumberOfIterations (SizeValueType _arg) |
virtual void | StartOptimization (void) ITK_OVERRIDE |
void | StopOptimization (void) |
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 StopConditionType & | GetStopCondition () const |
virtual const std::string | GetStopConditionDescription () const ITK_OVERRIDE |
Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual const CostFunctionType * | GetCostFunction () const |
virtual CostFunctionType * | GetModifiableCostFunction () |
MeasureType | GetValue (const ParametersType ¶meters) 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 ¶m) |
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 (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
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 ITK_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 ¶m) |
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 | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
Private Member Functions | |
GradientDescentOptimizer (const Self &) | |
void | operator= (const Self &) |
Private Attributes | |
SizeValueType | m_CurrentIteration |
SizeValueType | m_NumberOfIterations |
bool | m_Stop |
StopConditionType | m_StopCondition |
std::ostringstream | m_StopConditionDescription |
double | m_Value |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
typedef SmartPointer< const Self > itk::GradientDescentOptimizer::ConstPointer |
Definition at line 59 of file itkGradientDescentOptimizer.h.
Definition at line 58 of file itkGradientDescentOptimizer.h.
Standard class typedefs.
Definition at line 56 of file itkGradientDescentOptimizer.h.
Definition at line 57 of file itkGradientDescentOptimizer.h.
Codes of stopping conditions
Enumerator | |
---|---|
MaximumNumberOfIterations | |
MetricError |
Definition at line 68 of file itkGradientDescentOptimizer.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 129 of file itkGradientDescentOptimizer.h.
|
private |
|
virtual |
Advance one step following the gradient direction.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
|
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 |
Get the current iteration number.
|
virtual |
Get Gradient condition.
|
virtual |
Get the learning rate.
|
virtual |
Methods to configure the cost function.
|
inline |
Methods to configure the cost function.
Definition at line 77 of file itkGradientDescentOptimizer.h.
References m_Maximize.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::SingleValuedNonLinearOptimizer.
Reimplemented in itk::QuaternionRigidTransformGradientDescentOptimizer.
|
virtual |
Get the number of iterations.
|
virtual |
Get Stop condition.
|
virtual |
Get Stop condition.
Reimplemented from itk::Optimizer.
|
virtual |
Get the current value.
|
virtual |
Methods to configure the cost function.
Referenced by MinimizeOn().
|
virtual |
Methods to configure the cost function.
Referenced by MinimizeOff().
|
inline |
Methods to configure the cost function.
Definition at line 83 of file itkGradientDescentOptimizer.h.
References MaximizeOn().
|
inline |
Methods to configure the cost function.
Definition at line 81 of file itkGradientDescentOptimizer.h.
References MaximizeOff().
|
static |
Method for creation through the object factory.
|
private |
|
protectedvirtual |
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 | ( | void | ) |
Resume previously stopped optimization with current parameters
|
virtual |
Set the learning rate.
|
virtual |
Methods to configure the cost function.
Referenced by SetMinimize().
|
inline |
Methods to configure the cost function.
Definition at line 79 of file itkGradientDescentOptimizer.h.
References SetMaximize().
|
virtual |
Set the number of iterations.
|
virtual |
Start optimization.
Reimplemented from itk::Optimizer.
void itk::GradientDescentOptimizer::StopOptimization | ( | void | ) |
Stop optimization.
|
private |
Definition at line 147 of file itkGradientDescentOptimizer.h.
|
protected |
Definition at line 133 of file itkGradientDescentOptimizer.h.
|
protected |
Definition at line 137 of file itkGradientDescentOptimizer.h.
|
protected |
Definition at line 135 of file itkGradientDescentOptimizer.h.
Referenced by GetMinimize().
|
private |
Definition at line 146 of file itkGradientDescentOptimizer.h.
|
private |
Definition at line 143 of file itkGradientDescentOptimizer.h.
|
private |
Definition at line 145 of file itkGradientDescentOptimizer.h.
|
private |
Definition at line 148 of file itkGradientDescentOptimizer.h.
|
private |
Definition at line 144 of file itkGradientDescentOptimizer.h.