/usr/include/ITK-4.10/itkLBFGSOptimizerv4.h is in libinsighttoolkit4-dev 4.10.1-dfsg1-1.1+b1.
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 | /*=========================================================================
*
* Copyright Insight Software Consortium
*
* 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
*
* http://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 itkLBFGSOptimizerv4_h
#define itkLBFGSOptimizerv4_h
#include "itkLBFGSOptimizerBasev4.h"
#include "vnl/algo/vnl_lbfgs.h"
#include "ITKOptimizersv4Export.h"
namespace itk
{
/** \class LBFGSOptimizerv4
* \brief Wrap of the vnl_lbfgs algorithm for use in ITKv4 registration framework.
*
* \ingroup ITKOptimizersv4
*/
class ITKOptimizersv4_EXPORT LBFGSOptimizerv4:
public LBFGSOptimizerBasev4< vnl_lbfgs >
{
public:
/** Standard "Self" typedef. */
typedef LBFGSOptimizerv4 Self;
typedef LBFGSOptimizerBasev4<vnl_lbfgs> Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
typedef Superclass::MetricType MetricType;
typedef Superclass::ParametersType ParametersType;
typedef Superclass::ScalesType ScalesType;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(LBFGSOptimizerv4, Superclass);
/** Start optimization with an initial value. */
virtual void StartOptimization(bool doOnlyInitialization = false) ITK_OVERRIDE;
/** Plug in a Cost Function into the optimizer */
virtual void SetMetric(MetricType *metric) ITK_OVERRIDE;
void VerboseOn();
void VerboseOff();
/** Set/Get the line search accuracy. This is a positive real number
* with a default value of 0.9, which controls the accuracy of the line
* search. If the function and gradient evalutions are inexpensive with
* respect to the cost of the iterations it may be advantageous to set
* the value to a small value (say 0.1).
*/
void SetLineSearchAccuracy(double tol);
itkGetConstMacro(LineSearchAccuracy, double);
/** Set/Get the default step size. This is a positive real number
* with a default value of 1.0 which determines the step size in the line
* search.
*/
void SetDefaultStepLength(double stp);
itkGetConstMacro(DefaultStepLength, double);
protected:
LBFGSOptimizerv4();
virtual ~LBFGSOptimizerv4();
virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** InternalParameters typedef. */
typedef vnl_vector< double > InternalParametersType;
/** Internal optimizer type. */
typedef vnl_lbfgs InternalOptimizerType;
private:
LBFGSOptimizerv4(const Self &) ITK_DELETE_FUNCTION;
void operator=(const Self &) ITK_DELETE_FUNCTION;
bool m_Verbose;
double m_LineSearchAccuracy;
double m_DefaultStepLength;
};
} // end namespace itk
#endif
|