FREE::ExhaustiveSOOptimizerController Class Reference
[Optimizer controller, Setup optimization optimizer]

Derived class of a controller object for optimizers. More...

#include <freExhaustiveSOOptimizerController.h>

Inheritance diagram for FREE::ExhaustiveSOOptimizerController:

[legend]

Collaboration diagram for FREE::ExhaustiveSOOptimizerController:

[legend]

List of all members.

Public Types
typedef ExhaustiveSOOptimizer	ComponentType
typedef SetupOptimizationOptimizerControllerBase < ComponentType >	Superclass
Public Member Functions
	itkTypeMacro (ExhaustiveSOOptimizerController, SetupOptimizationOptimizerControllerBase)
	DeclareParameterMacro (StepLength)
	DeclareParameterMacro (NumberOfSteps)
	DeclareParameterMacro (ParameterAxis)
	DeclareParameterMacro (LogarithmicAxis)
	DeclareParameterMacro (MinimumIsBest)
virtual long	GetMaxIterationCount (const SessionComponentCache *pComponentCache, unsigned int iResolutionLevel=0) const
	ExhaustiveSOOptimizerController ()
Protected Member Functions
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
virtual void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const

---

Detailed Description

Derived class of a controller object for optimizers.

Definition at line 38 of file freExhaustiveSOOptimizerController.h.

---

Member Typedef Documentation

typedef ExhaustiveSOOptimizer FREE::ExhaustiveSOOptimizerController::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< TControlledOptimizer >.

Definition at line 43 of file freExhaustiveSOOptimizerController.h.

typedef SetupOptimizationOptimizerControllerBase<ComponentType> FREE::ExhaustiveSOOptimizerController::Superclass

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >.

Definition at line 44 of file freExhaustiveSOOptimizerController.h.

---

Constructor & Destructor Documentation

FREE::ExhaustiveSOOptimizerController::ExhaustiveSOOptimizerController

(

)

Definition at line 44 of file freExhaustiveSOOptimizerController.cxx.

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

Here is the call graph for this function:

---

Member Function Documentation

FREE::ExhaustiveSOOptimizerController::itkTypeMacro	(	ExhaustiveSOOptimizerController	,
		SetupOptimizationOptimizerControllerBase
	)

FREE::ExhaustiveSOOptimizerController::DeclareParameterMacro

(

StepLength

)

FREE::ExhaustiveSOOptimizerController::DeclareParameterMacro

(

NumberOfSteps

)

FREE::ExhaustiveSOOptimizerController::DeclareParameterMacro

(

ParameterAxis

)

FREE::ExhaustiveSOOptimizerController::DeclareParameterMacro

(

LogarithmicAxis

)

FREE::ExhaustiveSOOptimizerController::DeclareParameterMacro

(

MinimumIsBest

)

long FREE::ExhaustiveSOOptimizerController::GetMaxIterationCount	(	const SessionComponentCache *	pComponentCache,
		unsigned int	iResolutionLevel = 0
	)			const [virtual]

Returns the maximum number of iteration steps of the passed resolution level. The return of the function depends on the derived classes. If the return -1 the count is unknown (e.g optimizer has only a threshold value as stopping criterion)

Reimplemented from FREE::OptimizerControllerBase< TControlledOptimizer >.

Definition at line 70 of file freExhaustiveSOOptimizerController.cxx.

References FREE::ComponentControllerBase< TControlledOptimizer >::GetParameter(), FREE::SessionComponentCache::SetupIsAssigned(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

void FREE::ExhaustiveSOOptimizerController::GenerateProfile	(	CtrlProfile::ControllerProfile &	profile,
		const SessionComponentCache *	pComponentCache,
		bool	bRegardOldSetup
	)			const [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< TControlledOptimizer >.

Definition at line 53 of file freExhaustiveSOOptimizerController.cxx.

References FREE::ComponentControllerBase< TControlledOptimizer >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::Parameter::PVTBool, FREE::Parameter::PVTDouble, FREE::Parameter::PVTLong, and FREE::Parameter::PVTULong.

Here is the call graph for this function:

void FREE::ExhaustiveSOOptimizerController::ActualizeMainComponent	(	ComponentType *	pMainComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActLevel
	)			const [protected, virtual]

Definition at line 92 of file freExhaustiveSOOptimizerController.cxx.

References FREE::ComponentControllerBase< TControlledOptimizer >::ActualizeMainComponent(), catchAllNPassMacro, FREE::cComp_MainTransform, FREE::ComponentSetup::GetComponentByIDPath(), FREE::TransformSetupAdaptor::GetInitialTransformParameters(), FREE::SessionAccessor::GetParameter(), FREE::SessionAccessor::GetParameterValue(), FREE::SessionComponentCache::Setup(), throwCtrlExceptionMacro, and throwExceptionMacro.

Here is the call graph for this function:

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

Definition at line 138 of file freExhaustiveSOOptimizerController.cxx.

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:

• freExhaustiveSOOptimizerController.h
• freExhaustiveSOOptimizerController.cxx

---