Add labels

Adds an overlay to the specified input image with each object represented by a text label.

Description

Adds an overlay to the specified input image with each object represented by a text label. The label can include information such as measurements, associated object counts or ID numbers.

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".
Input objects	Objects to represent as overlays.
Apply to input image	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	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).
Label mode	Controls what information each label displays: "Child count" The number of children from a specific object collection for each object. The children to summarise are selected using the "Child objects for label" parameter. "ID" The ID number of the object. "Measurement value" A measurement associated with the object. The measurement is selected using the "Measurement for label" parameter. "Parent ID" The ID number of a parent of the object. The parent object is selected using the "Parent object for label" parameter. "Parent measurement value" A measurement associated with a parent of the object. The measurement is selected using the "Measurement for label" parameter and the parent object with the "Parent object for label" parameter. "Partner count" The number of partners from a specific object collection for each object. The partners to summarise are selected using the "Partner objects for label" parameter.
Decimal places	Number of decimal places to use when displaying numeric values.
Use scientific notation	When enabled, numeric values will be displayed in the format 1.23E-3. Otherwise, the same value would appear as 0.00123.
Label size	Font size of the text label.
X-offset	Offset the label by this number of pixels horizontally (along the x-axis). Increasingly positive numbers move the label right.
Y-offset	Offset the label by this number of pixels vertically (along the y-axis). Increasingly positive numbers move the label down.
Centre text
Child objects for label	If "Label mode" is set to "Child count", these are the child objects which will be counted and displayed on the label. These objects will be children of the input objects.
Parent object for label	If "Label mode" is set to either "Parent ID" or "Parent measurement value", these are the parent objects which will be used. These objects will be parents of the input objects.
Partner objects for label	If "Label mode" is set to "Partner count", these are the partner objects which will be counted and displayed on the label. These objects will be partners of the input objects.
Measurement for label	If "Label mode" is set to either "Measurement value" or "Parent measurement value", these are the measurements which will be used.
Prefix	Text to display at beginning of every label
Suffix	Text to display at end of every label
Label position	Determines the method used for placing the label overlay for each object: "Centre of object" Labels will be placed at the centroid (average coordinate location) of each object. This position won't necessarily coincide with a region corresponding to that object. For example, the centroid of a crescent shape won't lie on the crescent itself. "Fixed value" Labels will be placed at the x,y,z location specified by the user. "Inside largest part of object" Labels will be placed coincident with the largest region of each object. This ensures the label is placed directly over the relevant object. "Object measurement" Labels will be placed coincident with the specified measurements for each object.
X-position measurement	Object measurement specifying the X-position of the label. Measurement value must be specified in pixel units.
Y-position measurement	Object measurement specifying the Y-position of the label. Measurement value must be specified in pixel units.
Z-position measurement	Object measurement specifying the Z-position (slice) of the label. Measurement value must be specified in slice units.
X-position	Fixed value specifying the X-position of the label. Specified in pixel units.
Y-position	Fixed value specifying the Y-position of the label. Specified in pixel units.
Z-position	Fixed value specifying the Z-position of the label. Specified in pixel units.
Render in all object slices	Display overlay elements in all slices corresponding to that object.
Render in all frames	Display overlay elements in all frames, irrespective of whether each object is present in that frame.
Enable multithreading	Process multiple overlay elements simultaneously. This can provide a speed improvement when working on a computer with a multi-core CPU.