#include <itkSingleValuedNonLinearOptimizer.h>

Inheritance diagram for itk::SingleValuedNonLinearOptimizer:

Collaboration diagram for itk::SingleValuedNonLinearOptimizer:

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 Superclass::ScalesType	ScalesType
Public Types inherited from itk::Optimizer
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const CostFunctionType *	GetCostFunction ()
virtual const char *	GetNameOfClass () const
MeasureType	GetValue (const ParametersType &parameters) const
virtual void	SetCostFunction (CostFunctionType *costFunction)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	SingleValuedNonLinearOptimizer ()
virtual	~SingleValuedNonLinearOptimizer ()
	NonLinearOptimizer ()
virtual	~NonLinearOptimizer ()
Protected Member Functions inherited from itk::Optimizer
	Optimizer ()
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 ()

Protected Attributes
CostFunctionPointer	m_CostFunction

Private Member Functions
void	operator= (const Self &)
	SingleValuedNonLinearOptimizer (const Self &)

Detailed Description

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

Definition at line 34 of file itkSingleValuedNonLinearOptimizer.h.

Member Typedef Documentation

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

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

Reimplemented in itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::FRPROptimizer, and itk::RegularStepGradientDescentOptimizer.

Definition at line 57 of file itkSingleValuedNonLinearOptimizer.h.

typedef SingleValuedCostFunction itk::SingleValuedNonLinearOptimizer::CostFunctionType

Type of the Cost Function

Reimplemented in itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::FRPROptimizer, and itk::RegularStepGradientDescentOptimizer.

Definition at line 56 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 65 of file itkSingleValuedNonLinearOptimizer.h.

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

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

Reimplemented in itk::ParticleSwarmOptimizerBase.

Definition at line 61 of file itkSingleValuedNonLinearOptimizer.h.

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

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

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::AmoebaOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, and itk::FRPROptimizer.

Definition at line 49 of file itkSingleValuedNonLinearOptimizer.h.

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

typedef SingleValuedNonLinearOptimizer itk::SingleValuedNonLinearOptimizer::Self

typedef NonLinearOptimizer itk::SingleValuedNonLinearOptimizer::Superclass

Constructor & Destructor Documentation

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( )

protected

virtual itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer ( )

inlineprotectedvirtual

Definition at line 78 of file itkSingleValuedNonLinearOptimizer.h.

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer ( const Self & )

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::SingleValuedNonLinearOptimizer::CreateAnother ( void ) 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::ExhaustiveOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::AmoebaOptimizer, itk::LBFGSBOptimizer, itk::ParticleSwarmOptimizer, itk::FRPROptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::GradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, itk::SPSAOptimizer, itk::ConjugateGradientOptimizer, itk::LBFGSOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::RegularStepGradientDescentOptimizer.

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

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.

Reimplemented in itk::SPSAOptimizer.

static Pointer itk::SingleValuedNonLinearOptimizer::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::ExhaustiveOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::AmoebaOptimizer, itk::LBFGSBOptimizer, itk::ParticleSwarmOptimizer, itk::FRPROptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::GradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, itk::SPSAOptimizer, itk::ConjugateGradientOptimizer, itk::LBFGSOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::RegularStepGradientDescentOptimizer.

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

private

Types inherited from the superclass

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::SPSAOptimizer, itk::ParticleSwarmOptimizerBase, itk::LBFGSBOptimizer, itk::AmoebaOptimizer, itk::ExhaustiveOptimizer, itk::GradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::LBFGSOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::ParticleSwarmOptimizer, itk::VersorRigid3DTransformOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::ConjugateGradientOptimizer, and itk::RegularStepGradientDescentOptimizer.

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

protectedvirtual

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::AmoebaOptimizer, itk::PowellOptimizer, itk::GradientDescentOptimizer, itk::ExhaustiveOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::LBFGSOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::ParticleSwarmOptimizer, and itk::FRPROptimizer.