XMarkerListToCircular

MLModule

genre	Marker
author	Lennart Tautz
package	FMEstable/ReleaseMeVis
dll	MLXMarkerListToCircular
definition	XMarkerListToCircular.def
see also	Raster, RasterFunctions, Draw3DMacro, Draw3D, Mask, XMarkerToSphere, MarkerToMask, MaskToMarkers, MarkerToImage
keywords	Marker, XMarker, XMarkerList, circle, ring, draw, sphere, ball, disc, disk, blob, raster, object, influence, radius, mask

Purpose

At each position of markers from the connected XMarkerList, XMarkerListToCircular draws a primitive selected by Select Object To Draw (such as voxels, circles, spheres, balls, or discs).

Usage

Connect an image and an XMarkerList, decide how the radius of the drawn objects are determined, and press Update.

Details

The object type selected in Select Object To Draw is drawn at all positions of markers from the connected XMarkerList. Object voxel values are set to Mask Value, all other are set to Background Value.

All properties of the input image are passed unchanged to the output image, unless Set as minimum voxel value and Set as maximum voxel value are enabled to change image min/max voxel value. It is up to the user to provide an image with expected properties. Consider using Mask to generate an image with voxel values of the input image in object or background regions.

Note that the geometric radius of objects is applied only in spatial dimensions X, Y, and Z, but not in C, T, or U. That means a sphere with radius 3 at time point 5 is only drawn in time point 5, and is has no extents in time points 4 to 6.

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

The input image which is used to create an output image as mask.

markerList

name: markerList, type: XMarkerList(MLBase)

A list of XMarkers in world coordinates.

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

Output Fields

output0

name: output0, type: Image

The input image as mask into which the objects are drawn, or empty if no appropriate markerList is connected and Validate Output Even On No Or Empty XMarkerList is off. Image properties are usually bypassed from input to output image unless Set as minimum voxel value and Set as maximum voxel value are enabled to change image min/max voxel value.

Parameter Fields

Field Index

Auto Update: Bool	Set as minimum voxel value: Bool
Background Value: Double	Update: Trigger
Circle Radius: Double	Validate Output Even On No Or Empty XMarkerList: Bool
Get Circle Radius From: Enum
Mask Value: Double
Ring Width: Double
Select Object To Draw: Enum
Set as maximum voxel value: Bool

Visible Fields

Select Object To Draw

name: inObjectMode, type: Enum, default: Disc

Selects the object to draw at each XMarker position.

Values:

Title	Name	Description
​Disc	​Disc	​Draws a disc.
​Ball	​Ball	​Draws a filled sphere.
​Circle	​Circle	​Draws a circle (only the outline of a disc).
​Sphere	​Sphere	​Draws a sphere (only the outline of a sphere).
​Voxel	​Voxel	​At each marker position a single voxel is drawn.

Get Circle Radius From

name: inRadiusMode, type: Enum, default: Vector_ZComponent

Selects how the radius of drawn objects is determined. Maybe insensitive if not used by certain modes.

Values:

Title	Name	Description
​Vector ZComponent	​Vector_ZComponent	​The Z component of the marker vector is used as radius for the object drawn at the position of the marker.
​Radius Field	​RadiusField	​A fixed radius value given by Circle Radius is used for all drawn objects.
​Vector Length	​Vector_Length	​The radius of the drawn objects is determined by the length of the vectors of each XMarker in the XMarkerList This allow interactive drawing objects of a desired radius.

Circle Radius

name: inRadius, type: Double, default: 5, minimum: 0

Defines the object radius when Get Circle Radius From is set to Circle Radius, otherwise it is insensitive.

Ring Width

name: inRingWidth, type: Double, default: 2, minimum: 0

If circles or spheres are drawn then Ring Width determines the width of the circle ring or the thickness of the sphere surface in world coordinates. Note that dependent on the voxel size and the selected value the surface may not be connected. Ring Width maybe insensitive if not used by certain modes.

Background Value

name: inBackgroundValue, type: Double, default: 0

The voxel value to be used for all voxels where no objects are drawn.

Set as minimum voxel value

name: inSetMinVoxelValue, type: Bool, default: TRUE

If on then the minimum voxel value of the image is set to Background Value; otherwise the input minimum one is used for the output.

Mask Value

name: inMaskValue, type: Double, default: 255

The voxel value to be used for all voxels where objects are drawn.

Set as maximum voxel value

name: inSetMaxVoxelValue, type: Bool, default: TRUE

If on then the maximum voxel value of the image is set to Mask Value; otherwise the input maximum one is used for the output.

Validate Output Even On No Or Empty XMarkerList

name: inValidateImageOnEmptyXMarkerList, type: Bool, default: FALSE

If true then the output image is validated (but empty) even if no or only an empty XMarkerList is connected; otherwise the output image is invalidated.

Auto Update

name: autoUpdate, type: Bool, default: FALSE

If checked, any change in input fields will update the output.

Update

name: update, type: Trigger

Update the output.