# MultiBoxRegion3D

The MultiBoxRegion3D 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 Region3D structure that stores up to four fixtured 3D boxes.

It returns a Region3D structure containing the settings of the fixtured 3D box(es).

Inputs

The MultiBoxRegion3D function has the following syntax:

MultiBoxRegion3D(PointCloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition.,Fixture3D,ExternalFixture,NumberOfBoxes,Box3D0,ExternalBox0,Box3D1,ExternalBox1,Box3D2,ExternalBox2,Box3D3,ExternalBox3,Show)

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.
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.
Number of Boxes | Specifies the number of boxes used for specifying the region(s). The value range is 1–4 and the default value is 1 (that is, a single box will be used for specifying the region). Note: If this parameter is set to 1, then only the first Box 3D and External Box parameters will be enabled.
Box3D 0 | Specifies the size and position of the (first) 3D box structure to use for specifying the region. It is offset from the origin of the configured Fixture3D structure with the following arguments.
SizeX | The size of the box along the X-axis of Fixture3D. The value range is 0.001 to inf.
SizeY | The size of the box along the Y-axis of Fixture3D. The value range is 0.001 to inf.
SizeZ | The size of the box along the Z-axis of Fixture3D. The value range is 0.001 to inf.
X | Offset on the X-axis from the Fixture3D origin. The value range is -inf. to inf.
Y | Offset on the Y-axis from the Fixture3D origin. The value range is -inf. to inf.
Z | Offset on the Z-axis from the Fixture3D origin. The value range is -inf. to inf.
Rotation | Specifies the box's in-plane rotation (in degrees) about the 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 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.
Note: This parameter is available only if External Box 0 is set to 0.
External Box 0 | Specifies a reference to a Box3D structure defined in another cell to be used as the (first) region of the function. Set to 0 (OFF) to use the function's internal Box3D structure for configuring the region.
Box3D 1 | Specifies the size and position of the second 3D box structure to use for specifying the region. It is offset from the origin of the configured Fixture3D structure with the following arguments.
SizeX | The size of the box along the X-axis of Fixture3D. The value range is 0.001 to inf.
SizeY | The size of the box along the Y-axis of Fixture3D. The value range is 0.001 to inf.
SizeZ | The size of the box along the Z-axis of Fixture3D. The value range is 0.001 to inf.
X | Offset on the X-axis from the Fixture3D origin. The value range is -inf. to inf.
Y | Offset on the Y-axis from the Fixture3D origin. The value range is -inf. to inf.
Z | Offset on the Z-axis from the Fixture3D origin. The value range is -inf. to inf.
Rotation | Specifies the box's in-plane rotation (in degrees) about the 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 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.
Note: This parameter is available only if External Box 1 is set to 0.
External Box 1 | Specifies a reference to a Box3D structure defined in another cell to be used as the second region of the function. Set to 0 (OFF) to use the function's internal Box3D structure for configuring the region.
Box3D 2 | Specifies the size and position of the third 3D box structure to use for specifying the region. It is offset from the origin of the configured Fixture3D structure with the following arguments.
SizeX | The size of the box along the X-axis of Fixture3D. The value range is 0.001 to inf.
SizeY | The size of the box along the Y-axis of Fixture3D. The value range is 0.001 to inf.
SizeZ | The size of the box along the Z-axis of Fixture3D. The value range is 0.001 to inf.
X | Offset on the X-axis from the Fixture3D origin. The value range is -inf. to inf.
Y | Offset on the Y-axis from the Fixture3D origin. The value range is -inf. to inf.
Z | Offset on the Z-axis from the Fixture3D origin. The value range is -inf. to inf.
Rotation | Specifies the box's in-plane rotation (in degrees) about the 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 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.
Note: This parameter is available only if External Box 2 is set to 0.
External Box 2 | Specifies a reference to a Box3D structure defined in another cell to be used as the third region of the function. Set to 0 (OFF) to use the function's internal Box3D structure for configuring the region.
Box3D 3 | Specifies the size and position of the fourth 3D box structure to use for specifying the region. It is offset from the origin of the configured Fixture3D structure with the following arguments.
SizeX | The size of the box along the X-axis of Fixture3D. The value range is 0.001 to inf.
SizeY | The size of the box along the Y-axis of Fixture3D. The value range is 0.001 to inf.
SizeZ | The size of the box along the Z-axis of Fixture3D. The value range is 0.001 to inf.
X | Offset on the X-axis from the Fixture3D origin. The value range is -inf. to inf.
Y | Offset on the Y-axis from the Fixture3D origin. The value range is -inf. to inf.
Z | Offset on the Z-axis from the Fixture3D origin. The value range is -inf. to inf.
Rotation | Specifies the box's in-plane rotation (in degrees) about the 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 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.
Note: This parameter is available only if External Box 3 is set to 0.
External Box 3 | Specifies a reference to a Box3D structure defined in another cell to be used as the third region of the function. Set to 0 (OFF) to use the function's internal Box3D structure for configuring the region.
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 Region3D structure containing the parameters of the configured 3D region(s).
Results | A ❒Region3D structure, containing the settings of the configured region(s), or #ERR if any of the parameters have been configured incorrectly.