FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer > Class Template Reference
[Optimizer controller]

Derived class of a controller objects for vnl optimizers. More...

#include <freSVNonLinearVNLOptimizerControllerBase.h>

Inheritance diagram for FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >:

[legend]

Collaboration diagram for FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >:

[legend]

List of all members.

Public Types
typedef SVNonLinearOptimizerControllerBase < TControlledVNLOptimizer >	Superclass
typedef Superclass::ComponentType	ComponentType
typedef SVNonLinearOptimizerControllerBase < TControlledVNLOptimizer >	Self
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
typedef Superclass::MeasuresType	MeasuresType
typedef Superclass::ParametersType	ParametersType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ParametersType	GetCurrentPosition (TControlledVNLOptimizer *pOptimizer) const
virtual MeasuresType	GetCurrentValue (TControlledVNLOptimizer *pOptimizer) const
	SVNonLinearVNLOptimizerControllerBase ()
virtual	~SVNonLinearVNLOptimizerControllerBase ()
Protected Member Functions
virtual void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const

---

Detailed Description

template<class TControlledVNLOptimizer>
class FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >

Derived class of a controller objects for vnl optimizers.

SVNonLinearVNLOptimizerControllerBase is derived from OptimizerControllerBase and the base class for the control of vnl optimizers.
This class should be used as base for new vnl optimizer controller.

Definition at line 42 of file freSVNonLinearVNLOptimizerControllerBase.h.

---

Member Typedef Documentation

template<class TControlledVNLOptimizer>

typedef SVNonLinearOptimizerControllerBase<TControlledVNLOptimizer> FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::Superclass

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Reimplemented in FREE::AmoebaOptimizerController, FREE::ConjugateGradientOptimizerController, FREE::ContinuousLBFGSOptimizerController, and FREE::LBFGSOptimizerController.

Definition at line 45 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef Superclass::ComponentType FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::ComponentType

The component class managed by the controller. The component class must be a derivation from itk::LightObject to ensure the ability to use the smartpointer concept of itk

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Reimplemented in FREE::AmoebaOptimizerController, FREE::ConjugateGradientOptimizerController, FREE::ContinuousLBFGSOptimizerController, and FREE::LBFGSOptimizerController.

Definition at line 48 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef SVNonLinearOptimizerControllerBase<TControlledVNLOptimizer> FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::Self

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 49 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef Superclass::GenericComponentType FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GenericComponentType

Generic component type

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 50 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef Superclass::GenericComponentPointer FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GenericComponentPointer

Generic smartpointer for the controller interface

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 51 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef Superclass::GenericMediaPointer FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GenericMediaPointer

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 52 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef Superclass::MeasuresType FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::MeasuresType

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 53 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef Superclass::ParametersType FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::ParametersType

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 54 of file freSVNonLinearVNLOptimizerControllerBase.h.

---

Constructor & Destructor Documentation

template<class TControlledVNLOptimizer>

FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SVNonLinearVNLOptimizerControllerBase

(

)

[inline]

Definition at line 32 of file freSVNonLinearVNLOptimizerControllerBase.txx.

References FREE::ComponentControllerInterface::m_Description, FREE::ControllerID::SVNonLinearVNLOptimizerControllerBase, and FREE::ComponentControllerInterface::UpdateControllerID().

Here is the call graph for this function:

template<class TControlledVNLOptimizer>

FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::~SVNonLinearVNLOptimizerControllerBase

(

)

[inline, virtual]

Definition at line 40 of file freSVNonLinearVNLOptimizerControllerBase.txx.

---

Member Function Documentation

template<class TControlledVNLOptimizer>

virtual const char* FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 45 of file freSVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::ParametersType FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GetCurrentPosition

(

TControlledVNLOptimizer *

pOptimizer

)

const [inline, virtual]

Reimplemented from FREE::OptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 80 of file freSVNonLinearVNLOptimizerControllerBase.txx.

template<class TControlledVNLOptimizer>

SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::MeasuresType FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GetCurrentValue

(

TControlledVNLOptimizer *

pOptimizer

)

const [inline, virtual]

Implements FREE::SVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 88 of file freSVNonLinearVNLOptimizerControllerBase.txx.

template<class TControlledVNLOptimizer>

void FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent	(	StatisticEntry &	rStatisticEntry,
		ComponentType *	pMainComponent,
		SessionComponentCache *	pMainComponentCache,
		SessionInfo *	pSessionInfo,
		StatisticDictionary &	rDictionary
	)			const [inline, protected, virtual]

Reimplemented from FREE::OptimizerControllerBase< TControlledVNLOptimizer >.

Reimplemented in FREE::ContinuousLBFGSOptimizerController.

Definition at line 47 of file freSVNonLinearVNLOptimizerControllerBase.txx.

References FREE::StatisticEntry::AddValue(), FREE::StatisticDictionary::AddValueDefinition(), FREE::SessionComponentCache::GetIDPath(), FREE::StatisticValueDefinition::GetRefID(), FREE::StatisticDictionary::GetValueDefinitionByName(), and FREE::Convert::ToStr().

Here is the call graph for this function:

---

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

• freSVNonLinearVNLOptimizerControllerBase.h
• freSVNonLinearVNLOptimizerControllerBase.txx

---