go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
itkFiniteDifferenceGradientDescentOptimizer.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 __itkFiniteDifferenceGradientDescentOptimizer_h
20 #define __itkFiniteDifferenceGradientDescentOptimizer_h
21 
23 
24 namespace itk
25 {
26 
57 {
58 public:
59 
64  typedef SmartPointer< const Self > ConstPointer;
65 
67  itkNewMacro( Self );
68 
71 
73  typedef enum {
77 
79  virtual void AdvanceOneStep( void );
80 
82  void StartOptimization( void );
83 
86  void ResumeOptimization( void );
87 
90  void StopOptimization( void );
91 
93  itkSetMacro( NumberOfIterations, unsigned long );
94 
96  itkGetConstMacro( NumberOfIterations, unsigned long );
97 
99  itkGetConstMacro( CurrentIteration, unsigned long );
100 
102  itkGetConstMacro( Value, double );
103 
105  itkGetConstMacro( StopCondition, StopConditionType );
106 
108  itkSetMacro( Param_a, double );
109  itkGetMacro( Param_a, double );
110 
112  itkSetMacro( Param_c, double );
113  itkGetMacro( Param_c, double );
114 
116  itkSetMacro( Param_A, double );
117  itkGetMacro( Param_A, double );
118 
120  itkSetMacro( Param_alpha, double );
121  itkGetMacro( Param_alpha, double );
122 
124  itkSetMacro( Param_gamma, double );
125  itkGetMacro( Param_gamma, double );
126 
127  itkGetConstMacro( ComputeCurrentValue, bool );
128  itkSetMacro( ComputeCurrentValue, bool );
129  itkBooleanMacro( ComputeCurrentValue );
130 
132  itkGetConstMacro( GradientMagnitude, double );
133  itkGetConstMacro( LearningRate, double );
134 
135 protected:
136 
139 
141  void PrintSelf( std::ostream & os, Indent indent ) const;
142 
143  // made protected so subclass can access
147 
154 
155  // Functions to compute the parameters at iteration k.
156  virtual double Compute_a( unsigned long k ) const;
157 
158  virtual double Compute_c( unsigned long k ) const;
159 
160 private:
161 
162  FiniteDifferenceGradientDescentOptimizer( const Self & ); // purposely not implemented
163  void operator=( const Self & ); // purposely not implemented
164 
166  bool m_Stop;
167  double m_Value;
169  unsigned long m_NumberOfIterations;
170  unsigned long m_CurrentIteration;
171 
173  double m_Param_a;
174  double m_Param_c;
175  double m_Param_A;
178 
179 };
180 
181 } // end namespace itk
182 
183 #endif // end #ifndef __itkFiniteDifferenceGradientDescentOptimizer_h
itk::FiniteDifferenceGradientDescentOptimizer::m_StopCondition
StopConditionType m_StopCondition
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:168
SmartPointer< Self >
itk::FiniteDifferenceGradientDescentOptimizer::m_Param_gamma
double m_Param_gamma
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:177
itk::FiniteDifferenceGradientDescentOptimizer::~FiniteDifferenceGradientDescentOptimizer
virtual ~FiniteDifferenceGradientDescentOptimizer()
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:138
itk::FiniteDifferenceGradientDescentOptimizer::operator=
void operator=(const Self &)
itk::FiniteDifferenceGradientDescentOptimizer::m_Value
double m_Value
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:167
itk::FiniteDifferenceGradientDescentOptimizer::MaximumNumberOfIterations
@ MaximumNumberOfIterations
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:74
itk::FiniteDifferenceGradientDescentOptimizer::m_Param_alpha
double m_Param_alpha
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:176
itk::FiniteDifferenceGradientDescentOptimizer::PrintSelf
void PrintSelf(std::ostream &os, Indent indent) const
itk::FiniteDifferenceGradientDescentOptimizer::m_NumberOfIterations
unsigned long m_NumberOfIterations
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:169
itk::FiniteDifferenceGradientDescentOptimizer::StartOptimization
void StartOptimization(void)
itk::FiniteDifferenceGradientDescentOptimizer::m_GradientMagnitude
double m_GradientMagnitude
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:146
itk::FiniteDifferenceGradientDescentOptimizer::m_ComputeCurrentValue
bool m_ComputeCurrentValue
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:153
itk::FiniteDifferenceGradientDescentOptimizer::Pointer
SmartPointer< Self > Pointer
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:63
itk::FiniteDifferenceGradientDescentOptimizer::m_Param_A
double m_Param_A
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:175
itk::FiniteDifferenceGradientDescentOptimizer::ConstPointer
SmartPointer< const Self > ConstPointer
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:64
itk::FiniteDifferenceGradientDescentOptimizer::m_Stop
bool m_Stop
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:166
itk::FiniteDifferenceGradientDescentOptimizer::Compute_c
virtual double Compute_c(unsigned long k) const
itk::ScaledSingleValuedNonLinearOptimizer::DerivativeType
Superclass::DerivativeType DerivativeType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:83
itk::FiniteDifferenceGradientDescentOptimizer::m_Gradient
DerivativeType m_Gradient
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:144
itk::FiniteDifferenceGradientDescentOptimizer::MetricError
@ MetricError
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:75
itkScaledSingleValuedNonLinearOptimizer.h
itk::FiniteDifferenceGradientDescentOptimizer::Self
FiniteDifferenceGradientDescentOptimizer Self
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:61
itk::FiniteDifferenceGradientDescentOptimizer::StopConditionType
StopConditionType
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:73
itk::ScaledSingleValuedNonLinearOptimizer
Definition: itkScaledSingleValuedNonLinearOptimizer.h:64
itk::FiniteDifferenceGradientDescentOptimizer::m_Param_a
double m_Param_a
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:173
itk::FiniteDifferenceGradientDescentOptimizer::Compute_a
virtual double Compute_a(unsigned long k) const
itk::FiniteDifferenceGradientDescentOptimizer::m_LearningRate
double m_LearningRate
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:145
itk::FiniteDifferenceGradientDescentOptimizer::AdvanceOneStep
virtual void AdvanceOneStep(void)
itk::FiniteDifferenceGradientDescentOptimizer::StopOptimization
void StopOptimization(void)
itk::FiniteDifferenceGradientDescentOptimizer::ResumeOptimization
void ResumeOptimization(void)
itk::FiniteDifferenceGradientDescentOptimizer::m_CurrentIteration
unsigned long m_CurrentIteration
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:170
itk
Definition: itkAdvancedImageToImageMetric.h:40
itk::FiniteDifferenceGradientDescentOptimizer::Superclass
ScaledSingleValuedNonLinearOptimizer Superclass
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:62
itk::FiniteDifferenceGradientDescentOptimizer::FiniteDifferenceGradientDescentOptimizer
FiniteDifferenceGradientDescentOptimizer(const Self &)
itk::FiniteDifferenceGradientDescentOptimizer::FiniteDifferenceGradientDescentOptimizer
FiniteDifferenceGradientDescentOptimizer()
itk::FiniteDifferenceGradientDescentOptimizer
An optimizer based on gradient descent ...
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:57
itk::FiniteDifferenceGradientDescentOptimizer::m_Param_c
double m_Param_c
Definition: itkFiniteDifferenceGradientDescentOptimizer.h:174


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo