Number of partners
Filter an object collection based on the number of partners each object has from another object collection.
Description
Filter an object collection based on the number of partners each object has from another object collection. The threshold (reference) value can be either a fixed value (same for all objects), a measurement associated with an image (same for all objects within a single analysis run) or a measurement associated with a parent object (potentially different for all objects). Objects which satisfy the specified numeric filter (less than, equal to, greater than, etc.) 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:
|
| 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 | Numeric comparison used to determine which objects should be removed. Objects with specified property (e.g. a measurement value) that passes this filter will be removed. For example, an object with a measurement value of 7 would be removed if "Method for filtering" is set to "Less than" with a reference value of 10. Choices are: Less than, Less than or equal to, Equal to, Greater than or equal to, Greater than, Not equal to. |
| Reference mode | Type of reference value used to compare objects to:
|
| Reference value | When "Reference mode" is set to "Fixed value", all objects will be compared to this fixed value. |
| Reference value image | When "Reference mode" is set to "Image measurement", all objects will be compared to a measurement associated with this image. |
| Reference image measurement | When "Reference mode" is set to "Image measurement", all objects will be compared to this measurement, which itself is associated with the image specified by "Reference value image". |
| Reference value parent object | When "Reference mode" is set to "Parent object measurement", all objects will be compared to a measurement associated with their parent object from this collection. |
| Reference object measurement | When "Reference mode" is set to "Parent object measurement", all objects will be compared to this measurement, which itself is associated with the parent object specified by "Reference value parent object". |
| Reference value multiplier | Irrespective of how the reference value was determined, it can be systematically adjusted prior to use for comparison using this multiplier. For example, an image measurement reference value of 32 with a "Reference value multiplier" of "0.5" will see all objects compared against a value of 16. This is useful when comparing to dynamic values coming from image and parent object measurements. |
| Store summary filter results | When selected, a metadata value is stored in the workspace, which records the number of objects which failed the filter and were removed or moved to another object class (depending on the "Filter mode" parameter). |
| Store individual filter results | When selected, each input object will be assigned a measurement reporting if that object passed or failed the filter. The measurement value is "1" for objects that failed the filter (i.e. would be removed if the relevant removal setting was enabled) and "0" for objects that passed (i.e. wouldn't be removed). |
| Partner objects | Objects will be filtered against the number of partners they have from this object collection. |