1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkConjugateGradientOptimizer_h
#define itkConjugateGradientOptimizer_h
#include "itkIntTypes.h"
#include "itkSingleValuedNonLinearVnlOptimizer.h"
#include "vnl/algo/vnl_conjugate_gradient.h"
#include "ITKOptimizersExport.h"
#include <memory> // For unique_ptr.
namespace itk
{
/** \class ConjugateGradientOptimizer
* \brief Wrap of the vnl_conjugate_gradient
*
* \ingroup Numerics Optimizers
* \ingroup ITKOptimizers
*/
class ITKOptimizers_EXPORT ConjugateGradientOptimizer : public SingleValuedNonLinearVnlOptimizer
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ConjugateGradientOptimizer);
/** Standard class type aliases. */
using Self = ConjugateGradientOptimizer;
using Superclass = SingleValuedNonLinearVnlOptimizer;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ConjugateGradientOptimizer);
/** InternalParameters type alias. */
using InternalParametersType = vnl_vector<double>;
/** Internal Optimizer Type */
using InternalOptimizerType = vnl_conjugate_gradient;
/** Method for getting access to the internal optimizer */
vnl_conjugate_gradient *
GetOptimizer();
/** Start optimization with an initial value. */
void
StartOptimization() override;
/** Plug in a Cost Function into the optimizer */
void
SetCostFunction(SingleValuedCostFunction * costFunction) override;
/** Return the number of iterations performed so far */
SizeValueType
GetNumberOfIterations() const;
SizeValueType
GetCurrentIteration() const;
/** Return Current Value */
MeasureType
GetValue() const;
protected:
ConjugateGradientOptimizer();
~ConjugateGradientOptimizer() override;
using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
private:
/** The vnl optimization method for conjugate gradient. */
bool m_OptimizerInitialized{};
std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
};
} // end namespace itk
#endif
|
