Purpose

The module MLImageFormatSave saves an image output of any ML module as a file including user defined information and ML image properties.

Dependent on the available compression modes the image can be is stored compressed or uncompressed.

See also general documentation about the MLImageFormat, MLDataCompressors, and its capabilities for the composition, modification, and caching of very large volumes (see Processing Large Volumes in MeVisLab) which do not fit into memory or exceed the 2GB limit.

Windows

Default Panel

../../../Modules/ML/MLImageFormat/mhelp/Images/Screenshots/MLImageFormatSave._default.png

Input Fields

input0

name: input0, type: Image

Parameter Fields

Field Index

boolHintVal6: Bool dblHintVisible7: Bool Is Saving: Bool
boolHintVal7: Bool dblHintVisible8: Bool progress: Float
boolHintVal8: Bool dblHintVisible9: Bool regionOffset: IntVector6
boolHintVal9: Bool File Name: String Remove: Trigger
boolHintVisible0: Bool hintName0: String Save: Trigger
boolHintVisible1: Bool hintName1: String Save Time: Double
boolHintVisible2: Bool hintName2: String Status: String
boolHintVisible3: Bool hintName3: String Stop: Trigger
boolHintVisible4: Bool hintName4: String strHintVal6: String
boolHintVisible5: Bool hintName5: String strHintVal7: String
boolHintVisible6: Bool hintName6: String strHintVal8: String
boolHintVisible7: Bool hintName7: String strHintVal9: String
boolHintVisible8: Bool hintName8: String strHintVisible0: Bool
boolHintVisible9: Bool hintName9: String strHintVisible1: Bool
Calc Time: Double intHintVal6: Integer strHintVisible2: Bool
Compression: Enum intHintVal7: Integer strHintVisible3: Bool
Create: Trigger intHintVal8: Integer strHintVisible4: Bool
dblHintVal6: Double intHintVal9: Integer strHintVisible5: Bool
dblHintVal7: Double intHintVisible0: Bool strHintVisible6: Bool
dblHintVal8: Double intHintVisible1: Bool strHintVisible7: Bool
dblHintVal9: Double intHintVisible2: Bool strHintVisible8: Bool
dblHintVisible0: Bool intHintVisible3: Bool strHintVisible9: Bool
dblHintVisible1: Bool intHintVisible4: Bool suppressWorldPos: Bool
dblHintVisible2: Bool intHintVisible5: Bool Total Time: Double
dblHintVisible3: Bool intHintVisible6: Bool True File Name: String
dblHintVisible4: Bool intHintVisible7: Bool updateHintControls: Trigger
dblHintVisible5: Bool intHintVisible8: Bool Written Tag List: String
dblHintVisible6: Bool intHintVisible9: Bool  

Visible Fields

Compression

name: compression, type: Enum, default: LZ4

Defines the compression algorithm used for data compression.

See MLDataCompressors for more information.

Values:

Title Name
None None
MLCTComp2 MLCTComp2
BZip2 BZip2
Lzf LZF
Lzma LZMA
Zlib ZLIB
Lz4 LZ4

True File Name

name: trueFileName, type: String, persistent: no, deprecated name: autoFileName

The actual file name on the current system.

Remove

name: remove, type: Trigger

If pressed, the specified file is being removed from disk.

Stop

name: stop, type: Trigger

If pressed, the current saving process is stopped and the file that is written so far being removed.

Is Saving

name: isSaving, type: Bool, persistent: no

Shows if the module is currently saving.

Status

name: status, type: String, persistent: no

Shows information about the module's state.

Written Tag List

name: tagList, type: String, persistent: no

Shows a list of tags in the file.

Save

name: save, type: Trigger

If pressed, the attached image is being saved to the specified file.

Create

name: create, type: Trigger

Creates the image on disk, but only saves the tags/properties and fills all pages with the default value, which is the voxel value at (0,0,0,0,0,0).

Save Time

name: saveTime, type: Double, persistent: no

Shows the file IO time needed for recent save opertion exclusive the preparation times for calculation, compression, reordering, etc.

Calc Time

name: calcTime, type: Double, persistent: no

Shows the calculation time needed for compression, reordering, checksums, etc., during the recent save operation, exclusive the data request from the image input.

Total Time

name: totalTime, type: Double, persistent: no

Shows the total save time including data processing from module input, data reordering and IO times.

File Name

name: fileName, type: String

Sets the path to the file in which the connected input image shall be stored.

Note that also variables can be used such as $(NETWORK), $(HOME), and $(DemoDataPath) to specify paths into the current network directory, the user's homedirecory and to the installed example data directory of MeVisLab.

They reference some special directories to simplify relocation of module networks to other installations.

Hidden Fields

updateHintControls

name: updateHintControls, type: Trigger

hintName0

name: hintName0, type: String, persistent: no

dblHintVisible0

