ITK  4.9.0
Insight Segmentation and Registration Toolkit
itkConjugateGradientOptimizer.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 #ifndef itkConjugateGradientOptimizer_h
19 #define itkConjugateGradientOptimizer_h
20 
21 #include "itkIntTypes.h"
23 #include "vnl/algo/vnl_conjugate_gradient.h"
24 #include "ITKOptimizersExport.h"
25 
26 namespace itk
27 {
34 class ITKOptimizers_EXPORT ConjugateGradientOptimizer:
36 
37 {
38 public:
44 
46  itkNewMacro(Self);
47 
50 
52  typedef vnl_vector< double > InternalParametersType;
53 
55  typedef vnl_conjugate_gradient InternalOptimizerType;
56 
58  vnl_conjugate_gradient * GetOptimizer();
59 
61  virtual void StartOptimization(void) ITK_OVERRIDE;
62 
64  virtual void SetCostFunction(SingleValuedCostFunction *costFunction) ITK_OVERRIDE;
65 
67  SizeValueType GetNumberOfIterations() const;
68 
69  SizeValueType GetCurrentIteration() const;
70 
72  MeasureType GetValue() const;
73 
74 protected:
76  virtual ~ConjugateGradientOptimizer();
77 
79 
80 private:
81  ConjugateGradientOptimizer(const Self &) ITK_DELETE_FUNCTION;
82  void operator=(const Self &) ITK_DELETE_FUNCTION;
83 
85  bool m_OptimizerInitialized;
86  InternalOptimizerType *m_VnlOptimizer;
87 };
88 } // end namespace itk
89 
90 #endif
This class is a base for the CostFunctions returning a single value.
Light weight base class for most itk classes.
Superclass::CostFunctionAdaptorType CostFunctionAdaptorType
This class is a base for the Optimization methods that optimize a single valued function.
SingleValuedNonLinearVnlOptimizer Superclass
unsigned long SizeValueType
Definition: itkIntTypes.h:143
This class is a base for the Optimization methods that optimize a single valued function.
Wrap of the vnl_conjugate_gradient.