ClusterToMarkers

MLModule
genre Marker
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLClusterToMarkers
definition ClusterToMarkers.def
see also MaskToMarkers
keywords bounding, box, center, gravity

Purpose

The module ClusterToMarkers generates a marker for each cluster in an ML image.

A cluster is defined as the set of voxels with the same integer value. The input image needs to be of integer type. The cluster voxels do not need to form a connected component.

Windows

Default Panel

../../../Modules/ML/MLClusterToMarkers/mhelp/Images/Screenshots/ClusterToMarkers._default.png

Input Fields

input0

name: input0, type: Image

Output Fields

outMarkers

name: outMarkers, type: XMarkerList(MLBase)
For accessing this object via scripting see the Scripting Reference: MLXMarkerListWrapper.

Parameter Fields

Field Index

Background Value: Integer
Coordinate System Mode: Enum
Marker Mode: Enum
progress: Double
Update: Trigger
Update Mode: Enum

Visible Fields

Background Value

name: backgroundValue, type: Integer, default: 0

Sets a background value; voxels with this value are not considered to belong to any cluster and no marker is generated for voxels with this value.

Marker Mode

name: markerMode, type: Enum, default: Center

Defines the output marker mode.

The type of the marker is always set to the number of voxels in a cluster.

Values:

Title Name Description
Center Center For each cluster, a marker is generated in the center of gravity of all cluster voxels.
Bounding Box BoundingBox For each cluster, the marker’s pos is set to the min bounding box corner and the vec of the marker points to the max bounding box corner.

Coordinate System Mode

name: coordinateSystemMode, type: Enum, default: World

Defines the coordinate system mode.

Values:

Title Name Description
World World All positions and vectors (for bounding boxes) are in world space of the input image.
Voxel Voxel All positions and vectors (for bounding boxes) are in voxel space of the input image.

Update Mode

name: updateMode, type: Enum, default: Off

Defines the update mode.

Values:

Title Name Description
Off Off No update on any change.
Clear Clear The output marker list is cleared on any input/parameter change.
Update Update The output marker list is filled anew on any input/parameter change.

Update

name: update, type: Trigger

If pressed, the output marker list is filled anew.

Hidden Fields

progress

name: progress, type: Double, persistent: no