# Box3D

The Box3D 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. allows you to create a fixtured 3D box in the point cloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition..

It returns a Box3D structure containing the settings of the fixtured 3D box.

Inputs

The Box3D function has the following syntax:

Box3D(PointCloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition.,Fixture3D,ExternalFixture,Box3D,Show)

Parameter | Description
PointCloud | Reference to a cell containing a point cloud. The default value is $A$0.
Fixture3D | Specifies the point cloud coordinate system in which the 3D fixture A fixture is a coordinate location on the image that keeps the tool in the place determined by the fixture. is defined. It is offset from the PointCloud origin in the following format with the following arguments: {X, Y, Z, Rotation, Tilt, TiltDirection}
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.
Rotation | Specifies the in-plane rotation in degrees around the PointCloud Z-axis. The value range is -180 to 180. The tool normalizes external references with values outside the allowed range to the allowed range.
Tilt | Specifies the tilt angle in degrees from the PointCloud Z-axis after rotation. The value range is 0-180. External references with values outside the allowed range result in an error.
Tilt Direction | Specifies the direction of tilt in degrees from the rotated PointCloud X-axis of the tool, around the PointCloud Z-axis of the tool. The value range is -180 to 180. The tool normalizes external references with values outside the allowed range to the allowed range.
Note: The Fixture3D parameter is only available if you set External Fixture to 0. Note: You can use the Fixture3D parameter to set the ROI fixture.
External Fixture | Specifies a reference to a Fixture3D structure defined in another cell. The function uses the referenced cell as the fixture of the function. Set to 0 (OFF) to use the internal fixture of the function instead.
Box3D | Specifies the dimensions, offset and angle of the function's 3D box. It is offset from the Fixture3D origin in the following format with the following arguments: {SizeX, SizeY, X, Y, Z, Rotation, Tilt, TiltDirection}
SizeX | The size of the box along the Fixture3D X-axis.
SizeY | The size of the box along the Fixture3D Y-axis .
SizeZ | The size of the box along the Fixture3D Z-axis.
X | Offset on the X-axis from the Fixture3D origin.
Y | Offset on the Y-axis from the Fixture3D origin.
Z | Offset on the Z-axis from the Fixture3D origin.
Rotation | Specifies the box's in-plane rotation (in degrees) about the tool's Fixture3D Z-axis. The value range is -360 to 360. External references with values outside the allowed range will be normalized to the allowed range.
Tilt | Specifies the box's tilt angle (in degrees) from the tool's Fixture3D Z-axis after rotation. The value range is 0 - 180. External references with values outside the allowed range will result in an error.
Tilt Direction | Specifies the box's direction of tilt (in degrees) from the tool's rotated Fixture3D X-axis, about the tool's Fixture3D Z-axis. The value range is -360 to 360. External references with values outside the allowed range will be normalized to the allowed range.
Show | Selects the type of graphics to overlay on the image.
0 = hide all (default) | All graphics will be hidden, except when the cell containing the function is highlighted in the spreadsheet.
2 = input graphics only | The input data will be displayed at all times.

Outputs

Returns | A Box3D data structure containing the constructed 3D box, 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.
| SizeX | SizeY | SizeZ | X | Y | Z | Rotation | Tilt | Tilt Direction
❒Box3D | GetSizeX(Box3D) | GetSizeY(Box3D) | GetSizeZ(Box3D) | GetX(Box3D) | GetY(Box3D) | GetZ(Box3D) | GetRotation(Box3D) | GetTilt(Box3D) | GetTiltDirection(Box3D)

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
GetSizeX(Box3D) | Returns the size of the 3D box along the X-axis.
GetSizeY(Box3D) | Returns the size of the 3D box along the Y-axis.
GetSizeZ(Box3D) | Returns the size of the 3D box along the Z-axis.
GetX(Box3D) | Returns the X-axis coordinate of the center of the 3D box.
GetY(Box3D) | Returns the Y-axis coordinate of the center of the 3D box.
GetZ(Box3D) | Returns the Z-axis coordinate of the center of the 3D box.
GetRotation(Box3D) | Returns the rotation of the Z-axis in degrees, also known as the in-plane rotation.
GetTilt(Box3D) | Returns the tilt angle of the Box3D structure in degrees on the Z-axis.
GetTiltDirection(Box3D) | Returns the tilt direction angle of the specified Box3D 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.