FREE::TransformFieldMediaControllerBase< TVector, VDimension > Class Template Reference
[Media controller]

Base class for intensity (grayscale) image media. More...

#include <freTransformFieldMediaController.h>

Inheritance diagram for FREE::TransformFieldMediaControllerBase< TVector, VDimension >:

[legend]

Collaboration diagram for FREE::TransformFieldMediaControllerBase< TVector, VDimension >:

[legend]

List of all members.

Public Types
typedef itk::Image < TVector, VDimension >	ComponentType
typedef ComponentType	FieldType
typedef ImageMediaControllerBase < ComponentType >	Superclass
typedef TransformFieldMediaControllerBase < TVector, VDimension >	Self
typedef Superclass::ComponentPointer	ComponentPointer
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
	TransformFieldMediaControllerBase ()
virtual	~TransformFieldMediaControllerBase ()
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

---

Detailed Description

template<class TVector, unsigned int VDimension>
class FREE::TransformFieldMediaControllerBase< TVector, VDimension >

Base class for intensity (grayscale) image media.

Definition at line 45 of file freTransformFieldMediaController.h.

---

Member Typedef Documentation

template<class TVector, unsigned int VDimension>

typedef itk::Image< TVector, VDimension > FREE::TransformFieldMediaControllerBase< TVector, VDimension >::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::ImageMediaControllerBase< itk::Image< TVector, VDimension > >.

Reimplemented in FREE::TransformField2DMediaController, and FREE::TransformField3DMediaController.

Definition at line 48 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

typedef ComponentType FREE::TransformFieldMediaControllerBase< TVector, VDimension >::FieldType

Definition at line 49 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

typedef ImageMediaControllerBase<ComponentType> FREE::TransformFieldMediaControllerBase< TVector, VDimension >::Superclass

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >.

Reimplemented in FREE::TransformField2DMediaController, and FREE::TransformField3DMediaController.

Definition at line 50 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

typedef TransformFieldMediaControllerBase<TVector, VDimension> FREE::TransformFieldMediaControllerBase< TVector, VDimension >::Self

Definition at line 51 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

typedef Superclass::ComponentPointer FREE::TransformFieldMediaControllerBase< TVector, VDimension >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >.

Definition at line 52 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

typedef Superclass::GenericComponentType FREE::TransformFieldMediaControllerBase< TVector, VDimension >::GenericComponentType

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >.

Definition at line 53 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

typedef Superclass::GenericComponentPointer FREE::TransformFieldMediaControllerBase< TVector, VDimension >::GenericComponentPointer

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >.

Definition at line 54 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

typedef Superclass::GenericMediaPointer FREE::TransformFieldMediaControllerBase< TVector, VDimension >::GenericMediaPointer

Reimplemented from FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >.

Definition at line 55 of file freTransformFieldMediaController.h.

---

Constructor & Destructor Documentation

template<class TVector, unsigned int VDimension>

FREE::TransformFieldMediaControllerBase< TVector, VDimension >::TransformFieldMediaControllerBase

(

)

[inline]

Definition at line 59 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

virtual FREE::TransformFieldMediaControllerBase< TVector, VDimension >::~TransformFieldMediaControllerBase

(

)

[inline, virtual]

Definition at line 66 of file freTransformFieldMediaController.h.

---

Member Function Documentation

template<class TVector, unsigned int VDimension>

virtual const char* FREE::TransformFieldMediaControllerBase< TVector, VDimension >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >.

Reimplemented in FREE::TransformField2DMediaController, and FREE::TransformField3DMediaController.

Definition at line 57 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

virtual GenericMediaPointer FREE::TransformFieldMediaControllerBase< TVector, VDimension >::ComputeActualizedMedia	(	GenericMediaType *	pGenericMedia,
		GenericMediaType *	pGenericTransformationField
	)			const [inline, virtual]

Definition at line 68 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

virtual GenericMediaPointer FREE::TransformFieldMediaControllerBase< TVector, VDimension >::ComputeActualizedMediaByFunction	(	GenericMediaType *	pGenericMedia,
		GenericMediaType *	pGenericTransformationFunction
	)			const [inline, virtual]

Definition at line 107 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

virtual bool FREE::TransformFieldMediaControllerBase< TVector, VDimension >::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< itk::Image< TVector, VDimension > >.

Definition at line 168 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

virtual bool FREE::TransformFieldMediaControllerBase< TVector, VDimension >::SaveMedia

(

SessionComponentCache *

pCache

)

const [inline, virtual]

This function saves the media passed within the cache as component. The saving behavior depends on the controller (e.g. point set controller will save the media as parameter in the component setup of the cache; image media controller will save the media to the path specified in the component setup).

Parameters:

[in]

pCache

Cache containg the media to be saved as component. Most controller also need a component setup referenced by the cache.

Returns:

Returns if the media was successfully saved.

Reimplemented from FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >.

Definition at line 217 of file freTransformFieldMediaController.h.

template<class TVector, unsigned int VDimension>

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

This function saves the media passed. The location is specified by the passed path.

Parameters:

[in]	sMediaPath	Path locating the destination of the save operation.
[in]	pMedia	Pointer to media.

Returns:

Returns if the media was successfully saved.

Implements FREE::StoreableMediaControllerInterface.

Definition at line 264 of file freTransformFieldMediaController.h.

---

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

• freTransformFieldMediaController.h

---