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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/*=========================================================================
*
* 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 itkFRPROptimizer_h
#define itkFRPROptimizer_h
#include "itkPowellOptimizer.h"
#include "ITKOptimizersExport.h"
namespace itk
{
/** \class FRPROptimizerEnums
* \brief Contains enum classes used by FRPROptimizer class
* \ingroup ITKOptimizers
*/
class FRPROptimizerEnums
{
public:
/** \class Optimization
* \ingroup ITKOptimizers
* */
enum class Optimization : uint8_t
{
FletchReeves,
PolakRibiere
};
};
// Define how to print enumeration
extern ITKOptimizers_EXPORT std::ostream &
operator<<(std::ostream & out, const FRPROptimizerEnums::Optimization value);
/** \class FRPROptimizer
* \brief Implements Fletch-Reeves & Polak-Ribiere optimization using dBrent
* line search.
*
* This optimizer needs a cost function.
* This optimizer needs to be able to compute partial derivatives of the
* cost function with respect to each parameter.
*
* The SetStepLength determines the initial distance to step in a line
* direction when bounding the minimum (using bracketing triple spaced
* using a derivative-based search strategy).
*
* The StepTolerance terminates optimization when the parameter values are
* known to be within this (scaled) distance of the local extreme.
*
* The ValueTolerance terminates optimization when the cost function values at
* the current parameters and at the local extreme are likely (within a second
* order approximation) to be within this is tolerance.
*
* \ingroup Numerics Optimizers
*
* \ingroup ITKOptimizers
*/
class ITKOptimizers_EXPORT FRPROptimizer : public PowellOptimizer
{
public:
ITK_DISALLOW_COPY_AND_MOVE(FRPROptimizer);
/** Standard "Self" type alias. */
using Self = FRPROptimizer;
using Superclass = PowellOptimizer;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using ParametersType = SingleValuedNonLinearOptimizer::ParametersType;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(FRPROptimizer);
/** Type of the Cost Function */
using CostFunctionType = SingleValuedCostFunction;
using CostFunctionPointer = CostFunctionType::Pointer;
/** Convert gradient to a unit length vector */
itkSetMacro(UseUnitLengthGradient, bool);
itkGetConstMacro(UseUnitLengthGradient, bool);
itkBooleanMacro(UseUnitLengthGradient);
/** Start optimization. */
void
StartOptimization() override;
/** Set it to the Fletch-Reeves optimizer */
void
SetToFletchReeves();
/** Set it to the Fletch-Reeves optimizer */
void
SetToPolakRibiere();
protected:
FRPROptimizer();
~FRPROptimizer() override;
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Get the value of the n-dimensional cost function at this scalar step
* distance along the current line direction from the current line origin.
* Line origin and distances are set via SetLine */
virtual void
GetValueAndDerivative(ParametersType & p, double * val, ParametersType * xi);
virtual void
LineOptimize(ParametersType * p, ParametersType & xi, double * val);
virtual void
LineOptimize(ParametersType * p, ParametersType & xi, double * val, ParametersType & tempCoord);
private:
using OptimizationEnum = FRPROptimizerEnums::Optimization;
#if !defined(ITK_LEGACY_REMOVE)
/**Exposes enums values for backwards compatibility*/
static constexpr OptimizationEnum FletchReeves = OptimizationEnum::FletchReeves;
static constexpr OptimizationEnum PolakRibiere = OptimizationEnum::PolakRibiere;
#endif
OptimizationEnum m_OptimizationType{};
bool m_UseUnitLengthGradient{};
}; // end of class
} // end of namespace itk
#endif
|
