FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric > Class Template Reference
[Metric controller, Setup optimization metric]

Controller class for a registration quality metric. More...

#include <freConstrainedAccuracySOMetricController.h>

Inheritance diagram for FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >:

[legend]

Collaboration diagram for FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >:

[legend]

List of all members.

Public Types
typedef TControlledMetric	ComponentType
typedef AccuracySOMetricControllerBase < ComponentType >	Superclass
Public Member Functions
	DeclareParameterMacro (MaxConstraintPenalty)
	DeclareParameterMacro (FailureThreshold)
	DeclareParameterMacro (Constraints)
	itkTypeMacro (ConstrainedAccuracySOMetricControllerBase, AccuracySOMetricControllerBase)
Protected Member Functions
	ConstrainedAccuracySOMetricControllerBase ()
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
void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const

---

Detailed Description

template<class TControlledMetric>
class FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >

Controller class for a registration quality metric.

ConstrainedAccuracySOMetricControllerBase is based on AccuracySOMetricControllerBase and allows additionally to specify constraints for the parameters to be optimized.

Definition at line 43 of file freConstrainedAccuracySOMetricController.h.

---

Member Typedef Documentation

template<class TControlledMetric>

typedef TControlledMetric FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::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::AccuracySOMetricControllerBase< TControlledMetric >.

Reimplemented in FREE::ConstrainedAccuracy2DSOMetricController, and FREE::ConstrainedAccuracy3DSOMetricController.

Definition at line 50 of file freConstrainedAccuracySOMetricController.h.

template<class TControlledMetric>

typedef AccuracySOMetricControllerBase<ComponentType> FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::Superclass

Reimplemented from FREE::AccuracySOMetricControllerBase< TControlledMetric >.

Reimplemented in FREE::ConstrainedAccuracy2DSOMetricController, and FREE::ConstrainedAccuracy3DSOMetricController.

Definition at line 51 of file freConstrainedAccuracySOMetricController.h.

---

Constructor & Destructor Documentation

template<class TControlledMetric>

FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::ConstrainedAccuracySOMetricControllerBase

(

)

[inline, protected]

Definition at line 56 of file freConstrainedAccuracySOMetricController.h.

---

Member Function Documentation

template<class TControlledMetric>

FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::DeclareParameterMacro

(

MaxConstraintPenalty

)

template<class TControlledMetric>

FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::DeclareParameterMacro

(

FailureThreshold

)

template<class TControlledMetric>

FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::DeclareParameterMacro

(

Constraints

)

template<class TControlledMetric>

FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::itkTypeMacro	(	ConstrainedAccuracySOMetricControllerBase< TControlledMetric >	,
		AccuracySOMetricControllerBase
	)

template<class TControlledMetric>

virtual void FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::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::AccuracySOMetricControllerBase< TControlledMetric >.

Definition at line 65 of file freConstrainedAccuracySOMetricController.h.

template<class TControlledMetric>

virtual void FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::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::AccuracySOMetricControllerBase< TControlledMetric >.

Definition at line 77 of file freConstrainedAccuracySOMetricController.h.

template<class TControlledMetric>

void FREE::ConstrainedAccuracySOMetricControllerBase< TControlledMetric >::SetStatisticEntryMainComponent	(	StatisticEntry &	rStatisticEntry,
		ComponentType *	pMainComponent,
		SessionComponentCache *	pMainComponentCache,
		SessionInfo *	pSessionInfo,
		StatisticDictionary &	rDictionary
	)			const [inline, 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::AccuracySOMetricControllerBase< TControlledMetric >.

Definition at line 119 of file freConstrainedAccuracySOMetricController.h.

---

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

• freConstrainedAccuracySOMetricController.h

---