ml::MLImageFormatLoad Class Reference

ML module class to load an ML PagedImage from a file of type MLImageFormat with .mlimage suffix. More...

#include <mlImageFormatLoad.h>

Inheritance diagram for ml::MLImageFormatLoad:

List of all members.

Public Types
enum	ApplyModes { Off = 0, AutoApply, AutoClear, NumApplyModes }
	Modes how module reacts on parameter changes. More...
Public Member Functions
	MLImageFormatLoad ()
	Constructor.
virtual	~MLImageFormatLoad ()
	Destructor, closes file if still not done.
Protected Member Functions
Helper functions.
virtual void	_open ()
	Create loader instance, opens file and provide it at module output.
virtual void	_close ()
	Closes file and deletes loader instance.
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	calculateOutputImageProperties (int outIndex)
	Sets properties of the output image at output outIndex.
virtual void	calculateOutputSubImage (SubImage *outSubImg, int outIndex, SubImage *inSubImgs)
	Calculates page outSubImg of output image with index outIndex by using inSubimgs.

---

Detailed Description

ML module class to load an ML PagedImage from a file of type MLImageFormat with .mlimage suffix.

Definition at line 47 of file mlImageFormatLoad.h.

---

Member Enumeration Documentation

enum ml::MLImageFormatLoad::ApplyModes

Modes how module reacts on parameter changes.

Enumerator:

Off	Leave loaded image as it it even on change.
AutoApply	Updates loaded image on all parameter changes.
AutoClear	Invalidates loaded image on each change.
NumApplyModes	Number of modes, not to be used as mode.

Definition at line 52 of file mlImageFormatLoad.h.

---

Constructor & Destructor Documentation

ml::MLImageFormatLoad::MLImageFormatLoad

(

)

Constructor.

virtual ml::MLImageFormatLoad::~MLImageFormatLoad

(

)

[virtual]

Destructor, closes file if still not done.

---

Member Function Documentation

virtual void ml::MLImageFormatLoad::_close

(

)

[protected, virtual]

Closes file and deletes loader instance.

virtual void ml::MLImageFormatLoad::_open

(

)

[protected, virtual]

Create loader instance, opens file and provide it at module output.

virtual void ml::MLImageFormatLoad::activateAttachments

(

)

[protected, virtual]

Update internal module state after load or clone.

Reimplemented from ml::MLImageFormatIOBase.

virtual void ml::MLImageFormatLoad::calculateOutputImageProperties

(

int

outIndex

)

[protected, virtual]

Sets properties of the output image at output outIndex.

Reimplemented from ml::Module.

virtual void ml::MLImageFormatLoad::calculateOutputSubImage	(	SubImage *	outSubImg,
		int	outIndex,
		SubImage *	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 calculateInputSubImageBox. Array size is given by getNumInputImages().

Reimplemented from ml::Module.

virtual void ml::MLImageFormatLoad::handleNotification

(

Field *

field

)

[protected, virtual]

Handle field changes of the field field.

Reimplemented from ml::MLImageFormatIOBase.

---

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

• MeVisLab/Standard/Sources/ML/MLImageFormat/mlImageFormatLoad.h