name: dblHintVisible0, type: Bool, persistent: no

intHintVisible0

name: intHintVisible0, type: Bool, persistent: no

strHintVisible0

name: strHintVisible0, type: Bool, persistent: no

boolHintVisible0

name: boolHintVisible0, type: Bool, persistent: no

hintName1

name: hintName1, type: String, persistent: no

dblHintVisible1

name: dblHintVisible1, type: Bool, persistent: no

intHintVisible1

name: intHintVisible1, type: Bool, persistent: no

strHintVisible1

name: strHintVisible1, type: Bool, persistent: no

boolHintVisible1

name: boolHintVisible1, type: Bool, persistent: no

hintName2

name: hintName2, type: String, persistent: no

dblHintVisible2

name: dblHintVisible2, type: Bool, persistent: no

intHintVisible2

name: intHintVisible2, type: Bool, persistent: no

strHintVisible2

name: strHintVisible2, type: Bool, persistent: no

boolHintVisible2

name: boolHintVisible2, type: Bool, persistent: no

hintName3

name: hintName3, type: String, persistent: no

dblHintVisible3

name: dblHintVisible3, type: Bool, persistent: no

intHintVisible3

name: intHintVisible3, type: Bool, persistent: no

strHintVisible3

name: strHintVisible3, type: Bool, persistent: no

boolHintVisible3

name: boolHintVisible3, type: Bool, persistent: no

hintName4

name: hintName4, type: String, persistent: no

dblHintVisible4

name: dblHintVisible4, type: Bool, persistent: no

intHintVisible4

name: intHintVisible4, type: Bool, persistent: no

strHintVisible4

name: strHintVisible4, type: Bool, persistent: no

boolHintVisible4

name: boolHintVisible4, type: Bool, persistent: no

hintName5

name: hintName5, type: String, persistent: no

dblHintVisible5

name: dblHintVisible5, type: Bool, persistent: no

intHintVisible5

name: intHintVisible5, type: Bool, persistent: no

strHintVisible5

name: strHintVisible5, type: Bool, persistent: no

boolHintVisible5

name: boolHintVisible5, type: Bool, persistent: no

hintName6

name: hintName6, type: String, persistent: no

dblHintVal6

name: dblHintVal6, type: Double, default: 0

intHintVal6

name: intHintVal6, type: Integer, default: 0

strHintVal6

name: strHintVal6, type: String

boolHintVal6

name: boolHintVal6, type: Bool, default: FALSE

dblHintVisible6

name: dblHintVisible6, type: Bool, persistent: no

intHintVisible6

name: intHintVisible6, type: Bool, persistent: no

strHintVisible6

name: strHintVisible6, type: Bool, persistent: no

boolHintVisible6

name: boolHintVisible6, type: Bool, persistent: no

hintName7

name: hintName7, type: String, persistent: no

dblHintVal7

name: dblHintVal7, type: Double, default: 0

intHintVal7

name: intHintVal7, type: Integer, default: 0

strHintVal7

name: strHintVal7, type: String

boolHintVal7

name: boolHintVal7, type: Bool, default: FALSE

dblHintVisible7

name: dblHintVisible7, type: Bool, persistent: no

intHintVisible7

name: intHintVisible7, type: Bool, persistent: no

strHintVisible7

name: strHintVisible7, type: Bool, persistent: no

boolHintVisible7

name: boolHintVisible7, type: Bool, persistent: no

hintName8

name: hintName8, type: String, persistent: no

dblHintVal8

name: dblHintVal8, type: Double, default: 0

intHintVal8

name: intHintVal8, type: Integer, default: 0

strHintVal8

name: strHintVal8, type: String

boolHintVal8

name: boolHintVal8, type: Bool, default: FALSE

dblHintVisible8

name: dblHintVisible8, type: Bool, persistent: no

intHintVisible8

name: intHintVisible8, type: Bool, persistent: no

strHintVisible8

name: strHintVisible8, type: Bool, persistent: no

boolHintVisible8

name: boolHintVisible8, type: Bool, persistent: no

hintName9

name: hintName9, type: String, persistent: no

dblHintVal9

name: dblHintVal9, type: Double, default: 0

intHintVal9

name: intHintVal9, type: Integer, default: 0

strHintVal9

name: strHintVal9, type: String

boolHintVal9

name: boolHintVal9, type: Bool, default: FALSE

dblHintVisible9

name: dblHintVisible9, type: Bool, persistent: no

intHintVisible9

name: intHintVisible9, type: Bool, persistent: no

strHintVisible9

name: strHintVisible9, type: Bool, persistent: no

boolHintVisible9

name: boolHintVisible9, type: Bool, persistent: no

progress

name: progress, type: Float, persistent: no

regionOffset

name: regionOffset, type: IntVector6, default: 0 0 0 0 0 0

suppressWorldPos

name: suppressWorldPos, type: Bool, default: FALSE