itk::SingleValuedNonLinearOptimizer Class Reference
[Numerics, Optimizers]

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

#include <itkSingleValuedNonLinearOptimizer.h>

Inheritance diagram for itk::SingleValuedNonLinearOptimizer:

[legend]Collaboration diagram for itk::SingleValuedNonLinearOptimizer:

[legend]List of all members.

Public Types
typedef SingleValuedNonLinearOptimizer	Self
typedef NonLinearOptimizer	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
typedef SingleValuedCostFunction	CostFunctionType
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef CostFunctionType::MeasureType	MeasureType
typedef CostFunctionType::DerivativeType	DerivativeType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetCostFunction (CostFunctionType *costFunction)
virtual const CostFunctionType *	GetCostFunction ()
MeasureType	GetValue (const ParametersType &parameters) const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	SingleValuedNonLinearOptimizer ()
virtual	~SingleValuedNonLinearOptimizer ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
CostFunctionPointer	m_CostFunction

---

Detailed Description

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

Definition at line 33 of file itkSingleValuedNonLinearOptimizer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 41 of file itkSingleValuedNonLinearOptimizer.h.

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

Reimplemented in itk::FRPROptimizer, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer. Definition at line 56 of file itkSingleValuedNonLinearOptimizer.h.

typedef SingleValuedCostFunction itk::SingleValuedNonLinearOptimizer::CostFunctionType

Type of the Cost Function Reimplemented in itk::FRPROptimizer, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer. Definition at line 55 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 64 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::LBFGSBOptimizer. Definition at line 60 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::FRPROptimizer, itk::PowellOptimizer, and itk::QuaternionRigidTransformGradientDescentOptimizer. Definition at line 52 of file itkSingleValuedNonLinearOptimizer.h.

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

Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 40 of file itkSingleValuedNonLinearOptimizer.h.

typedef SingleValuedNonLinearOptimizer itk::SingleValuedNonLinearOptimizer::Self

Standard "Self" typedef. Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 38 of file itkSingleValuedNonLinearOptimizer.h.

typedef NonLinearOptimizer itk::SingleValuedNonLinearOptimizer::Superclass

Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 39 of file itkSingleValuedNonLinearOptimizer.h.

---

Constructor & Destructor Documentation

itk::SingleValuedNonLinearOptimizer::SingleValuedNonLinearOptimizer (   )  [protected]

virtual itk::SingleValuedNonLinearOptimizer::~SingleValuedNonLinearOptimizer (   )  [inline, protected, virtual]

Definition at line 77 of file itkSingleValuedNonLinearOptimizer.h.

---

Member Function Documentation

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

Get the cost function.

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

Run-time type information (and related methods). Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

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

Get the cost function value at the given parameters. Reimplemented in itk::SPSAOptimizer.

Pointer itk::SingleValuedNonLinearOptimizer::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::ExhaustiveOptimizer, itk::FRPROptimizer, itk::GradientDescentOptimizer, itk::LBFGSBOptimizer, itk::LBFGSOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SPSAOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

void itk::SingleValuedNonLinearOptimizer::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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

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

Set the cost function.

---

Member Data Documentation

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction [protected]

Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.

---

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

• itkSingleValuedNonLinearOptimizer.h

---