Surface Plane

The Plane tool provides measurements that report a plane's position and orientation (X Angle, Y Angle, Z Offset, Normal, Distance), as well as the maximum and average deviations from the plane.

The Z offset reported is the Z position at zero position on the X axis and the Y axis.

The results of the Angle X and Angle Y measurements can be used to manually customize the tilt angle in the Hole, Opening, and Stud tools.

For information on adding, managing, and removing tools, as well as detailed descriptions of settings common to most tools, see Tool Configuration.

Inputs

You configure the tool's inputs in the expandable Inputs section.

To use a measurement as an anchor, it must be enabled and properly configured in the tool providing the anchor. For more information on anchoring, see Measurement Anchoring.

Inputs
Name	Description
Enable Batching	When Enable Batching is checked, the tool takes an array as input and processes each surface in the array individually. There is no limit to the size of the array, other than processing limitations of the sensor. When Enable Batching is unchecked, the tool takes either a single surface, or an array of surfaces with any number of elements. If the input is an array, the tool will aggregate the data in the array, and process that data as a whole. For more information on arrays, batching, and aggregating, see Arrays, Batching, and Aggregation.
Surface Input	The data the tool applies measurements to or processes. This tool can optionally take an array as input. For more information, see Arrays, Batching, and Aggregation.
Anchor X Anchor Y Anchor Z	The X, Y, or Z measurement of another tool that this tool uses as a positional anchor. Positional anchors are optional.
Anchor Z Angle	The Z Angle measurement of another tool to use as a rotational anchor for this tool. Rotational anchors are optional.

Parameters

The following parameters are in the expandable Parameters section in the tool's configuration.

Parameters
Parameter	Description
Regions	When expanded, displays the region- and mask-related settings.
Enable	Enables regions and displays the region- and mask-related settings (see below).
Mask Mode Number of Regions Region Type {n} Region {n}	When you enable regions (see above), the tool displays additional settings related to the region type. For details on the regions supported by this tool and their settings, see Flexible Regions. For general information on regions and the difference between standard and "flexible" regions, see Regions.
External ID	The external ID of the tool that appears in GoHMI Designer. For more information, see GoHMI and GoHMI Designer.

Outputs

Outputs section with a measurement expanded to show user-configurable decision min/max fields and an external ID

You configure the Min and Max parameters by expanding the measurement in the Outputs section. In order for a measurement to return a Pass decision, the measurement must be between maximum and minimum values; the range is inclusive.

Measurements
Measurement	Illustration
X Angle Determines the X angle of the surface with respect to the alignment target.
Y Angle Determines the Y angle of the surface with respect to the alignment target.
Z Offset Determines the Z value of intersection of the plane and the Z axis.
Standard Deviation Measures the standard deviation of the points of the surface from the detected plane within the specified region or regions.
Min Error Measures the minimum error from the detected plane (the maximum distance below the plane, perpendicular to the plane) within the specified region or regions.
Max Error Measures the maximum error from the detected plane (the maximum distance above the plane, perpendicular to the plane) within the specified region or regions.
Normal X Returns the X component of the surface normal vector.
Normal Y Returns the Y component of the surface normal vector.
Normal Z Returns the Z component of the surface normal vector.
Distance Distance from the origin to the plane.

Features
Type	Description
Plane	The fitted plane.

For more information on geometric features, see Geometric Features.