FREE::FEMRegistrationControllerBase< TControlledFEMProcessor > Class Template Reference
[Processor controller, Registration controller]

Controllerclass for a finite element model based registration. More...

#include <freFEMRegistrationController.h>

Inheritance diagram for FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >:

[legend]

Collaboration diagram for FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >:

[legend]

List of all members.

Public Types
typedef TControlledFEMProcessor	ComponentType
typedef RegistrationProcessorControllerBase < ComponentType >	Superclass
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
Public Member Functions
	itkTypeMacro (FEMRegistrationControllerBase, RegistrationProcessorControllerBase)
virtual ValidityTag::Pointer	GetMediaValidityTagRequirement (const MediaID &mediaID, SessionComponentCache *pComponentCache) const
Protected Member Functions
	FEMRegistrationControllerBase ()
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual GenericComponentType *	GetSubComponentCasted (ComponentType *pMainComponent, const ComponentID &compID, SessionComponentCache *pMainComponentCache) const
virtual void	SetSubComponentCasted (GenericComponentType *pSubComponent, ComponentType *pMainComponent, const ComponentID compID, SessionComponentCache *pMainComponentCache) const
virtual void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const
virtual GenericMediaPointer	GetMediaCasted (const MediaID &mediaID, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void	SetMediaCasted (const MediaID &mediaID, GenericMediaType *pMedia, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const

---

Detailed Description

template<class TControlledFEMProcessor>
class FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >

Controllerclass for a finite element model based registration.

FEMRegistrationControllerBase is derived from RegistrationProcessorControllerBase and is the controller for finite element model based registration implemented by FEMRegistrationProcessor.

Definition at line 44 of file freFEMRegistrationController.h.

---

Member Typedef Documentation

template<class TControlledFEMProcessor>

typedef TControlledFEMProcessor FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::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::RegistrationProcessorControllerBase< TControlledFEMProcessor >.

Reimplemented in FREE::FEM2DRegistrationController, and FREE::FEM3DRegistrationController.

Definition at line 49 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

typedef RegistrationProcessorControllerBase<ComponentType> FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::Superclass

Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledFEMProcessor >.

Reimplemented in FREE::FEM2DRegistrationController, and FREE::FEM3DRegistrationController.

Definition at line 50 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

typedef Superclass::GenericComponentType FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::GenericComponentType

Generic component type

Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledFEMProcessor >.

Definition at line 51 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

typedef Superclass::GenericComponentPointer FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::GenericComponentPointer

Generic smartpointer for the controller interface

Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledFEMProcessor >.

Definition at line 52 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

typedef Superclass::GenericMediaPointer FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::GenericMediaPointer

Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledFEMProcessor >.

Definition at line 53 of file freFEMRegistrationController.h.

---

Constructor & Destructor Documentation

template<class TControlledFEMProcessor>

FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::FEMRegistrationControllerBase

(

)

[inline, protected]

Definition at line 89 of file freFEMRegistrationController.h.

---

Member Function Documentation

template<class TControlledFEMProcessor>

FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::itkTypeMacro	(	FEMRegistrationControllerBase< TControlledFEMProcessor >	,
		RegistrationProcessorControllerBase
	)

template<class TControlledFEMProcessor>

virtual ValidityTag::Pointer FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::GetMediaValidityTagRequirement	(	const MediaID &	mediaID,
		SessionComponentCache *	pComponentCache
	)			const [inline, virtual]

Retrieves the validity tag requirement of the media specified by the mediaID. The requirement is the most up to date ValidityTag in the dependency chain of a media component.
Reimplement GetMediaValidityTagRequirement() to realize special controller behavior accordingly a certain dependency chain.
This version returns only the ValidityTag of the specified media; thus the media has no dependencies.

Parameters:

[in]	mediaID	ID specifying the wanted media.
[in]	pComponentCache	Pointer to the component cache.

Returns:

ValidityTag requirement

Reimplemented from FREE::ComponentControllerBase< TControlledFEMProcessor >.

Definition at line 55 of file freFEMRegistrationController.h.

Referenced by FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::GetMediaCasted().

template<class TControlledFEMProcessor>

virtual void FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::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< TControlledFEMProcessor >.

Definition at line 96 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

virtual GenericComponentType* FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::GetSubComponentCasted	(	ComponentType *	pMainComponent,
		const ComponentID &	compID,
		SessionComponentCache *	pMainComponentCache
	)			const [inline, protected, virtual]

Returns the subcomponent specified by the ComponentID. If the component ID is not defined, the return is NULL.
Reimplement the virtual variant of this member function to realize special controller behavior. This version is only for establishing a generic interface.

Parameters:

[in]	pMainComponent	Pointer to the main component, containing the wanted subcomponent.
[in]	compID	ID specifying the wanted subcomponent.

Returns:

Pointer to the subcomponent. Is NULL if component does not exist.

Reimplemented from FREE::ComponentControllerBase< TControlledFEMProcessor >.

Definition at line 149 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

virtual void FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::SetSubComponentCasted	(	GenericComponentType *	pSubComponent,
		ComponentType *	pMainComponent,
		const ComponentID	compID,
		SessionComponentCache *	pMainComponentCache
	)			const [inline, protected, virtual]

Definition at line 157 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

virtual void FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::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::ComponentControllerBase< TControlledFEMProcessor >.

Definition at line 164 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

virtual GenericMediaPointer FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::GetMediaCasted	(	const MediaID &	mediaID,
		ComponentType *	pComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const [inline, protected, virtual]

Returns the media specified by the MediaID. If the media ID is not handled, an exception will be thrown.
Reimplement this member function to realize special controller behavior. This version is only for establishing a generic interface.

Parameters:

[in]	mediaID	ID specifying the wanted media.
[in]	pComponent	Pointer to the casted component of the passed cache.
[in]	pComponentCache	Pointer to the component cache.
[in]	pSessionInfo	Pointer to the session info.

Returns:

Smartpointer to the media.

Remarks:

If media is unknown to controller, an exception will be raised.

Reimplemented from FREE::ComponentControllerBase< TControlledFEMProcessor >.

Definition at line 182 of file freFEMRegistrationController.h.

template<class TControlledFEMProcessor>

virtual void FREE::FEMRegistrationControllerBase< TControlledFEMProcessor >::SetMediaCasted	(	const MediaID &	mediaID,
		GenericMediaType *	pMedia,
		ComponentType *	pComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const [inline, protected, virtual]

Definition at line 213 of file freFEMRegistrationController.h.

---

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

• freFEMRegistrationController.h

---