Defines the class InputSubImageProperties which is a simple container for some properties which can be defined for an input subimage which is to be delivered to the corresponding call of the module's calculateOutputSubImage method. More...

#include <mlInputSubImageProperties.h>

Public Member Functions
	InputSubImageProperties ()
	Constructor initializing all members.

Public Attributes
MLDataType	dataType
	Data type for the subimage. It must not be changed if useInputTileCache is true.

bool	dataTypeWasSet
	A flag if the datatype was set by the user.

bool	useInputTileCache
	Data type for the subimage.

bool	readOnlyInputTile
	If this flag is set, the input tiles (SubImgs) that are passed to Module::calculateOutputSubImage are read-only and may not be written to in Module::calculateOutputSubImage, the default is false, so that a module may write to the input tiles.

ScaleShiftData	scaleShift
	Describes scaling of the input data buffers; default is the identity, that is _shift=0 and _scale = 1.

Detailed Description

Defines the class InputSubImageProperties which is a simple container for some properties which can be defined for an input subimage which is to be delivered to the corresponding call of the module's calculateOutputSubImage method.

The members are public since it is only a data container and no functionality is implemented on them.

Definition at line 33 of file mlInputSubImageProperties.h.

Constructor & Destructor Documentation

◆ InputSubImageProperties()

ml::InputSubImageProperties::InputSubImageProperties ( )

inline

Constructor initializing all members.

Definition at line 39 of file mlInputSubImageProperties.h.

Member Data Documentation

◆ dataType

MLDataType ml::InputSubImageProperties::dataType

Data type for the subimage. It must not be changed if useInputTileCache is true.

Definition at line 49 of file mlInputSubImageProperties.h.

◆ dataTypeWasSet

bool ml::InputSubImageProperties::dataTypeWasSet

A flag if the datatype was set by the user.

Definition at line 52 of file mlInputSubImageProperties.h.

◆ readOnlyInputTile

bool ml::InputSubImageProperties::readOnlyInputTile

If this flag is set, the input tiles (SubImgs) that are passed to Module::calculateOutputSubImage are read-only and may not be written to in Module::calculateOutputSubImage, the default is false, so that a module may write to the input tiles.

This flag can be used by the ml::Host to directly pass ML pages to Module::calculateOutputSubImage if the size/datatype of the input tile matches the size/type of a page.

Definition at line 64 of file mlInputSubImageProperties.h.

◆ scaleShift

ScaleShiftData ml::InputSubImageProperties::scaleShift

Describes scaling of the input data buffers; default is the identity, that is _shift=0 and _scale = 1.

It must not be set to non default values if useInputTileCache is also true.

Definition at line 69 of file mlInputSubImageProperties.h.

◆ useInputTileCache

bool ml::InputSubImageProperties::useInputTileCache

Data type for the subimage.

useInputTileCache=true does not work together with non default scaleShift settings or inSubImgDType which differs from the type of the corresponding input subimage.

Definition at line 57 of file mlInputSubImageProperties.h.

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

MeVis/Foundation/Sources/ML/include/mlInputSubImageProperties.h

Public Member Functions

Public Attributes