ImageClear

MLModule

genre	FlowControl
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLBasicModules
definition	mlBasicModules.def
see also	Bypass
keywords	output

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

[]: Trigger

Clear: Trigger

Has Valid Input: Bool

Has Valid Output: Bool

Update: Trigger

Update automatically: Bool

Visible Fields

Update

name: update, type: Trigger

Update Output Image

Clear

name: clear, type: Trigger

Clear Output Image

Update automatically

name: autoUpdate, type: Bool, default: FALSE

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

Has Valid Input

name: validInImage, type: Bool, persistent: no

Indicates if the current input image is valid

Has Valid Output

name: validOutImage, type: Bool, persistent: no

Indicates if the current output image is valid

[]

name: updateDone, type: Trigger, persistent: no

Triggered by the module after an update is complete and all output fields up-to-date and notified.

The field is also triggered if ‘update’ is pressed when the output image is already up-to-date (although the output image and validOutputImage fields will not be touched in these cases).