Objects with specific IDs

Filter an object collection based on user-defined list of object ID numbers.

Description

Filter an object collection based on user-defined list of object ID numbers. When the module executes, the user is presented with a dialog box where they can enter a comma-separated list of object IDs to remove. Once the list is complete, the user presses "OK" to proceed. All objects with ID numbers matching those in the list 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). To assist with selection of ID numbers, an optional image can be displayed - this could be pre-prepared to display object ID numbers using the "Add labels" module. The number of objects specified for removal 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".
Show image	When selected, a specific image will be displayed when this module executes. This can be used to display a pre-prepared, object ID-labelled image to the user, thus acting as a reference for which object IDs to remove. The image to be displayed is set using the "Image to display" parameter.
Image to display	Image to display when the module executes. For example, this could be a pre-prepared image with object IDs inserted as text overlays using the "Add labels" module.
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]_BY_ID").