FREE::ROICoupleControllerBase< TCoupleROI > Class Template Reference

Controllerclass for a couple of ROIs. More...

#include <freROICoupleController.h>

Inheritance diagram for FREE::ROICoupleControllerBase< TCoupleROI >:

[legend]

Collaboration diagram for FREE::ROICoupleControllerBase< TCoupleROI >:

[legend]

List of all members.

Public Types
typedef TCoupleROI	ComponentType
typedef ComponentControllerBase < ComponentType >	Superclass
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual GenericMediaPointer	ComputeActualizedMedia (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationField) const
virtual GenericMediaPointer	ComputeActualizedMediaByFunction (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationFunction) const
Protected Member Functions
	ROICoupleControllerBase ()
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 TCoupleROI>
class FREE::ROICoupleControllerBase< TCoupleROI >

Controllerclass for a couple of ROIs.

ROICoupleControllerBase is derived from ComponentControllerBase and is the controller for FREE::ImageROICoupleBase or derivates.

Definition at line 43 of file freROICoupleController.h.

---

Member Typedef Documentation

template<class TCoupleROI>

typedef TCoupleROI FREE::ROICoupleControllerBase< TCoupleROI >::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::MediaControllerBase< TCoupleROI >.

Reimplemented in FREE::MaskedROICoupleControllerBase< VImageDimension >, FREE::ROICouple2DController, FREE::ROICouple3DController, FREE::MaskedROICoupleControllerBase< 2 >, and FREE::MaskedROICoupleControllerBase< 3 >.

Definition at line 46 of file freROICoupleController.h.

template<class TCoupleROI>

typedef ComponentControllerBase<ComponentType> FREE::ROICoupleControllerBase< TCoupleROI >::Superclass

Reimplemented from FREE::MediaControllerBase< TCoupleROI >.

Reimplemented in FREE::MaskedROICoupleControllerBase< VImageDimension >, FREE::ROICouple2DController, FREE::ROICouple3DController, FREE::MaskedROICoupleControllerBase< 2 >, and FREE::MaskedROICoupleControllerBase< 3 >.

Definition at line 47 of file freROICoupleController.h.

template<class TCoupleROI>

typedef Superclass::GenericComponentType FREE::ROICoupleControllerBase< TCoupleROI >::GenericComponentType

Reimplemented from FREE::MediaControllerBase< TCoupleROI >.

Definition at line 48 of file freROICoupleController.h.

template<class TCoupleROI>

typedef Superclass::GenericComponentPointer FREE::ROICoupleControllerBase< TCoupleROI >::GenericComponentPointer

Reimplemented from FREE::MediaControllerBase< TCoupleROI >.

Definition at line 49 of file freROICoupleController.h.

template<class TCoupleROI>

typedef Superclass::GenericMediaPointer FREE::ROICoupleControllerBase< TCoupleROI >::GenericMediaPointer

Reimplemented from FREE::MediaControllerBase< TCoupleROI >.

Definition at line 50 of file freROICoupleController.h.

---

Constructor & Destructor Documentation

template<class TCoupleROI>

FREE::ROICoupleControllerBase< TCoupleROI >::ROICoupleControllerBase

(

)

[inline, protected]

The Constructor of this class is protected, because this class should be used only as ancestor for derived classes

Definition at line 73 of file freROICoupleController.h.

---

Member Function Documentation

template<class TCoupleROI>

virtual const char* FREE::ROICoupleControllerBase< TCoupleROI >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::MediaControllerBase< TCoupleROI >.

Reimplemented in FREE::MaskedROICoupleControllerBase< VImageDimension >, FREE::MaskedROICouple2DController, FREE::MaskedROICouple3DController, FREE::ROICouple2DController, FREE::ROICouple3DController, FREE::MaskedROICoupleControllerBase< 2 >, and FREE::MaskedROICoupleControllerBase< 3 >.

Definition at line 52 of file freROICoupleController.h.

template<class TCoupleROI>

virtual GenericMediaPointer FREE::ROICoupleControllerBase< TCoupleROI >::ComputeActualizedMedia	(	GenericMediaType *	pGenericMedia,
		GenericMediaType *	pGenericTransformationField
	)			const [inline, virtual]

Definition at line 54 of file freROICoupleController.h.

template<class TCoupleROI>

virtual GenericMediaPointer FREE::ROICoupleControllerBase< TCoupleROI >::ComputeActualizedMediaByFunction	(	GenericMediaType *	pGenericMedia,
		GenericMediaType *	pGenericTransformationFunction
	)			const [inline, virtual]

Definition at line 62 of file freROICoupleController.h.

template<class TCoupleROI>

virtual void FREE::ROICoupleControllerBase< TCoupleROI >::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::MediaControllerBase< TCoupleROI >.

Reimplemented in FREE::MaskedROICoupleControllerBase< VImageDimension >, FREE::MaskedROICoupleControllerBase< 2 >, and FREE::MaskedROICoupleControllerBase< 3 >.

Definition at line 79 of file freROICoupleController.h.

Referenced by FREE::MaskedROICoupleControllerBase< 3 >::GenerateProfile().

template<class TCoupleROI>

virtual void FREE::ROICoupleControllerBase< TCoupleROI >::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. For more information see ControllerBase::ActualizeMainComponent.

Reimplemented from FREE::ComponentControllerBase< TCoupleROI >.

Definition at line 101 of file freROICoupleController.h.

Referenced by FREE::MaskedROICoupleControllerBase< 3 >::ActualizeMainComponent().

---

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

• freROICoupleController.h

---