go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
itkGenericConjugateGradientOptimizer.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 __itkGenericConjugateGradientOptimizer_h
20 #define __itkGenericConjugateGradientOptimizer_h
21 
23 #include "itkLineSearchOptimizer.h"
24 #include <vector>
25 #include <map>
26 
27 namespace itk
28 {
42 {
43 public:
44 
48  typedef SmartPointer< const Self > ConstPointer;
49 
50  itkNewMacro( Self );
53 
60 
63 
67  )( const DerivativeType &,
68  const DerivativeType &,
69  const ParametersType & );
70  typedef std::string BetaDefinitionType;
71  typedef std::map< BetaDefinitionType,
73 
74  typedef enum {
81  Unknown
83 
84  virtual void StartOptimization( void );
85 
86  virtual void ResumeOptimization( void );
87 
88  virtual void StopOptimization( void );
89 
91  itkGetConstMacro( CurrentIteration, unsigned long );
92  itkGetConstMacro( CurrentValue, MeasureType );
93  itkGetConstReferenceMacro( CurrentGradient, DerivativeType );
94  itkGetConstMacro( InLineSearch, bool );
95  itkGetConstReferenceMacro( StopCondition, StopConditionType );
96  itkGetConstMacro( CurrentStepLength, double );
97 
101 
103  itkGetConstMacro( MaximumNumberOfIterations, unsigned long );
104  itkSetClampMacro( MaximumNumberOfIterations, unsigned long,
105  1, NumericTraits< unsigned long >::max() );
106 
113  itkGetConstMacro( GradientMagnitudeTolerance, double );
114  itkSetMacro( GradientMagnitudeTolerance, double )
115 
116 
123  itkGetConstMacro( ValueTolerance, double );
124  itkSetMacro( ValueTolerance, double );
125 
129  virtual void SetMaxNrOfItWithoutImprovement( unsigned long arg );
130 
131  itkGetConstMacro( MaxNrOfItWithoutImprovement, unsigned long );
132 
134  virtual void SetBetaDefinition( const BetaDefinitionType & arg );
135 
136  itkGetConstReferenceMacro( BetaDefinition, BetaDefinitionType );
137 
138 protected:
139 
142 
143  void PrintSelf( std::ostream & os, Indent indent ) const;
144 
147  unsigned long m_CurrentIteration;
149  bool m_Stop;
151 
155 
158  itkSetMacro( InLineSearch, bool );
159 
165 
168 
172 
178  virtual void AddBetaDefinition(
179  const BetaDefinitionType & name,
180  ComputeBetaFunctionType function );
181 
193  const DerivativeType & previousGradient,
194  const DerivativeType & gradient,
195  ParametersType & searchDir );
196 
201  virtual void LineSearch(
202  const ParametersType searchDir,
203  double & step,
204  ParametersType & x,
205  MeasureType & f,
206  DerivativeType & g );
207 
212  virtual bool TestConvergence( bool firstLineSearchDone );
213 
215  virtual double ComputeBeta(
216  const DerivativeType & previousGradient,
217  const DerivativeType & gradient,
218  const ParametersType & previousSearchDir );
219 
224  const DerivativeType & previousGradient,
225  const DerivativeType & gradient,
226  const ParametersType & previousSearchDir );
227 
230  const DerivativeType & previousGradient,
231  const DerivativeType & gradient,
232  const ParametersType & previousSearchDir );
233 
236  const DerivativeType & previousGradient,
237  const DerivativeType & gradient,
238  const ParametersType & previousSearchDir );
239 
242  const DerivativeType & previousGradient,
243  const DerivativeType & gradient,
244  const ParametersType & previousSearchDir );
245 
248  const DerivativeType & previousGradient,
249  const DerivativeType & gradient,
250  const ParametersType & previousSearchDir );
251 
254  const DerivativeType & previousGradient,
255  const DerivativeType & gradient,
256  const ParametersType & previousSearchDir );
257 
258 private:
259 
260  GenericConjugateGradientOptimizer( const Self & ); // purposely not implemented
261  void operator=( const Self & ); // purposely not implemented
262 
267 
269 
270 };
271 
272 } // end namespace itk
273 
274 #endif //#ifndef __itkGenericConjugateGradientOptimizer_h
itk::GenericConjugateGradientOptimizer::StopOptimization
virtual void StopOptimization(void)
itk::GenericConjugateGradientOptimizer::BetaDefinitionType
std::string BetaDefinitionType
Definition: itkGenericConjugateGradientOptimizer.h:70
itk::GenericConjugateGradientOptimizer::SetMaxNrOfItWithoutImprovement
virtual void SetMaxNrOfItWithoutImprovement(unsigned long arg)
itk::ScaledSingleValuedNonLinearOptimizer::ScaledCostFunctionType
ScaledSingleValuedCostFunction ScaledCostFunctionType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:87
itk::GenericConjugateGradientOptimizer::m_CurrentGradient
DerivativeType m_CurrentGradient
Definition: itkGenericConjugateGradientOptimizer.h:145
itk::GenericConjugateGradientOptimizer
A set of conjugate gradient algorithms.
Definition: itkGenericConjugateGradientOptimizer.h:42
SmartPointer< Self >
itk::GenericConjugateGradientOptimizer::m_BetaDefinition
BetaDefinitionType m_BetaDefinition
Definition: itkGenericConjugateGradientOptimizer.h:167
itk::GenericConjugateGradientOptimizer::CostFunctionType
Superclass::CostFunctionType CostFunctionType
Definition: itkGenericConjugateGradientOptimizer.h:56
itk::GenericConjugateGradientOptimizer::m_ValueTolerance
double m_ValueTolerance
Definition: itkGenericConjugateGradientOptimizer.h:264
itk::GenericConjugateGradientOptimizer::m_CurrentIteration
unsigned long m_CurrentIteration
Definition: itkGenericConjugateGradientOptimizer.h:147
itk::GenericConjugateGradientOptimizer::BetaDefinitionMapType
std::map< BetaDefinitionType, ComputeBetaFunctionType > BetaDefinitionMapType
Definition: itkGenericConjugateGradientOptimizer.h:72
itk::GenericConjugateGradientOptimizer::PrintSelf
void PrintSelf(std::ostream &os, Indent indent) const
itk::GenericConjugateGradientOptimizer::ComputeSearchDirection
virtual void ComputeSearchDirection(const DerivativeType &previousGradient, const DerivativeType &gradient, ParametersType &searchDir)
itk::GenericConjugateGradientOptimizer::InfiniteBeta
@ InfiniteBeta
Definition: itkGenericConjugateGradientOptimizer.h:80
itk::GenericConjugateGradientOptimizer::m_GradientMagnitudeTolerance
double m_GradientMagnitudeTolerance
Definition: itkGenericConjugateGradientOptimizer.h:265
itk::GenericConjugateGradientOptimizer::m_BetaDefinitionMap
BetaDefinitionMapType m_BetaDefinitionMap
Definition: itkGenericConjugateGradientOptimizer.h:171
itk::ScaledSingleValuedNonLinearOptimizer::DerivativeType
Superclass::DerivativeType DerivativeType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:83
itk::GenericConjugateGradientOptimizer::m_LineSearchOptimizer
LineSearchOptimizerPointer m_LineSearchOptimizer
Definition: itkGenericConjugateGradientOptimizer.h:268
itk::GenericConjugateGradientOptimizer::m_Stop
bool m_Stop
Definition: itkGenericConjugateGradientOptimizer.h:149
itk::GenericConjugateGradientOptimizer::Pointer
SmartPointer< Self > Pointer
Definition: itkGenericConjugateGradientOptimizer.h:47
itk::GenericConjugateGradientOptimizer::LineSearch
virtual void LineSearch(const ParametersType searchDir, double &step, ParametersType &x, MeasureType &f, DerivativeType &g)
itk::GenericConjugateGradientOptimizer::ComputeBetaSD
double ComputeBetaSD(const DerivativeType &previousGradient, const DerivativeType &gradient, const ParametersType &previousSearchDir)
itkLineSearchOptimizer.h
itk::GenericConjugateGradientOptimizer::TestConvergence
virtual bool TestConvergence(bool firstLineSearchDone)
itk::GenericConjugateGradientOptimizer::LineSearchError
@ LineSearchError
Definition: itkGenericConjugateGradientOptimizer.h:76
itk::GenericConjugateGradientOptimizer::ScalesType
Superclass::ScalesType ScalesType
Definition: itkGenericConjugateGradientOptimizer.h:59
itk::GenericConjugateGradientOptimizer::LineSearchOptimizerPointer
LineSearchOptimizerType::Pointer LineSearchOptimizerPointer
Definition: itkGenericConjugateGradientOptimizer.h:62
itk::GenericConjugateGradientOptimizer::m_MaxNrOfItWithoutImprovement
unsigned long m_MaxNrOfItWithoutImprovement
Definition: itkGenericConjugateGradientOptimizer.h:266
double
itk::GenericConjugateGradientOptimizer::StopConditionType
StopConditionType
Definition: itkGenericConjugateGradientOptimizer.h:74
itk::GenericConjugateGradientOptimizer::m_InLineSearch
bool m_InLineSearch
Definition: itkGenericConjugateGradientOptimizer.h:157
itk::GenericConjugateGradientOptimizer::m_PreviousGradientAndSearchDirValid
bool m_PreviousGradientAndSearchDirValid
Definition: itkGenericConjugateGradientOptimizer.h:158
itk::GenericConjugateGradientOptimizer::Unknown
@ Unknown
Definition: itkGenericConjugateGradientOptimizer.h:81
itkScaledSingleValuedNonLinearOptimizer.h
itk::GenericConjugateGradientOptimizer::GradientMagnitudeTolerance
@ GradientMagnitudeTolerance
Definition: itkGenericConjugateGradientOptimizer.h:78
itk::GenericConjugateGradientOptimizer::SetBetaDefinition
virtual void SetBetaDefinition(const BetaDefinitionType &arg)
itk::ScaledSingleValuedNonLinearOptimizer::CostFunctionType
Superclass::CostFunctionType CostFunctionType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:84
itk::ScaledSingleValuedNonLinearOptimizer::MeasureType
Superclass::MeasureType MeasureType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:78
itk::GenericConjugateGradientOptimizer::m_StopCondition
StopConditionType m_StopCondition
Definition: itkGenericConjugateGradientOptimizer.h:148
itk::ScaledSingleValuedNonLinearOptimizer
Definition: itkScaledSingleValuedNonLinearOptimizer.h:64
itk::GenericConjugateGradientOptimizer::m_MaximumNumberOfIterations
unsigned long m_MaximumNumberOfIterations
Definition: itkGenericConjugateGradientOptimizer.h:263
itk::GenericConjugateGradientOptimizer::Self
GenericConjugateGradientOptimizer Self
Definition: itkGenericConjugateGradientOptimizer.h:45
itk::GenericConjugateGradientOptimizer::ScaledCostFunctionType
Superclass::ScaledCostFunctionType ScaledCostFunctionType
Definition: itkGenericConjugateGradientOptimizer.h:57
itk::GenericConjugateGradientOptimizer::Superclass
ScaledSingleValuedNonLinearOptimizer Superclass
Definition: itkGenericConjugateGradientOptimizer.h:46
itk::GenericConjugateGradientOptimizer::m_UseDefaultMaxNrOfItWithoutImprovement
bool m_UseDefaultMaxNrOfItWithoutImprovement
Definition: itkGenericConjugateGradientOptimizer.h:154
itk::GenericConjugateGradientOptimizer::ComputeBetaPR
double ComputeBetaPR(const DerivativeType &previousGradient, const DerivativeType &gradient, const ParametersType &previousSearchDir)
itk::GenericConjugateGradientOptimizer::ComputeBetaFR
double ComputeBetaFR(const DerivativeType &previousGradient, const DerivativeType &gradient, const ParametersType &previousSearchDir)
itk::GenericConjugateGradientOptimizer::LineSearchOptimizerType
LineSearchOptimizer LineSearchOptimizerType
Definition: itkGenericConjugateGradientOptimizer.h:61
itk::GenericConjugateGradientOptimizer::ConstPointer
SmartPointer< const Self > ConstPointer
Definition: itkGenericConjugateGradientOptimizer.h:48
itk::GenericConjugateGradientOptimizer::ComputeBetaDYHS
double ComputeBetaDYHS(const DerivativeType &previousGradient, const DerivativeType &gradient, const ParametersType &previousSearchDir)
itk::GenericConjugateGradientOptimizer::MetricError
@ MetricError
Definition: itkGenericConjugateGradientOptimizer.h:75
itk::GenericConjugateGradientOptimizer::GenericConjugateGradientOptimizer
GenericConjugateGradientOptimizer(const Self &)
itk::GenericConjugateGradientOptimizer::MeasureType
Superclass::MeasureType MeasureType
Definition: itkGenericConjugateGradientOptimizer.h:58
itk::GenericConjugateGradientOptimizer::ComputeBeta
virtual double ComputeBeta(const DerivativeType &previousGradient, const DerivativeType &gradient, const ParametersType &previousSearchDir)
itk::GenericConjugateGradientOptimizer::AddBetaDefinition
virtual void AddBetaDefinition(const BetaDefinitionType &name, ComputeBetaFunctionType function)
itk
Definition: itkAdvancedImageToImageMetric.h:40
itk::GenericConjugateGradientOptimizer::MaximumNumberOfIterations
@ MaximumNumberOfIterations
Definition: itkGenericConjugateGradientOptimizer.h:77
itk::ScaledSingleValuedNonLinearOptimizer::ParametersType
Superclass::ParametersType ParametersType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:82
itk::GenericConjugateGradientOptimizer::StartOptimization
virtual void StartOptimization(void)
itk::GenericConjugateGradientOptimizer::ResumeOptimization
virtual void ResumeOptimization(void)
itk::GenericConjugateGradientOptimizer::ComputeBetaHS
double ComputeBetaHS(const DerivativeType &previousGradient, const DerivativeType &gradient, const ParametersType &previousSearchDir)
itk::ScaledSingleValuedNonLinearOptimizer::ScalesType
NonLinearOptimizer::ScalesType ScalesType
Definition: itkScaledSingleValuedNonLinearOptimizer.h:86
itk::GenericConjugateGradientOptimizer::ComputeBetaFunctionType
double(Self::* ComputeBetaFunctionType)(const DerivativeType &, const DerivativeType &, const ParametersType &)
Definition: itkGenericConjugateGradientOptimizer.h:67
itk::GenericConjugateGradientOptimizer::DerivativeType
Superclass::DerivativeType DerivativeType
Definition: itkGenericConjugateGradientOptimizer.h:55
itk::GenericConjugateGradientOptimizer::operator=
void operator=(const Self &)
itk::LineSearchOptimizer
A base class for LineSearch optimizers.
Definition: itkLineSearchOptimizer.h:38
itk::GenericConjugateGradientOptimizer::ParametersType
Superclass::ParametersType ParametersType
Definition: itkGenericConjugateGradientOptimizer.h:52
itk::GenericConjugateGradientOptimizer::m_CurrentStepLength
double m_CurrentStepLength
Definition: itkGenericConjugateGradientOptimizer.h:150
itk::GenericConjugateGradientOptimizer::ComputeBetaDY
double ComputeBetaDY(const DerivativeType &previousGradient, const DerivativeType &gradient, const ParametersType &previousSearchDir)
itk::GenericConjugateGradientOptimizer::m_CurrentValue
MeasureType m_CurrentValue
Definition: itkGenericConjugateGradientOptimizer.h:146
itk::GenericConjugateGradientOptimizer::ValueTolerance
@ ValueTolerance
Definition: itkGenericConjugateGradientOptimizer.h:79


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo