ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members

#include <itkPowellOptimizer.h>

+ Inheritance diagram for itk::PowellOptimizer:
+ Collaboration diagram for itk::PowellOptimizer:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CostFunctionPointer = CostFunctionType::Pointer
 
using CostFunctionType = SingleValuedCostFunction
 
using ParametersType = SingleValuedNonLinearOptimizer::ParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = PowellOptimizer
 
using Superclass = SingleValuedNonLinearOptimizer
 
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
using ConstPointer = SmartPointer< const Self >
 
using CostFunctionPointer = CostFunctionType::Pointer
 
using CostFunctionType = SingleValuedCostFunction
 
using DerivativeType = CostFunctionType::DerivativeType
 
using MeasureType = CostFunctionType::MeasureType
 
using ParametersType = Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = SingleValuedNonLinearOptimizer
 
using Superclass = NonLinearOptimizer
 
- Public Types inherited from itk::NonLinearOptimizer
using ConstPointer = SmartPointer< const Self >
 
using ParametersType = Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using ScalesType = Superclass::ScalesType
 
using Self = NonLinearOptimizer
 
using Superclass = Optimizer
 
- Public Types inherited from itk::Optimizer
using ConstPointer = SmartPointer< const Self >
 
using ParametersType = OptimizerParameters< double >
 
using Pointer = SmartPointer< Self >
 
using ScalesType = Array< double >
 
using Self = Optimizer
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const CostFunctionTypeGetCostFunction () const
 
virtual CostFunctionTypeGetModifiableCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersTypeGetInitialPosition () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
static Pointer New ()
 
- Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Optimizer
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
unsigned int m_SpaceDimension
 
unsigned int m_CurrentIteration
 
unsigned int m_CurrentLineIteration
 
unsigned int m_MaximumIteration
 
unsigned int m_MaximumLineIteration
 
bool m_CatchGetValueException
 
double m_MetricWorstPossibleValue
 
bool m_Maximize
 
double m_StepLength
 
double m_StepTolerance
 
ParametersType m_LineOrigin
 
vnl_vector< double > m_LineDirection
 
double m_ValueTolerance
 
MeasureType m_CurrentCost
 
bool m_Stop
 
std::ostringstream m_StopConditionDescription
 
virtual void SetMaximize (bool _arg)
 
virtual void MaximizeOn ()
 
virtual void MaximizeOff ()
 
virtual const bool & GetMaximize () const
 
virtual void SetMaximumIteration (unsigned int _arg)
 
virtual const unsigned int & GetMaximumIteration () const
 
virtual void SetMaximumLineIteration (unsigned int _arg)
 
virtual unsigned int GetMaximumLineIteration () const
 
virtual void SetStepLength (double _arg)
 
virtual const double & GetStepLength () const
 
virtual void SetStepTolerance (double _arg)
 
virtual const double & GetStepTolerance () const
 
virtual void SetValueTolerance (double _arg)
 
virtual const double & GetValueTolerance () const
 
virtual const MeasureTypeGetCurrentCost () const
 
MeasureType GetValue () const
 
virtual const unsigned int & GetCurrentIteration () const
 
virtual const unsigned int & GetCurrentLineIteration () const
 
void StartOptimization () override
 
void StopOptimization ()
 
virtual const bool & GetCatchGetValueException () const
 
virtual void SetCatchGetValueException (bool _arg)
 
virtual const double & GetMetricWorstPossibleValue () const
 
virtual void SetMetricWorstPossibleValue (double _arg)
 
const std::string GetStopConditionDescription () const override
 
 PowellOptimizer ()
 
 PowellOptimizer (const PowellOptimizer &)
 
 ~PowellOptimizer () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetCurrentCost (double _arg)
 
void SetLine (const ParametersType &origin, const vnl_vector< double > &direction)
 
double GetLineValue (double x) const
 
double GetLineValue (double x, ParametersType &tempCoord) const
 
void SetCurrentLinePoint (double x, double fx)
 
void Swap (double *a, double *b) const
 
void Shift (double *a, double *b, double *c, double d) const
 
virtual void LineBracket (double *ax, double *bx, double *cx, double *fa, double *fb, double *fc)
 
virtual void LineBracket (double *ax, double *bx, double *cx, double *fa, double *fb, double *fc, ParametersType &tempCoord)
 
virtual void BracketedLineOptimize (double ax, double bx, double cx, double fa, double fb, double fc, double *extX, double *extVal)
 
virtual void BracketedLineOptimize (double ax, double bx, double cx, double fa, double fb, double fc, double *extX, double *extVal, ParametersType &tempCoord)
 
