Get Segment Properties

Use this tool to get properties of one or more segments.

The properties representing positions or lengths are returned in pixels by default. However, if a segment ROI is connected from a tool with calibration data, the position and length properties of the segment is returned in the respective world coordinate, e.g., "mm".

Parameters

Basic Parameters

Image:

This parameter represents the input image containing the segment ROI.

Segment:

This parameter defines the segment region(s) of interest (ROIs) for the processing. By default no ROI is defined. To define the segments to be checked, you either have to connect the parameter to an appropriate ROI result of a previous tool or you have to draw new ROIs into the image using the available ROI buttons.

Results

Basic Results

X Start:

This result contains the start position of the segment in x-direction. The result is returned in pixels. if there is no unit specified for the ROI. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

Y Start:

This result contains the start position of the segment in y-direction. The result is returned in pixels. if there is no unit specified for the ROI. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

X End:

This result contains the end position of the segment in x-direction. The result is returned in pixels. if there is no unit specified for the ROI. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

Y End:

This result contains the end position of the segment in y-direction. The result is returned in pixels. if there is no unit specified for the ROI. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

Length:

This result contains the length of the segment in pixels. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

Orientation:

This result returns the information how far and in which direction the Segment is rotated in form of an angle in degrees. Without calibration or a left handed coordinate system, positive values indicate a clockwise rotation, negative values indicate a counterclockwise rotation. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

X Center:

This result contains the position of the center of the segment in x-direction. The result is returned in pixels.. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

Y Center:

This result contains the position of the center of the segment in y-direction. The result is returned in pixels.. If more than one segment was processed via the parameter Segment, a tuple of values is returned.

Tool State:

"Tool State" returns information about the state of the tool and thus can be used for error handling. For more information, see Tool State Result

Additional Results

Processing Time:

This result returns the duration of the most recent execution of the tool in milliseconds. The result is provided as additional result. Therefore, it is hidden by default but it can be displayed via the button beside the tool results. For more information see the section Processing Time in the tool reference overview.