FREE::TransformFunctionMediaControllerBase< TMedia > Class Template Reference
[Media controller]

Base class for transform fields specified as a function/trasnform. More...

#include <freTransformFunctionMediaController.h>

Inheritance diagram for FREE::TransformFunctionMediaControllerBase< TMedia >:

[legend]

Collaboration diagram for FREE::TransformFunctionMediaControllerBase< TMedia >:

[legend]

List of all members.

Public Types
typedef TMedia	ComponentType
typedef MediaControllerBase < ComponentType >	Superclass
typedef TransformFunctionMediaControllerBase < TMedia >	Self
typedef Superclass::ComponentPointer	ComponentPointer
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
Public Member Functions
	itkTypeMacro (TransformFunctionMediaControllerBase, MediaControllerBase)
	TransformFunctionMediaControllerBase ()
virtual	~TransformFunctionMediaControllerBase ()
virtual GenericMediaPointer	ComputeActualizedMedia (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationField) const
virtual GenericMediaPointer	ComputeActualizedMediaByFunction (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationFunction) const
virtual bool	LoadMedia (SessionComponentCache *pCache) const
virtual bool	SaveMedia (SessionComponentCache *pCache) const
virtual bool	SaveMedia (std::string sMediaPath, GenericMediaType *pMedia) const
unsigned long	GetMediaDimension () const

---

Detailed Description

template<typename TMedia>
class FREE::TransformFunctionMediaControllerBase< TMedia >

Base class for transform fields specified as a function/trasnform.

Transformation can be defined by two approaches. First, transformation vector fields (see TransformFieldMediaController) or a transformation function defining the field analytically (based on itk::Transform). The second option is less memory consuming and in some cases faster then using a whole field.

Definition at line 43 of file freTransformFunctionMediaController.h.

---

Member Typedef Documentation

template<typename TMedia>

typedef TMedia FREE::TransformFunctionMediaControllerBase< TMedia >::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< TMedia >.

Reimplemented in FREE::TransformFunction2DMediaController, and FREE::TransformFunction3DMediaController.

Definition at line 46 of file freTransformFunctionMediaController.h.

template<typename TMedia>

typedef MediaControllerBase<ComponentType> FREE::TransformFunctionMediaControllerBase< TMedia >::Superclass

Reimplemented from FREE::MediaControllerBase< TMedia >.

Reimplemented in FREE::TransformFunction2DMediaController, and FREE::TransformFunction3DMediaController.

Definition at line 47 of file freTransformFunctionMediaController.h.

template<typename TMedia>

typedef TransformFunctionMediaControllerBase<TMedia> FREE::TransformFunctionMediaControllerBase< TMedia >::Self

Definition at line 48 of file freTransformFunctionMediaController.h.

template<typename TMedia>

typedef Superclass::ComponentPointer FREE::TransformFunctionMediaControllerBase< TMedia >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 49 of file freTransformFunctionMediaController.h.

template<typename TMedia>

typedef Superclass::GenericComponentType FREE::TransformFunctionMediaControllerBase< TMedia >::GenericComponentType

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 50 of file freTransformFunctionMediaController.h.

template<typename TMedia>

typedef Superclass::GenericComponentPointer FREE::TransformFunctionMediaControllerBase< TMedia >::GenericComponentPointer

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 51 of file freTransformFunctionMediaController.h.

template<typename TMedia>

typedef Superclass::GenericMediaPointer FREE::TransformFunctionMediaControllerBase< TMedia >::GenericMediaPointer

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 52 of file freTransformFunctionMediaController.h.

---

Constructor & Destructor Documentation

template<typename TMedia>

FREE::TransformFunctionMediaControllerBase< TMedia >::TransformFunctionMediaControllerBase

(

)

[inline]

Definition at line 56 of file freTransformFunctionMediaController.h.

template<typename TMedia>

virtual FREE::TransformFunctionMediaControllerBase< TMedia >::~TransformFunctionMediaControllerBase

(

)

[inline, virtual]

Definition at line 63 of file freTransformFunctionMediaController.h.

---

Member Function Documentation

template<typename TMedia>

FREE::TransformFunctionMediaControllerBase< TMedia >::itkTypeMacro	(	TransformFunctionMediaControllerBase< TMedia >	,
		MediaControllerBase
	)

template<typename TMedia>

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

Definition at line 65 of file freTransformFunctionMediaController.h.

template<typename TMedia>

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

Definition at line 75 of file freTransformFunctionMediaController.h.

template<typename TMedia>

virtual bool FREE::TransformFunctionMediaControllerBase< TMedia >::LoadMedia

(

SessionComponentCache *

pCache

)

const [inline, virtual]

This function loads the media and stored it as component in the cache. The loading behavior depends on the controller (e.g. image media controller will save the media to the path specified in the component setup).

Parameters:

[in,out]

pCache

Cache containg the component setup most controller need to load the media. The media will be stored as component in the passed cache.

Returns:

Returns if the media was successfully loaded.

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 85 of file freTransformFunctionMediaController.h.

template<typename TMedia>

virtual bool FREE::TransformFunctionMediaControllerBase< TMedia >::SaveMedia

(

SessionComponentCache *

pCache

)

const [inline, virtual]

Definition at line 90 of file freTransformFunctionMediaController.h.

template<typename TMedia>

virtual bool FREE::TransformFunctionMediaControllerBase< TMedia >::SaveMedia	(	std::string	sMediaPath,
		GenericMediaType *	pMedia
	)			const [inline, virtual]

Definition at line 95 of file freTransformFunctionMediaController.h.

template<typename TMedia>

unsigned long FREE::TransformFunctionMediaControllerBase< TMedia >::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< TMedia >.

Definition at line 101 of file freTransformFunctionMediaController.h.

---

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

• freTransformFunctionMediaController.h

---