Description

Adds an overlay to the specified input image showing a fixed text label. Slice and frame indices can be dynamically inserted into the text using keywords.

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".

Apply to input image (default = "false") 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".

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).

Text (default = "") Fixed text to be displayed

X-position (default = "0") Horizontal location of the text to be displayed. Specified in pixel units relative to the left of the image (x=0).

Y-position (default = "0") Vertical location of the text to be displayed. Specified in pixel units relative to the top of the image (y=0).

Z-range (default = "1-end") Z-slices on which to display the text. This is specified as a comma-separated list of slice indices. The keyword "end" is used to denote the final slice in the stack and will be interpreted automatically. Accepted formats are "[VALUE]" for a single index, "[RANGE START]-[RANGE END]" for a complete range of indices and "[RANGE START]-[RANGE-END]-[INTERVAL]" for indices evenly spaced at the specified interval.

Frame-range (default = "1-end") Frames on which to display the text. This is specified as a comma-separated list of frame indices. The keyword "end" is used to denote the final frame in the stack and will be interpreted automatically. Accepted formats are "[VALUE]" for a single index, "[RANGE START]-[RANGE END]" for a complete range of indices and "[RANGE START]-[RANGE-END]-[INTERVAL]" for indices evenly spaced at the specified interval.

Label size (default = "8") Font size of the text label.

Label colour (default = "Black") Colour of the text label. Choices are: White, Black, Red, Orange, Yellow, Green, Cyan, Blue, Violet, Magenta.