Purpose

This module decomposes an ImageVector into its components.

Usage

Set a vector, and press Update.

Windows

Default Panel

../../../Projects/MLCoordinateInfrastructure/Modules/mhelp/Images/Screenshots/DecomposeImageVector._default.png

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

Image Vector

name: inImageVector, type: IntVector6, default: 0 0 0 0 0 0

Input integer vector.

X

name: outX, type: Integer, persistent: no

X component.

Y

name: outY, type: Integer, persistent: no

Y component.

Z

name: outZ, type: Integer, persistent: no

Z component.

C

name: outC, type: Integer, persistent: no

C component.

T

name: outT, type: Integer, persistent: no

T component.

U

name: outU, type: Integer, persistent: no

U component.

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.