BitImageSave

MLModule

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

Purpose

The module BitImageSave stores a connected ml.BitImage object in a file or it converts an ML image with an interval to a BitImage, which then is saved alternatively.

Usage

Select the input from which you want to save the BitImage by activating Save BitImage From Base Connector, then press Save. If you create a BitImage from the connected ML image, specify the value interval beforehand to define which values are set to true and which ones to false.

Windows

Default Panel

Input Fields

The module has two input connectors, an ML image and a Base connector, which accepts BitImage Base objects. The flag Save BitImage From Base Connector controls which one is saved. The other input is ignored.

input0

name: input0, type: Image

Input ML image.

inputBitImage

name: inputBitImage, type: BitImage(MLBase)

Input BitImage.

Parameter Fields

Field Index

File Name: String	Status: String
Int Max: Double
Int Min: Double
Reduce To Minimum Extent: Bool
Save: Trigger
Save BitImage From Base Connector: Bool
Src Box Mode: Enum
Src Box Origin: IntVector6

Visible Fields

File Name

name: fileName, type: String

Sets the path and name of BitImage to be saved.

Status

name: status, type: String, persistent: no

Shows status information.

Int Min

name: intMin, type: Double, default: 1

Sets the minimum (incl.) limit of the interval that defines true bit image values.

Int Max

name: intMax, type: Double, default: 256

Sets the maximum (excl.) limit of the interval that defines true bit image values.

Src Box Mode

name: srcBoxMode, type: Enum, default: Auto

Defines how the source box is to be set in the stored BitImage.

Values:

Title	Name	Description
​Auto	​Auto	​Uses the source box of the connected input BitImage or the extent of the used ML image as box.
​Empty	​Empty	​Always sets an empty source box.
​User	​User	​Set source box given by Src Box Origin and extent of the created or the input BitImage.

Src Box Origin

name: srcBoxOrigin, type: IntVector6, default: 0 0 0 0 0 0

Sets the origin of the source box of the stored BitImage if the Src Box Mode User is used.

Save

name: save, type: Trigger

When pressed, the bit image is saved.

Save BitImage From Base Connector

name: saveBaseInput, type: Bool, default: FALSE

If checked, the BitImage from the Base connector is saved.

Otherwise, the module converts and saves the connected ML image.

Reduce To Minimum Extent

name: reduceToMinimumExtent, type: Bool, default: FALSE

If checked, only the region with the mask is saved and the source image extent is stored in srcImageBox member.