# PlaneFromPoints3D

The PlaneFromPoints3D function Functions are tools that are available in Spreadsheet for processing and analyzing acquisitions or other results. You can add functions to your Spreadsheet job to create tool chains and produce results for specific applications. is used to construct a plane from 3 Point3D structures specified in the function's parameters. The constructed plane is returned in a Plane3D structure.

Inputs

The PlaneFromPoints3D function has the following syntax:

PlaneFromPoints3D(PointCloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition.,Point3D0,ExternalPoint0,Point3D1,ExternalPoint1,Point3D2,ExternalPoint2,Show)

See the table for a description of the available parameters.

Parameter | Description
PointCloud | Reference to a cell containing a point cloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition.. The default value is $A$0.
Point3D 0 | Specifies the offset of the first 3D point to use. It is offset from the PointCloud origin in the following format with the following arguments: {X, Y, Z}
X | Offset on the X-axis from the PointCloud origin.
Y | Offset on the Y-axis from the PointCloud origin.
Z | Offset on the Z-axis from the PointCloud origin.
Note: This parameter is only available if External Point 0 is set to 0.
External Point 0 | Specifies a reference to a Point3D structure defined in another cell for the first 3D point to use in constructing the plane. Set to 0 (OFF) to use the function's internal Point3D structure.
Point3D 1 | Specifies the offset of the second 3D point to use. It is offset from the PointCloud origin in the following format with the following arguments: {X, Y, Z}
X | Offset on the X-axis from the PointCloud origin.
Y | Offset on the Y-axis from the PointCloud origin.
Z | Offset on the Z-axis from the PointCloud origin.
Note: This parameter is only available if External Point 1 is set to 0.
External Point 1 | Specifies a reference to a Point3D structure defined in another cell for the second 3D point to use in constructing the plane. Set to 0 (OFF) to use the function's internal Point3D structure.
Point3D 2 | Specifies the offset of the third 3D point to use. It is offset from the PointCloud origin in the following format with the following arguments: {X, Y, Z}
X | Offset on the X-axis from the PointCloud origin.
Y | Offset on the Y-axis from the PointCloud origin.
Z | Offset on the Z-axis from the PointCloud origin.
Note: This parameter is only available if External Point 2 is set to 0.
External Point 2 | Specifies a reference to a Point3D structure defined in another cell for the third 3D point to use in constructing the plane. Set to 0 (OFF) to use the function's internal Point3D structure.
Show | Selects the type of graphics to overlay on the image.
0 = hide all (default) | All graphics are hidden, except when the cell containing the function is highlighted in the spreadsheet.
1 = result graphics only | The result graphics of the function are displayed at all times.
2 = input and result graphics | The region of interest, the input data and the results are displayed at all times.

(Outputs

Returns | A Plane3D data structure containing the constructed 3D plane, or #ERR if any of the input parameters are invalid.
Results | When initially inserted into a cell, the following functions are automatically inserted into the spreadsheet to create a result table.
| X | Y | Z | Tilt | Tilt Direction
❒Plane3D | GetX(Plane3D) | GetY(Plane3D) | GetZ(Plane3D) | GetTilt(Plane3D) | GetTiltDirection(Plane3D)

(Vision Data Access functions

The following Structures 3D Vision Data Access functions are automatically inserted into the spreadsheet to create the result table:

Function | Description
GetX(Plane3D) | Returns the X-axis coordinate of the 3D plane's center point.
GetY(Plane3D) | Returns the Y-axis coordinate of the 3D plane's center point.
GetZ(Plane3D) | Returns the Z-axis coordinate of the 3D plane's center point.
GetTiltDirection(Plane3D) | Returns the tilt direction angle of the specified Plane3D structure in degrees. The angle is measured in the X-Y plane of the original reference coordinate system, and specifies the direction for the projection of the tilted Z-axis onto that plane.
GetTilt(Plane3D) | Returns the tilt angle of the Plane3D structure in degrees on the Z-axis.