![]() |
Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages |
#include <elxStandardGradientDescent.h>
Public Member Functions | |
virtual void | AfterEachIteration (void) |
virtual void | AfterEachResolution (void) |
virtual void | AfterRegistration (void) |
virtual void | BeforeEachResolution (void) |
virtual void | BeforeRegistration (void) |
elxClassNameMacro ("StandardGradientDescent") | |
virtual const char * | GetClassName () const |
virtual const unsigned long & | GetMaximumNumberOfSamplingAttempts () |
virtual void | MetricErrorResponse (ExceptionObject &err) |
virtual void | SetCurrentPositionPublic (const ParametersType ¶m) |
virtual void | SetMaximumNumberOfSamplingAttempts (unsigned long _arg) |
virtual void | StartOptimization (void) |
![]() | |
virtual void | AdvanceOneStep (void) |
virtual double | GetCurrentTime () const |
virtual double | GetInitialTime () const |
virtual double | GetParam_a () const |
virtual double | GetParam_A () const |
virtual double | GetParam_alpha () const |
virtual void | ResetCurrentTimeToInitialTime (void) |
virtual void | SetInitialTime (double _arg) |
virtual void | SetParam_a (double _arg) |
virtual void | SetParam_A (double _arg) |
virtual void | SetParam_alpha (double _arg) |
![]() | |
virtual unsigned int | GetCurrentIteration () const |
virtual const DerivativeType & | GetGradient () |
virtual const double & | GetLearningRate () |
virtual const unsigned long & | GetNumberOfIterations () |
virtual const StopConditionType & | GetStopCondition () |
virtual const double & | GetValue () |
virtual void | ResumeOptimization (void) |
virtual void | SetLearningRate (double _arg) |
virtual void | SetNumberOfIterations (unsigned long _arg) |
virtual void | StopOptimization (void) |
![]() | |
virtual const ParametersType & | GetCurrentPosition (void) const |
virtual bool | GetMaximize () const |
virtual const ScaledCostFunctionType * | GetScaledCostFunction () |
virtual const ParametersType & | GetScaledCurrentPosition () |
bool | GetUseScales (void) const |
virtual void | InitializeScales (void) |
virtual void | MaximizeOff () |
virtual void | MaximizeOn () |
virtual void | SetCostFunction (CostFunctionType *costFunction) |
virtual void | SetMaximize (bool _arg) |
virtual void | SetUseScales (bool arg) |
![]() | |
virtual void | BeforeEachResolutionBase () |
virtual ITKBaseType * | GetAsITKBaseType (void) |
virtual const ITKBaseType * | GetAsITKBaseType (void) const |
virtual void | SetCurrentPositionPublic (const ParametersType ¶m) |
virtual void | SetSinusScales (double amplitude, double frequency, unsigned long numberOfParameters) |
![]() | |
virtual ConfigurationType * | GetConfiguration (void) const |
virtual ElastixType * | GetElastix (void) const |
virtual RegistrationPointer | GetRegistration (void) const |
virtual void | SetConfiguration (ConfigurationType *_arg) |
virtual void | SetElastix (ElastixType *_arg) |
![]() | |
virtual void | AfterEachIterationBase (void) |
virtual void | AfterEachResolutionBase (void) |
virtual void | AfterRegistrationBase (void) |
virtual int | BeforeAll (void) |
virtual int | BeforeAllBase (void) |
virtual void | BeforeRegistrationBase (void) |
virtual const char * | elxGetClassName (void) const |
virtual const char * | GetComponentLabel (void) const |
virtual void | SetComponentLabel (const char *label, unsigned int idx) |
Static Public Member Functions | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
static Pointer | New () |
Private Member Functions | |
void | operator= (const Self &) |
StandardGradientDescent (const Self &) | |
Private Attributes | |
unsigned long | m_CurrentNumberOfSamplingAttempts |
unsigned long | m_MaximumNumberOfSamplingAttempts |
unsigned long | m_PreviousErrorAtIteration |
Additional Inherited Members | |
![]() | |
double | m_CurrentTime |
![]() | |
DerivativeType | m_Gradient |
double | m_LearningRate |
StopConditionType | m_StopCondition |
![]() | |
ScaledCostFunctionPointer | m_ScaledCostFunction |
ParametersType | m_ScaledCurrentPosition |
![]() | |
ConfigurationPointer | m_Configuration |
ElastixPointer | m_Elastix |
RegistrationPointer | m_Registration |
A gradient descent optimizer with a decaying gain.
This class is a wrap around the StandardGradientDescentOptimizer class. It takes care of setting parameters and printing progress information. For more information about the optimisation method, please read the documentation of the StandardGradientDescentOptimizer class.
The parameters used in this class are:
Optimizer: Select this optimizer as follows:
(Optimizer "StandardGradientDescent")
MaximumNumberOfIterations: The maximum number of iterations in each resolution.
example: (MaximumNumberOfIterations 100 100 50)
Default/recommended value: 500.
MaximumNumberOfSamplingAttempts: The maximum number of sampling attempts. Sometimes not enough corresponding samples can be drawn, upon which an exception is thrown. With this parameter it is possible to try to draw another set of samples.
example: (MaximumNumberOfSamplingAttempts 10 15 10)
Default value: 0, i.e. just fail immediately, for backward compatibility.
SP_a: The gain at each iteration
is defined by
.
SP_a can be defined for each resolution.
example: (SP_a 3200.0 3200.0 1600.0)
The default value is 400.0. Tuning this variable for you specific problem is recommended.
SP_A: The gain at each iteration
is defined by
.
SP_A can be defined for each resolution.
example: (SP_A 50.0 50.0 100.0)
The default/recommended value is 50.0.
SP_alpha: The gain at each iteration
is defined by
.
SP_alpha can be defined for each resolution.
example: (SP_alpha 0.602 0.602 0.602)
The default/recommended value is 0.602.
Definition at line 67 of file elxStandardGradientDescent.h.
typedef Superclass2::ConfigurationPointer elastix::StandardGradientDescent< TElastix >::ConfigurationPointer |
Definition at line 103 of file elxStandardGradientDescent.h.
typedef Superclass2::ConfigurationType elastix::StandardGradientDescent< TElastix >::ConfigurationType |
Definition at line 102 of file elxStandardGradientDescent.h.
typedef SmartPointer<const Self> elastix::StandardGradientDescent< TElastix >::ConstPointer |
Definition at line 80 of file elxStandardGradientDescent.h.
typedef Superclass1::CostFunctionPointer elastix::StandardGradientDescent< TElastix >::CostFunctionPointer |
Definition at line 96 of file elxStandardGradientDescent.h.
typedef Superclass1::CostFunctionType elastix::StandardGradientDescent< TElastix >::CostFunctionType |
Typedef's inherited from Superclass1, the StandardGradientDescentOptimizer.
Definition at line 95 of file elxStandardGradientDescent.h.
typedef Superclass2::ElastixPointer elastix::StandardGradientDescent< TElastix >::ElastixPointer |
Definition at line 101 of file elxStandardGradientDescent.h.
typedef Superclass2::ElastixType elastix::StandardGradientDescent< TElastix >::ElastixType |
Typedef's inherited from Superclass2, the elastix OptimizerBase .
Definition at line 100 of file elxStandardGradientDescent.h.
typedef Superclass2::ITKBaseType elastix::StandardGradientDescent< TElastix >::ITKBaseType |
Definition at line 106 of file elxStandardGradientDescent.h.
typedef Superclass1::ParametersType elastix::StandardGradientDescent< TElastix >::ParametersType |
Typedef for the ParametersType.
Definition at line 109 of file elxStandardGradientDescent.h.
typedef SmartPointer<Self> elastix::StandardGradientDescent< TElastix >::Pointer |
Definition at line 79 of file elxStandardGradientDescent.h.
typedef Superclass2::RegistrationPointer elastix::StandardGradientDescent< TElastix >::RegistrationPointer |
Definition at line 105 of file elxStandardGradientDescent.h.
typedef Superclass2::RegistrationType elastix::StandardGradientDescent< TElastix >::RegistrationType |
Definition at line 104 of file elxStandardGradientDescent.h.
typedef StandardGradientDescent elastix::StandardGradientDescent< TElastix >::Self |
Standard ITK.
Definition at line 76 of file elxStandardGradientDescent.h.
typedef Superclass1::StopConditionType elastix::StandardGradientDescent< TElastix >::StopConditionType |
Definition at line 97 of file elxStandardGradientDescent.h.
typedef StandardGradientDescentOptimizer elastix::StandardGradientDescent< TElastix >::Superclass1 |
Definition at line 77 of file elxStandardGradientDescent.h.
typedef OptimizerBase<TElastix> elastix::StandardGradientDescent< TElastix >::Superclass2 |
Definition at line 78 of file elxStandardGradientDescent.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 143 of file elxStandardGradientDescent.h.
|
private |
|
virtual |
Reimplemented from elastix::BaseComponent.
|
virtual |
Reimplemented from elastix::BaseComponent.
|
virtual |
Reimplemented from elastix::BaseComponent.
|
virtual |
Reimplemented from elastix::BaseComponent.
|
virtual |
Methods invoked by elastix, in which parameters can be set and progress information can be printed.
Reimplemented from elastix::BaseComponent.
elastix::StandardGradientDescent< TElastix >::elxClassNameMacro | ( | "StandardGradientDescent< TElastix >" | ) |
Name of this class. Use this name in the parameter file to select this specific optimizer. example: (Optimizer "StandardGradientDescent")
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::StandardGradientDescentOptimizer.
|
virtual |
Get the MaximumNumberOfSamplingAttempts.
|
virtual |
Stop optimisation and pass on exception.
Reimplemented from itk::GradientDescentOptimizer2.
|
static |
Method for creation through the object factory.
|
private |
|
inlinevirtual |
Add SetCurrentPositionPublic, which calls the protected SetCurrentPosition of the itkStandardGradientDescentOptimizer class.
Definition at line 129 of file elxStandardGradientDescent.h.
|
virtual |
Set the MaximumNumberOfSamplingAttempts.
|
virtual |
Check if any scales are set, and set the UseScales flag on or off; after that call the superclass' implementation
Reimplemented from itk::StandardGradientDescentOptimizer.
|
private |
Definition at line 153 of file elxStandardGradientDescent.h.
|
private |
Private variables for the sampling attempts.
Definition at line 152 of file elxStandardGradientDescent.h.
|
private |
Definition at line 154 of file elxStandardGradientDescent.h.
Generated on 06-12-2013 for elastix by ![]() |
![]() |