#include <itkPowellOptimizerv4.h>

Detailed Description

template<typename TInternalComputationValueType>
class itk::PowellOptimizerv4< TInternalComputationValueType >

Implements Powell optimization using Brent line search.

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

https://www.netlib.org/go/zeroin.f https://en.wikipedia.org/wiki/Brent_method https://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 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 60 of file itkPowellOptimizerv4.h.

Inheritance diagram for itk::PowellOptimizerv4< TInternalComputationValueType >:

Collaboration diagram for itk::PowellOptimizerv4< TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = PowellOptimizerv4

using	Superclass = ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >

Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename MetricType::DerivativeType

using	MeasureType = typename MetricType::MeasureType

using	MetricType = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >

using	MetricTypePointer = typename MetricType::Pointer

using	NumberOfParametersType = typename MetricType::NumberOfParametersType

using	ParametersType = OptimizerParameters< TInternalComputationValueType >

using	Pointer = SmartPointer< Self >

using	ScalesEstimatorType = OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >

using	ScalesType = OptimizerParameters< TInternalComputationValueType >

using	Self = ObjectToObjectOptimizerBaseTemplate

using	StopConditionDescriptionType = std::ostringstream

using	StopConditionReturnStringType = std::string

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 void	CatchGetValueExceptionOn ()

virtual const bool &	GetCatchGetValueException () const

virtual const unsigned int &	GetCurrentLineIteration () const

virtual const double &	GetMetricWorstPossibleValue () const

const char *	GetNameOfClass () const override

std::string	GetStopConditionDescription () const override

virtual void	SetCatchGetValueException (bool _arg)

virtual void	SetMetricWorstPossibleValue (double _arg)

void	StartOptimization (bool doOnlyInitialization=false) override

void	StopOptimization ()


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 MeasureType &	GetCurrentCost () const

const MeasureType &	GetValue () const override

Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
virtual bool	CanUseScales () const

virtual SizeValueType	GetCurrentIteration () const

virtual const MeasureType &	GetCurrentMetricValue () const

virtual const ParametersType &	GetCurrentPosition () const

const char *	GetNameOfClass () const override

virtual SizeValueType	GetNumberOfIterations () const

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

virtual const ScalesType &	GetScales () const

virtual const bool &	GetScalesAreIdentity () const

bool	GetScalesInitialized () const

virtual StopConditionReturnStringType	GetStopConditionDescription () const=0

virtual const MeasureType &	GetValue () const

virtual const ScalesType &	GetWeights () const

virtual const bool &	GetWeightsAreIdentity () const

virtual void	SetNumberOfIterations (SizeValueType _arg)

virtual void	SetNumberOfWorkUnits (ThreadIdType number)

virtual void	SetScalesEstimator (ScalesEstimatorType *_arg)

virtual void	SetWeights (ScalesType _arg)

virtual void	StartOptimization (bool doOnlyInitialization=false)

virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual void	SetScales (const ScalesType &scales)

virtual void	SetDoEstimateScales (bool _arg)

virtual const bool &	GetDoEstimateScales () const

virtual void	DoEstimateScalesOn ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () 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) const

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
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
virtual void	BracketedLineOptimize (double ax, double bx, double cx, double fa, double functionValueOfb, double fc, double extX, double extVal)

virtual void	BracketedLineOptimize (double ax, double bx, double cx, double fa, double functionValueOfb, double fc, double extX, double extVal, ParametersType &tempCoord)

double	GetLineValue (double x) const

double	GetLineValue (double x, ParametersType &tempCoord) const

virtual unsigned int	GetSpaceDimension ()

virtual bool	GetStop ()

virtual void	LineBracket (double x1, double x2, double x3, double f1, double f2, double f3)

virtual void	LineBracket (double x1, double x2, double x3, double f1, double f2, double f3, ParametersType &tempCoord)

	PowellOptimizerv4 ()

	PowellOptimizerv4 (const PowellOptimizerv4 &)

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetCurrentCost (double _arg)

