ImageClear

MLModule

genre	FlowControl
status	work-in-progress
authors	Kanthak, Christian
package	FMEstable/General
dll	MLImageClear
definition	MLImageClear.def
keywords	clear, output, image

Purpose

Relays an image with the optional possibility of clear the output explicitly or on input change. This prevents unwanted output notifications and possibly unwanted updates of subsequent modules.

Usage

Put the module in front of a subnetwork that has auto-update enabled to prevent unwanted updates. Put the module after a network with a lot of extra notifications to hide these from the subsequent modules.

Details

The input image is not cached but only bypassed, so no performance loss occurs and no memory is used.

Interaction

When pressing 'update' while the output is already up-to-date, no additional notification is sent. The same goes for 'clear' when the output is cleared anyway.

Tips

It is often a good idea to implement all input and output image fields of a macro with ImageClear modules (instead of bypass modules, which do not allow 'clear').

Windows

Default Panel

Input Fields

input0

name: input0, type: Image

Input Image

Output Fields

output0

name: output0, type: Image

Output Image (i.e. Bypassed Input Image)

Parameter Fields

Field Index

Auto-Update: Bool

Clear: Trigger

Update: Trigger

Valid Input Image: Bool

Valid Output Image: Bool

Visible Fields

Update

name: update, type: Trigger

Update Output Image

Clear

name: clear, type: Trigger

Clear Output Image

Valid Output Image

name: validOutImage, type: Bool, persistent: no

Indicates if the current output image is valid

Valid Input Image

name: validInImage, type: Bool, persistent: no

Indicates if the current input image is valid

Auto-Update

name: autoUpdate, type: Bool, default: FALSE

If enabled, the output image is automatically udpated on each input image notification