itk::ConjugateGradientOptimizer Class Reference
[Numerics, Optimizers]

Wrap of the vnl_conjugate_gradient. More...

#include <itkConjugateGradientOptimizer.h>

Inheritance diagram for itk::ConjugateGradientOptimizer:

[legend]Collaboration diagram for itk::ConjugateGradientOptimizer:

[legend]List of all members.

Public Types
typedef ConjugateGradientOptimizer	Self
typedef SingleValuedNonLinearVnlOptimizer	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef vnl_vector< double >	InternalParametersType
typedef vnl_conjugate_gradient	InternalOptimizerType
Public Member Functions
virtual const char *	GetNameOfClass () const
vnl_conjugate_gradient *	GetOptimizer (void)
void	StartOptimization (void)
virtual void	SetCostFunction (SingleValuedCostFunction *costFunction)
MeasureType	GetValue () const
unsigned long	GetNumberOfIterations (void) const
unsigned long	GetCurrentIteration (void) const
Static Public Member Functions
Pointer	New ()
Protected Types
typedef Superclass::CostFunctionAdaptorType	CostFunctionAdaptorType
Protected Member Functions
	ConjugateGradientOptimizer ()
virtual	~ConjugateGradientOptimizer ()

---

Detailed Description

Wrap of the vnl_conjugate_gradient.

Definition at line 31 of file itkConjugateGradientOptimizer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer. Definition at line 40 of file itkConjugateGradientOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer. Definition at line 75 of file itkConjugateGradientOptimizer.h.

typedef vnl_conjugate_gradient itk::ConjugateGradientOptimizer::InternalOptimizerType

Internal Optimizer Type Definition at line 52 of file itkConjugateGradientOptimizer.h.

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

InternalParameters typedef. Definition at line 49 of file itkConjugateGradientOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer. Definition at line 39 of file itkConjugateGradientOptimizer.h.

typedef ConjugateGradientOptimizer itk::ConjugateGradientOptimizer::Self

Standard class typedefs. Reimplemented from itk::SingleValuedNonLinearVnlOptimizer. Definition at line 37 of file itkConjugateGradientOptimizer.h.

typedef SingleValuedNonLinearVnlOptimizer itk::ConjugateGradientOptimizer::Superclass

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer. Definition at line 38 of file itkConjugateGradientOptimizer.h.

---

Constructor & Destructor Documentation

itk::ConjugateGradientOptimizer::ConjugateGradientOptimizer (   )  [protected]

virtual itk::ConjugateGradientOptimizer::~ConjugateGradientOptimizer (   )  [protected, virtual]

---

Member Function Documentation

unsigned long itk::ConjugateGradientOptimizer::GetCurrentIteration (  void   )  const

Return the number of iterations performed so far

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

Run-time type information (and related methods). Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

unsigned long itk::ConjugateGradientOptimizer::GetNumberOfIterations (  void   )  const

Return the number of iterations performed so far

vnl_conjugate_gradient* itk::ConjugateGradientOptimizer::GetOptimizer (  void   )

Method for getting access to the internal optimizer

MeasureType itk::ConjugateGradientOptimizer::GetValue (   )  const

Return Current Value

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

Method for creation through the object factory. Reimplemented from itk::SingleValuedNonLinearOptimizer.

virtual void itk::ConjugateGradientOptimizer::SetCostFunction (  SingleValuedCostFunction *  costFunction  )  [virtual]

Plug in a Cost Function into the optimizer Implements itk::SingleValuedNonLinearVnlOptimizer.

void itk::ConjugateGradientOptimizer::StartOptimization (  void   )  [virtual]

Start optimization with an initial value. Reimplemented from itk::Optimizer.

---

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

• itkConjugateGradientOptimizer.h

---