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
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/*=========================================================================
*
* 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 itkLevenbergMarquardtOptimizer_h
#define itkLevenbergMarquardtOptimizer_h
#include "itkMultipleValuedNonLinearVnlOptimizer.h"
#include "vnl/algo/vnl_levenberg_marquardt.h"
#include "ITKOptimizersExport.h"
#include <memory> // For unique_ptr.
namespace itk
{
/** \class LevenbergMarquardtOptimizer
* \brief Wrap of the vnl_levenberg_marquardt algorithm
*
* \ingroup Numerics Optimizers
* \ingroup ITKOptimizers
*
* \sphinx
* \sphinxexample{Numerics/Optimizers/LevenbergMarquardtOptimization, Levenberg-Marquardt Optimization}
* \endsphinx
*/
class ITKOptimizers_EXPORT LevenbergMarquardtOptimizer : public MultipleValuedNonLinearVnlOptimizer
{
public:
ITK_DISALLOW_COPY_AND_MOVE(LevenbergMarquardtOptimizer);
/** Standard "Self" type alias. */
using Self = LevenbergMarquardtOptimizer;
using Superclass = MultipleValuedNonLinearVnlOptimizer;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(LevenbergMarquardtOptimizer);
/** InternalParameters type alias. */
using InternalParametersType = vnl_vector<double>;
/** Internal optimizer type. */
using InternalOptimizerType = vnl_levenberg_marquardt;
/** Method for getting access to the internal optimizer. */
vnl_levenberg_marquardt *
GetOptimizer() const;
/** Start optimization with an initial value. */
void
StartOptimization() override;
/** Plug in a Cost Function into the optimizer */
void
SetCostFunction(MultipleValuedCostFunction * costFunction) override;
void
SetNumberOfIterations(unsigned int iterations);
void
SetValueTolerance(double tol);
void
SetGradientTolerance(double tol);
void
SetEpsilonFunction(double epsilon);
/** Get the current value */
MeasureType
GetValue() const;
const std::string
GetStopConditionDescription() const override;
protected:
LevenbergMarquardtOptimizer();
~LevenbergMarquardtOptimizer() override;
using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
private:
bool m_OptimizerInitialized{};
std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
unsigned int m_NumberOfIterations{};
double m_ValueTolerance{};
double m_GradientTolerance{};
double m_EpsilonFunction{};
};
} // end namespace itk
#endif
|
