#include <itkFRPROptimizer.h>

Inheritance diagram for itk::FRPROptimizer:

Collaboration diagram for itk::FRPROptimizer:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CostFunctionPointer = CostFunctionType::Pointer

using	CostFunctionType = SingleValuedCostFunction

using	ParametersType = SingleValuedNonLinearOptimizer::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = FRPROptimizer

using	Superclass = PowellOptimizer

Public Types inherited from itk::PowellOptimizer
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::PowellOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const

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

Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const CostFunctionType *	GetCostFunction () const

virtual CostFunctionType *	GetModifiableCostFunction ()

MeasureType	GetValue (const ParametersType &parameters) const

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetInitialPosition () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () const

virtual const ParametersType &	GetCurrentPosition () 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

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)

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

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::PowellOptimizer
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 val)

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

static Pointer	New ()

using	OptimizationEnum = FRPROptimizerEnums::Optimization

OptimizationEnum	m_OptimizationType

bool	m_UseUnitLengthGradient

virtual void	SetUseUnitLengthGradient (bool _arg)

virtual bool	GetUseUnitLengthGradient () const

void	StartOptimization () override

void	SetToFletchReeves ()

void	SetToPolakRibiere ()

	FRPROptimizer ()

	~FRPROptimizer () override

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

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)

Additional Inherited Members
Protected Member Functions inherited from itk::PowellOptimizer
	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 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)

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)

virtual unsigned int	GetSpaceDimension ()

void	SetSpaceDimension (unsigned int dim)

virtual void	SetCurrentIteration (unsigned int _arg)

virtual bool	GetStop ()

virtual void	SetStop (bool _arg)

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 &timeStamp)

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 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.

Definition at line 70 of file itkFRPROptimizer.h.

Member Typedef Documentation

◆ ConstPointer

using itk::FRPROptimizer::ConstPointer = SmartPointer<const Self>

Definition at line 78 of file itkFRPROptimizer.h.

◆ CostFunctionPointer

using itk::FRPROptimizer::CostFunctionPointer = CostFunctionType::Pointer

Definition at line 90 of file itkFRPROptimizer.h.

◆ CostFunctionType

using itk::FRPROptimizer::CostFunctionType = SingleValuedCostFunction

Type of the Cost Function

Definition at line 89 of file itkFRPROptimizer.h.

◆ OptimizationEnum

using itk::FRPROptimizer::OptimizationEnum = FRPROptimizerEnums::Optimization

private

Convert gradient to a unit length vector

Definition at line 129 of file itkFRPROptimizer.h.

◆ ParametersType

using itk::FRPROptimizer::ParametersType = SingleValuedNonLinearOptimizer::ParametersType

Definition at line 80 of file itkFRPROptimizer.h.

◆ Pointer

using itk::FRPROptimizer::Pointer = SmartPointer<Self>

Definition at line 77 of file itkFRPROptimizer.h.

◆ Self

using itk::FRPROptimizer::Self = FRPROptimizer

Standard "Self" type alias.

Definition at line 75 of file itkFRPROptimizer.h.

◆ Superclass

using itk::FRPROptimizer::Superclass = PowellOptimizer

Definition at line 76 of file itkFRPROptimizer.h.

Constructor & Destructor Documentation

◆ FRPROptimizer()

itk::FRPROptimizer::FRPROptimizer ( )

protected

Convert gradient to a unit length vector

◆ ~FRPROptimizer()

itk::FRPROptimizer::~FRPROptimizer ( )

overrideprotected

Convert gradient to a unit length vector

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::FRPROptimizer::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::Object.

◆ GetNameOfClass()

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::PowellOptimizer.

◆ GetUseUnitLengthGradient()

virtual bool itk::FRPROptimizer::GetUseUnitLengthGradient ( ) const

virtual

Convert gradient to a unit length vector

◆ GetValueAndDerivative()

virtual void itk::FRPROptimizer::GetValueAndDerivative	(	ParametersType &	p,
		double *	val,
		ParametersType *	xi
	)

protectedvirtual

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

◆ LineOptimize() [1/2]

virtual void itk::FRPROptimizer::LineOptimize	(	ParametersType *	p,
		ParametersType &	xi,
		double *	val
	)

protectedvirtual

Convert gradient to a unit length vector

◆ LineOptimize() [2/2]

virtual void itk::FRPROptimizer::LineOptimize	(	ParametersType *	p,
		ParametersType &	xi,
		double *	val,
		ParametersType &	tempCoord
	)

protectedvirtual

Convert gradient to a unit length vector

◆ New()

static Pointer itk::FRPROptimizer::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

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

overrideprotectedvirtual

Convert gradient to a unit length vector

Reimplemented from itk::Object.

◆ SetToFletchReeves()

void itk::FRPROptimizer::SetToFletchReeves ( )

Set it to the Fletch-Reeves optimizer

◆ SetToPolakRibiere()

void itk::FRPROptimizer::SetToPolakRibiere ( )

Set it to the Fletch-Reeves optimizer

◆ SetUseUnitLengthGradient()

virtual void itk::FRPROptimizer::SetUseUnitLengthGradient ( bool _arg )

virtual

Convert gradient to a unit length vector

◆ StartOptimization()

void itk::FRPROptimizer::StartOptimization ( )

overridevirtual

Start optimization.

Reimplemented from itk::Optimizer.

Member Data Documentation

◆ m_OptimizationType

OptimizationEnum itk::FRPROptimizer::m_OptimizationType

private

Convert gradient to a unit length vector

Definition at line 136 of file itkFRPROptimizer.h.

◆ m_UseUnitLengthGradient

bool itk::FRPROptimizer::m_UseUnitLengthGradient

private

Convert gradient to a unit length vector

Definition at line 138 of file itkFRPROptimizer.h.

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

itkFRPROptimizer.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ CostFunctionPointer

◆ CostFunctionType

◆ OptimizationEnum

◆ ParametersType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ FRPROptimizer()

◆ ~FRPROptimizer()

Member Function Documentation

◆ CreateAnother()

◆ GetNameOfClass()

◆ GetUseUnitLengthGradient()

◆ GetValueAndDerivative()

◆ LineOptimize() [1/2]

◆ LineOptimize() [2/2]

◆ New()

◆ PrintSelf()

◆ SetToFletchReeves()

◆ SetToPolakRibiere()

◆ SetUseUnitLengthGradient()

◆ StartOptimization()

Member Data Documentation

◆ m_OptimizationType

◆ m_UseUnitLengthGradient