Modules

Mask objects

Applies the mask image to the specified object collection.

Description

Applies the mask image to the specified object collection. Any object coordinates coincident with black pixels (intensity 0) will be removed.

Parameters

Parameter Description
Input objects Objects to be masked.
Output object mode Controls how the masked objects will be stored:
  • "Create new objects" (Default) Will add the masked objects to a new object set and store this set in the workspace.
  • "Update input objects" Will replace the coordinates of the input object with the masked coordinates. All measurements associated with input objects will be transferred to the masked objects.
Output objects Name for the output masked objects to be stored in workspace.
Mask mode Controls whether the input objects will be masked by an image or an object collection:
  • "Mask from image" (Default) Input objects will be masked based on the image specified by "Mask image". Any object regions coincident with black pixels (0 pixel intensity) will be removed.
  • "Mask from objects (remove overlap)" Input objects will be masked based on all objects of the collection specified by "Mask objects". Any object regions coincident with any objects in the masking collection will be removed. The masking objects will be unaffected by this process.
  • "Mask from objects (retain overlap)" Input objects will be masked based on all objects of the collection specified by "Mask objects". Any object regions not coincident with any objects in the masking collection will be removed. The masking objects will be unaffected by this process.
Mask objects Object collection to use as mask on input objects. Depending on which object-masking mode is selected, the input objects will either have coordinates coincident with these objects removed or retained.
Mask image Image to use as mask on input objects. Object coordinates coincident with black pixels (pixel intensity = 0) are removed.
Remove empty objects When selected, any objects which have no volume following masking will be removed.