Purpose

Generates an XMarkerList based on a CSOList.

Usage

Attach a CSOList to the module’s inputs, adjust the parameters and press Apply.

Details

The seed points, path points, starting point, end point, or center point and plane normal of each CSO are converted to XMarkers. The position in world coordinates is written to the markers x-, y- and z-values. The time point is written to the t-value, the value of a CSO’s path point is written to the marker’s c-value. To distinguish the markers of different CSOs from each other the CSO’s id is written the the markers type when Marker Type Mode is set to CSOId.

Windows

Default Panel

../../../Projects/CSOConvertToXMarkerList/Modules/mhelp/Images/Screenshots/CSOConvertToXMarkerList._default.png

Input Fields

inImage

name: inImage, type: Image

The image on which the markers should be generated. The image is only necessary if Coord Mode is set to VOXEL.

inCSOList

name: inCSOList, type: MLBase

The list of CSOs to be converted.

Output Fields

outputXMarkerList

name: outputXMarkerList, type: MLBase

The generated marker list.

Parameter Fields

Field Index

Auto apply: Bool Mode: Enum
Clear: Trigger Repaint: Bool
Conversion Mode: Enum Update: Trigger
Coord Mode: Enum  
done: Trigger  
Finishing: Bool  
isProcessing: Bool  
Marker Type Mode: Enum  

Visible Fields

Mode

name: updateMode, type: Enum, default: AutoClear

Determines how the module should react on input image changes and CSOList notifications. Values are Off and Auto Update. Default is Off.

Values:

Title Name Description
Off Off The module does not change its state even if inImage changes.
Auto Update AutoUpdate The module updates change its state if the inImage changes.
Auto Clear AutoClear The module resets its output on any change of the input image.

Auto apply

name: autoApply, type: Bool, default: FALSE

If checked, all changes of fields on the module’s GUI lead to a new computation of the output. Default is off.

Update

name: apply, type: Trigger

If pressed, the module computes its output anew.

Conversion Mode

name: conversionMode, type: Enum, default: PathPoints

Defines which properties of the csos should be converted. Default is PathPoints.

Values:

Title Name Description
Seed Points SeedPoints Converts seed points of the CSOs to markers.
Path Points PathPoints Converts path points of the CSOs to markers.
Start Points StartPoints Converts start points of the CSOs to markers.
End Points EndPoints Converts end points of the CSOs to markers.
Start And End Points StartAndEndPoints Converts start and end points of the CSOs to markers.
Center Points And Normal Vectors CenterPointsAndNormalVectors Converts the bounding box centers of the CSOs to markers and adds the plane normals of the csos as vectors to the markers (only if the cso can be considered planar, otherwise a 0-vector is used instead).
Start Point And Vector To End Point StartPointAndVectorToEndPoint Convert the start points + the vectors from start to end points to XMarkers.

Coord Mode

name: coordMode, type: Enum, default: World

Indicates if the positions of the markers should be given in voxel or world coordinates; if no input image is available then always world coordinates are used.

Marker Type Mode

name: inMarkerTypeMode, type: Enum, default: CSOId

Select how the marker types will be determined

Values:

Title Name Description
CSO ID CSOId Every marker gets the ID of the source CSO as type.
Position in contour PositionInContour The marker type depends on the relative position of the point in the source CSO. The first point is assigned type 1 (start), the last point is assigned type 3 (end) (only if it differs from the first one), all remaining points are assigned type 2 (inner point) (only if they differ from first and last one).
CSOGroup Id CSOGroupId Converts the unique id of the first CSO group to the XMarker.markerType if there is at least one group, otherwise -1 is used instead.

Repaint

name: listenInteractionNotifications, type: Bool, default: FALSE

If checked, and the module’s update mode is set to Auto Update, each repaint notification of the CSOList leads to a new computation of the output.

Finishing

name: listenInteractionFinished, type: Bool, default: TRUE

If checked, and the module’s update mode is set to Auto Update, each finishing notification of the CSOList leads to a new computation of the output.

Clear

name: clear, type: Trigger

If pressed the output marker list is deleted.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, persistent: no

Set to true during the calculation of the output.

done

name: done, type: Trigger, persistent: no

Triggered after the output has been calculated.