itk::NonLinearOptimizer Class Reference

#include <itkNonLinearOptimizer.h>

Inheritance diagram for itk::NonLinearOptimizer:

Collaboration diagram for itk::NonLinearOptimizer:

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.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef NonLinearOptimizer	Self
typedef Optimizer	Superclass
Public Types inherited from itk::Optimizer
typedef SmartPointer< const Self >	ConstPointer
typedef OptimizerParameters < double >	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Array< double >	ScalesType
typedef Optimizer	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::Optimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const ParametersType &	GetCurrentPosition () const
virtual const ParametersType &	GetInitialPosition () const
virtual const 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 *)
unsigned long	AddObserver (const EventObject &event, Command *) 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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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::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 ()

Protected Member Functions
	NonLinearOptimizer ()
virtual	~NonLinearOptimizer ()
Protected Member Functions inherited from itk::Optimizer
	Optimizer ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetCurrentPosition (const ParametersType &param)
virtual	~Optimizer ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 ()

Private Member Functions
	NonLinearOptimizer (const Self &) ITK_DELETE_FUNCTION
void	operator= (const Self &) ITK_DELETE_FUNCTION

Additional Inherited Members
Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition
bool	m_ScalesInitialized
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< const Self > itk::NonLinearOptimizer::ConstPointer

Definition at line 43 of file itkNonLinearOptimizer.h.

typedef Superclass::ParametersType itk::NonLinearOptimizer::ParametersType

Types inherited from the superclass

Definition at line 49 of file itkNonLinearOptimizer.h.

typedef SmartPointer< Self > itk::NonLinearOptimizer::Pointer

Definition at line 42 of file itkNonLinearOptimizer.h.

typedef Superclass::ScalesType itk::NonLinearOptimizer::ScalesType

Definition at line 53 of file itkNonLinearOptimizer.h.

typedef NonLinearOptimizer itk::NonLinearOptimizer::Self

Standard class typedefs.

Definition at line 40 of file itkNonLinearOptimizer.h.

typedef Optimizer itk::NonLinearOptimizer::Superclass

Definition at line 41 of file itkNonLinearOptimizer.h.

Constructor & Destructor Documentation

itk::NonLinearOptimizer::NonLinearOptimizer ( )

inlineprotected

Definition at line 56 of file itkNonLinearOptimizer.h.

virtual itk::NonLinearOptimizer::~NonLinearOptimizer ( )

protectedvirtual

itk::NonLinearOptimizer::NonLinearOptimizer ( const Self &  )

private

Member Function Documentation

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

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

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::Optimizer.

Reimplemented in itk::ExhaustiveOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::AmoebaOptimizer, itk::LBFGSBOptimizer, itk::ParticleSwarmOptimizer, itk::CumulativeGaussianOptimizer, itk::ParticleSwarmOptimizerBase, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, itk::SPSAOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::IterateNeighborhoodOptimizer, itk::SingleValuedNonLinearOptimizer, itk::ConjugateGradientOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::LBFGSOptimizer, and itk::LevenbergMarquardtOptimizer.

static Pointer itk::NonLinearOptimizer::New ( )

static

Method for creation through the object factory.

void itk::NonLinearOptimizer::operator= ( const Self &  )

private

---

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

• itkNonLinearOptimizer.h