CurvesFromXMarkerList

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MLCurvesFromXMarkerList
definition	MLCurvesFromXMarkerList.def
see also	XMarkerListToProfileCurve
keywords	profile, curve, marker, list, sample, trajectory, dimension, conversion

Purpose

This module creates curves by collecting XMarker properties over a chosen dimension (called index for this purpose).

Usage

Connect an XMarkerList to inMarkerList, choose how the index of the properties should be determined (Index Mode), the property to be collected (Profile Mode), and press Update.

Details

Markers and the resulting curves are grouped by marker type. The original use case was creating profiles for markers on different MPRs (identified by marker type) over all time points. The profile property can be, for example, a marker coordinate component.

The module will not check for unique or meaningful index values. The resulting curves might be degenerate. Index values are sorted ascending.

Tips

Together with an XMarkerListImageData module, this module offers a flexible way to create intensity profiles with sampling positions given as markers.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

An XMarkerList.

Output Fields

outCurveList

name: outCurveList, type: MLBase

A CurveList, with one CurveData per profile as identified by marker type.

Parameter Fields

Field Index

[]: Trigger	Status Message: String
Clear: Trigger	Update: Trigger
doNotClearOnFailedUpdate: Bool
Has Valid Output: Bool
Index Mode: Enum
On Input Change Behavior: Enum
Profile Mode: 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: shouldAutoUpdate,shouldUpdateAutomatically

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).

Index Mode

name: inIndexMode, type: Enum, default: TDimension

The index mode determines the “dimension” where marker properties are collected over, and the X values of the resulting curves.

Values:

Title	Name	Description
Index	Index	The marker index is used to sort the markers, that is, the order in the list is used.
TDimension	TDimension	The T dimension coordinate is used for sorting.
UDimension	UDimension	The U dimension coordinate is used for sorting.
Relative Index	RelativeIndex	If there is only one type present in the marker list, this mode is identical to Index. If there are multiple types, the relative index in each group is used as X value (that is, each group curve starts at 0).

Profile Mode

name: inProfileMode, type: Enum, default: X

The property of each marker that is collected.

Values:

Title	Name	Description
X	X	X coordinate.
Y	Y	Y coordinate.
Z	Z	Z coordinate.
C	C	C coordinate.
T	T	T coordinate.
U	U	U coordinate.
Vector X	VectorX	X component of marker vector.
Vector Y	VectorY	Y component of marker vector.
Vector Z	VectorZ	Z component of marker vector.
Vector Length	VectorLength	Length of marker vector.

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.