Modules

With / without metadata

Filter an object collection based on the presence of a specific metadata item for each object.

Description

Filter an object collection based on the presence of a specific metadata item for each object. Objects which do/don't have the relevant metadata item can be removed from the input collection, moved to another collection (and removed from the input collection) or simply counted (but retained in the input collection). The number of objects failing the filter can be stored as a metadata value.

Parameters

Parameter Description
Input objects Objects to be filtered.
Filter mode Controls what happens to objects which don't pass the filter:
  • "Do nothing" Retains all input objects, irrespective of whether they passed or failed the filter. This is useful when also storing the filter results as metadata values (i.e. just counting the number of objects which pass the filter).
  • "Move filtered objects to new class" Objects failing the filter are moved to a new object class. The name of the class is determined by the "Output (filtered) objects" parameter. All existing measurements and relationships are carried forward into the new object collection.
  • "Remove filtered objects" (default) Removes objects failing the filter. Once removed, these objects are unavailable for further use by modules and won't be included in exported results.
Output (filtered) objects New object collection containing input objects which did not pass the filter. These objects are only stored if "Filter mode" is set to "Move filtered objects to new class".
Method for filtering Controls whether objects are removed when a specific metadata item is present or not:

- "Remove objects without metadata" Objects without the metadata item specified by "Metadata item to filter on" are removed, counted or moved (depending on the "Filter mode" parameter).

- "Remove objects with metadata" Objects with the metadata item specified by "Metadata item to filter on" are removed, counted or moved (depending on the "Filter mode" parameter).
Metadata item to filter on Metadata item to filter by. The presence or absence of this metadata item will determine which of the input objects are counted, removed or moved (depending on the "Filter mode" parameter).
Store filter results When selected, the number of removed (or moved) objects is counted and stored as a metadata item (name in the format "FILTER // NUM_[inputObjectsName] WITHOUT [metadata item name] METADATA").