ComposeImageVector

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MLCoordinateInfrastructure
definition	MLCoordinateInfrastructure.def
see also	ComposeVector3, ComposeVector4, ComposeVector6, DecomposeImageVector
keywords	image, vector, 6d, vec, dimension, component

Purpose

This module composes an ImageVector from six integer components.

Usage

Set the component values, and press Update.

Windows

Default Panel

Parameter Fields

Field Index

[]: Trigger	Status Message: String
C: Integer	T: Integer
Clear: Trigger	U: Integer
doNotClearOnFailedUpdate: Bool	Update: Trigger
Has Valid Output: Bool	X: Integer
Image Vector: IntVector6	Y: Integer
On Input Change Behavior: Enum	Z: Integer
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).

X

name: inX, type: Integer, default: 0

X component.

Y

name: inY, type: Integer, default: 0

Y component.

Z

name: inZ, type: Integer, default: 0

Z component.

C

name: inC, type: Integer, default: 0

C component.

T

name: inT, type: Integer, default: 0

T component.

U

name: inU, type: Integer, default: 0

U component.

Image Vector

name: outImageVector, type: IntVector6, persistent: no

Resulting integer 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.