XMarkerListToCSOList

MacroModule

author	MeVis Medical Solutions AG
package	MeVisLab/Standard
definition	XMarkerListToCSOList.def

Purpose

The module XMarkerListToCSOList converts XMarkers to CSOs.

Details

The module XMarkerListToCSOList converts XMarkers of the same type and with the same time point index (t-dimension of the marker’s 6D position) to a CSO.

The XMarkers are used in their order to create the CSOs’ seed points, and an Interpolation Mode can be chosen.

Those CSOs can be closed or left open, depending on the field Should Close.

For CSO creation, a number of parameters can be adjusted; an extra window with all the available creation parameters is opened by pressing the button Show Creation Parameters.

For creating the path points, the number of path points per millimeter can be set with the field Points per mm.

Windows

Default Panel

CSO Creation Parameters

Input Fields

inXMarkerList

name: inXMarkerList, type: XMarkerList(MLBase)

For accessing this object via scripting, see the Scripting Reference: MLXMarkerListWrapper.

Output Fields

outCSOList

name: outCSOList, type: CSOList(MLBase)

For accessing this object via scripting, see the Scripting Reference: MLCSOListWrapper.

Parameter Fields

Field Index

Add to group mode: Enum	Interpolation Mode: Enum	Style (defaultPathPointStyle): Enum
Alpha (defaultPathPointAlpha): Float	Label: String	Style (defaultSeedPointStyle): Enum
Alpha (defaultSeedPointAlpha): Float	Mode: Enum	Value: Float
Apply: Trigger	moduleCreatorString: String	Width: Float
Clear: Trigger	Points per mm: Float
Color (defaultPathPointColor): Color	Should Close: Bool
Color (defaultSeedPointColor): Color	Should Empty Group Before Generating: Bool
Id: Integer	Size: Float

Visible Fields

Interpolation Mode

name: interpolationMode, type: Enum, default: Linear

Defines the interpolation mode for generating path points.

Values:

Title	Name	Description
Linear	Linear	The path points are created by a linear interpolation.
Spline Interpolation	SplineInterpolation	The path points are created by a spline interpolation.
Spline Approximation	SplineApproximation	The path points are created by a spline approximation.

Should Close

name: shouldClose, type: Bool, default: FALSE

If checked, the resulting CSOs are closed, connecting the last and the first seed point.

Points per mm

name: pointsPerMM, type: Float, default: 1, minimum: 0.001, maximum: 100

Sets the number of path points created per millimeter.

Add to group mode

name: addCSOToGroupMode, type: Enum, default: GROUP_NONE

Values:

Title	Name
None	GROUP_NONE
By Label	GROUP_BY_LABEL
By Id	GROUP_BY_ID

Should Empty Group Before Generating

name: shouldEmptyGroupBeforeGenerating, type: Bool, default: FALSE

Label

name: addCSOToGroupLabel, type: String

Id

name: addCSOToGroupId, type: Integer, default: -1, minimum: -1

Style (defaultPathPointStyle)

name: defaultPathPointStyle, type: Enum, default: PATH_POINTS_STYLE_SOLID

Values:

Title	Name
None	PATH_POINTS_STYLE_NONE
Solid	PATH_POINTS_STYLE_SOLID
Dashed	PATH_POINTS_STYLE_DASHED
Dotted	PATH_POINTS_STYLE_DOTTED
Short Dashed	PATH_POINTS_STYLE_SHORT_DASHED

Width

name: defaultPathPointWidth, type: Float, default: 1, minimum: 1, maximum: 8

Color (defaultPathPointColor)

name: defaultPathPointColor, type: Color, default: 1 1 1

Alpha (defaultPathPointAlpha)

name: defaultPathPointAlpha, type: Float, default: 1, minimum: 0, maximum: 1

Style (defaultSeedPointStyle)

name: defaultSeedPointStyle, type: Enum, default: SEED_POINT_STYLE_RECTANGLE

Values:

Title	Name
None	SEED_POINT_STYLE_NONE
Rectangle	SEED_POINT_STYLE_RECTANGLE
Circle	SEED_POINT_STYLE_CIRCLE
Fixed Size Circle	SEED_POINT_STYLE_FIXED_SIZE_CIRCLE
Triangle	SEED_POINT_STYLE_TRIANGLE
Filled Rectangle	SEED_POINT_STYLE_FILLED_RECTANGLE
Filled Circle	SEED_POINT_STYLE_FILLED_CIRCLE
Filled Triangle	SEED_POINT_STYLE_FILLED_TRIANGLE
Dashed Rectangle	SEED_POINT_STYLE_DASHED_RECTANGLE

Size

name: defaultSeedPointSize, type: Float, default: 2, minimum: 1, maximum: 16

Color (defaultSeedPointColor)

name: defaultSeedPointColor, type: Color, default: 1 1 1

Alpha (defaultSeedPointAlpha)

name: defaultSeedPointAlpha, type: Float, default: 1, minimum: 0, maximum: 1

Mode

name: defaultVoxelWriteMode, type: Enum, default: VOXEL_WRITE_MODULE

Values:

Title	Name	Deprecated Name
Id	VOXEL_WRITE_ID	VOXEL_VALUE_ID
Const	VOXEL_WRITE_CONST	VOXEL_VALUE_CONST
Const Plus Id	VOXEL_WRITE_CONST_PLUS_ID	VOXEL_VALUE_CONST_PLUS_ID
Module	VOXEL_WRITE_MODULE	VOXEL_VALUE_MODULE

Value

name: defaultVoxelWriteValue, type: Float, default: 1024

Clear

name: clear, type: Trigger

Apply

name: apply, type: Trigger

Hidden Fields

moduleCreatorString

name: moduleCreatorString, type: String, default: XMarkerListToCSOList