Purpose

Filter list of markers by a mask.

Usage

Connect a mask image, an XMarker list and press Update.

Details

The voxel value at each marker position is looked up in the mask image. If the voxel value reads as true (that is, not zero), the marker is kept, otherwise it is discarded. The order of markers in the list is kept.

Windows

Default Panel

../../../Projects/MLFilterMarkersByMask/Modules/mhelp/Images/Screenshots/FilterMarkersByMask._default.png

Input Fields

input0

name: input0, type: Image, deprecated name: inMask

A mask image.

inMarkerList

name: inMarkerList, type: MLBase

A marker list.

Output Fields

outMarkerList

name: outMarkerList, type: MLBase

The filtered marker list.

Parameter Fields

Field Index

[]: Trigger
Clear: Trigger
doNotClearOnFailedUpdate: Bool
Has Valid Output: Bool
On Input Change Behavior: Enum
Status Code: Enum
Status Message: String
Update: Trigger

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

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.