FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer > Class Template Reference
[Optimizer controller]

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

#include <freSVNonLinearOptimizerControllerBase.h>

Inheritance diagram for FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >:

[legend]

Collaboration diagram for FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >:

[legend]

List of all members.

Public Types
typedef OptimizerControllerBase < TControlledOptimizer >	Superclass
typedef Superclass::ComponentType	ComponentType
typedef SVNonLinearOptimizerControllerBase < TControlledOptimizer >	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 MeasuresType	GetCurrentValue (TControlledOptimizer *pOptimizer) const =0
	SVNonLinearOptimizerControllerBase ()
virtual	~SVNonLinearOptimizerControllerBase ()
Protected Member Functions
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const

---

Detailed Description

template<class TControlledOptimizer>
class FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >

Derived class of a controller objects for vnl optimizers.

SVNonLinearOptimizerControllerBase 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 freSVNonLinearOptimizerControllerBase.h.

---

Member Typedef Documentation

template<class TControlledOptimizer>

typedef OptimizerControllerBase<TControlledOptimizer> FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::Superclass

Reimplemented from FREE::OptimizerControllerBase< TControlledOptimizer >.

Reimplemented in FREE::EvolutionaryStrategyOptimizerController, FREE::EvolutionaryStrategyOptimizerControllerBase< TOptimizer >, FREE::AmoebaOptimizerController, FREE::ConjugateGradientOptimizerController, FREE::ContinuousLBFGSOptimizerController, FREE::ExhaustiveOptimizerController, FREE::GradientDescentOptimizerController, FREE::LBFGSOptimizerController, FREE::OnePlusOneEvolutionaryOptimizerController, FREE::PowellOptimizerController, FREE::RegStepGradDescOptimizerController, FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >, FREE::SPSAOptimizerController, FREE::VersorRigid3DTransformOptimizerController, FREE::VersorTransformOptimizerController, FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::EvolutionaryStrategyOptimizerControllerBase< FREE::ES::EvolutionaryStrategyOptimizer< FREE::ES::Individual > >, FREE::RegStepGradDescOptimizerControllerBase< itk::VersorRigid3DTransformOptimizer >, FREE::RegStepGradDescOptimizerControllerBase< itk::RegularStepGradientDescentOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 45 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

typedef Superclass::ComponentType FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::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::OptimizerControllerBase< TControlledOptimizer >.

Reimplemented in FREE::EvolutionaryStrategyOptimizerController, FREE::EvolutionaryStrategyOptimizerControllerBase< TOptimizer >, FREE::AmoebaOptimizerController, FREE::ConjugateGradientOptimizerController, FREE::ContinuousLBFGSOptimizerController, FREE::ExhaustiveOptimizerController, FREE::GradientDescentOptimizerController, FREE::LBFGSOptimizerController, FREE::OnePlusOneEvolutionaryOptimizerController, FREE::PowellOptimizerController, FREE::RegStepGradDescOptimizerController, FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >, FREE::SPSAOptimizerController, FREE::VersorRigid3DTransformOptimizerController, FREE::VersorTransformOptimizerController, FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::EvolutionaryStrategyOptimizerControllerBase< FREE::ES::EvolutionaryStrategyOptimizer< FREE::ES::Individual > >, FREE::RegStepGradDescOptimizerControllerBase< itk::VersorRigid3DTransformOptimizer >, FREE::RegStepGradDescOptimizerControllerBase< itk::RegularStepGradientDescentOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 48 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

typedef SVNonLinearOptimizerControllerBase<TControlledOptimizer> FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::Self

Reimplemented in FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 49 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

typedef Superclass::GenericComponentType FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::GenericComponentType

Generic component type

Reimplemented from FREE::ComponentControllerBase< TControlledOptimizer >.

Reimplemented in FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 50 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

typedef Superclass::GenericComponentPointer FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::GenericComponentPointer

Generic smartpointer for the controller interface

Reimplemented from FREE::ComponentControllerBase< TControlledOptimizer >.

Reimplemented in FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 51 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

typedef Superclass::GenericMediaPointer FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::GenericMediaPointer

Reimplemented from FREE::ComponentControllerBase< TControlledOptimizer >.

