go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
itkStandardGradientDescentOptimizer.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 __itkStandardGradientDescentOptimizer_h
20 #define __itkStandardGradientDescentOptimizer_h
21 
23 
24 namespace itk
25 {
26 
67 {
68 public:
69 
73 
75  typedef SmartPointer< const Self > ConstPointer;
76 
78  itkNewMacro( Self );
79 
82 
92 
94  itkSetMacro( Param_a, double );
95  itkGetConstMacro( Param_a, double );
96 
98  itkSetMacro( Param_A, double );
99  itkGetConstMacro( Param_A, double );
100 
102  itkSetMacro( Param_alpha, double );
103  itkGetConstMacro( Param_alpha, double );
104 
107  virtual void AdvanceOneStep( void );
108 
110  virtual void StartOptimization( void );
111 
117  itkSetMacro( InitialTime, double );
118  itkGetConstMacro( InitialTime, double );
119 
122  itkGetConstMacro( CurrentTime, double );
123 
127  virtual void ResetCurrentTimeToInitialTime( void )
128  {
129  this->m_CurrentTime = this->m_InitialTime;
130  }
131 
132 
133 protected:
134 
137 
139  virtual double Compute_a( double k ) const;
140 
145  virtual void UpdateCurrentTime( void );
146 
149 
152 
153 private:
154 
155  StandardGradientDescentOptimizer( const Self & ); // purposely not implemented
156  void operator=( const Self & ); // purposely not implemented
157 
159  double m_Param_a;
160  double m_Param_A;
162 
165 
166 };
167 
168 } // end namespace itk
169 
170 #endif // end #ifndef __itkStandardGradientDescentOptimizer_h
itk::StandardGradientDescentOptimizer::m_UseConstantStep
bool m_UseConstantStep
Definition: itkStandardGradientDescentOptimizer.h:151
itk::StandardGradientDescentOptimizer::ScalesType
Superclass::ScalesType ScalesType
Definition: itkStandardGradientDescentOptimizer.h:88
SmartPointer< Self >
itk::StandardGradientDescentOptimizer::AdvanceOneStep
virtual void AdvanceOneStep(void)
itk::StandardGradientDescentOptimizer::ScaledCostFunctionType
Superclass::ScaledCostFunctionType ScaledCostFunctionType
Definition: itkStandardGradientDescentOptimizer.h:89
itk::StandardGradientDescentOptimizer::MeasureType
Superclass::MeasureType MeasureType
Definition: itkStandardGradientDescentOptimizer.h:81
itk::GradientDescentOptimizer2::ScalesType
Superclass::ScalesType ScalesType
Definition: itkGradientDescentOptimizer2.h:75
itk::StandardGradientDescentOptimizer::ConstPointer
SmartPointer< const Self > ConstPointer
Definition: itkStandardGradientDescentOptimizer.h:75
itk::StandardGradientDescentOptimizer::CostFunctionType
Superclass::CostFunctionType CostFunctionType
Definition: itkStandardGradientDescentOptimizer.h:87
itk::GradientDescentOptimizer2::ParametersType
Superclass::ParametersType ParametersType
Definition: itkGradientDescentOptimizer2.h:72
itk::GradientDescentOptimizer2
Implement a gradient descent optimizer.
Definition: itkGradientDescentOptimizer2.h:55
itk::StandardGradientDescentOptimizer::Self
StandardGradientDescentOptimizer Self
Definition: itkStandardGradientDescentOptimizer.h:71
itk::StandardGradientDescentOptimizer
This class implements a gradient descent optimizer with a decaying gain.
Definition: itkStandardGradientDescentOptimizer.h:67
itk::StandardGradientDescentOptimizer::StopConditionType
Superclass::StopConditionType StopConditionType
Definition: itkStandardGradientDescentOptimizer.h:91
itk::StandardGradientDescentOptimizer::StandardGradientDescentOptimizer
StandardGradientDescentOptimizer()
itk::GradientDescentOptimizer2::ScaledCostFunctionType
Superclass::ScaledCostFunctionType ScaledCostFunctionType
Definition: itkGradientDescentOptimizer2.h:76
itk::StandardGradientDescentOptimizer::Pointer
SmartPointer< Self > Pointer
Definition: itkStandardGradientDescentOptimizer.h:74
itk::GradientDescentOptimizer2::ScaledCostFunctionPointer
Superclass::ScaledCostFunctionPointer ScaledCostFunctionPointer
Definition: itkGradientDescentOptimizer2.h:77
itk::StandardGradientDescentOptimizer::m_Param_A
double m_Param_A
Definition: itkStandardGradientDescentOptimizer.h:160
itk::ScaledSingleValuedNonLinearOptimizer
Definition: itkScaledSingleValuedNonLinearOptimizer.h:64
itk::StandardGradientDescentOptimizer::m_Param_alpha
double m_Param_alpha
Definition: itkStandardGradientDescentOptimizer.h:161
itk::StandardGradientDescentOptimizer::Superclass
GradientDescentOptimizer2 Superclass
Definition: itkStandardGradientDescentOptimizer.h:72
itk::StandardGradientDescentOptimizer::UpdateCurrentTime
virtual void UpdateCurrentTime(void)
itkGradientDescentOptimizer2.h
itk::StandardGradientDescentOptimizer::operator=
void operator=(const Self &)
itk::StandardGradientDescentOptimizer::~StandardGradientDescentOptimizer
virtual ~StandardGradientDescentOptimizer()
Definition: itkStandardGradientDescentOptimizer.h:136
itk::StandardGradientDescentOptimizer::DerivativeType
Superclass::DerivativeType DerivativeType
Definition: itkStandardGradientDescentOptimizer.h:86
itk::StandardGradientDescentOptimizer::ResetCurrentTimeToInitialTime
virtual void ResetCurrentTimeToInitialTime(void)
Definition: itkStandardGradientDescentOptimizer.h:127
itk::GradientDescentOptimizer2::MeasureType
Superclass::MeasureType MeasureType
Definition: itkGradientDescentOptimizer2.h:68
itk
Definition: itkAdvancedImageToImageMetric.h:40
itk::GradientDescentOptimizer2::DerivativeType
Superclass::DerivativeType DerivativeType
Definition: itkGradientDescentOptimizer2.h:73
itk::StandardGradientDescentOptimizer::m_CurrentTime
double m_CurrentTime
Definition: itkStandardGradientDescentOptimizer.h:148
itk::StandardGradientDescentOptimizer::Compute_a
virtual double Compute_a(double k) const
itk::StandardGradientDescentOptimizer::ScaledCostFunctionPointer
Superclass::ScaledCostFunctionPointer ScaledCostFunctionPointer
Definition: itkStandardGradientDescentOptimizer.h:90
itk::GradientDescentOptimizer2::CostFunctionType
Superclass::CostFunctionType CostFunctionType
Definition: itkGradientDescentOptimizer2.h:74
itk::StandardGradientDescentOptimizer::StartOptimization
virtual void StartOptimization(void)
itk::StandardGradientDescentOptimizer::ParametersType
Superclass::ParametersType ParametersType
Definition: itkStandardGradientDescentOptimizer.h:85
itk::GradientDescentOptimizer2::StopConditionType
StopConditionType
Definition: itkGradientDescentOptimizer2.h:82
itk::StandardGradientDescentOptimizer::m_InitialTime
double m_InitialTime
Definition: itkStandardGradientDescentOptimizer.h:164
itk::StandardGradientDescentOptimizer::StandardGradientDescentOptimizer
StandardGradientDescentOptimizer(const Self &)
itk::StandardGradientDescentOptimizer::m_Param_a
double m_Param_a
Definition: itkStandardGradientDescentOptimizer.h:159


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo