MLImageFormatLoad¶

MLModule¶

genre	`MLImageFormat`
author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`MLImageFormat`
definition	MLImageFormat.def
see also	`MLImageFormatInfo`, `MLImageFormatSave`, `MLImageFormatFileCache`, `ImageSave`, `ImageLoad`, `LocalImage`, `BitImageLoad`, `BitImageSave`, `LocalPath`
keywords	`save`, `store`, `read`, `write`, `file`, `cache`, `storage`, `disc`, `disk`, `import`, `export`, `io`, `lzf`, `lzw`, `lzma`, `bzip2`, `compressor`, `compression`, `tag`

Purpose¶

The module MLImageFormatLoad loads MLImageFormat files specified by a file name and provides the stored image at the output connector.

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 2 GB limit.

See the documentation of the module MLImageFormatSave for many user interface parameters not described here.

Windows¶

Default Panel¶

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

Parameter Fields¶

Field Index¶

`Apply Mode`: `Enum`	`dblHintVisible7`: `Bool`	`isSaving`: `Bool`
`boolHintVal6`: `Bool`	`dblHintVisible8`: `Bool`	`Open`: `Trigger`
`boolHintVal7`: `Bool`	`dblHintVisible9`: `Bool`	`progress`: `Float`
`boolHintVal8`: `Bool`	`File Name`: `String`	`regionOffset`: `IntVector6`
`boolHintVal9`: `Bool`	`hintName0`: `String`	`remove`: `Trigger`
`boolHintVisible0`: `Bool`	`hintName1`: `String`	`Status`: `String`
`boolHintVisible1`: `Bool`	`hintName2`: `String`	`stop`: `Trigger`
`boolHintVisible2`: `Bool`	`hintName3`: `String`	`strHintVal6`: `String`
`boolHintVisible3`: `Bool`	`hintName4`: `String`	`strHintVal7`: `String`
`boolHintVisible4`: `Bool`	`hintName5`: `String`	`strHintVal8`: `String`
`boolHintVisible5`: `Bool`	`hintName6`: `String`	`strHintVal9`: `String`
`boolHintVisible6`: `Bool`	`hintName7`: `String`	`strHintVisible0`: `Bool`
`boolHintVisible7`: `Bool`	`hintName8`: `String`	`strHintVisible1`: `Bool`
`boolHintVisible8`: `Bool`	`hintName9`: `String`	`strHintVisible2`: `Bool`
`boolHintVisible9`: `Bool`	`intHintVal6`: `Integer`	`strHintVisible3`: `Bool`
`Close File`: `Trigger`	`intHintVal7`: `Integer`	`strHintVisible4`: `Bool`
`Compression`: `Enum`	`intHintVal8`: `Integer`	`strHintVisible5`: `Bool`
`dblHintVal6`: `Double`	`intHintVal9`: `Integer`	`strHintVisible6`: `Bool`
`dblHintVal7`: `Double`	`intHintVisible0`: `Bool`	`strHintVisible7`: `Bool`
`dblHintVal8`: `Double`	`intHintVisible1`: `Bool`	`strHintVisible8`: `Bool`
`dblHintVal9`: `Double`	`intHintVisible2`: `Bool`	`strHintVisible9`: `Bool`
`dblHintVisible0`: `Bool`	`intHintVisible3`: `Bool`	`Suppress Check Sum Tests`: `Bool`
`dblHintVisible1`: `Bool`	`intHintVisible4`: `Bool`	`suppressWorldPos`: `Bool`
`dblHintVisible2`: `Bool`	`intHintVisible5`: `Bool`	`Tag List`: `String`
`dblHintVisible3`: `Bool`	`intHintVisible6`: `Bool`	`True File Name`: `String`
`dblHintVisible4`: `Bool`	`intHintVisible7`: `Bool`	`updateHintControls`: `Trigger`
`dblHintVisible5`: `Bool`	`intHintVisible8`: `Bool`
`dblHintVisible6`: `Bool`	`intHintVisible9`: `Bool`

Visible Fields¶

Compression¶

name: compression, type: Enum, persistent: no¶: Shows the used compression algorithm.

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¶: Shows the true and absolute file name of the file on the current system.

Status¶

name: status, type: String, persistent: no¶: Shows state information about the module.

Apply Mode¶

name: applyMode, type: Enum, default: AutoUpdate, deprecated name: updateMode¶: Defines the apply mode.

Values:

Title	Name	Description
Off	Off	Nothing happens if any field is changed.
Auto Update	AutoUpdate	If any field is changed, the module loads the specified image anew.
Auto Clear	AutoClear	If any field changes, the image output is being invalidated.

Open¶

name: open, type: Trigger¶: When pressed, the specified file is being loaded.

Close File¶

name: close, type: Trigger¶: When pressed, the loaded file is being closed and the output being invalidated.

Suppress Check Sum Tests¶

name: suppressCheckSumTests, type: Bool, default: TRUE¶

If checked, time-consuming checksum calculations and -tests are disabled while reading page data from a file.

In most applications, the time needed for these checksum-tests is not relevant in comparison with IO times and other calculations on the data. Nevertheless, this can be useful to gain maximum load performance in a few applications when reading image data from SSDs or ram disks. However, corrupted files will probably not be detected anymore. Therefore, this mode is not recommended.

File Name¶

name: fileName, type: String¶

Sets the name of the file to be loaded.

This name can contain variables. See the documentation of MLImageFormatSave for more information.

Hidden Fields¶

updateHintControls¶

name: updateHintControls, type: Trigger, persistent: no¶

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, persistent: no¶

intHintVal6¶

name: intHintVal6, type: Integer, persistent: no¶

strHintVal6¶

name: strHintVal6, type: String, persistent: no¶

boolHintVal6¶

name: boolHintVal6, type: Bool, persistent: no¶

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, persistent: no¶

intHintVal7¶

name: intHintVal7, type: Integer, persistent: no¶

strHintVal7¶

name: strHintVal7, type: String, persistent: no¶

boolHintVal7¶

name: boolHintVal7, type: Bool, persistent: no¶

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, persistent: no¶

intHintVal8¶

name: intHintVal8, type: Integer, persistent: no¶

strHintVal8¶

name: strHintVal8, type: String, persistent: no¶

boolHintVal8¶

name: boolHintVal8, type: Bool, persistent: no¶

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, persistent: no¶

intHintVal9¶

name: intHintVal9, type: Integer, persistent: no¶

strHintVal9¶

name: strHintVal9, type: String, persistent: no¶

boolHintVal9¶

name: boolHintVal9, type: Bool, persistent: no¶

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¶

remove¶

name: remove, type: Trigger¶

stop¶

name: stop, type: Trigger¶

isSaving¶

name: isSaving, type: Bool, persistent: no¶

regionOffset¶

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

suppressWorldPos¶

name: suppressWorldPos, type: Bool, default: FALSE¶