FlagsFilter
Type Sample
Category Sampling > Filters

FlagsFilter

Description

Filters sample to only the cells that match the flag conditions.

Arguments

Type Name (Display Name) Description Default
Sample input_grid (Sample) Sample to be filtered.
bool match_all (Match All) Whether or not to require matching all flags in match_flags, or only one. false
Flags match_flags (Match Flags) For each cell, if it has any or all of these flags (depending on match_all), it's kept in. If not, it's filtered out. []
Flags exclude_flags (Exclude Flags) For each cell, if it has any of these flags, it's always filtered out. []

Outputs

Sample - filtered_grid (Filtered Sample)

Returns the Sample after filtering has been applied.