#include <itkSingleValuedNonLinearOptimizer.h>

Inheritance diagram for itk::SingleValuedNonLinearOptimizer:

Collaboration diagram for itk::SingleValuedNonLinearOptimizer:

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.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef CostFunctionType::Pointer	CostFunctionPointer

typedef SingleValuedCostFunction	CostFunctionType

typedef CostFunctionType::DerivativeType	DerivativeType

typedef CostFunctionType::MeasureType	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef SingleValuedNonLinearOptimizer	Self

typedef NonLinearOptimizer	Superclass

Public Types inherited from itk::NonLinearOptimizer
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 CostFunctionType *	GetCostFunction () const

virtual CostFunctionType *	GetModifiableCostFunction ()

virtual const char *	GetNameOfClass () const

MeasureType	GetValue (const ParametersType &parameters) const

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::Optimizer
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::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 flag)

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

static Pointer	New ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override

	SingleValuedNonLinearOptimizer ()

virtual	~SingleValuedNonLinearOptimizer () override

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

virtual	~NonLinearOptimizer () override

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

virtual void	SetCurrentPosition (const ParametersType &param)

virtual	~Optimizer () override

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

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

Protected Attributes
CostFunctionPointer	m_CostFunction

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::SingleValuedNonLinearOptimizer::ConstPointer

Definition at line 43 of file itkSingleValuedNonLinearOptimizer.h.

typedef CostFunctionType::Pointer itk::SingleValuedNonLinearOptimizer::CostFunctionPointer

Definition at line 58 of file itkSingleValuedNonLinearOptimizer.h.

typedef SingleValuedCostFunction itk::SingleValuedNonLinearOptimizer::CostFunctionType

Type of the Cost Function

Definition at line 57 of file itkSingleValuedNonLinearOptimizer.h.

typedef CostFunctionType::DerivativeType itk::SingleValuedNonLinearOptimizer::DerivativeType

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

Definition at line 66 of file itkSingleValuedNonLinearOptimizer.h.

typedef CostFunctionType::MeasureType itk::SingleValuedNonLinearOptimizer::MeasureType

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

Definition at line 62 of file itkSingleValuedNonLinearOptimizer.h.

typedef Superclass::ParametersType itk::SingleValuedNonLinearOptimizer::ParametersType

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

Definition at line 50 of file itkSingleValuedNonLinearOptimizer.h.

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

Definition at line 42 of file itkSingleValuedNonLinearOptimizer.h.

typedef SingleValuedNonLinearOptimizer itk::SingleValuedNonLinearOptimizer::Self

Standard "Self" typedef.

Definition at line 40 of file itkSingleValuedNonLinearOptimizer.h.

typedef NonLinearOptimizer itk::SingleValuedNonLinearOptimizer::Superclass

Definition at line 41 of file itkSingleValuedNonLinearOptimizer.h.

Constructor & Destructor Documentation

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( )

protected

virtual itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( )

inlineoverrideprotectedvirtual

Definition at line 79 of file itkSingleValuedNonLinearOptimizer.h.

Member Function Documentation

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

Reimplemented in itk::VersorTransformOptimizer, itk::VersorRigid3DTransformOptimizer, itk::SPSAOptimizer, and itk::IterateNeighborhoodOptimizer.

virtual const CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetCostFunction ( ) const

virtual

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

virtual

Get the cost function.

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

virtual

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

Get the cost function value at the given parameters.

static Pointer itk::SingleValuedNonLinearOptimizer::New ( )

static

Method for creation through the object factory.

virtual 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::SPSAOptimizer, itk::ParticleSwarmOptimizerBase, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::LBFGSOptimizer, itk::AmoebaOptimizer, itk::PowellOptimizer, itk::GradientDescentOptimizer, itk::ExhaustiveOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::IterateNeighborhoodOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::ParticleSwarmOptimizer, and itk::FRPROptimizer.