RigidTransformationFromMarkerLists

MLModule
genre Registration
author Torben Paetz
package FMEstable/ReleaseMeVis
dll MLRigidTransformationFromMarkerLists
definition MLRigidTransformationFromMarkerLists.def
see also ICP
keywords rigid, transformation, registration, landmark, SVD

Purpose

Calculates the least squares rigid transformation matrix from reference to template markers via a singular value decomposition of the covariance matrix of the marker positions.

Usage

Connect two marker list of the same size representing corresponding marker positions in both coordinate systems. The modules output is the transformation matrix from the reference to the template coordinate system.

Windows

Default Panel

../../../Projects/MLMarkerInfrastructure/RigidTransformationFromMarkerLists/Modules/mhelp/Images/Screenshots/RigidTransformationFromMarkerLists._default.png

Input Fields

inReferenceMarker

name: inReferenceMarker, type: MLBase

List of reference marker positions

inTemplateMarker

name: inTemplateMarker, type: MLBase

List of template marker positions

Parameter Fields

Field Index

[]: Trigger Update: Trigger
Clear: Trigger  
doNotClearOnFailedUpdate: Bool  
Has Valid Output: Bool  
On Input Change Behavior: Enum  
Status Code: Enum  
Status Message: String  
Transformation matrix: Matrix  

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 any input field value changes. If set to True the output field values will be updated. Otherwise they will be cleared.

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

Transformation matrix

name: outTransformationMatrix, type: Matrix, persistent: no

Transformation matrix from reference to template coordinate system

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.