ITK  5.0.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:
39  ITK_DISALLOW_COPY_AND_ASSIGN(ConjugateGradientOptimizer);
40 
46 
48  itkNewMacro(Self);
49 
52 
54  using InternalParametersType = vnl_vector< double >;
55 
57  using InternalOptimizerType = vnl_conjugate_gradient;
58 
60  vnl_conjugate_gradient * GetOptimizer();
61 
63  void StartOptimization() override;
64 
66  void SetCostFunction(SingleValuedCostFunction *costFunction) override;
67 
69  SizeValueType GetNumberOfIterations() const;
70 
71  SizeValueType GetCurrentIteration() const;
72 
74  MeasureType GetValue() const;
75 
76 protected:
78  ~ConjugateGradientOptimizer() override;
79 
80  using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
81 
82 private:
86 };
87 } // end namespace itk
88 
89 #endif
Superclass::CostFunctionAdaptorType CostFunctionAdaptorType
This class is a base for the CostFunctions returning a single value.
Light weight base class for most itk classes.
unsigned long SizeValueType
Definition: itkIntTypes.h:83
This class is a base for the Optimization methods that optimize a single valued function.
This class is a base for the Optimization methods that optimize a single valued function.
Wrap of the vnl_conjugate_gradient.