FREE::ImageMediaControllerBase< TImage > Class Template Reference
[Media controller]

Base class for image media. More...

#include <freImageMediaControllerBase.h>

Inheritance diagram for FREE::ImageMediaControllerBase< TImage >:

[legend]

Collaboration diagram for FREE::ImageMediaControllerBase< TImage >:

[legend]

List of all members.

Public Types
typedef StoreableMediaControllerBase < TImage >	Superclass
typedef Superclass::ComponentType	ComponentType
typedef Superclass::ComponentPointer	ComponentPointer
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
Public Member Functions
	itkTypeMacro (ImageMediaControllerBase, StoreableMediaControllerBase)
	DeclareParameterMacro (ImageSource)
	DeclareParameterMacro (LoadingType)
virtual ComponentPointer	GetComponent (const SessionComponentCache *pComponentCache) const
virtual unsigned long	GetMediaDimension () const
virtual ValidityTag::Pointer	GetMediaValidityTagRequirement (const MediaID &mediaID, SessionComponentCache *pComponentCache) const
	ImageMediaControllerBase ()
Protected Member Functions
virtual ComponentPointer	BuildMainComponent (ComponentSetup *pComponentSetup, SessionComponentCache *pComponentCache) const
virtual GenericMediaPointer	GetMediaCasted (const MediaID &mediaID, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const

---

Detailed Description

template<class TImage>
class FREE::ImageMediaControllerBase< TImage >

Base class for image media.

Definition at line 38 of file freImageMediaControllerBase.h.

---

Member Typedef Documentation

template<class TImage>

typedef StoreableMediaControllerBase<TImage> FREE::ImageMediaControllerBase< TImage >::Superclass

Reimplemented from FREE::StoreableMediaControllerBase< TImage >.

Reimplemented in FREE::CharImage2DMediaController, FREE::CharImage3DMediaController, FREE::UnsignedCharImage2DMediaController, FREE::UnsignedCharImage3DMediaController, FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::IntensityImage2DMediaController, FREE::IntensityImage3DMediaController, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImage2DMediaController, FREE::RegionImage3DMediaController, FREE::ShortImage2DMediaController, FREE::ShortImage3DMediaController, FREE::UnsignedShortImage2DMediaController, FREE::UnsignedShortImage3DMediaController, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::TransformField2DMediaController, FREE::TransformField3DMediaController, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Definition at line 41 of file freImageMediaControllerBase.h.

template<class TImage>

typedef Superclass::ComponentType FREE::ImageMediaControllerBase< TImage >::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::StoreableMediaControllerBase< TImage >.

Reimplemented in FREE::CharImage2DMediaController, FREE::CharImage3DMediaController, FREE::UnsignedCharImage2DMediaController, FREE::UnsignedCharImage3DMediaController, FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::IntensityImage2DMediaController, FREE::IntensityImage3DMediaController, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImage2DMediaController, FREE::RegionImage3DMediaController, FREE::ShortImage2DMediaController, FREE::ShortImage3DMediaController, FREE::UnsignedShortImage2DMediaController, FREE::UnsignedShortImage3DMediaController, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::TransformField2DMediaController, FREE::TransformField3DMediaController, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Definition at line 42 of file freImageMediaControllerBase.h.

template<class TImage>

typedef Superclass::ComponentPointer FREE::ImageMediaControllerBase< TImage >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::StoreableMediaControllerBase< TImage >.

Reimplemented in FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Definition at line 43 of file freImageMediaControllerBase.h.

template<class TImage>

typedef Superclass::GenericComponentType FREE::ImageMediaControllerBase< TImage >::GenericComponentType

Reimplemented from FREE::StoreableMediaControllerBase< TImage >.

Reimplemented in FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Definition at line 44 of file freImageMediaControllerBase.h.

template<class TImage>

typedef Superclass::GenericComponentPointer FREE::ImageMediaControllerBase< TImage >::GenericComponentPointer

Reimplemented from FREE::StoreableMediaControllerBase< TImage >.

Reimplemented in FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Definition at line 45 of file freImageMediaControllerBase.h.

template<class TImage>

typedef Superclass::GenericMediaPointer FREE::ImageMediaControllerBase< TImage >::GenericMediaPointer

Reimplemented from FREE::StoreableMediaControllerBase< TImage >.

Reimplemented in FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Definition at line 46 of file freImageMediaControllerBase.h.

---

Constructor & Destructor Documentation

template<class TImage>

FREE::ImageMediaControllerBase< TImage >::ImageMediaControllerBase

(

)

[inline]

Definition at line 48 of file freImageMediaControllerBase.txx.

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

Here is the call graph for this function:

---

Member Function Documentation

template<class TImage>

FREE::ImageMediaControllerBase< TImage >::itkTypeMacro	(	ImageMediaControllerBase< TImage >	,
		StoreableMediaControllerBase
	)

template<class TImage>

FREE::ImageMediaControllerBase< TImage >::DeclareParameterMacro

(

ImageSource

)

template<class TImage>

FREE::ImageMediaControllerBase< TImage >::DeclareParameterMacro

(

LoadingType

)

template<class TImage>

ImageMediaControllerBase< TImage >::ComponentPointer FREE::ImageMediaControllerBase< TImage >::GetComponent

(

const SessionComponentCache *

pComponentCache

)

const [inline, virtual]

Returns the component managed by the controller and stored in the cache. Reimplement GetComponent() to realize special controller behavior. This version only accesses the component in the cache and returns the pointer.

Parameters:

[in]

pComponentCache

Pointer to the component cache.

Returns:

Smartpointer to the component.

Reimplemented from FREE::ComponentControllerBase< TImage >.

Definition at line 146 of file freImageMediaControllerBase.txx.

References catchAllNPassMacro, FREE::ComponentControllerBase< TImage >::GetComponent(), FREE::DirectSessionComponentAccessor::GetComponent(), FREE::SessionAccessor::GetParameterValue(), FREE::DirectSessionComponentAccessor::GetRepositoryElement(), FREE::MediaControllerBase< TImage >::LoadMedia(), FREE::DirectSessionComponentAccessor::SetComponent(), FREE::DirectSessionComponentAccessor::SetRepositoryElement(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

template<class TImage>

unsigned long FREE::ImageMediaControllerBase< TImage >::GetMediaDimension

(

)

const [inline, virtual]

This function returns the dimension of the media controlled by the controller.

Returns:

Returns dimension of the controlled media. A dimension of 0 indicates that media has no dimensionality or that it is arbitrary.

Reimplemented from FREE::MediaControllerBase< TImage >.

Definition at line 100 of file freImageMediaControllerBase.txx.

Referenced by FREE::ImageMediaControllerBase< TImage >::GenerateProfile().

template<class TImage>

ValidityTag::Pointer FREE::ImageMediaControllerBase< TImage >::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< TImage >.

Definition at line 75 of file freImageMediaControllerBase.txx.

References catchAllNPassMacro, FREE::ComponentControllerBase< TImage >::GetMediaValidityTagRequirement(), FREE::SessionAccessor::GetParameterValue(), and FREE::ValidityTag::New().

Here is the call graph for this function:

template<class TImage>

ImageMediaControllerBase< TImage >::ComponentPointer FREE::ImageMediaControllerBase< TImage >::BuildMainComponent	(	ComponentSetup *	pComponentSetup,
		SessionComponentCache *	pComponentCache
	)			const [inline, protected, virtual]

This function (called by BuildSetup()) creates an object of the controlled class by the use of the passed setup information and initializes other elements in the cache if required.
In a derived class this function should be overridden if a simple instantiation is not sufficient.

Parameters:

[in]	pComponentSetup	The setup information for the component that should be build.
[in,out]	pComponentCache	Pointer to the component cache associated with the component. The component will be automatically added to the cache by the BuildSetup()

Returns:

Smart pointer to the newly created component. Will be added to the cache.

Reimplemented from FREE::MediaControllerBase< TImage >.

Definition at line 108 of file freImageMediaControllerBase.txx.

References FREE::ComponentControllerBase< TImage >::ActualizeMediaValidityTag(), FREE::MediaControllerBase< TImage >::BuildMainComponent(), catchAllNPassMacro, FREE::DirectSessionComponentAccessor::GetComponent(), FREE::SessionAccessor::GetParameterValue(), FREE::MediaControllerBase< TImage >::LoadMedia(), FREE::DirectSessionComponentAccessor::SetRepositoryElement(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

template<class TImage>

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

Definition at line 201 of file freImageMediaControllerBase.txx.

References FREE::ComponentControllerBase< TImage >::GetGenericComponent(), and FREE::MediaControllerBase< TImage >::GetMediaCasted().

Here is the call graph for this function:

template<class TImage>

void FREE::ImageMediaControllerBase< TImage >::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::StoreableMediaControllerBase< TImage >.

Reimplemented in FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, and FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >.

Definition at line 58 of file freImageMediaControllerBase.txx.

References FREE::DAGet, FREE::StoreableMediaControllerBase< TImage >::GenerateProfile(), FREE::ImageMediaControllerBase< TImage >::GetMediaDimension(), FREE::CtrlProfile::ControllerProfileBase::MediaMap(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), and FREE::Parameter::PVTInteger.

Referenced by FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::GenerateProfile().

Here is the call graph for this function:

---

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

• freImageMediaControllerBase.h
• freImageMediaControllerBase.txx

---