MarkerToMask¶

MLModule¶

genre	`Marker`
authors	`Susanne Bock`, `Ola Friman`
package	`FMEstable/ReleaseMeVis`
dll	`MLXMarkerUtilsStable`
definition	MLXMarkerUtilsStable.def
see also	`MaskToMarkers`
keywords	`xmarker`, `mask`, `xmarkerlist`, `marker`, `binary`, `image`

Purpose¶

The module MarkerToMask creates a binary (mask) image from an XMarkerList.

Usage¶

Connect an XMarkerList that shall be converted into a mask image, and an image that serves as a template for setting the image and page extents (the content of input0 is disregarded and not even requested).

Each marker that lies within the valid image region will be rounded to the nearest voxel and lead to a voxel set in the output.

Windows¶

Default Panel¶

../../../Modules/ML/MLXMarkerUtilsStable/mhelp/Images/Screenshots/MarkerToMask._default.png

Input Fields¶

input0¶

name: input0, type: Image¶: template image for image & page extent

inputXMarkerList¶

name: inputXMarkerList, type: MLBase¶: markers that shall be displayed in the output mask image

Output Fields¶

output0¶

name: output0, type: Image¶

Parameter Fields¶

Field Index¶

Auto Update: Bool

Background Value: Integer

Mask Value: Integer

Output Data Type: Enum

Start Value: Integer

Update: Trigger

Write Mode: Enum

Visible Fields¶

Mask Value¶

name: maskValue, type: Integer, default: 1, deprecated name: writeValue¶: Sets the foreground value of the mask image.

Start Value¶

name: incrementalStartValue, type: Integer, default: 1¶: Start value used if Write Mode is Incremental (indices start at zero, which is also the default background value).

Background Value¶

name: backgroundValue, type: Integer, default: 0, deprecated name: fillValue¶: Sets the background value of the mask image.

Update¶

name: update, type: Trigger¶: If pressed, the module computes its mask output image anew.

Auto Update¶

name: autoUpdate, type: Bool, default: TRUE¶: If checked, the module computes anew if an input is changed or touched.

Write Mode¶

name: writeMode, type: Enum, default: MaskValue¶: Defines what’s written into the output image at the marker positions.

Values:

Title	Name	Description
Mask Value	MaskValue	The `Mask Value` is written to the output image at positions of markers.
Marker Type	MarkerType	The type attribute of the markers is written into the output image.
Incremental	Incremental	The marker index, incremented by `Start Value`, is written to the output image.

Output Data Type¶

name: outputType, type: Enum, default: int16¶: Defines the data type of the output image.