virtual void	SetCurrentIteration (unsigned int _arg)

void	SetCurrentLinePoint (double x, double fx)

void	SetLine (const ParametersType &origin, const vnl_vector< double > &direction)

void	SetSpaceDimension (unsigned int dim)

virtual void	SetStop (bool _arg)

void	Shift (double a, double b, double *c, double d) const

void	Swap (double a, double b) const

	~PowellOptimizerv4 () override=default

Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
void	PrintSelf (std::ostream &os, Indent indent) const override

	ObjectToObjectOptimizerBaseTemplate ()

	~ObjectToObjectOptimizerBaseTemplate () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
bool	m_CatchGetValueException { false }

MeasureType	m_CurrentCost {}

unsigned int	m_CurrentLineIteration { 0 }

ParametersType	m_CurrentPosition {}

vnl_vector< double >	m_LineDirection {}

ParametersType	m_LineOrigin {}

unsigned int	m_MaximumIteration { 100 }

unsigned int	m_MaximumLineIteration { 100 }

double	m_MetricWorstPossibleValue { 0 }

unsigned int	m_SpaceDimension { 0 }

double	m_StepLength { 0 }

double	m_StepTolerance { 0 }

bool	m_Stop { false }

std::ostringstream	m_StopConditionDescription {}

double	m_ValueTolerance { 0 }

Additional Inherited Members
Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
SizeValueType	m_CurrentIteration

MeasureType	m_CurrentMetricValue

bool	m_DoEstimateScales

MetricTypePointer	m_Metric

SizeValueType	m_NumberOfIterations

ThreadIdType	m_NumberOfWorkUnits

ScalesType	m_Scales

bool	m_ScalesAreIdentity

ScalesEstimatorType::Pointer	m_ScalesEstimator

ScalesType	m_Weights

bool	m_WeightsAreIdentity

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInternalComputationValueType >

using itk::PowellOptimizerv4< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 68 of file itkPowellOptimizerv4.h.

◆ Pointer

template<typename TInternalComputationValueType >

using itk::PowellOptimizerv4< TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 67 of file itkPowellOptimizerv4.h.

◆ Self

template<typename TInternalComputationValueType >

using itk::PowellOptimizerv4< TInternalComputationValueType >::Self = PowellOptimizerv4

Standard "Self" type alias.

Definition at line 65 of file itkPowellOptimizerv4.h.

◆ Superclass

template<typename TInternalComputationValueType >

using itk::PowellOptimizerv4< TInternalComputationValueType >::Superclass = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>

Definition at line 66 of file itkPowellOptimizerv4.h.

Constructor & Destructor Documentation

◆ PowellOptimizerv4() [1/2]

template<typename TInternalComputationValueType >

itk::PowellOptimizerv4< TInternalComputationValueType >::PowellOptimizerv4 ( )

protected

◆ PowellOptimizerv4() [2/2]

template<typename TInternalComputationValueType >

itk::PowellOptimizerv4< TInternalComputationValueType >::PowellOptimizerv4 ( const PowellOptimizerv4< TInternalComputationValueType > & )

protected

◆ ~PowellOptimizerv4()

template<typename TInternalComputationValueType >

itk::PowellOptimizerv4< TInternalComputationValueType >::~PowellOptimizerv4 ( )

overrideprotecteddefault

Member Function Documentation

◆ BracketedLineOptimize() [1/2]

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::BracketedLineOptimize	(	double	ax,
		double	bx,
		double	cx,
		double	fa,
		double	functionValueOfb,
		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]

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::BracketedLineOptimize	(	double	ax,
		double	bx,
		double	cx,
		double	fa,
		double	functionValueOfb,
		double	fc,
		double *	extX,
		double *	extVal,
		ParametersType &	tempCoord
	)

protectedvirtual

◆ CatchGetValueExceptionOn()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::CatchGetValueExceptionOn ( )

