go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
itkStandardStochasticGradientDescentOptimizer.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright UMC Utrecht and contributors
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 
19 #ifndef __itkStandardStochasticGradientOptimizer_h
20 #define __itkStandardStochasticGradientOptimizer_h
21 
23 
24 namespace itk
25 {
66 {
67 public:
68 
72  typedef SmartPointer<Self> Pointer;
73  typedef SmartPointer<const Self> ConstPointer;
74 
76  itkNewMacro( Self );
77 
80 
90 
92  itkSetMacro( Param_a, double );
93  itkGetConstMacro( Param_a, double );
94 
96  itkSetMacro( Param_beta, double );
97  itkGetConstMacro( Param_beta, double );
98 
100  itkSetMacro( Param_A, double );
101  itkGetConstMacro( Param_A, double );
102 
104  itkSetMacro( Param_alpha, double );
105  itkGetConstMacro( Param_alpha, double );
106 
109  void AdvanceOneStep( void ) override;
110 
112  void StartOptimization( void ) override;
113 
119  itkSetMacro( InitialTime, double );
120  itkGetConstMacro( InitialTime, double );
121 
124  itkGetConstMacro( CurrentTime, double );
125 
129  virtual void ResetCurrentTimeToInitialTime( void )
130  {
131  this->m_CurrentTime = this->m_InitialTime;
132  }
133 
134 protected:
135 
138 
140  virtual double Compute_a( double k ) const;
141 
143  virtual double Compute_beta( double k ) const;
144 
149  virtual void UpdateCurrentTime( void );
150 
153 
156 
157 private:
158 
159  StandardStochasticGradientOptimizer( const Self& ); // purposely not implemented
160  void operator=( const Self& ); // purposely not implemented
161 
163  double m_Param_a;
164  double m_Param_beta;
165  double m_Param_A;
167 
170 
171 }; // end class StandardStochasticGradientOptimizer
172 
173 
174 } // end namespace itk
175 
176 
177 #endif // end #ifndef __itkStandardStochasticGradientOptimizer_h
This class implements a gradient descent optimizer with a decaying gain.
virtual double Compute_beta(double k) const
virtual double Compute_a(double k) const
Superclass::ScaledCostFunctionPointer ScaledCostFunctionPointer


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.9.1 elastix logo