Get local object region

Creates a local object region (sphere or circle) for each object in a specified object collection.

Description

Creates a local object region (sphere or circle) for each object in a specified object collection. The radius of each local region can be based on a fixed value, or taken from an object measurement. Similarly, the output sphere or circle can either be centred on the input object centroid or a location specified by XYZ measurements. Local object regions are stored as children of their respective input object.

Parameters

ParameterDescription
Input objectsObject collection from the workspace for which local object regions will be generated. One region will be generated for each object and assigned as a child of the respective input object.
Output objectsOutput local region objects to add to the workspace. Each local object region is a sphere with centroid coincident with the centroid of the corresponding input object. These objects are assigned as a child of their respective input object.
Centoid value sourceControls how the centroid location of the output sphere/circle is defined:
  • "Fixed value" A specific centroid location, defined by "X position", "Y position" and "Z position", will be used for all objects.
  • "Measurement" The centroid will be equal to the values of specific measurements (specified by "X-measurement", "Y-measurement" and "Z-measurement") associated with the object being measured. Centroids will potentially be different for each object.
  • "Object centroid" The output objects will be centred on the centroid of the corresponding input object.
  • "Parent measurement" The centroid will be equal to the values of specific measurements (specified by "X-measurement", "Y-measurement" and "Z-measurement") associated a parent of the object being measured (specified by "Parent object for centroid"). Centroids will potentially be different for each object.
X positionFixed X-coordinate of the centroid to use for generating all local object regions when "Centoid value source" is in "Fixed value" mode.
Y positionFixed Y-coordinate of the centroid to use for generating all local object regions when "Centoid value source" is in "Fixed value" mode.
Z positionFixed Z-coordinate of the centroid to use for generating all local object regions when "Centoid value source" is in "Fixed value" mode.
X-measurementMeasurement associated with the input or specified parent object. This will be used as X-centroid for generating the local object region when "Centoid value source" is in "Measurement" or "Parent measurement" mode.
Y-measurementMeasurement associated with the input or specified parent object. This will be used as Y-centroid for generating the local object region when "Centoid value source" is in "Measurement" or "Parent measurement" mode.
Z-measurementMeasurement associated with the input or specified parent object. This will be used as Z-centroid for generating the local object region when "Centoid value source" is in "Measurement" or "Parent measurement" mode.
Parent object for centroidParent object of the input object being processed. This parent will provide the measurements (specified by "X-measurement", "Y-measurement" and "Z-measurement") to be used as the spot centroid location for generating the local object region when "Centoid value source" is in "Parent measurement" mode.
Centroid spatial unitsControls whether spot centroid values (irrespective of whether they are fixed values, measurements or parent measurements) are assumed to be specified in calibrated units (as defined by the "Input control" parameter "Spatial unit") or pixel units.
Radius value sourceControls how the radius of the output sphere/circle is defined:
  • "Fixed value" A single radius, defined by "Radius (px)", will be used for all objects.
  • "Measurement" The radius will be equal to the value of a measurement (specified by "Radius measurement") associated with the object being measured. Radii will potentially be different for each object.
  • "Parent measurement" The radius will be equal to the value of a measurement (specified by "Radius measurement") associated a parent of the object being measured (specified by "Parent object for radius"). Radii will potentially be different for each object.
  • "Single point" The output objects will all be a single point corresponding to the centroid of the input object.
Radius (px)Fixed spot radius to use for generating all local object regions when "Radius value source" is in "Fixed value" mode.
Radius measurementMeasurement associated with the input or specified parent object. This will be used as spot the radius for generating the local object region when "Radius value source" is in "Measurement" or "Parent measurement" mode.
Parent object for radiusParent object of the input object being processed. This parent will provide the measurement (specified by "Radius measurement") to be used as the spot radius for generating the local object region when "Radius value source" is in "Parent measurement" mode.
Radius spatial unitsControls whether spot radius values (irrespective of whether they are fixed values, measurements or parent measurements) are assumed to be specified in calibrated units (as defined by the "Input control" parameter "Spatial unit") or pixel units.