ml::MLImageFormatFileCache Class Reference

A file cache for a whole volume which is changed only if load, clear or auto load is activated. More...

#include <mlImageFormatFileCache.h>

Inheritance diagram for ml::MLImageFormatFileCache:

List of all members.

Public Types

enum UPDATE_MODE { UPDATE_OFF = 0, UPDATE_AUTOUPDATE, UPDATE_AUTOCLEAR, UPDATE_MODE_NUM }

Enum to controls how input and parameter changes influence/update the result image. More...

Public Member Functions

MLImageFormatFileCache ()

Constructor.

virtual ~MLImageFormatFileCache ()

Destructor.

Provide access to module parameters, see documentation of corresponding members.

BoolField & getValidFld () const

NotifyField & getLoadFld () const

NotifyField & getUpdateRegionFld () const

NotifyField & getClearFld () const

EnumField & getAutoLoadFld () const

StringField & getTmpFileNamePrefixFld () const

Static Public Attributes

static const char *const UPDATE_MODE_NAMES [UPDATE_MODE_NUM]

String constants corresponding to the UPDATE_MODE constants.

Protected Member Functions

Field and parameter handling

virtual void activateAttachments ()

Update internal module state after load or clone.

virtual void handleNotification (Field *field)

Handle field changes of the field field.

Image processing methods.

virtual void calcOutImageProps (int outIndex)

Sets properties of the output image at output outIndex.

virtual BaseOp::INPUT_HANDLE handleInput (int, BaseOp::INPUT_STATE) const

Enables usage of open or closed & undefined inputs by redirecting all accesses to open and undefined inputs to the dummy module.

virtual SubImgBox calcInSubImageBox (int, const SubImgBox &outSubImgBox, int)

Determines the data to be loaded from input image for page processing.

virtual void calcOutSubImage (SubImg *outSubImg, int outIndex, SubImg *inSubImgs)

Calculates page outSubImg of output image with index outIndex by using inSubimgs.

template<typename DATATYPE >

void calcOutSubImage (TSubImg< DATATYPE > *outSubImg, int, TSubImg< DATATYPE > *)

Method template for type-specific page calculation.

Detailed Description

A file cache for a whole volume which is changed only if load, clear or auto load is activated.

Input changes can be hidden so that the volume can survive even if input changes.

Definition at line 41 of file mlImageFormatFileCache.h.

Member Enumeration Documentation

enum ml::MLImageFormatFileCache::UPDATE_MODE

Enum to controls how input and parameter changes influence/update the result image.

Enumerator:

UPDATE_OFF	Do nothing on input changes.
UPDATE_AUTOUPDATE	Update cached image and output (if possible) if input changes.
UPDATE_AUTOCLEAR	Invalidate cached image if input changes.
UPDATE_MODE_NUM

Definition at line 46 of file mlImageFormatFileCache.h.

Constructor & Destructor Documentation

ml::MLImageFormatFileCache::MLImageFormatFileCache ( )

Constructor.

virtual ml::MLImageFormatFileCache::~MLImageFormatFileCache ( ) [virtual]

Destructor.

Member Function Documentation

virtual void ml::MLImageFormatFileCache::activateAttachments ( ) [protected, virtual]

Update internal module state after load or clone.

Reimplemented from ml::MLImageFormatIOBase.

virtual SubImgBox ml::MLImageFormatFileCache::calcInSubImageBox	(	int	,
		const SubImgBox &	outSubImgBox,
		int
	)			`[protected, virtual]`

Determines the data to be loaded from input image for page processing.

virtual void ml::MLImageFormatFileCache::calcOutImageProps ( int outIndex ) [protected, virtual]

Sets properties of the output image at output outIndex.

template<typename DATATYPE >

void ml::MLImageFormatFileCache::calcOutSubImage	(	TSubImg< DATATYPE > *	outSubImg,
		int	,
		TSubImg< DATATYPE > *
	)			`[inline, protected]`

Method template for type-specific page calculation.

Called by calcOutSubImage().

Parameters:

outSubImg The typed subimage of output image outIndex loaded form file. Parameter outIndex is the index of the output the subimage is calculated for and is not used here.

virtual void ml::MLImageFormatFileCache::calcOutSubImage	(	SubImg *	outSubImg,
		int	outIndex,
		SubImg *	inSubImgs
	)			`[protected, virtual]`