Reimplemented in FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 52 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

typedef Superclass::MeasuresType FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::MeasuresType

Reimplemented from FREE::OptimizerControllerBase< TControlledOptimizer >.

Reimplemented in FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 53 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

typedef Superclass::ParametersType FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::ParametersType

Reimplemented from FREE::OptimizerControllerBase< TControlledOptimizer >.

Reimplemented in FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 54 of file freSVNonLinearOptimizerControllerBase.h.

---

Constructor & Destructor Documentation

template<class TControlledOptimizer>

FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::SVNonLinearOptimizerControllerBase

(

)

[inline]

Definition at line 33 of file freSVNonLinearOptimizerControllerBase.txx.

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

Here is the call graph for this function:

template<class TControlledOptimizer>

FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::~SVNonLinearOptimizerControllerBase

(

)

[inline, virtual]

Definition at line 59 of file freSVNonLinearOptimizerControllerBase.txx.

---

Member Function Documentation

template<class TControlledOptimizer>

virtual const char* FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::OptimizerControllerBase< TControlledOptimizer >.

Reimplemented in FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 45 of file freSVNonLinearOptimizerControllerBase.h.

template<class TControlledOptimizer>

virtual MeasuresType FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::GetCurrentValue

(

TControlledOptimizer *

pOptimizer

)

const [pure virtual]

Reimplemented from FREE::OptimizerControllerBase< TControlledOptimizer >.

Implemented in FREE::GradientDescentOptimizerController, FREE::OnePlusOneEvolutionaryOptimizerController, FREE::PowellOptimizerController, FREE::RegStepGradDescOptimizerController, FREE::SPSAOptimizerController, FREE::VersorRigid3DTransformOptimizerController, FREE::VersorTransformOptimizerController, FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::LBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::ContinuousLBFGSOptimizer >, FREE::SVNonLinearVNLOptimizerControllerBase< itk::AmoebaOptimizer >, and FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

template<class TControlledOptimizer>

void FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::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< TControlledOptimizer >.

Reimplemented in FREE::EvolutionaryStrategyOptimizerController, FREE::EvolutionaryStrategyOptimizerControllerBase< TOptimizer >, FREE::AmoebaOptimizerController, FREE::ContinuousLBFGSOptimizerController, FREE::ExhaustiveOptimizerController, FREE::GradientDescentOptimizerController, FREE::LBFGSOptimizerController, FREE::OnePlusOneEvolutionaryOptimizerController, FREE::PowellOptimizerController, FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >, FREE::SPSAOptimizerController, FREE::VersorRigid3DTransformOptimizerController, FREE::VersorTransformOptimizerController, FREE::EvolutionaryStrategyOptimizerControllerBase< FREE::ES::EvolutionaryStrategyOptimizer< FREE::ES::Individual > >, FREE::RegStepGradDescOptimizerControllerBase< itk::VersorRigid3DTransformOptimizer >, and FREE::RegStepGradDescOptimizerControllerBase< itk::RegularStepGradientDescentOptimizer >.

Definition at line 42 of file freSVNonLinearOptimizerControllerBase.txx.

References FREE::CtrlProfile::ProfileOption::CheckForInheritance(), FREE::cIDPParent, FREE::ComponentControllerBase< TControlledOptimizer >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Inheritance(), FREE::ControllerID::OptimizerOwnerControllerBase, and FREE::CtrlProfile::ControllerProfile::Requirements().

Referenced by FREE::VersorTransformOptimizerController::GenerateProfile(), FREE::SPSAOptimizerController::GenerateProfile(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::GenerateProfile(), FREE::PowellOptimizerController::GenerateProfile(), FREE::OnePlusOneEvolutionaryOptimizerController::GenerateProfile(), FREE::GradientDescentOptimizerController::GenerateProfile(), FREE::ExhaustiveOptimizerController::GenerateProfile(), and FREE::EvolutionaryStrategyOptimizerControllerBase< TOptimizer >::GenerateProfile().

Here is the call graph for this function:

---

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

• freSVNonLinearOptimizerControllerBase.h
• freSVNonLinearOptimizerControllerBase.txx

---