BitImageLoad

MLModule

genre	BitImageIO
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLBitImageTools
definition	MLBitImageTools.def
see also	BitImageSave, BitImageToML, MLToBitImage, BitImageArithmetic, ImageLoad, ImageSave, LocalImage, LocalPath, MLImageFormatLoad, MLImageFormatSave, MLImageFormatFileCache
keywords	save, io, binary, bitplane, store, read, write, file, cache, storage, disc, disk, import, export

Purpose

The module BitImageLoad loads a ml.BitImage from a file and provides it as an ML image and an Base connector output.

Usage

Select the ml.BitImage file to be loaded and press Load. The Background Value and the Foreground Value specify the values in the ML image to be used instead of false and true values.

Windows

Default Panel

Output Fields

The module has two outputs, an ML output image containing background values for false and foreground values for true BitImage voxels as well as a Base connector which directly passes the BitImage as data structure.

output0

name: output0, type: Image

ML image representing the BitImage. Instead of true and false, the Foreground Value and Background Value is set.

outBitImage

name: outBitImage, type: BitImage(MLBase)

Base structure containing the BitImage.

Parameter Fields

Field Index

Background Value: Double

Clear: Trigger

File Name: String

Foreground Value: Double

Load: Trigger

Out Type: Enum

Status: String

Use Source Image Extent: Bool

Visible Fields

File Name

name: fileName, type: String

Sets path and name of the BitImage to be loaded.

Load

name: load, type: Trigger

If pressed, the bit image specified in File Name is loaded.

Clear

name: clear, type: Trigger

If pressed, the currently loaded BitImage is cleared.

Out Type

name: outType, type: Enum, default: unsigned int8

Defines the data type of the output image.

Values:

Title	Name
int8	int8
unsigned int8	unsigned int8
int16	int16
unsigned int16	unsigned int16
int32	int32
unsigned int32	unsigned int32
float	float
double	double
int64	int64
unsigned int64	unsigned int64

Background Value

name: backgroundValue, type: Double, default: 0

Sets the value in output image used for false BitImage voxels.

Foreground Value

name: foregroundValue, type: Double, default: 255

Sets the value in output image used for true BitImage voxels.

Use Source Image Extent

name: useSourceImageExtent, type: Bool, default: FALSE

If enabled then the extent of the sourceImageBox member of the loaded BitImage is interpreted in a special way: v1 is taken as origin of the valid BitImage area relative to the origin (0,0,0,0,0,0) and v2 is taken as the image extent (if a valid stored box is found); otherwise only the actual BitImage extent is taken.

Status

name: status, type: String, persistent: no

Shows the status of the module.