itk::ConjugateGradientOptimizer Class Reference

Wrap of the vnl_conjugate_gradient. More...

#include <itkConjugateGradientOptimizer.h>

Inheritance diagram for itk::ConjugateGradientOptimizer:

Collaboration diagram for itk::ConjugateGradientOptimizer:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef vnl_conjugate_gradient	InternalOptimizerType
typedef vnl_vector< double >	InternalParametersType
typedef SmartPointer< Self >	Pointer
typedef ConjugateGradientOptimizer	Self
typedef SingleValuedNonLinearVnlOptimizer	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
SizeValueType	GetCurrentIteration (void) const
virtual const char *	GetNameOfClass () const
SizeValueType	GetNumberOfIterations (void) const
vnl_conjugate_gradient *	GetOptimizer (void)
MeasureType	GetValue () const
virtual void	SetCostFunction (SingleValuedCostFunction *costFunction)
void	StartOptimization (void)
Static Public Member Functions
static Pointer	New ()
Protected Types
typedef Superclass::CostFunctionAdaptorType	CostFunctionAdaptorType
Protected Member Functions
	ConjugateGradientOptimizer ()
virtual	~ConjugateGradientOptimizer ()
Private Member Functions
	ConjugateGradientOptimizer (const Self &)
void	operator= (const Self &)
Private Attributes
bool	m_OptimizerInitialized
InternalOptimizerType *	m_VnlOptimizer

---

Detailed Description

Wrap of the vnl_conjugate_gradient.

Definition at line 33 of file itkConjugateGradientOptimizer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 42 of file itkConjugateGradientOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 77 of file itkConjugateGradientOptimizer.h.

typedef vnl_conjugate_gradient itk::ConjugateGradientOptimizer::InternalOptimizerType

Internal Optimizer Type

Definition at line 54 of file itkConjugateGradientOptimizer.h.

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

InternalParameters typedef.

Definition at line 48 of file itkConjugateGradientOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 41 of file itkConjugateGradientOptimizer.h.

typedef ConjugateGradientOptimizer itk::ConjugateGradientOptimizer::Self

Standard class typedefs.

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 39 of file itkConjugateGradientOptimizer.h.

typedef SingleValuedNonLinearVnlOptimizer itk::ConjugateGradientOptimizer::Superclass

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 40 of file itkConjugateGradientOptimizer.h.

---

Constructor & Destructor Documentation

itk::ConjugateGradientOptimizer::ConjugateGradientOptimizer

(

)

[protected]

virtual itk::ConjugateGradientOptimizer::~ConjugateGradientOptimizer

(

)

[protected, virtual]

itk::ConjugateGradientOptimizer::ConjugateGradientOptimizer

(

const Self &

)

[private]

---

Member Function Documentation

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

SizeValueType itk::ConjugateGradientOptimizer::GetCurrentIteration

(

void

)

const

virtual const char* itk::ConjugateGradientOptimizer::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

SizeValueType 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

static Pointer itk::ConjugateGradientOptimizer::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

void itk::ConjugateGradientOptimizer::operator=

(

const Self &

)

[private]

Types inherited from the superclass

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

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.

---

Member Data Documentation

bool itk::ConjugateGradientOptimizer::m_OptimizerInitialized [private]

The vnl optimization method for conjugate gradient.

Definition at line 83 of file itkConjugateGradientOptimizer.h.

InternalOptimizerType* itk::ConjugateGradientOptimizer::m_VnlOptimizer [private]

Definition at line 84 of file itkConjugateGradientOptimizer.h.

---

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

• itkConjugateGradientOptimizer.h