/usr/include/InsightToolkit/Numerics/itkFRPROptimizer.h is in libinsighttoolkit3-dev 3.20.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkFRPROptimizer.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkFRPROptimizer_h
#define __itkFRPROptimizer_h
#include <itkVector.h>
#include <itkMatrix.h>
#include <itkPowellOptimizer.h>
namespace itk
{
/** \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
*
*/
class ITK_EXPORT FRPROptimizer:
public PowellOptimizer
{
public:
/** Standard "Self" typedef. */
typedef FRPROptimizer Self;
typedef PowellOptimizer Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
typedef SingleValuedNonLinearOptimizer::ParametersType ParametersType;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(FRPROptimizer, PowellOptimizer );
/** Type of the Cost Function */
typedef SingleValuedCostFunction CostFunctionType;
typedef CostFunctionType::Pointer CostFunctionPointer;
/** Convert gradient to a unit length vector */
itkSetMacro( UseUnitLengthGradient, bool );
itkGetConstMacro( UseUnitLengthGradient, bool );
/** Start optimization. */
void StartOptimization();
/** Set it to the Fletch-Reeves optimizer */
void SetToFletchReeves();
/** Set it to the Fletch-Reeves optimizer */
void SetToPolakRibiere();
protected:
FRPROptimizer();
virtual ~FRPROptimizer();
void PrintSelf(std::ostream& os, Indent indent) const;
/** 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:
FRPROptimizer(const FRPROptimizer&); // not implemented
typedef enum
{
FletchReeves,
PolakRibiere
} OptimizationType;
OptimizationType m_OptimizationType;
bool m_UseUnitLengthGradient;
}; // end of class
} // end of namespace itk
#endif
|