ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Private Member Functions | Private Attributes
itk::ConjugateGradientOptimizer Class Reference

#include <itkConjugateGradientOptimizer.h>

+ Inheritance diagram for itk::ConjugateGradientOptimizer:
+ Collaboration diagram for itk::ConjugateGradientOptimizer:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef vnl_conjugate_gradient InternalOptimizerType
typedef vnl_vector< double > InternalParametersType
typedef SmartPointer< SelfPointer
typedef ConjugateGradientOptimizer Self
typedef
SingleValuedNonLinearVnlOptimizer 
Superclass
- Public Types inherited from itk::SingleValuedNonLinearVnlOptimizer
typedef ReceptorMemberCommand
< Self
CommandType
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef CostFunctionType::Pointer CostFunctionPointer
typedef SingleValuedCostFunction CostFunctionType
typedef
CostFunctionType::DerivativeType 
DerivativeType
typedef
CostFunctionType::MeasureType 
MeasureType
typedef Superclass::ParametersType ParametersType
- 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
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)
- Public Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizer
virtual const bool & GetMaximize ()
virtual void SetMaximize (bool _arg)
virtual void MaximizeOn ()
virtual void MaximizeOff ()
bool GetMinimize () const
void SetMinimize (bool v)
void MinimizeOn ()
void MinimizeOff ()
virtual const MeasureTypeGetCachedValue ()
virtual const DerivativeTypeGetCachedDerivative ()
virtual const ParametersTypeGetCachedCurrentPosition ()
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual const CostFunctionTypeGetCostFunction ()
MeasureType GetValue (const ParametersType &parameters) const
virtual void SetCostFunction (CostFunctionType *costFunction)

Static Public Member Functions

static Pointer New ()

Protected Types

typedef
Superclass::CostFunctionAdaptorType 
CostFunctionAdaptorType
- Protected Types inherited from itk::SingleValuedNonLinearVnlOptimizer

Protected Member Functions

 ConjugateGradientOptimizer ()
virtual ~ConjugateGradientOptimizer ()
- Protected Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizer
const CostFunctionAdaptorTypeGetCostFunctionAdaptor (void) const
CostFunctionAdaptorTypeGetCostFunctionAdaptor (void)
CostFunctionAdaptorTypeGetNonConstCostFunctionAdaptor (void) const
void PrintSelf (std::ostream &os, Indent indent) const
void SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
 SingleValuedNonLinearVnlOptimizer ()
virtual ~SingleValuedNonLinearVnlOptimizer ()
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
 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 ()

Private Member Functions

 ConjugateGradientOptimizer (const Self &)
void operator= (const Self &)

Private Attributes

bool m_OptimizerInitialized
InternalOptimizerTypem_VnlOptimizer

Detailed Description

Wrap of the vnl_conjugate_gradient.

Definition at line 33 of file itkConjugateGradientOptimizer.h.


Member Typedef Documentation

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.

Internal Optimizer Type

Definition at line 54 of file itkConjugateGradientOptimizer.h.

InternalParameters typedef.

Definition at line 48 of file itkConjugateGradientOptimizer.h.

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 41 of file itkConjugateGradientOptimizer.h.

Standard class typedefs.

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 39 of file itkConjugateGradientOptimizer.h.

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 40 of file itkConjugateGradientOptimizer.h.


Constructor & Destructor Documentation

itk::ConjugateGradientOptimizer::ConjugateGradientOptimizer ( )
protected
virtual itk::ConjugateGradientOptimizer::~ConjugateGradientOptimizer ( )
protectedvirtual
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: