/usr/include/InsightToolkit/Numerics/itkOptimizer.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 | /*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkOptimizer.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 __itkOptimizer_h
#define __itkOptimizer_h
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkExceptionObject.h"
#include "itkArray.h"
namespace itk
{
/** \class Optimizer
* \brief Generic representation for an optimization method.
*
* This class is a base for a hierarchy of optimizers.
* It is not intended to be instantiated.
*
* \ingroup Numerics Optimizers
*/
class ITK_EXPORT Optimizer : public Object
{
public:
/** Standard class typedefs. */
typedef Optimizer Self;
typedef Object Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(Optimizer, Object);
/** Parameters type.
* It defines a position in the optimization search space. */
typedef Array<double> ParametersType;
/** Scale type.
* This array defines scale to be applied to parameters before
* being evaluated in the cost function. This allows to
* map to a more convenient space. In particular this is
* used to normalize parameter spaces in which some parameters
* have a different dynamic range. */
typedef Array<double> ScalesType;
/** Set the position to initialize the optimization. */
virtual void SetInitialPosition( const ParametersType & param );
/** Get the position to initialize the optimization. */
itkGetConstReferenceMacro(InitialPosition, ParametersType);
/** Set current parameters scaling. */
void SetScales(const ScalesType & scales);
/** Get current parameters scaling. */
itkGetConstReferenceMacro( Scales, ScalesType );
/** Get current position of the optimization. */
itkGetConstReferenceMacro( CurrentPosition, ParametersType );
/** Start optimization. */
virtual void StartOptimization() {};
/** Get the reason for termination */
virtual const std::string GetStopConditionDescription() const;
protected:
Optimizer();
virtual ~Optimizer() {};
void PrintSelf(std::ostream& os, Indent indent) const;
/** Set the current position. */
virtual void SetCurrentPosition( const ParametersType & param );
bool m_ScalesInitialized;
// Keep m_CurrentPosition as a protected var so that subclasses can
// have fast access. This is important when optimizing high-dimensional
// spaces, e.g. bspline transforms.
ParametersType m_CurrentPosition;
private:
Optimizer(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
ParametersType m_InitialPosition;
ScalesType m_Scales;
};
} // end namespace itk
#endif
|