Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::AmoebaOptimizer Class Reference
[NumericsOptimizers]

Wrap of the vnl_amoeba algorithm. More...

#include <itkAmoebaOptimizer.h>

Inheritance diagram for itk::AmoebaOptimizer:

Inheritance graph
[legend]
Collaboration diagram for itk::AmoebaOptimizer:

Collaboration graph
[legend]
List of all members.

Public Types

typedef AmoebaOptimizer Self
typedef SingleValuedNonLinearVnlOptimizer Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef vnl_vector< double > InternalParametersType
typedef vnl_amoeba InternalOptimizerType

Public Member Functions

virtual const char * GetClassName () const
vnl_amoeba * GetOptimizer (void)
void StartOptimization (void)
virtual void SetCostFunction (SingleValuedCostFunction *costFunction)
virtual void SetMaximumNumberOfIterations (unsigned int n)
virtual unsigned int GetMaximumNumberOfIterations ()
virtual void SetParametersConvergenceTolerance (double tol)
virtual double GetParametersConvergenceTolerance ()
virtual void SetFunctionConvergenceTolerance (double tol)
virtual double GetFunctionConvergenceTolerance ()

Static Public Member Functions

Pointer New ()

Protected Types

typedef Superclass::CostFunctionAdaptorType CostFunctionAdaptorType

Protected Member Functions

 AmoebaOptimizer ()
virtual ~AmoebaOptimizer ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

Wrap of the vnl_amoeba algorithm.

Definition at line 31 of file itkAmoebaOptimizer.h.


Member Typedef Documentation

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 39 of file itkAmoebaOptimizer.h.

typedef Superclass::CostFunctionAdaptorType itk::AmoebaOptimizer::CostFunctionAdaptorType [protected]
 

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 87 of file itkAmoebaOptimizer.h.

typedef vnl_amoeba itk::AmoebaOptimizer::InternalOptimizerType
 

Internal optimizer type. Definition at line 51 of file itkAmoebaOptimizer.h.

typedef vnl_vector<double> itk::AmoebaOptimizer::InternalParametersType
 

InternalParameters typedef. Definition at line 48 of file itkAmoebaOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 38 of file itkAmoebaOptimizer.h.

typedef AmoebaOptimizer itk::AmoebaOptimizer::Self
 

Standard "Self" typedef.

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 36 of file itkAmoebaOptimizer.h.

typedef SingleValuedNonLinearVnlOptimizer itk::AmoebaOptimizer::Superclass
 

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 37 of file itkAmoebaOptimizer.h.


Constructor & Destructor Documentation

itk::AmoebaOptimizer::AmoebaOptimizer  )  [protected]
 

virtual itk::AmoebaOptimizer::~AmoebaOptimizer  )  [protected, virtual]
 


Member Function Documentation

virtual const char* itk::AmoebaOptimizer::GetClassName  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

virtual double itk::AmoebaOptimizer::GetFunctionConvergenceTolerance  )  [virtual]
 

The optimization algorithm will terminate when the simplex diameter and the difference in cost function within the simplex falls below user specified thresholds. The simplex diameter threshold is set via method SetParametersConvergenceTolerance() with the default value being 1e-8. The cost function convergence threshold is set via method SetFunctionConvergenceTolerance() with the default value being 1e-4.

virtual unsigned int itk::AmoebaOptimizer::GetMaximumNumberOfIterations  )  [virtual]
 

Set/Get the maximum number of iterations. The optimization algorithm will terminate after the maximum number of iterations has been reached. The default value is 500.

vnl_amoeba* itk::AmoebaOptimizer::GetOptimizer void   ) 
 

Method for getting access to the internal optimizer.

virtual double itk::AmoebaOptimizer::GetParametersConvergenceTolerance  )  [virtual]
 

The optimization algorithm will terminate when the simplex diameter and the difference in cost function within the simplex falls below user specified thresholds. The simplex diameter threshold is set via method SetParametersConvergenceTolerance() with the default value being 1e-8. The cost function convergence threshold is set via method SetFunctionConvergenceTolerance() with the default value being 1e-4.

Pointer itk::AmoebaOptimizer::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

void itk::AmoebaOptimizer::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::SingleValuedNonLinearOptimizer.

virtual void itk::AmoebaOptimizer::SetCostFunction SingleValuedCostFunction costFunction  )  [virtual]
 

Plug in a Cost Function into the optimizer

Implements itk::SingleValuedNonLinearVnlOptimizer.

virtual void itk::AmoebaOptimizer::SetFunctionConvergenceTolerance double  tol  )  [virtual]
 

The optimization algorithm will terminate when the simplex diameter and the difference in cost function within the simplex falls below user specified thresholds. The simplex diameter threshold is set via method SetParametersConvergenceTolerance() with the default value being 1e-8. The cost function convergence threshold is set via method SetFunctionConvergenceTolerance() with the default value being 1e-4.

virtual void itk::AmoebaOptimizer::SetMaximumNumberOfIterations unsigned int  n  )  [virtual]
 

Set/Get the maximum number of iterations. The optimization algorithm will terminate after the maximum number of iterations has been reached. The default value is 500.

virtual void itk::AmoebaOptimizer::SetParametersConvergenceTolerance double  tol  )  [virtual]
 

The optimization algorithm will terminate when the simplex diameter and the difference in cost function within the simplex falls below user specified thresholds. The simplex diameter threshold is set via method SetParametersConvergenceTolerance() with the default value being 1e-8. The cost function convergence threshold is set via method SetFunctionConvergenceTolerance() with the default value being 1e-4.

void itk::AmoebaOptimizer::StartOptimization void   )  [virtual]
 

Start optimization with an initial value.

Reimplemented from itk::Optimizer.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 03:02:33 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000