![]() |
ITK
5.1.0
Insight Toolkit
|
#include <itkGradientDescentLineSearchOptimizerv4.h>
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const char * | GetNameOfClass () const |
![]() | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
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 | SetMinimumConvergenceValue (TInternalComputationValueType _arg) |
virtual void | SetConvergenceWindowSize (SizeValueType _arg) |
virtual const TInternalComputationValueType & | GetConvergenceValue () const |
virtual void | SetReturnBestParametersAndValue (bool _arg) |
virtual const bool & | GetReturnBestParametersAndValue () const |
virtual void | ReturnBestParametersAndValueOn () |
virtual void | ReturnBestParametersAndValueOff () |
void | StartOptimization (bool doOnlyInitialization=false) override |
void | StopOptimization () override |
void | ResumeOptimization () override |
virtual void | EstimateLearningRate () |
![]() | |
virtual const DerivativeType & | GetGradient () const |
virtual const StopConditionObjectToObjectOptimizerEnum & | GetStopCondition () const |
void | SetNumberOfIterations (const SizeValueType numberOfIterations) override |
SizeValueType | GetNumberOfIterations () const override |
SizeValueType | GetCurrentIteration () const override |
const StopConditionReturnStringType | GetStopConditionDescription () const override |
virtual void | ModifyGradientByScales () |
virtual void | ModifyGradientByLearningRate () |
![]() | |
virtual void | SetMetric (MetricType *_arg) |
virtual MetricType * | GetModifiableMetric () |
virtual const MetricType * | GetMetric () const |
virtual const MeasureType & | GetCurrentMetricValue () const |
virtual const MeasureType & | GetValue () const |
virtual void | SetScales (const ScalesType &scales) |
virtual const ScalesType & | GetScales () const |
virtual const bool & | GetScalesAreIdentity () const |
virtual void | SetWeights (ScalesType _arg) |
virtual const ScalesType & | GetWeights () const |
virtual const bool & | GetWeightsAreIdentity () const |
bool | GetScalesInitialized () const |
virtual void | SetScalesEstimator (ScalesEstimatorType *_arg) |
virtual void | SetDoEstimateScales (bool _arg) |
virtual const bool & | GetDoEstimateScales () const |
virtual void | DoEstimateScalesOn () |
virtual void | DoEstimateScalesOff () |
virtual void | SetNumberOfWorkUnits (ThreadIdType number) |
virtual const ThreadIdType & | GetNumberOfWorkUnits () const |
virtual const ParametersType & | GetCurrentPosition () const |
![]() | |
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 noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
![]() | |
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 Pointer | New () |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
TInternalComputationValueType | m_LowerLimit |
TInternalComputationValueType | m_UpperLimit |
TInternalComputationValueType | m_Phi |
TInternalComputationValueType | m_Resphi |
TInternalComputationValueType | m_Epsilon |
unsigned int | m_MaximumLineSearchIterations |
unsigned int | m_LineSearchIterations |
virtual void | SetEpsilon (TInternalComputationValueType _arg) |
virtual TInternalComputationValueType | GetEpsilon () |
virtual void | SetLowerLimit (TInternalComputationValueType _arg) |
virtual TInternalComputationValueType | GetLowerLimit () |
virtual void | SetUpperLimit (TInternalComputationValueType _arg) |
virtual TInternalComputationValueType | GetUpperLimit () |
virtual void | SetMaximumLineSearchIterations (unsigned int _arg) |
virtual unsigned int | GetMaximumLineSearchIterations () |
void | AdvanceOneStep () override |
GradientDescentLineSearchOptimizerv4Template () | |
~GradientDescentLineSearchOptimizerv4Template () override=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
TInternalComputationValueType | GoldenSectionSearch (TInternalComputationValueType a, TInternalComputationValueType b, TInternalComputationValueType c, TInternalComputationValueType metricb=NumericTraits< TInternalComputationValueType >::max()) |
Gradient descent optimizer with a golden section line search.
GradientDescentLineSearchOptimizer implements a simple gradient descent optimizer that is followed by a line search to find the best value for the learning rate. At each iteration the current position is updated according to
Options are identical to the superclass's except for:
options Epsilon, LowerLimit and UpperLimit that will guide a golden section line search to find the optimal gradient update within the range :
[ learningRate * LowerLimit , learningRate * UpperLimit ]
where Epsilon sets the resolution of the search. Smaller values lead to additional computation time but better localization of the minimum.
By default, this optimizer will return the best value and associated parameters that were calculated during the optimization. See SetReturnBestParametersAndValue().
Definition at line 60 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self> |
Definition at line 71 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::ConvergenceMonitoringType = itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType> |
Type for the convergence checker
Definition at line 90 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::DerivativeType = typename Superclass::DerivativeType |
Derivative type
Definition at line 83 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::InternalComputationValueType = TInternalComputationValueType |
It should be possible to derive the internal computation type from the class object.
Definition at line 80 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::MeasureType = typename Superclass::MeasureType |
Metric type over which this class is templated
Definition at line 86 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::ParametersType = typename Superclass::ParametersType |
Definition at line 87 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::Pointer = SmartPointer<Self> |
Definition at line 70 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::Self = GradientDescentLineSearchOptimizerv4Template |
Standard class type aliases.
Definition at line 68 of file itkGradientDescentLineSearchOptimizerv4.h.
using itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >::Superclass = GradientDescentOptimizerv4Template<TInternalComputationValueType> |
Definition at line 69 of file itkGradientDescentLineSearchOptimizerv4.h.
|
protected |
Default constructor
|
overrideprotecteddefault |
Destructor
|
overrideprotectedvirtual |
Advance one Step following the gradient direction. Includes transform update.
Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
|
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.
|
virtual |
Controls the maximum recursion depth for the golden section search
|
virtual |
Controls the maximum recursion depth for the golden section search
|
virtual |
Controls the maximum recursion depth for the golden section search
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >.
Reimplemented in itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >.
|
virtual |
Controls the maximum recursion depth for the golden section search
|
protected |
Controls the maximum recursion depth for the golden section search
|
static |
New macro for creation of through a Smart Pointer
|
overrideprotectedvirtual |
Controls the maximum recursion depth for the golden section search
Reimplemented from itk::Object.
|
virtual |
The epsilon determines the accuracy of the line search i.e. the energy alteration that is considered convergent.
|
virtual |
The upper and lower limit below determine the range of values over which the learning rate can be adjusted by the golden section line search. The update can then occur in the range from the smallest change given by : NewParams = OldParams + LowerLimit * gradient to the largest change given by : NewParams = OldParams + UpperLimit * gradient Reasonable values might be 0 and 2.
|
virtual |
Controls the maximum recursion depth for the golden section search
|
virtual |
Controls the maximum recursion depth for the golden section search
|
protected |
Controls the maximum recursion depth for the golden section search
Definition at line 141 of file itkGradientDescentLineSearchOptimizerv4.h.
|
protected |
Counts the recursion depth for the golden section search
Definition at line 147 of file itkGradientDescentLineSearchOptimizerv4.h.
|
protected |
Controls the maximum recursion depth for the golden section search
Definition at line 137 of file itkGradientDescentLineSearchOptimizerv4.h.
|
protected |
Controls the maximum recursion depth for the golden section search
Definition at line 144 of file itkGradientDescentLineSearchOptimizerv4.h.
|
protected |
Controls the maximum recursion depth for the golden section search
Definition at line 139 of file itkGradientDescentLineSearchOptimizerv4.h.
|
protected |
Controls the maximum recursion depth for the golden section search
Definition at line 140 of file itkGradientDescentLineSearchOptimizerv4.h.
|
protected |
Controls the maximum recursion depth for the golden section search
Definition at line 138 of file itkGradientDescentLineSearchOptimizerv4.h.