FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer > Class Template Reference
[Optimizer controller, Setup optimization optimizer]

Derived class of a controller objects for registration optimizers based on vnl optimizers. More...

#include <freVnlSetupOptimizationOptimizerControllerBase.h>

Inheritance diagram for FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >:

[legend]

Collaboration diagram for FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >:

[legend]

List of all members.

Public Types
typedef TControlledVnlOptimizer	ComponentType
typedef SetupOptimizationOptimizerControllerBase < ComponentType >	Superclass
typedef Superclass::ParametersType	ParametersType
typedef Superclass::MeasuresType	MeasuresType
Public Member Functions
	itkTypeMacro (VnlSetupOptimizationOptimizerControllerBase, SetupOptimizationOptimizerControllerBase)
	DeclareParameterMacro (Minimize)
virtual ParametersType	GetCurrentPosition (TControlledVnlOptimizer *pOptimizer) const
virtual MeasuresType	GetCurrentValue (TControlledVnlOptimizer *pOptimizer) const
Protected Member Functions
	VnlSetupOptimizationOptimizerControllerBase ()
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual void	ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const

---

Detailed Description

template<class TControlledVnlOptimizer>
class FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >

Derived class of a controller objects for registration optimizers based on vnl optimizers.

Definition at line 38 of file freVnlSetupOptimizationOptimizerControllerBase.h.

---

Member Typedef Documentation

template<class TControlledVnlOptimizer>

typedef TControlledVnlOptimizer FREE::VnlSetupOptimizationOptimizerControllerBase< 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::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Reimplemented in FREE::AmoebaSOOptimizerController, and FREE::LimitedAxisAmoebaSOOptimizerController.

Definition at line 45 of file freVnlSetupOptimizationOptimizerControllerBase.h.

template<class TControlledVnlOptimizer>

typedef SetupOptimizationOptimizerControllerBase<ComponentType> FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::Superclass

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Reimplemented in FREE::AmoebaSOOptimizerController, and FREE::LimitedAxisAmoebaSOOptimizerController.

Definition at line 46 of file freVnlSetupOptimizationOptimizerControllerBase.h.

template<class TControlledVnlOptimizer>

typedef Superclass::ParametersType FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::ParametersType

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Definition at line 47 of file freVnlSetupOptimizationOptimizerControllerBase.h.

template<class TControlledVnlOptimizer>

typedef Superclass::MeasuresType FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::MeasuresType

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Definition at line 48 of file freVnlSetupOptimizationOptimizerControllerBase.h.

---

Constructor & Destructor Documentation

template<class TControlledVnlOptimizer>

FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::VnlSetupOptimizationOptimizerControllerBase

(

)

[inline, protected]

Definition at line 44 of file freVnlSetupOptimizationOptimizerControllerBase.txx.

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

Here is the call graph for this function:

---

Member Function Documentation

template<class TControlledVnlOptimizer>

FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::itkTypeMacro	(	VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >	,
		SetupOptimizationOptimizerControllerBase
	)

template<class TControlledVnlOptimizer>

FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::DeclareParameterMacro

(

Minimize

)

template<class TControlledVnlOptimizer>

VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::ParametersType FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::GetCurrentPosition

(

TControlledVnlOptimizer *

pOptimizer

)

const [inline, virtual]

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Definition at line 86 of file freVnlSetupOptimizationOptimizerControllerBase.txx.

template<class TControlledVnlOptimizer>

VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::MeasuresType FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::GetCurrentValue

(

TControlledVnlOptimizer *

pOptimizer

)

const [inline, virtual]

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Definition at line 94 of file freVnlSetupOptimizationOptimizerControllerBase.txx.

template<class TControlledVnlOptimizer>

void FREE::VnlSetupOptimizationOptimizerControllerBase< 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::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Reimplemented in FREE::AmoebaSOOptimizerController, and FREE::LimitedAxisAmoebaSOOptimizerController.

Definition at line 53 of file freVnlSetupOptimizationOptimizerControllerBase.txx.

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

Here is the call graph for this function:

template<class TControlledVnlOptimizer>

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

This function (called by ActualizeComponent()) actualizes the passed component with the setup information considering the actual resolution level of the ongoing registration. In a derived class this function should be overridden to provide a specific behavior.

Parameters:

[in,out]	pMainComponent	Pointer to the main component. Can also be retrieved via component cache, but offered directly and already casted for more convenience.
[in,out]	pComponentCache	Pointer to the component cache that should be actualized.
[in]	pSessionInfo	Pointer to the session info.
[in]	iActLevel	Indicates which layer of a parameter should be used, if the parameter is layer sensitive (e.g. as resolution level of a registration). Default is 0.

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >.

Definition at line 65 of file freVnlSetupOptimizationOptimizerControllerBase.txx.

References FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >::ActualizeMainComponent(), catchAllNPassMacro, and FREE::SessionAccessor::GetParameterValue().

Here is the call graph for this function:

---

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

• freVnlSetupOptimizationOptimizerControllerBase.h
• freVnlSetupOptimizationOptimizerControllerBase.txx

---