XMarkerListFilter

MLModule

genre	Marker
authors	Florian Weiler, Ola Friman
package	FMEwork/ReleaseMeVis
dll	MLXMarkerUtils
definition	MLXMarkerUtils.def
see also	XMarkerAtIndex
keywords	Marker, XMarker, points, filter, include, extract, exclude, remove, position, type, size

Purpose

This module filters XMarkers from an XMarkerList by various properties.

Usage

Connect an XMarkerList, select the Filter mode and update your results.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: XMarkerList(MLBase), deprecated name: inXMarkerList

The XMarkerList to be filtered.

For accessing this object via scripting see the Scripting Reference: MLXMarkerListWrapper.

Output Fields

outMarkerList

name: outMarkerList, type: XMarkerList(MLBase), deprecated name: outXMarkerList

A new XMarkerList containing those XMarkers from the input list that match the filtering criteria.

For accessing this object via scripting see the Scripting Reference: MLXMarkerListWrapper.

Parameter Fields

Field Index

[]: Trigger	inFilterVectorDirectionInvalidVectorMode: Enum	inUseMinVectorLength: Bool
Clear: Trigger	inFilterVectorLength: Bool	Maximum angle: Double
doNotClearOnFailedUpdate: Bool	inFilterX: Bool	Minimum angle: Double
Enable filtering by vector direction: Bool	inFilterY: Bool	On Input Change Behavior: Enum
Has Valid Output: Bool	inFilterZ: Bool	outNumFilteredMarkers: Integer
inAllowSwapMinMax: Bool	inMarkerName: String	Reference Direction: Vector3
inFilterC: Bool	inMarkerTypes: String	Status Code: Enum
inFilterMode: Enum	inMaxNumMarkers: Integer	Status Message: String
inFilterName: Bool	inMaxValues: Vector6	Update: Trigger
inFilterPosition: Bool	inMaxVectorLength: Double	Use (inUseMinVectorAngle): Bool
inFilterT: Bool	inMinValues: Vector6	Use (inUseMaxVectorAngle): Bool
inFilterType: Bool	inMinVectorLength: Double
inFilterU: Bool	inUseMaxVectorLength: Bool

Visible Fields

Update

name: update, type: Trigger

Triggers a manual update.

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: autoUpdate,shouldAutoUpdate,shouldUpdateAutomatically

This field currently acts as a mixed Auto-Apply / Auto-Update option. Might be changed in the future.

Values:

Title	Name	Deprecated Name
Update	Update	TRUE,True
Clear	Clear	False,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).

Enable filtering by vector direction

name: inFilterVectorDirection, type: Bool, default: FALSE

Enable filtering of markers based on the direction of their vectors.

Reference Direction

name: inReferenceDirection, type: Vector3, default: 0 0 0

Reference direction to which marker vectors are compared.

Minimum angle

name: inMinVectorAngle, type: Double, default: 0, minimum: 0, maximum: 180

Minimum angle between a marker’s vector and Reference Direction in order to be added to outMarkerList.

Maximum angle

name: inMaxVectorAngle, type: Double, default: 90, minimum: 0, maximum: 180

Maximum angle between a marker’s vector and Reference Direction in order to be added to outMarkerList.

Use (inUseMinVectorAngle)

name: inUseMinVectorAngle, type: Bool, default: TRUE

Toggle whether to use the minimal angle as filtering criteria.

Use (inUseMaxVectorAngle)

name: inUseMaxVectorAngle, type: Bool, default: TRUE

Toggle whether to use the maximal angle as filtering criteria.

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.

inFilterMode

name: inFilterMode, type: Enum, default: Include, deprecated name: filterMode

Select whether to include or exclude markers. When filtering for several criteria at once, a boolean AND is applied.

Values:

Title	Name
Include	Include
Exclude	Exclude

inFilterType

name: inFilterType, type: Bool, default: FALSE, deprecated name: filterType

Enable filtering for marker type.

inFilterPosition

name: inFilterPosition, type: Bool, default: FALSE, deprecated name: filterPosition

Enable filtering for marker position.

inFilterName

name: inFilterName, type: Bool, default: FALSE, deprecated name: filterName

Enable filtering of markers by name.

inFilterVectorLength

name: inFilterVectorLength, type: Bool, default: FALSE, deprecated name: filterVectorLength

Enable filtering of markers by their vector length.

inMarkerTypes

name: inMarkerTypes, type: String, deprecated name: markerTypes

The types to be filtered. Multiple types may be given, separated by a comma. Whitespaces are stripped from the input string.

inMarkerName

name: inMarkerName, type: String, deprecated name: markerName

inMinVectorLength

name: inMinVectorLength, type: Double, default: 0, deprecated name: minVectorLength

Minimum length of a marker’s vector in order to be considered for filtering.

inMaxVectorLength

name: inMaxVectorLength, type: Double, default: 1, deprecated name: maxVectorLength

Minimum length of a marker’s vector in order to be considered for filtering.

inUseMinVectorLength

name: inUseMinVectorLength, type: Bool, default: FALSE, deprecated name: useMinVectorLength

Toggle whether to use the minimal marker length as filtering criteria.

inUseMaxVectorLength

name: inUseMaxVectorLength, type: Bool, default: TRUE, deprecated name: useMaxVectorLength

Toggle whether to use the maximal marker length as filtering criteria.

inFilterVectorDirectionInvalidVectorMode

name: inFilterVectorDirectionInvalidVectorMode, type: Enum, default: Exclude

Defines how markers with invalid vectors should be treated.

Values:

Title	Name
Include	Include
Exclude	Exclude

inFilterX

name: inFilterX, type: Bool, default: TRUE, deprecated name: filterX

Toggles specifying to filter for the x coordinate.

inFilterY

name: inFilterY, type: Bool, default: TRUE, deprecated name: filterY

Toggles specifying to filter for the y coordinate.

inFilterZ

name: inFilterZ, type: Bool, default: TRUE, deprecated name: filterZ

Toggles specifying to filter for the z coordinate.

inFilterC

name: inFilterC, type: Bool, default: FALSE, deprecated name: filterC

Toggles specifying to filter for the c coordinate.

inFilterT

name: inFilterT, type: Bool, default: FALSE, deprecated name: filterT

Toggles specifying to filter for the t coordinate.

inFilterU

name: inFilterU, type: Bool, default: FALSE, deprecated name: filterU

Toggles specifying to filter for the u coordinate.

inAllowSwapMinMax

name: inAllowSwapMinMax, type: Bool, default: TRUE, deprecated name: allowSwapMinMax

When filtering for a markers position, allow to swap min & max in case min is greater than max. This is useful, when manually defining a region using e.g. a SoView2DRectangle.

inMinValues

name: inMinValues, type: Vector6, default: 0 0 0 0 0 0, deprecated name: minValues

6D world position for filtering.

inMaxValues

name: inMaxValues, type: Vector6, default: 1 1 1 0 0 0, deprecated name: maxValues

6D world position for filtering.

inMaxNumMarkers

name: inMaxNumMarkers, type: Integer, default: -1, deprecated name: maxNumMarkers

Allows to restrict the number of passing markers. Use -1 to let all markers pass, otherwise only the first n markers are allowed to pass.

Default is -1.

outNumFilteredMarkers

name: outNumFilteredMarkers, type: Integer, default: 0, deprecated name: numFilteredMarkers