Calculates page outSubImg of output image with index outIndex by using inSubimgs.

Parameters:

	outSubImg	The subimage of output image `outIndex` calculated from `inSubImgs`.
	outIndex	The index of the output the subimage is calculated for.
	inSubImgs	Array of subimage(s) of the input(s) whose extents were specified by `calcInSubImageBox`. Array size is given by `getInputNum()`.

EnumField& ml::MLImageFormatFileCache::getAutoLoadFld ( ) const [inline]

Definition at line 68 of file mlImageFormatFileCache.h.

NotifyField& ml::MLImageFormatFileCache::getClearFld ( ) const [inline]

Definition at line 67 of file mlImageFormatFileCache.h.

NotifyField& ml::MLImageFormatFileCache::getLoadFld ( ) const [inline]

Definition at line 65 of file mlImageFormatFileCache.h.

StringField& ml::MLImageFormatFileCache::getTmpFileNamePrefixFld ( ) const [inline]

Definition at line 69 of file mlImageFormatFileCache.h.

NotifyField& ml::MLImageFormatFileCache::getUpdateRegionFld ( ) const [inline]

Definition at line 66 of file mlImageFormatFileCache.h.

BoolField& ml::MLImageFormatFileCache::getValidFld ( ) const [inline]

Definition at line 64 of file mlImageFormatFileCache.h.

virtual BaseOp::INPUT_HANDLE ml::MLImageFormatFileCache::handleInput	(	int	,
		BaseOp::INPUT_STATE
	)			const `[protected, virtual]`

Enables usage of open or closed & undefined inputs by redirecting all accesses to open and undefined inputs to the dummy module.

Test for equality to DummyOp::getGlobalInstance() or its output image to check for invalid inputs.

Reimplemented from ml::Module.

virtual void ml::MLImageFormatFileCache::handleNotification ( Field * field ) [protected, virtual]

Handle field changes of the field field.

Reimplemented from ml::MLImageFormatIOBase.

Member Data Documentation

const char* const ml::MLImageFormatFileCache::UPDATE_MODE_NAMES[UPDATE_MODE_NUM] [static]

String constants corresponding to the UPDATE_MODE constants.

Definition at line 54 of file mlImageFormatFileCache.h.

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

MeVisLab/Standard/Sources/ML/MLImageFormat/mlImageFormatFileCache.h


Public Types
enum	UPDATE_MODE { UPDATE_OFF = 0, UPDATE_AUTOUPDATE, UPDATE_AUTOCLEAR, UPDATE_MODE_NUM }
	Enum to controls how input and parameter changes influence/update the result image. More...
Public Member Functions
	MLImageFormatFileCache ()
	Constructor.
virtual	~MLImageFormatFileCache ()
	Destructor.
Provide access to module parameters, see documentation of corresponding members.
BoolField &	getValidFld () const
NotifyField &	getLoadFld () const
NotifyField &	getUpdateRegionFld () const
NotifyField &	getClearFld () const
EnumField &	getAutoLoadFld () const
StringField &	getTmpFileNamePrefixFld () const
Static Public Attributes
static const char *const	UPDATE_MODE_NAMES [UPDATE_MODE_NUM]
	String constants corresponding to the `UPDATE_MODE` constants.
Protected Member Functions
Field and parameter handling
virtual void	activateAttachments ()
	Update internal module state after load or clone.
virtual void	handleNotification (Field *field)
	Handle field changes of the field `field`.
Image processing methods.
virtual void	calcOutImageProps (int outIndex)
	Sets properties of the output image at output `outIndex`.
virtual BaseOp::INPUT_HANDLE	handleInput (int, BaseOp::INPUT_STATE) const
	Enables usage of open or closed & undefined inputs by redirecting all accesses to open and undefined inputs to the dummy module.
virtual SubImgBox	calcInSubImageBox (int, const SubImgBox &outSubImgBox, int)
	Determines the data to be loaded from input image for page processing.
virtual void	calcOutSubImage (SubImg outSubImg, int outIndex, SubImg inSubImgs)
	Calculates page `outSubImg` of output image with index `outIndex` by using `inSubimgs`.
template<typename DATATYPE >
void	calcOutSubImage (TSubImg< DATATYPE > outSubImg, int, TSubImg< DATATYPE > )
	Method template for type-specific page calculation.