XMarkerListImageData

MLModule

genre	Marker
author	Christian Schumann
package	FMEwork/ReleaseMeVis
dll	MLXMarkerListImageData
definition	MLXMarkerListImageData.def
see also	XMarkerModify, WEMImageData

Purpose

Reads image data at marker positions and modifies marker properties (vector, type) based on it.

Usage

Provide a XMarkerList at inXMarkerList and an image at input0, select a mode and update.

Details

The module does not accept vector images, although this would seem obvious. If multiple components per vector are needed for a certain mode, they have to provided in the c-dimension of the image. You can use the TypeDecomposer and ConcatenateImages to convert your vec3-image into a float image with 3 entries in the c-dimension.

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

The image to be sampled.

inXMarkerList

name: inXMarkerList, type: MLBase

The input marker list.

Output Fields

outXMarkerList

name: outXMarkerList, type: MLBase

The modified marker list.

Parameter Fields

Field Index

[]: Trigger	Status Message: String
Clear: Trigger	Update: Trigger
doNotClearOnFailedUpdate: Bool
Fill Value: Double
Has Valid Output: Bool
Mode: Enum
On Input Change Behavior: Enum
Status Code: Enum

Visible Fields

Update

name: update, type: Trigger

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldUpdateAutomatically,shouldAutoUpdate

Declares how the module should react if a value of an input field changes.

Values:

Title	Name	Deprecated Name
Update	Update	TRUE
Clear	Clear	FALSE

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title	Name
Ok	Ok
Invalid input object	Invalid input object
Invalid input parameter	Invalid input parameter
Internal error	Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Mode

name: inMode, type: Enum, default: SetType

Mode defining how image values are used to modify marker properties.

Values:

Title	Name	Description
Set Type	SetType	Sets the type of the marker based on the voxel value. Only works with integer images.
Set Vector	SetVector	Sets the vector of the marker based on the voxel value. Only works with float, double and integer images with at least 3 values in the c-dimension.
Set Vector X	SetVectorX	Sets the x-component vector of the marker based on the voxel value. Only works with float, double and integer images. The other components keep the values of the input marker.
Set Vector Y	SetVectorY	Sets the y-component vector of the marker based on the voxel value. Only works with float, double and integer images. The other components keep the values of the input marker.
Set Vector Z	SetVectorZ	Sets the z-component vector of the marker based on the voxel value. Only works with float, double and integer images. The other components keep the values of the input marker.
Scale Vector	ScaleVector	Scales the vector of the marker based on the voxel value. Only works with float, double and integer images. If the image has at least 3 entries in the c-dimension, each component is scaled individually with the corresponding entry. Otherwise, all components are scaled with the first entry.

Fill Value

name: inFillValue, type: Double, default: 0

Field defining value to use outside the image.

Hidden Fields

doNotClearOnFailedUpdate

name: doNotClearOnFailedUpdate, type: Bool, persistent: no

Prevents automated clear after update failed. This does not affect status fields. It enables the developer to analyze module’s state after failure.