FREE::ConjugateGradientOptimizerController Class Reference
[Optimizer controller]

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

#include <freConjugateGradientOptimizerController.h>

Inheritance diagram for FREE::ConjugateGradientOptimizerController:

[legend]

Collaboration diagram for FREE::ConjugateGradientOptimizerController:

[legend]

List of all members.

Public Types
typedef itk::ConjugateGradientOptimizer	ComponentType
typedef SVNonLinearVNLOptimizerControllerBase < ComponentType >	Superclass
Public Member Functions
	itkTypeMacro (ConjugateGradientOptimizerController, SVNonLinearVNLOptimizerControllerBase)
	ConjugateGradientOptimizerController ()
virtual	~ConjugateGradientOptimizerController ()
Protected Member Functions
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.

ConjugateGradientOptimizerController is derived from OptimizerControllerBase and the class for the control of a conjugate gradient optimizer. The class uses the itk::ConjugateGradientOptimizer

Definition at line 42 of file freConjugateGradientOptimizerController.h.

---

Member Typedef Documentation

typedef itk::ConjugateGradientOptimizer FREE::ConjugateGradientOptimizerController::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::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 47 of file freConjugateGradientOptimizerController.h.

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

Reimplemented from FREE::SVNonLinearVNLOptimizerControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 48 of file freConjugateGradientOptimizerController.h.

---

Constructor & Destructor Documentation

FREE::ConjugateGradientOptimizerController::ConjugateGradientOptimizerController

(

)

Implementation of FREE::ConjugateGradientOptimizerController ///////

Definition at line 36 of file freConjugateGradientOptimizerController.cxx.

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

Here is the call graph for this function:

FREE::ConjugateGradientOptimizerController::~ConjugateGradientOptimizerController

(

)

[virtual]

Definition at line 46 of file freConjugateGradientOptimizerController.cxx.

---

Member Function Documentation

FREE::ConjugateGradientOptimizerController::itkTypeMacro	(	ConjugateGradientOptimizerController	,
		SVNonLinearVNLOptimizerControllerBase
	)

void FREE::ConjugateGradientOptimizerController::ActualizeMainComponent	(	ComponentType *	pMainComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActLevel
	)			const [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::ComponentControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 52 of file freConjugateGradientOptimizerController.cxx.

References FREE::cComp_MainTransform, FREE::SessionComponentCache::Controller(), FREE::ComponentSetup::GetComponentByIDPath(), FREE::ComponentControllerInterface::GetParameter(), FREE::SessionComponentCache::GetParentCache(), FREE::TransformSetupAdaptor::GetScales(), FREE::SessionComponentCache::Setup(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

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

This function (called by SetStatisticEntry()) records any statistical information of the passed component In a derived class this function should be overridden to provide a specific behavior.

Parameters:

[in,out]	rStatisticEntry	reference to the Statistic object, where the relevant information should be stored.
[in]	pMainComponent	Pointer to the casted component. Also available via cache, but already casted for convenience.
[in]	pMainComponentCache	Pointer to the component cache.
[in]	pSessionInfo	Pointer to the session info
[in,out]	rDictionary	Dictionary with information about the stored facts (e.g. Type, Name) The entry in the dictionary should set by the controller if needed.

Reimplemented from FREE::ComponentControllerBase< itk::ConjugateGradientOptimizer >.

Definition at line 71 of file freConjugateGradientOptimizerController.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:

• freConjugateGradientOptimizerController.h
• freConjugateGradientOptimizerController.cxx

---