virtual

◆ GetCatchGetValueException()

template<typename TInternalComputationValueType >

virtual const bool & itk::PowellOptimizerv4< TInternalComputationValueType >::GetCatchGetValueException ( ) const

virtual

◆ GetCurrentCost()

template<typename TInternalComputationValueType >

virtual const MeasureType & itk::PowellOptimizerv4< TInternalComputationValueType >::GetCurrentCost ( ) const

virtual

Return Current Value

◆ GetCurrentLineIteration()

template<typename TInternalComputationValueType >

virtual const unsigned int & itk::PowellOptimizerv4< TInternalComputationValueType >::GetCurrentLineIteration ( ) const

virtual

Get the current line search iteration

◆ GetLineValue() [1/2]

template<typename TInternalComputationValueType >

double itk::PowellOptimizerv4< TInternalComputationValueType >::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]

template<typename TInternalComputationValueType >

double itk::PowellOptimizerv4< TInternalComputationValueType >::GetLineValue	(	double	x,
		ParametersType &	tempCoord
	)		const

protected

◆ GetMaximumIteration()

template<typename TInternalComputationValueType >

virtual const unsigned int & itk::PowellOptimizerv4< TInternalComputationValueType >::GetMaximumIteration ( ) const

virtual

Set/Get maximum iteration limit.

◆ GetMaximumLineIteration()

template<typename TInternalComputationValueType >

virtual unsigned int itk::PowellOptimizerv4< TInternalComputationValueType >::GetMaximumLineIteration ( ) const

virtual

Set/Get the maximum number of line search iterations

◆ GetMetricWorstPossibleValue()

template<typename TInternalComputationValueType >

virtual const double & itk::PowellOptimizerv4< TInternalComputationValueType >::GetMetricWorstPossibleValue ( ) const

virtual

◆ GetNameOfClass()

template<typename TInternalComputationValueType >

const char * itk::PowellOptimizerv4< TInternalComputationValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetSpaceDimension()

template<typename TInternalComputationValueType >

virtual unsigned int itk::PowellOptimizerv4< TInternalComputationValueType >::GetSpaceDimension ( )

protectedvirtual

◆ GetStepLength()

template<typename TInternalComputationValueType >

virtual const double & itk::PowellOptimizerv4< TInternalComputationValueType >::GetStepLength ( ) const

virtual

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

◆ GetStepTolerance()

template<typename TInternalComputationValueType >

virtual const double & itk::PowellOptimizerv4< TInternalComputationValueType >::GetStepTolerance ( ) const

virtual

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

◆ GetStop()

template<typename TInternalComputationValueType >

virtual bool itk::PowellOptimizerv4< TInternalComputationValueType >::GetStop ( )

protectedvirtual

◆ GetStopConditionDescription()

template<typename TInternalComputationValueType >

std::string itk::PowellOptimizerv4< TInternalComputationValueType >::GetStopConditionDescription ( ) const

overridevirtual

Stop condition return string type

Implements itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

◆ GetValue()

template<typename TInternalComputationValueType >

const MeasureType & itk::PowellOptimizerv4< TInternalComputationValueType >::GetValue ( ) const

inlineoverridevirtual

Return Current Value

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

Definition at line 112 of file itkPowellOptimizerv4.h.

◆ GetValueTolerance()

template<typename TInternalComputationValueType >

virtual const double & itk::PowellOptimizerv4< TInternalComputationValueType >::GetValueTolerance ( ) const

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

◆ LineBracket() [1/2]

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::LineBracket	(	double *	x1,
		double *	x2,
		double *	x3,
		double *	f1,
		double *	f2,
		double *	f3
	)

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]

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::LineBracket	(	double *	x1,
		double *	x2,
		double *	x3,
		double *	f1,
		double *	f2,
		double *	f3,
		ParametersType &	tempCoord
	)

protectedvirtual

◆ New()

template<typename TInternalComputationValueType >

