ITK
6.0.0
Insight Toolkit
|
#include <itkRegularStepGradientDescentOptimizer.h>
Implement a gradient descent optimizer.
Definition at line 33 of file itkRegularStepGradientDescentOptimizer.h.
Public Member Functions | |
const char * | GetNameOfClass () const override |
Public Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer | |
const char * | GetNameOfClass () const override |
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 () |
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 StopConditionEnum & | GetStopCondition () const |
virtual const MeasureType & | GetValue () const |
virtual const DerivativeType & | GetGradient () const |
Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer | |
virtual CostFunctionType * | GetModifiableCostFunction () |
const char * | GetNameOfClass () const override |
MeasureType | GetValue (const ParametersType ¶meters) const |
virtual void | SetCostFunction (CostFunctionType *costFunction) |
const char * | GetNameOfClass () const override |
Public Member Functions inherited from itk::Optimizer | |
virtual const ParametersType & | GetCurrentPosition () const |
virtual const ParametersType & | GetInitialPosition () const |
const char * | GetNameOfClass () const override |
virtual std::string | GetStopConditionDescription () const |
virtual void | SetInitialPosition (const ParametersType ¶m) |
void | SetScales (const ScalesType &scales) |
virtual void | StartOptimization () |
virtual const ScalesType & | GetScales () const |
virtual const ScalesType & | GetInverseScales () const |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
LightObject::Pointer | CreateAnother () const override |
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 |
const char * | GetNameOfClass () const override |
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) const |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
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 | |
Pointer | Clone () const |
virtual Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
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 val) |
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 () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetCurrentPosition (const ParametersType ¶m) |
~Optimizer () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~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 | PrintSelf (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 } |
StopConditionEnum | 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 {} |
Definition at line 42 of file itkRegularStepGradientDescentOptimizer.h.
Definition at line 52 of file itkRegularStepGradientDescentOptimizer.h.
using itk::RegularStepGradientDescentOptimizer::CostFunctionType = Superclass::CostFunctionType |
Cost function type alias.
Definition at line 51 of file itkRegularStepGradientDescentOptimizer.h.
Definition at line 41 of file itkRegularStepGradientDescentOptimizer.h.
Standard class type aliases.
Definition at line 39 of file itkRegularStepGradientDescentOptimizer.h.
using itk::RegularStepGradientDescentOptimizer::Superclass = RegularStepGradientDescentBaseOptimizer |
Definition at line 40 of file itkRegularStepGradientDescentOptimizer.h.
|
protecteddefault |
|
overrideprotecteddefault |
|
overridevirtual |
Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
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 overridden by optimization methods in non-vector spaces
Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.