CSOMarkerGenerator

MLModule

genre	CSOModule
author	Frank Heckel
package	FMEwork/ReleaseMeVis
dll	MLCSOMiscModules
definition	MLCSOMiscModules.def
see also	CSOManager, CSOIsoGenerator
keywords	CSO, contour, segmentation, XMarker, generation

Purpose

The CSOMarkerGenerator allows a generation of CSOs from an XMarkerList.

Usage

Attach a CSOList that is to be filled (attach a CSOManager to it) with the CSOs, an image and an XMarkerList to this module.

Details

This module generates one CSO for each type value and each timepoint of any XMarker in the XMarkerList. The markers are added to the CSO in order of their position in the XMarkerList.

Windows

Default Panel

Input Fields

inImage

name: inImage, type: Image

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

inXMarkerList

name: inXMarkerList, type: MLBase

The XMarkerList that should be used for generation of the CSOs.

inCSOList

name: inCSOList, type: MLBase

The CSOList where the generated CSOs should be stored (typically this is the output of a CSOManager).

Parameter Fields

Field Index

Add CSOTo Group With Label: String	Generation Mode: Enum	seedPointSize: Float
addCSOToGroupMode: Enum	Id: Integer	seedPointStyle: Enum
addCSOToGroupWithId: Integer	isProcessing: Bool	Should close CSO: Bool
Apply: Trigger	Overwrite Type: Bool	Smoothing Amount: Integer
Auto Apply: Bool	pathPointStyle: Enum	Smoothing Mode: Enum
Coord Mode: Enum	pathPointWidth: Float	Sub Type: String
done: Trigger	seedPointAlpha: Float	Type: String
Empty Group Before Generation: Bool	seedPointColor: Color	Update Mode: Enum

Visible Fields

Update Mode

name: updateMode, type: Enum, default: Off

The update mode configures if the module generates new CSOs on an input image change. Values are Off and Auto Update.

Values:

Title	Name
Off	Off
Auto Update	AutoUpdate

Auto Apply

name: autoApply, type: Bool, default: FALSE

If checked, all changes of fields on the GUI lead to a new computation.

Apply

name: apply, type: Trigger

If pressed, the module generates new CSOs.

Empty Group Before Generation

name: emptyGroupBeforeGeneration, type: Bool, default: FALSE

If checked and a valid group name is supplied, this group is being emptied before a new generation, thus keeping only the latest results. Default is off.

Add CSOTo Group With Label

name: addCSOToGroupWithLabel, type: String

If non-empty, the CSOGroup with this string as a label is looked up before generation of CSOs. If the group is not existent it is created. All generated CSOs are added to this group. Default is empty.

Id

name: id, type: Integer, default: 0

The creator id is set as a parameter in each generated CSO to determine its origin later on. Default is 0.

Should close CSO

name: shouldCloseCSO, type: Bool, default: FALSE

If enabled the CSOs are closed. Otherwise the will not be closed even if the first and the last marker have the same position.

Generation Mode

name: generationMode, type: Enum, default: OrderOfMarkers

The mode which is used for generation of a CSO.

Values:

Title	Name	Description
Order Of Markers	OrderOfMarkers	Generates a CSO for all consecutive markers on the same slice.
Point CSOs	PointCSOs	Generates a point CSO for each individual marker.

Coord Mode

name: coordMode, type: Enum, default: Voxel

Indicates if the positions of the markers are given in voxel or world coordinates.

Values:

Title	Name
Voxel	Voxel
World	World

Overwrite Type

name: overwriteType, type: Bool, default: FALSE

If true the user defined type is used instead of the default type.

Type

name: type, type: String, default: CSOMarkerGenerator

The type that should be used for the generated CSOs instead of the default type.

Sub Type

name: subType, type: String, default: SUB_TYPE_NOT_SET

The subtype that should be used for the generated CSOs instead of the default subtype.

Smoothing Mode

name: smoothingMode, type: Enum, default: SmoothingModeSplineApproximation

Determines the smoothing mode. Values as None, Spline Approximation and Spline Interpolation. Default is Spline Approximation.

Values:

Title	Name
None	SmoothingModeNone
Spline Approximation	SmoothingModeSplineApproximation
Spline Interpolation	SmoothingModeSplineInterpolation

Smoothing Amount

name: smoothingAmount, type: Integer, default: 1

The amount of smoothing applied to the CSO.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, default: FALSE

done

name: done, type: Trigger

addCSOToGroupMode

name: addCSOToGroupMode, type: Enum, default: AddToGroupByLabel

Values:

Title	Name
None	AddToGroupNone
By Label	AddToGroupByLabel
By Id	AddToGroupById

addCSOToGroupWithId

name: addCSOToGroupWithId, type: Integer, default: -1

pathPointStyle

name: pathPointStyle, type: Enum, default: LineStyleSolid, deprecated name: pathPointLineStyle

Values:

Title	Name
None	LineStyleNone
Solid	LineStyleSolid
Dashed	LineStyleDashed
Dotted	LineStyleDotted
Short Dashed	LineStyleShortDashed

pathPointWidth

name: pathPointWidth, type: Float, default: 1, deprecated name: pathPointLineWidth

seedPointStyle

name: seedPointStyle, type: Enum, default: MarkerModeNone, deprecated name: markerMode

Values:

Title	Name
None	MarkerModeNone
Rect	MarkerModeRect
Circle	MarkerModeCircle

seedPointSize

name: seedPointSize, type: Float, default: 2, deprecated name: markerSize

seedPointColor

name: seedPointColor, type: Color, default: 0 1 0, deprecated name: markerColor

seedPointAlpha

name: seedPointAlpha, type: Float, default: 1, deprecated name: markerAlpha