static Pointer itk::PowellOptimizerv4< TInternalComputationValueType >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ SetCatchGetValueException()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetCatchGetValueException ( bool _arg )

virtual

◆ SetCurrentCost()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetCurrentCost ( double _arg )

protectedvirtual

◆ SetCurrentIteration()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetCurrentIteration ( unsigned int _arg )

protectedvirtual

◆ SetCurrentLinePoint()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::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()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::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.

◆ SetMaximumIteration()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetMaximumIteration ( unsigned int _arg )

virtual

Set/Get maximum iteration limit.

◆ SetMaximumLineIteration()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetMaximumLineIteration ( unsigned int _arg )

virtual

Set/Get the maximum number of line search iterations

◆ SetMetricWorstPossibleValue()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetMetricWorstPossibleValue ( double _arg )

virtual

◆ SetSpaceDimension()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::SetSpaceDimension ( unsigned int dim )

inlineprotected

Definition at line 225 of file itkPowellOptimizerv4.h.

◆ SetStepLength()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetStepLength ( double _arg )

virtual

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

◆ SetStepTolerance()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::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()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::SetStop ( bool _arg )

protectedvirtual

◆ SetValueTolerance()

template<typename TInternalComputationValueType >

virtual void itk::PowellOptimizerv4< TInternalComputationValueType >::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()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::Shift	(	double *	a,
		double *	b,
		double *	c,
		double	d
	)		const

protected

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

◆ StartOptimization()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::StartOptimization ( bool doOnlyInitialization = false )

overridevirtual

Start optimization.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

◆ StopOptimization()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::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 129 of file itkPowellOptimizerv4.h.

◆ Swap()

template<typename TInternalComputationValueType >

void itk::PowellOptimizerv4< TInternalComputationValueType >::Swap	(	double *	a,
		double *	b
	)		const

protected

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

Member Data Documentation

◆ m_CatchGetValueException

template<typename TInternalComputationValueType >

bool itk::PowellOptimizerv4< TInternalComputationValueType >::m_CatchGetValueException { false }

private

Definition at line 249 of file itkPowellOptimizerv4.h.

◆ m_CurrentCost

template<typename TInternalComputationValueType >

MeasureType itk::PowellOptimizerv4< TInternalComputationValueType >::m_CurrentCost {}

private

Internal storage for the value type / used as a cache

Definition at line 262 of file itkPowellOptimizerv4.h.

◆ m_CurrentLineIteration

template<typename TInternalComputationValueType >

unsigned int itk::PowellOptimizerv4< TInternalComputationValueType >::m_CurrentLineIteration { 0 }

private

Current iteration

Definition at line 243 of file itkPowellOptimizerv4.h.

◆ m_CurrentPosition

template<typename TInternalComputationValueType >

ParametersType itk::PowellOptimizerv4< TInternalComputationValueType >::m_CurrentPosition {}

private

Definition at line 270 of file itkPowellOptimizerv4.h.

◆ m_LineDirection

template<typename TInternalComputationValueType >

vnl_vector<double> itk::PowellOptimizerv4< TInternalComputationValueType >::m_LineDirection {}

private

Definition at line 257 of file itkPowellOptimizerv4.h.

◆ m_LineOrigin

template<typename TInternalComputationValueType >

ParametersType itk::PowellOptimizerv4< TInternalComputationValueType >::m_LineOrigin {}

private

Definition at line 256 of file itkPowellOptimizerv4.h.

◆ m_MaximumIteration

template<typename TInternalComputationValueType >

unsigned int itk::PowellOptimizerv4< TInternalComputationValueType >::m_MaximumIteration { 100 }

private

Maximum iteration limit.

Definition at line 246 of file itkPowellOptimizerv4.h.

◆ m_MaximumLineIteration

template<typename TInternalComputationValueType >

unsigned int itk::PowellOptimizerv4< TInternalComputationValueType >::m_MaximumLineIteration { 100 }

