Add text

Adds an overlay to the specified input image showing a fixed text label.

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

Parameter	Description
Colour mode	Method for assigning colour of each object: "Child count" Colour is determined by the number of children each object has. Colour range runs across the first half of the visible spectrum (i.e. red to cyan) and is maximised, so the object with the fewest children is shown in red and the object with the most, in cyan. Objects without any children are always shown in red. Child objects used for counting are selected with the "Child objects for colour" parameter. "ID" Colour is quasi-randomly selected based on the ID number of the object. The colour used for a specific ID number will always be the same and is calculated using the equation hue = (ID 1048576 % 255) / 255. "Measurement value" Colour is determined by a measurement value. Colour range runs across the first half of the visible spectrum (i.e. red to cyan) and is maximised, so the object with the smallest measurement is shown in red and the object with the largest, in cyan. Objects missing the relevant measurement are always shown in red. The measurement value is selected with the "Measurement for colour" parameter. "Parent ID" Colour is quasi-randomly selected based on the ID number of a parent of this object. The colour used for a specific ID number will always be the same and is calculated using the equation hue = (ID * 1048576 % 255) / 255*. The parent object is selected with the "Parent object for colour" parameter. "Parent measurement value" Colour is determined by a measurement value of a parent of this object. Colour range runs across the first half of the visible spectrum (i.e. red to cyan) and is maximised, so the object with the smallest measurement is shown in red and the object with the largest, in cyan. Objects either missing the relevant measurement or without the relevant parent are always shown in red. The parent object is selected with the "Parent object for colour" parameter and the measurement value is selected with the "Measurement for colour" parameter. "Partner count" Colour is determined by the number of partners each object has. Colour range runs across the first half of the visible spectrum (i.e. red to cyan) and is maximised, so the object with the fewest partners is shown in red and the object with the most, in cyan. Objects without any partners are always shown in red. Partner objects used for counting are selected with the "Partner objects for colour" parameter. "Random colour" Colour is randomly selected for each object. Unlike the "ID" option, the colours generated here will be different for each evaluation of the module. "Single colour" (default option) Colour is fixed to one of a predetermined list of colours. All objects will be assigned the same overlay colour. The colour is chosen using the "Single colour" parameter.
Colour map	Colourmap used for colour gradients. This parameter is used if "Colour mode" is set to any mode which yields a range of colours (e.g. measurements or IDs). Choices are: Black fire, Ice, Jet, Physics, Random, Random (vibrant), Spectrum, Thermal.
Single colour	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	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	Measurement used to determine the colour when "Colour mode" is set to either "Measurement value" or "Parent measurement value".
Parent object for colour	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	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 (%)	Opacity of the overlay to be rendered. This is a value between 0 (totally transparent) and 100 (totally opaque).
Range minimum mode	Controls whether the minimum range for displayed colours is set automatically to the minimum available value (e.g. the smallest measurement being rendered), or whether it is defined manually by the "Minimum value" parameter.
Minimum value	When "Range minimum mode" is set to "Manual", this is the minimum value that will be displayed as a unique colour. All values smaller than this will be displayed with the same colour.
Range maximum mode	Controls whether the maximum range for displayed colours is set automatically to the maximum available value (e.g. the largest measurement being rendered), or whether it is defined manually by the "Maximum value" parameter.
Maximum value	When "Range maximum mode" is set to "Manual", this is the maximum value that will be displayed as a unique colour. All values larger than this will be displayed with the same colour.
Input image	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	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	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	The name of the new image to be saved to the workspace (if not applying the changes directly to the input image).
Text	Fixed text to be displayed. The current slice and frame numbers can be inserted using "D{SLICE}" and "D{FRAME}". Similarly, it's possible to insert the elapsed frame time in the form "T{HH:mm:ss.SSS}" (where this example would give hours:minutes:seconds.millis). The full description of supported time values can be found here.
X-position	Horizontal location of the text to be displayed. Specified in pixel units relative to the left of the image (x=0).
Y-position	Vertical location of the text to be displayed. Specified in pixel units relative to the top of the image (y=0).
Z-range	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	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.
Centre text	When selected, text will be centred on the specified XY coordinate. Otherwise, text will be based with its top-left corner at the specified coordinate.
Label size	Font size of the text label.
Label colour	Colour of the text label. Choices are: White, Black, Red, Orange, Yellow, Green, Cyan, Blue, Violet, Magenta.