#include <itkSingleValuedNonLinearOptimizer.h>

Detailed Description

This class is a base for the Optimization methods that optimize a single valued function.

Definition at line 35 of file itkSingleValuedNonLinearOptimizer.h.

Inheritance diagram for itk::SingleValuedNonLinearOptimizer:

Collaboration diagram for itk::SingleValuedNonLinearOptimizer:

Public Types
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 CostFunctionType *	GetModifiableCostFunction ()

const char *	GetNameOfClass () const override

MeasureType	GetValue (const ParametersType &parameters) const

virtual void	SetCostFunction (CostFunctionType *costFunction)

const char *	GetNameOfClass () const override

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

virtual const ParametersType &	GetInitialPosition () const

const char *	GetNameOfClass () const override

virtual std::string	GetStopConditionDescription () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual void	StartOptimization ()

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () const

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::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 ()

Protected Member Functions
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 ()

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

virtual void	SetCurrentPosition (const ParametersType &param)

	~Optimizer () override=default

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

Protected Attributes
CostFunctionPointer	m_CostFunction {}

Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition {}

bool	m_ScalesInitialized { false }

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 44 of file itkSingleValuedNonLinearOptimizer.h.

◆ CostFunctionPointer

using itk::SingleValuedNonLinearOptimizer::CostFunctionPointer = CostFunctionType::Pointer

Definition at line 58 of file itkSingleValuedNonLinearOptimizer.h.

◆ CostFunctionType

using itk::SingleValuedNonLinearOptimizer::CostFunctionType = SingleValuedCostFunction

Type of the Cost Function

Definition at line 57 of file itkSingleValuedNonLinearOptimizer.h.

◆ DerivativeType

using itk::SingleValuedNonLinearOptimizer::DerivativeType = CostFunctionType::DerivativeType

Derivative type. It defines a type used to return the cost function derivative.

Definition at line 66 of file itkSingleValuedNonLinearOptimizer.h.

◆ MeasureType

using itk::SingleValuedNonLinearOptimizer::MeasureType = CostFunctionType::MeasureType

Measure type. It defines a type used to return the cost function value.

Definition at line 62 of file itkSingleValuedNonLinearOptimizer.h.

◆ ParametersType

using itk::SingleValuedNonLinearOptimizer::ParametersType = Superclass::ParametersType

Parameters type. It defines a position in the optimization search space.

Definition at line 54 of file itkSingleValuedNonLinearOptimizer.h.

◆ Pointer

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

Definition at line 43 of file itkSingleValuedNonLinearOptimizer.h.

◆ Self

using itk::SingleValuedNonLinearOptimizer::Self = SingleValuedNonLinearOptimizer

Standard "Self" type alias.

Definition at line 41 of file itkSingleValuedNonLinearOptimizer.h.

◆ Superclass

using itk::SingleValuedNonLinearOptimizer::Superclass = NonLinearOptimizer

Definition at line 42 of file itkSingleValuedNonLinearOptimizer.h.

Constructor & Destructor Documentation

◆ SingleValuedNonLinearOptimizer()

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( )

protected

◆ ~SingleValuedNonLinearOptimizer()

itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( )

overrideprotecteddefault

Member Function Documentation

◆ GetModifiableCostFunction()

virtual CostFunctionType * itk::SingleValuedNonLinearOptimizer::GetModifiableCostFunction ( )

virtual

Get the cost function.

◆ GetNameOfClass()

const char * itk::SingleValuedNonLinearOptimizer::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, and itk::VersorTransformOptimizer.

◆ GetValue()

MeasureType itk::SingleValuedNonLinearOptimizer::GetValue ( const ParametersType & parameters ) const

Get the cost function value at the given parameters.

◆ New()

static Pointer itk::SingleValuedNonLinearOptimizer::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

void itk::SingleValuedNonLinearOptimizer::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::Optimizer.

Reimplemented in itk::SingleValuedNonLinearVnlOptimizer, and itk::SPSAOptimizer.

◆ SetCostFunction()

virtual void itk::SingleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType * costFunction )

virtual

Set the cost function.

Member Data Documentation

◆ m_CostFunction

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction {}