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

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

#include <freMVNonLinearVNLOptimizerControllerBase.h>

Inheritance diagram for FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >:

[legend]

Collaboration diagram for FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >:

[legend]

List of all members.

Public Types
typedef MVNonLinearOptimizerControllerBase < TControlledVNLOptimizer >	Superclass
typedef Superclass::ComponentType	ComponentType
typedef MVNonLinearOptimizerControllerBase < 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
	DeclareParameterMacro (UseCostFunctionGradient)
virtual ParametersType	GetCurrentPosition (TControlledVNLOptimizer *pOptimizer) const
virtual MeasuresType	GetCurrentValue (TControlledVNLOptimizer *pOptimizer) const
	MVNonLinearVNLOptimizerControllerBase ()
Protected Member Functions
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const
virtual void	ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const

---

Detailed Description

template<class TControlledVNLOptimizer>
class FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >

Derived class of a controller objects for vnl optimizers.

MVNonLinearVNLOptimizerControllerBase 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 freMVNonLinearVNLOptimizerControllerBase.h.

---

Member Typedef Documentation

template<class TControlledVNLOptimizer>

typedef MVNonLinearOptimizerControllerBase<TControlledVNLOptimizer> FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::Superclass

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Reimplemented in FREE::LevenbergMarquardtOptimizerController.

Definition at line 49 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef Superclass::ComponentType FREE::MVNonLinearVNLOptimizerControllerBase< 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::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Reimplemented in FREE::LevenbergMarquardtOptimizerController.

Definition at line 50 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

typedef MVNonLinearOptimizerControllerBase<TControlledVNLOptimizer> FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::Self

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 51 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

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

Generic component type

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 52 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

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

Generic smartpointer for the controller interface

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 53 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

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

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 54 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

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

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 55 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

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

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 56 of file freMVNonLinearVNLOptimizerControllerBase.h.

---

Constructor & Destructor Documentation

template<class TControlledVNLOptimizer>

FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::MVNonLinearVNLOptimizerControllerBase

(

)

[inline]

Definition at line 40 of file freMVNonLinearVNLOptimizerControllerBase.txx.

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

Here is the call graph for this function:

---

Member Function Documentation

template<class TControlledVNLOptimizer>

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

(

)

const [inline, virtual]

Reimplemented from FREE::MVNonLinearOptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 45 of file freMVNonLinearVNLOptimizerControllerBase.h.

template<class TControlledVNLOptimizer>

FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::DeclareParameterMacro

(

UseCostFunctionGradient

)

template<class TControlledVNLOptimizer>

MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::ParametersType FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GetCurrentPosition

(

TControlledVNLOptimizer *

pOptimizer

)

const [inline, virtual]

Reimplemented from FREE::OptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 109 of file freMVNonLinearVNLOptimizerControllerBase.txx.

template<class TControlledVNLOptimizer>

MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::MeasuresType FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GetCurrentValue

(

TControlledVNLOptimizer *

pOptimizer

)

const [inline, virtual]

Reimplemented from FREE::OptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 117 of file freMVNonLinearVNLOptimizerControllerBase.txx.

template<class TControlledVNLOptimizer>

void FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::GenerateProfile	(	CtrlProfile::ControllerProfile &	profile,
		const SessionComponentCache *	pComponentCache,
		bool	bRegardOldSetup
	)			const [inline, protected, virtual]

Adjusts the current profile according to the definitions of the controller.
Method should call the superclass variant to regard demands of basic controllers.

Parameters:

[in,out]	profile	Reference of the current profile.
[in]	pComponentCache	Pointer to the cache indicating the location of the component that should be profiled. This pointer can be null. In this case only a default profile that isn't context sensitive is wanted (others aren't possible anyway)
[in]	bRegardOldSetup	If true, the setup of pComponentCache is valid and should be regarded when the profile is generated. Otherwise just use defaults if setup information is needed.

Reimplemented from FREE::ComponentControllerBase< TControlledVNLOptimizer >.

Reimplemented in FREE::LevenbergMarquardtOptimizerController.

Definition at line 50 of file freMVNonLinearVNLOptimizerControllerBase.txx.

References FREE::ComponentControllerBase< TControlledVNLOptimizer >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), and FREE::Parameter::PVTBool.

Referenced by FREE::LevenbergMarquardtOptimizerController::GenerateProfile().

Here is the call graph for this function:

template<class TControlledVNLOptimizer>

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

Reimplemented from FREE::OptimizerControllerBase< TControlledVNLOptimizer >.

Definition at line 63 of file freMVNonLinearVNLOptimizerControllerBase.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:

template<class TControlledVNLOptimizer>

void FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::ActualizeMainComponent	(	ComponentType *	pMainComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActLevel
	)			const [inline, protected, virtual]

Definition at line 125 of file freMVNonLinearVNLOptimizerControllerBase.txx.

References FREE::ComponentControllerBase< TControlledVNLOptimizer >::ActualizeMainComponent(), catchAllNPassMacro, and FREE::SessionAccessor::GetParameterValue().

Referenced by FREE::LevenbergMarquardtOptimizerController::ActualizeMainComponent().

Here is the call graph for this function:

---

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

• freMVNonLinearVNLOptimizerControllerBase.h
• freMVNonLinearVNLOptimizerControllerBase.txx

---