FREE::ROIControllerBase< TSingleROI > Class Template Reference

Controllerclass for a singel region of interest (ROI). More...

#include <freROIController.h>

Inheritance diagram for FREE::ROIControllerBase< TSingleROI >:

[legend]

Collaboration diagram for FREE::ROIControllerBase< TSingleROI >:

[legend]

List of all members.

Public Types
typedef TSingleROI	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
	ROIControllerBase ()
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 TSingleROI>
class FREE::ROIControllerBase< TSingleROI >

Controllerclass for a singel region of interest (ROI).

ROIControllerBase is derived from ComponentControllerBase and is the controller for FREE::ImageROIBase or derivates.

Definition at line 44 of file freROIController.h.

---

Member Typedef Documentation

template<class TSingleROI>

typedef TSingleROI FREE::ROIControllerBase< TSingleROI >::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< TSingleROI >.

Reimplemented in FREE::MaskedROIControllerBase< VImageDimension >, FREE::ROI2DController, FREE::ROI3DController, FREE::MaskedROIControllerBase< 2 >, and FREE::MaskedROIControllerBase< 3 >.

Definition at line 47 of file freROIController.h.

template<class TSingleROI>

typedef ComponentControllerBase<ComponentType> FREE::ROIControllerBase< TSingleROI >::Superclass

Reimplemented from FREE::MediaControllerBase< TSingleROI >.

Reimplemented in FREE::MaskedROIControllerBase< VImageDimension >, FREE::ROI2DController, FREE::ROI3DController, FREE::MaskedROIControllerBase< 2 >, and FREE::MaskedROIControllerBase< 3 >.

Definition at line 48 of file freROIController.h.

template<class TSingleROI>

typedef Superclass::GenericComponentType FREE::ROIControllerBase< TSingleROI >::GenericComponentType

Reimplemented from FREE::MediaControllerBase< TSingleROI >.

Definition at line 49 of file freROIController.h.

template<class TSingleROI>

typedef Superclass::GenericComponentPointer FREE::ROIControllerBase< TSingleROI >::GenericComponentPointer

Reimplemented from FREE::MediaControllerBase< TSingleROI >.

Definition at line 50 of file freROIController.h.

template<class TSingleROI>

typedef Superclass::GenericMediaPointer FREE::ROIControllerBase< TSingleROI >::GenericMediaPointer

Reimplemented from FREE::MediaControllerBase< TSingleROI >.

Definition at line 51 of file freROIController.h.

---

Constructor & Destructor Documentation

template<class TSingleROI>

FREE::ROIControllerBase< TSingleROI >::ROIControllerBase

(

)

[inline, protected]

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

Definition at line 74 of file freROIController.h.

---

Member Function Documentation

template<class TSingleROI>

virtual const char* FREE::ROIControllerBase< TSingleROI >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::MediaControllerBase< TSingleROI >.

Reimplemented in FREE::MaskedROIControllerBase< VImageDimension >, FREE::MaskedROI2DController, FREE::MaskedROI3DController, FREE::ROI2DController, FREE::ROI3DController, FREE::MaskedROIControllerBase< 2 >, and FREE::MaskedROIControllerBase< 3 >.

Definition at line 53 of file freROIController.h.

template<class TSingleROI>

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

Definition at line 55 of file freROIController.h.

template<class TSingleROI>

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

Definition at line 63 of file freROIController.h.

template<class TSingleROI>

virtual void FREE::ROIControllerBase< TSingleROI >::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< TSingleROI >.

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

Definition at line 80 of file freROIController.h.

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

template<class TSingleROI>

virtual void FREE::ROIControllerBase< TSingleROI >::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< TSingleROI >.

Definition at line 100 of file freROIController.h.

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

---

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

• freROIController.h

---