Filter Array Output
Overview
Filter Array Output keeps only the items from an upstream array that match one or more conditions.
Filter fields change based on the array item type: primitive string/number arrays use array-level validation modes; object arrays use per-key filters (string, number, boolean, rectangle, contour, or nested string/number arrays).
Input
Tool
string requiredSelect the tool that contains the array.
Output array from tool
string requiredSelect the array to filter. Shown after a tool is selected.
Array Validation Mode
stringShown when the array items are strings or numbers (or when filtering a nested array[string] / array[number] property).
Values:
ALL_OF— All of: every item must meet the conditions.ANY_OF(default) — Any of: at least one item must meet the conditions.NONE_OF— None of: no item may meet the conditions.
Array Conditions
arrayConditions applied to string or number array items. Each condition includes Comparison Mode and Filter Value (and Case Sensitive for strings).
Filters
arrayShown when array items are objects. Each filter targets one object key (Filter Item) and shows type-specific comparison fields:
String keys
- Comparison Mode:
EQUALS(default),NOT_EQUALS,CONTAINS,NOT_CONTAINS,STARTS_WITH,ENDS_WITH,MATCHES_REGEX - Filter Value (string)
- Case Sensitive (default
false) - Or group (optional)
Number keys
- Comparison Mode:
EQUALS(default),NOT_EQUALS,GREATER_THAN,LESS_THAN,GREATER_THAN_OR_EQUAL,LESS_THAN_OR_EQUAL - Filter Value (number, default
0) - Or group (optional)
Boolean keys
- Comparison Mode:
EQUALS(default),NOT_EQUALS - Filter Value (boolean, default
false) - Or group (optional)
Rectangle keys (object{x,y,width,height})
- Box Width / Box height —
[min, max]ranges (default[0, 100000]) - Draw Areas of Interest (AOI) — optional polygons; when set, also AOI Object position (
TOTAL,TOP,CENTERdefault,BOTTOM), Draw AOI Overlay (defaulttrue), AOI Overlay Color (default#FF0000) - Or group (optional)
Contour keys (array[array[integer,integer]])
- Contour Area —
[min, max](default[0, 100000]) - Same optional AOI fields as rectangle
- Or group (optional)
Nested array[string] / array[number] keys
- Array Validation Mode and Array Conditions as above
- Or group (optional)
Or group
stringOptional label that groups conditions with OR / “Any of” semantics: if at least one condition in the group is true, the group is true.
Image to draw overlays info
imageOptional image frame reference for drawing overlays (for example AOI).
Output
outValue
arrayFiltered array. Item type matches the selected input array.
Array Size
integerNumber of items remaining after filtering.
Default: 0
Overlay Image
imageFrame with optional AOI overlay drawings when an image input and AOI filters are used.