#include <itkNonLinearOptimizer.h>

Detailed Description

Wrap of the vnl_nonlinear_minimizer to be adapted.

This class is provided to support the structure of an Optimizers Hierarchy. It is not intended to be instantiated.

Definition at line 35 of file itkNonLinearOptimizer.h.

Inheritance diagram for itk::NonLinearOptimizer:

Collaboration diagram for itk::NonLinearOptimizer:

Public Types
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

const char *	GetNameOfClass () const override

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

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

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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Additional Inherited Members
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::NonLinearOptimizer::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkNonLinearOptimizer.h.

◆ ParametersType

using itk::NonLinearOptimizer::ParametersType = Superclass::ParametersType

Types inherited from the superclass

Definition at line 54 of file itkNonLinearOptimizer.h.

◆ Pointer

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

Definition at line 44 of file itkNonLinearOptimizer.h.

◆ ScalesType

using itk::NonLinearOptimizer::ScalesType = Superclass::ScalesType

Definition at line 55 of file itkNonLinearOptimizer.h.

◆ Self

using itk::NonLinearOptimizer::Self = NonLinearOptimizer

Standard class type aliases.

Definition at line 42 of file itkNonLinearOptimizer.h.

◆ Superclass

using itk::NonLinearOptimizer::Superclass = Optimizer

Definition at line 43 of file itkNonLinearOptimizer.h.

Constructor & Destructor Documentation

◆ NonLinearOptimizer()

itk::NonLinearOptimizer::NonLinearOptimizer ( )

protecteddefault

Referenced by GetNameOfClass().

◆ ~NonLinearOptimizer()

itk::NonLinearOptimizer::~NonLinearOptimizer ( )

overrideprotected

Member Function Documentation

◆ CreateAnother()

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

Reimplemented in itk::OnePlusOneEvolutionaryOptimizer, itk::ParticleSwarmOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SPSAOptimizer, and itk::VersorTransformOptimizer.

◆ GetNameOfClass()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Reimplemented in itk::OnePlusOneEvolutionaryOptimizer, itk::ParticleSwarmOptimizer, itk::ParticleSwarmOptimizerBase, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, and itk::VersorTransformOptimizer.

References NonLinearOptimizer().

◆ New()

static Pointer itk::NonLinearOptimizer::New ( )

static

Method for creation through the object factory.

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

itkNonLinearOptimizer.h