private

Definition at line 247 of file itkPowellOptimizerv4.h.

◆ m_MetricWorstPossibleValue

template<typename TInternalComputationValueType >

double itk::PowellOptimizerv4< TInternalComputationValueType >::m_MetricWorstPossibleValue { 0 }

private

Definition at line 250 of file itkPowellOptimizerv4.h.

◆ m_SpaceDimension

template<typename TInternalComputationValueType >

unsigned int itk::PowellOptimizerv4< TInternalComputationValueType >::m_SpaceDimension { 0 }

private

Definition at line 240 of file itkPowellOptimizerv4.h.

◆ m_StepLength

template<typename TInternalComputationValueType >

double itk::PowellOptimizerv4< TInternalComputationValueType >::m_StepLength { 0 }

private

The minimal size of search

Definition at line 253 of file itkPowellOptimizerv4.h.

◆ m_StepTolerance

template<typename TInternalComputationValueType >

double itk::PowellOptimizerv4< TInternalComputationValueType >::m_StepTolerance { 0 }

private

Definition at line 254 of file itkPowellOptimizerv4.h.

◆ m_Stop

template<typename TInternalComputationValueType >

bool itk::PowellOptimizerv4< TInternalComputationValueType >::m_Stop { false }

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 268 of file itkPowellOptimizerv4.h.

◆ m_StopConditionDescription

template<typename TInternalComputationValueType >

std::ostringstream itk::PowellOptimizerv4< TInternalComputationValueType >::m_StopConditionDescription {}

private

Definition at line 272 of file itkPowellOptimizerv4.h.

◆ m_ValueTolerance

template<typename TInternalComputationValueType >

double itk::PowellOptimizerv4< TInternalComputationValueType >::m_ValueTolerance { 0 }

private

Definition at line 259 of file itkPowellOptimizerv4.h.

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

itkPowellOptimizerv4.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ PowellOptimizerv4() [1/2]

◆ PowellOptimizerv4() [2/2]

◆ ~PowellOptimizerv4()

Member Function Documentation

◆ BracketedLineOptimize() [1/2]

◆ BracketedLineOptimize() [2/2]

◆ CatchGetValueExceptionOn()

◆ GetCatchGetValueException()

◆ GetCurrentCost()

◆ GetCurrentLineIteration()

◆ GetLineValue() [1/2]

◆ GetLineValue() [2/2]

◆ GetMaximumIteration()

◆ GetMaximumLineIteration()

◆ GetMetricWorstPossibleValue()

◆ GetNameOfClass()

◆ GetSpaceDimension()

◆ GetStepLength()

◆ GetStepTolerance()

◆ GetStop()

◆ GetStopConditionDescription()

◆ GetValue()

◆ GetValueTolerance()

◆ LineBracket() [1/2]

◆ LineBracket() [2/2]

◆ New()

◆ PrintSelf()

◆ SetCatchGetValueException()

◆ SetCurrentCost()

◆ SetCurrentIteration()

◆ SetCurrentLinePoint()

◆ SetLine()

◆ SetMaximumIteration()

◆ SetMaximumLineIteration()

◆ SetMetricWorstPossibleValue()

◆ SetSpaceDimension()

◆ SetStepLength()

◆ SetStepTolerance()

◆ SetStop()

◆ SetValueTolerance()

◆ Shift()

◆ StartOptimization()

◆ StopOptimization()

◆ Swap()

Member Data Documentation

◆ m_CatchGetValueException

◆ m_CurrentCost

◆ m_CurrentLineIteration

◆ m_CurrentPosition

◆ m_LineDirection

◆ m_LineOrigin

◆ m_MaximumIteration

◆ m_MaximumLineIteration

◆ m_MetricWorstPossibleValue

◆ m_SpaceDimension

◆ m_StepLength

◆ m_StepTolerance

◆ m_Stop

◆ m_StopConditionDescription

◆ m_ValueTolerance