virtual unsigned int GetSpaceDimension ()
 
void SetSpaceDimension (unsigned int dim)
 
virtual void SetCurrentIteration (unsigned int _arg)
 
virtual bool GetStop ()
 
virtual void SetStop (bool _arg)
 

Additional Inherited Members

- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SingleValuedNonLinearOptimizer ()
 
 ~SingleValuedNonLinearOptimizer () override=default
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()=default
 
 ~NonLinearOptimizer () override
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
 ~Optimizer () override=default
 
virtual void SetCurrentPosition (const ParametersType &param)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer m_CostFunction
 
- Protected Attributes inherited from itk::Optimizer
bool m_ScalesInitialized { false }
 
ParametersType m_CurrentPosition
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

Implements Powell optimization using Brent line search.

The code in this class was adapted from the Wikipedia and the netlib.org zeroin function.

http://www.netlib.org/go/zeroin.f http://en.wikipedia.org/wiki/Brent_method http://en.wikipedia.org/wiki/Golden_section_search

This optimizer needs a cost function. Partial derivatives of that function are not required.

For an N-dimensional parameter space, each iteration minimizes(maximizes) the function in N (initially orthogonal) directions. Typically only 2-5 iterations are required. If gradients are available, consider a conjugate gradient line search strategy.

The SetStepLength determines the initial distance to step in a line direction when bounding the minimum (using bracketing triple spaced using a golden 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.

Definition at line 62 of file itkPowellOptimizer.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 69 of file itkPowellOptimizer.h.

◆ CostFunctionPointer

Definition at line 81 of file itkPowellOptimizer.h.

◆ CostFunctionType

Type of the Cost Function

Definition at line 80 of file itkPowellOptimizer.h.

◆ ParametersType

Definition at line 71 of file itkPowellOptimizer.h.

◆ Pointer

Definition at line 68 of file itkPowellOptimizer.h.

◆ Self

Standard "Self" type alias.

Definition at line 66 of file itkPowellOptimizer.h.

◆ Superclass

Definition at line 67 of file itkPowellOptimizer.h.

Constructor & Destructor Documentation

◆ PowellOptimizer() [1/2]

itk::PowellOptimizer::PowellOptimizer ( )
protected

Current iteration

◆ PowellOptimizer() [2/2]

itk::PowellOptimizer::PowellOptimizer ( const PowellOptimizer )
protected

Current iteration

◆ ~PowellOptimizer()

itk::PowellOptimizer::~PowellOptimizer ( )
overrideprotected

Current iteration

Member Function Documentation

◆ BracketedLineOptimize() [1/2]

virtual void itk::PowellOptimizer::BracketedLineOptimize ( double  ax,
double  bx,
double  cx,
double  fa,
double  fb,
double  fc,
double *  extX,
double *  extVal 
)
protectedvirtual

Given a bracketing triple of points and their function values, returns a bounded extreme. These values are in parameter space, along the current line and wrt the current origin set via SetLine. Optimization terminates based on MaximumIteration, StepTolerance, or ValueTolerance. Implemented as Brent line optimizers from NRC.

◆ BracketedLineOptimize() [2/2]

virtual void itk::PowellOptimizer::BracketedLineOptimize ( double  ax,
double  bx,
double  cx,
double  fa,
double  fb,
double  fc,
double *  extX,
double *  extVal,
ParametersType tempCoord 
)
protectedvirtual

Current iteration

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::PowellOptimizer::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::NonLinearOptimizer.

◆ GetCatchGetValueException()

virtual const bool& itk::PowellOptimizer::GetCatchGetValueException ( ) const
virtual

Current iteration

◆ GetCurrentCost()

virtual const MeasureType& itk::PowellOptimizer::GetCurrentCost ( ) const
virtual

Return Current Value

◆ GetCurrentIteration()

virtual const unsigned int& itk::PowellOptimizer::GetCurrentIteration ( ) const
virtual

Return Current Iteration

◆ GetCurrentLineIteration()

virtual const unsigned int& itk::PowellOptimizer::GetCurrentLineIteration ( ) const
virtual

Get the current line search iteration

◆ GetLineValue() [1/2]

double itk::PowellOptimizer::GetLineValue ( double  x) const
protected

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

◆ GetLineValue() [2/2]

double itk::PowellOptimizer::GetLineValue ( double  x,
ParametersType tempCoord 
) const
protected

Current iteration

◆ GetMaximize()

virtual const bool& itk::PowellOptimizer::GetMaximize ( ) const
virtual

Current iteration

◆ GetMaximumIteration()

virtual const unsigned int& itk::PowellOptimizer::GetMaximumIteration ( ) const
virtual

Current iteration

◆ GetMaximumLineIteration()

virtual unsigned int itk::PowellOptimizer::GetMaximumLineIteration ( ) const
virtual

Current iteration

◆ GetMetricWorstPossibleValue()

virtual const double& itk::PowellOptimizer::GetMetricWorstPossibleValue ( ) const
virtual

Current iteration

◆ GetNameOfClass()

virtual const char* itk::PowellOptimizer::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Reimplemented in itk::FRPROptimizer.

◆ GetSpaceDimension()

virtual unsigned int itk::PowellOptimizer::GetSpaceDimension ( )
protectedvirtual

Current iteration

◆ GetStepLength()

virtual const double& itk::PowellOptimizer::GetStepLength ( ) const
virtual

Current iteration

◆ GetStepTolerance()

virtual const double& itk::PowellOptimizer::GetStepTolerance ( ) const
virtual

Current iteration

◆ GetStop()

virtual bool itk::PowellOptimizer::GetStop ( )
protectedvirtual

Current iteration

◆ GetStopConditionDescription()

const std::string itk::PowellOptimizer::GetStopConditionDescription ( ) const
overridevirtual

Current iteration

Reimplemented from itk::Optimizer.

◆ GetValue()

MeasureType itk::PowellOptimizer::GetValue ( ) const
inline

Current iteration

Definition at line 121 of file itkPowellOptimizer.h.

◆ GetValueTolerance()

virtual const double& itk::PowellOptimizer::GetValueTolerance ( ) const
virtual

Current iteration

◆ LineBracket() [1/2]

virtual void itk::PowellOptimizer::LineBracket ( double *  ax,
double *  bx,
double *  cx,
double *  fa,
double *  fb,
double *  fc 
)
protectedvirtual

The LineBracket routine from NRC. Later reimplemented from the description of the method available in the Wikipedia.

Uses current origin and line direction (from SetLine) to find a triple of points (ax, bx, cx) that bracket the extreme "near" the origin. Search first considers the point StepLength distance from ax.

IMPORTANT: The value of ax and the value of the function at ax (i.e., fa), must both be provided to this function.

◆ LineBracket() [2/2]

virtual void itk::PowellOptimizer::LineBracket ( double *  ax,
double *  bx,
double *  cx,
double *  fa,
double *  fb,
double *  fc,
ParametersType tempCoord 
)
protectedvirtual

Current iteration

◆ MaximizeOff()

virtual void itk::PowellOptimizer::MaximizeOff ( )
virtual

Current iteration

◆ MaximizeOn()

virtual void itk::PowellOptimizer::MaximizeOn ( )
virtual

Current iteration

◆ New()

static Pointer itk::PowellOptimizer::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

void itk::PowellOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Current iteration

Reimplemented from itk::Optimizer.

◆ SetCatchGetValueException()

virtual void itk::PowellOptimizer::SetCatchGetValueException ( bool  _arg)
virtual

Current iteration

◆ SetCurrentCost()

virtual void itk::PowellOptimizer::SetCurrentCost ( double  _arg)
protectedvirtual

Current iteration

◆ SetCurrentIteration()

virtual void itk::PowellOptimizer::SetCurrentIteration ( unsigned int  _arg)
protectedvirtual

Current iteration

◆ SetCurrentLinePoint()

void itk::PowellOptimizer::SetCurrentLinePoint ( double  x,
double  fx 
)
protected

Set the given scalar step distance (x) and function value (fx) as the "best-so-far" optimizer values.

◆ SetLine()

void itk::PowellOptimizer::SetLine ( const ParametersType origin,
const vnl_vector< double > &  direction 
)
protected

Used to specify the line direction through the n-dimensional parameter space the is currently being bracketed and optimized.

◆ SetMaximize()

virtual void itk::PowellOptimizer::SetMaximize ( bool  _arg)
virtual

Set if the Optimizer should Maximize the metric

◆ SetMaximumIteration()

virtual void itk::PowellOptimizer::SetMaximumIteration ( unsigned int  _arg)
virtual

Set/Get maximum iteration limit.

◆ SetMaximumLineIteration()

virtual void itk::PowellOptimizer::SetMaximumLineIteration ( unsigned int  _arg)
virtual

Set/Get the maximum number of line search iterations

◆ SetMetricWorstPossibleValue()

virtual void itk::PowellOptimizer::SetMetricWorstPossibleValue ( double  _arg)
virtual

Current iteration

◆ SetSpaceDimension()

void itk::PowellOptimizer::SetSpaceDimension ( unsigned int  dim)
inlineprotected

Current iteration

Definition at line 236 of file itkPowellOptimizer.h.

◆ SetStepLength()

virtual void itk::PowellOptimizer::SetStepLength ( double  _arg)
virtual

Set/Get StepLength for the (scaled) spacing of the sampling of parameter space while bracketing the extremum

◆ SetStepTolerance()

virtual void itk::PowellOptimizer::SetStepTolerance ( double  _arg)
virtual

Set/Get StepTolerance. Once the local extreme is known to be within this distance of the current parameter values, optimization terminates

◆ SetStop()

virtual void itk::PowellOptimizer::SetStop ( bool  _arg)
protectedvirtual

Current iteration

◆ SetValueTolerance()

virtual void itk::PowellOptimizer::SetValueTolerance ( double  _arg)
virtual

Set/Get ValueTolerance. Once this current cost function value is known to be within this tolerance of the cost function value at the local extreme, optimization terminates

◆ Shift()

void itk::PowellOptimizer::Shift ( double *  a,
double *  b,
double *  c,
double  d 
) const
protected

Used in bracketing the extreme along the current line. Adapted from NRC

◆ StartOptimization()

void itk::PowellOptimizer::StartOptimization ( )
overridevirtual

Start optimization.

Reimplemented from itk::Optimizer.

◆ StopOptimization()

void itk::PowellOptimizer::StopOptimization ( )
inline

When users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.

Definition at line 141 of file itkPowellOptimizer.h.

◆ Swap()

void itk::PowellOptimizer::Swap ( double *  a,
double *  b 
) const
protected

Used in bracketing the extreme along the current line. Adapted from NRC

Member Data Documentation

◆ m_CatchGetValueException

bool itk::PowellOptimizer::m_CatchGetValueException
private

Current iteration

Definition at line 261 of file itkPowellOptimizer.h.

◆ m_CurrentCost

MeasureType itk::PowellOptimizer::m_CurrentCost
private

Internal storage for the value type / used as a cache

Definition at line 277 of file itkPowellOptimizer.h.

◆ m_CurrentIteration

unsigned int itk::PowellOptimizer::m_CurrentIteration
private

Current iteration

Definition at line 254 of file itkPowellOptimizer.h.

◆ m_CurrentLineIteration

unsigned int itk::PowellOptimizer::m_CurrentLineIteration
private

Current iteration

Definition at line 255 of file itkPowellOptimizer.h.

◆ m_LineDirection

vnl_vector<double> itk::PowellOptimizer::m_LineDirection
private

Current iteration

Definition at line 272 of file itkPowellOptimizer.h.

◆ m_LineOrigin

ParametersType itk::PowellOptimizer::m_LineOrigin
private

Current iteration

Definition at line 271 of file itkPowellOptimizer.h.

◆ m_Maximize

bool itk::PowellOptimizer::m_Maximize
private

Set if the Metric should be maximized: Default = False

Definition at line 265 of file itkPowellOptimizer.h.

◆ m_MaximumIteration

unsigned int itk::PowellOptimizer::m_MaximumIteration
private

Maximum iteration limit.

Definition at line 258 of file itkPowellOptimizer.h.

◆ m_MaximumLineIteration

unsigned int itk::PowellOptimizer::m_MaximumLineIteration
private

Current iteration

Definition at line 259 of file itkPowellOptimizer.h.

◆ m_MetricWorstPossibleValue

double itk::PowellOptimizer::m_MetricWorstPossibleValue
private

Current iteration

Definition at line 262 of file itkPowellOptimizer.h.

◆ m_SpaceDimension

unsigned int itk::PowellOptimizer::m_SpaceDimension
private

Current iteration

Definition at line 248 of file itkPowellOptimizer.h.

◆ m_StepLength

double itk::PowellOptimizer::m_StepLength
private

The minimal size of search

Definition at line 268 of file itkPowellOptimizer.h.

◆ m_StepTolerance

double itk::PowellOptimizer::m_StepTolerance
private

Current iteration

Definition at line 269 of file itkPowellOptimizer.h.

◆ m_Stop

bool itk::PowellOptimizer::m_Stop
private

this is user-settable flag to stop optimization. when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.

Definition at line 283 of file itkPowellOptimizer.h.

◆ m_StopConditionDescription

std::ostringstream itk::PowellOptimizer::m_StopConditionDescription
private

Current iteration

Definition at line 285 of file itkPowellOptimizer.h.

◆ m_ValueTolerance

double itk::PowellOptimizer::m_ValueTolerance
private

Current iteration

Definition at line 274 of file itkPowellOptimizer.h.


The documentation for this class was generated from the following file: