ApplyTransformationMatrix

MacroModule
author Florian Weiler
package FMEstable/ReleaseMeVis
definition ApplyTransformationMatrix.def

Purpose

Applies a transformation given as matrix on the input image.

Usage

See example network.

Windows

Default Panel

../../../Projects/ApplyTransformationMatrix/Modules/mhelp/Images/Screenshots/ApplyTransformationMatrix._default.png

Input Fields

inImage

name: inImage, type: Image

Input image.

Output Fields

outImage

name: outImage, type: Image

Output image.

Parameter Fields

Field Index

[]: Trigger Status Message: String
Clear: Trigger Update: Trigger
doNotClearOnFailedUpdate: Bool  
Has Valid Output: Bool  
inInvert: Bool  
inTransformation: Matrix  
On Input Change Behavior: 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

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

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.

Hidden Fields

inTransformation

name: inTransformation, type: Matrix, default: 0 0 0 0, 0 0 0 0, 0 0 0 0, 0 0 0 0, deprecated name: transformation

Input transformation matrix to be applied on the input image.

inInvert

name: inInvert, type: Bool, default: FALSE, deprecated name: invert

Defines if the transformation is inverted before applying.

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.