ITK
4.0.0
Insight Segmentation and Registration Toolkit
|
Abstract base class for gradient descent-style optimizers. More...
#include <itkGradientDescentOptimizerBasev4.h>
Abstract base class for gradient descent-style optimizers.
Gradient modification is threaded in ModifyGradient
.
Derived classes must override ModifyGradientOverSubRange
and ResumeOptimization
.
Definition at line 38 of file itkGradientDescentOptimizerBasev4.h.
typedef SmartPointer< const Self > itk::GradientDescentOptimizerBasev4::ConstPointer |
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
Definition at line 46 of file itkGradientDescentOptimizerBasev4.h.
Derivative type
Reimplemented in itk::GradientDescentOptimizerv4.
Definition at line 72 of file itkGradientDescentOptimizerBasev4.h.
typedef GradientDescentOptimizerBasev4ModifyGradientByScalesThreader::IndexRangeType itk::GradientDescentOptimizerBasev4::IndexRangeType [protected] |
Definition at line 117 of file itkGradientDescentOptimizerBasev4.h.
typedef Superclass::InternalComputationValueType itk::GradientDescentOptimizerBasev4::InternalComputationValueType |
Internal computation type, for maintaining a desired precision
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
Definition at line 78 of file itkGradientDescentOptimizerBasev4.h.
Measure type
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4.
Definition at line 75 of file itkGradientDescentOptimizerBasev4.h.
Metric type over which this class is templated
Reimplemented from itk::ObjectToObjectOptimizerBase.
Definition at line 68 of file itkGradientDescentOptimizerBasev4.h.
Reimplemented from itk::ObjectToObjectOptimizerBase.
Definition at line 69 of file itkGradientDescentOptimizerBasev4.h.
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
Definition at line 45 of file itkGradientDescentOptimizerBasev4.h.
Standard class typedefs.
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
Definition at line 43 of file itkGradientDescentOptimizerBasev4.h.
typedef std::ostringstream itk::GradientDescentOptimizerBasev4::StopConditionDescriptionType |
Stop condition internal string type
Definition at line 65 of file itkGradientDescentOptimizerBasev4.h.
typedef std::string itk::GradientDescentOptimizerBasev4::StopConditionReturnStringType |
Stop condition return string type
Definition at line 62 of file itkGradientDescentOptimizerBasev4.h.
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
Definition at line 44 of file itkGradientDescentOptimizerBasev4.h.
Codes of stopping conditions.
MAXIMUM_NUMBER_OF_ITERATIONS | |
COSTFUNCTION_ERROR | |
UPDATE_PARAMETERS_ERROR | |
STEP_TOO_SMALL | |
QUASI_NEWTON_STEP_ERROR | |
OTHER_ERROR |
Definition at line 52 of file itkGradientDescentOptimizerBasev4.h.
itk::GradientDescentOptimizerBasev4::GradientDescentOptimizerBasev4 | ( | ) | [protected] |
Default constructor
virtual itk::GradientDescentOptimizerBasev4::~GradientDescentOptimizerBasev4 | ( | ) | [protected, virtual] |
Default constructor
itk::GradientDescentOptimizerBasev4::GradientDescentOptimizerBasev4 | ( | const Self & | ) | [private] |
virtual void itk::GradientDescentOptimizerBasev4::EstimateLearningRate | ( | ) | [protected, pure virtual] |
Estimate the learning rate
Implemented in itk::GradientDescentOptimizerv4.
virtual SizeValueType itk::GradientDescentOptimizerBasev4::GetCurrentIteration | ( | ) | const [virtual] |
Get the current iteration number.
virtual const DerivativeType& itk::GradientDescentOptimizerBasev4::GetGradient | ( | ) | [virtual] |
Get the most recent gradient values.
virtual const char* itk::GradientDescentOptimizerBasev4::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
virtual const SizeValueType& itk::GradientDescentOptimizerBasev4::GetNumberOfIterations | ( | ) | [virtual] |
Get the number of iterations.
virtual const StopConditionType& itk::GradientDescentOptimizerBasev4::GetStopCondition | ( | ) | [virtual] |
Get stop condition enum
virtual const StopConditionReturnStringType itk::GradientDescentOptimizerBasev4::GetStopConditionDescription | ( | ) | const [virtual] |
Get the reason for termination
virtual void itk::GradientDescentOptimizerBasev4::ModifyGradient | ( | ) | [protected, virtual] |
Modify the gradient in place, to advance the optimization. This call performs a threaded modification for transforms with local support (assumed to be dense). Otherwise the modification is performed w/out threading. At completion, m_Gradient can be used to update the transform parameters. Derived classes may hold additional results in other member variables.
virtual void itk::GradientDescentOptimizerBasev4::ModifyGradientByLearningRateOverSubRange | ( | const IndexRangeType & | subrange | ) | [protected, pure virtual] |
Derived classes define this worker method to modify the gradient by learning rates. Modifications must be performed over the index range defined in subrange
. Called from ModifyGradient(), either directly or via threaded operation.
Implemented in itk::GradientDescentOptimizerv4.
virtual void itk::GradientDescentOptimizerBasev4::ModifyGradientByScalesOverSubRange | ( | const IndexRangeType & | subrange | ) | [protected, pure virtual] |
Derived classes define this worker method to modify the gradient by scales. Modifications must be performed over the index range defined in subrange
. Called from ModifyGradient(), either directly or via threaded operation.
Implemented in itk::GradientDescentOptimizerv4.
void itk::GradientDescentOptimizerBasev4::operator= | ( | const Self & | ) | [private] |
Mutex lock to protect modification to the reference count
Reimplemented from itk::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
virtual void itk::GradientDescentOptimizerBasev4::PrintSelf | ( | std::ostream & | os, |
Indent | indent | ||
) | const [protected, virtual] |
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::ObjectToObjectOptimizerBase.
Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.
virtual void itk::GradientDescentOptimizerBasev4::ResumeOptimization | ( | ) | [pure virtual] |
Resume optimization. This runs the optimization loop, and allows continuation of stopped optimization
Implemented in itk::GradientDescentOptimizerv4.
virtual void itk::GradientDescentOptimizerBasev4::SetNumberOfIterations | ( | SizeValueType | _arg | ) | [virtual] |
Set the number of iterations.
virtual void itk::GradientDescentOptimizerBasev4::StopOptimization | ( | void | ) | [virtual] |
Stop optimization. The object is left in a state so the optimization can be resumed by calling ResumeOptimization.
friend class GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader [friend] |
Definition at line 115 of file itkGradientDescentOptimizerBasev4.h.
friend class GradientDescentOptimizerBasev4ModifyGradientByScalesThreader [friend] |
Definition at line 114 of file itkGradientDescentOptimizerBasev4.h.
Definition at line 154 of file itkGradientDescentOptimizerBasev4.h.
Current gradient
Definition at line 157 of file itkGradientDescentOptimizerBasev4.h.
GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader::Pointer itk::GradientDescentOptimizerBasev4::m_ModifyGradientByLearningRateThreader [protected] |
Definition at line 120 of file itkGradientDescentOptimizerBasev4.h.
GradientDescentOptimizerBasev4ModifyGradientByScalesThreader::Pointer itk::GradientDescentOptimizerBasev4::m_ModifyGradientByScalesThreader [protected] |
Definition at line 119 of file itkGradientDescentOptimizerBasev4.h.
Definition at line 153 of file itkGradientDescentOptimizerBasev4.h.
bool itk::GradientDescentOptimizerBasev4::m_Stop [protected] |
Definition at line 150 of file itkGradientDescentOptimizerBasev4.h.
Definition at line 151 of file itkGradientDescentOptimizerBasev4.h.
StopConditionDescriptionType itk::GradientDescentOptimizerBasev4::m_StopConditionDescription [protected] |
Definition at line 152 of file itkGradientDescentOptimizerBasev4.h.