Description

Adds an overlay to the specified input image showing the extent of each specified input object as a filled shape. The opacity of the filled shape can be varied to see the image underneath.

Parameters

Colour mode (default = "Single colour") Method for assigning colour of each object:

Single colour (default = "White") Colour for all object overlays to be rendered using. This parameter is used if "Colour mode" is set to "Single colour". Choices are: White, Black, Red, Orange, Yellow, Green, Cyan, Blue, Violet, Magenta.
Child objects for colour (default = "") Object collection used to determine the colour based on number of children per object when "Colour mode" is set to "Child count". These objects will be children of the input objects.

Measurement for colour (default = "") Measurement used to determine the colour when "Colour mode" is set to either "Measurement value" or "Parent measurement value".

Parent object for colour (default = "") Object collection used to determine the colour based on either the ID or measurement value of a parent object when "Colour mode" is set to either "Parent ID" or "Parent measurement value". These objects will be parents of the input objects.

Partner objects for colour (default = "") Object collection used to determine the colour based on number of partners per object when "Colour mode" is set to "Partner count". These objects will be partners of the input objects.

Opacity (%) (default = "100.0") Opacity of the overlay to be rendered. This is a value between 0 (totally transparent) and 100 (totally opaque).

Input image (default = "") Image onto which overlay will be rendered. Input image will only be updated if "Apply to input image" is enabled, otherwise the image containing the overlay will be stored as a new image with name specified by "Output image".

Input objects (default = "") Objects to represent as overlays.

Apply to input image (default = "false") Determines if the modifications made to the input image (added overlay elements) will be applied to that image or directed to a new image. When selected, the input image will be updated.

Add output image to workspace (default = "false") If the modifications (overlay) aren't being applied directly to the input image, this control will determine if a separate image containing the overlay should be saved to the workspace.

Output image (default = "") The name of the new image to be saved to the workspace (if not applying the changes directly to the input image).

Render in all frames (default = "false") Display the overlay elements in all frames (time axis) of the input image stack, irrespective of whether the object was present in that frame.

Enable multithreading (default = "true") Process multiple overlay elements simultaneously. This can provide a speed improvement when working on a computer with a multi-core CPU.