ProjectMarkersToPlane

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MarkerPlaneAlgorithms
definition	MarkerPlaneAlgorithms.def

Purpose

This module projects markers to a plane.

Usage

Connect a marker list (inMarkerList), set a mode (Projection Mode) and possibly a plane (Plane), and press Update.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

A marker list.

Output Fields

outMarkerList

name: outMarkerList, type: MLBase

A marker list where all input markers have been projected to a plane as set by the parameters.

Parameter Fields

Field Index

[]: Trigger	Status Code: Enum
Clear: Trigger	Status Message: String
doNotClearOnFailedUpdate: Bool	Update: Trigger
Has Valid Output: Bool
Marker Plane: Plane
On Input Change Behavior: Enum
Plane: Plane
Projection Mode: 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).

Projection Mode

name: inProjectionMode, type: Enum, default: MarkerPlane

Marker projection mode

Values:

Title	Name	Description
Marker Plane	MarkerPlane	The input markers are projected to the plane defined by the shortest Eigenvector of the markers’ PCA.
Plane Parameter	PlaneParameter	The input markers are projected to the plane given in Plane.

Plane

name: inPlane, type: Plane, default: 0 0 0 0

Plane to project the markers to.

Marker Plane

name: outPlane, type: Plane, persistent: no

The marker plane, as determined by PCA.

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.