# ProfileArea3D

The ProfileArea3D function allows you to measure the area between a profile and a user-defined line in a Profile3D structure.

The ProfileArea3D function requires an existing Profile3D structure as input. You can also define a Region of Interest within the profile to narrow down the analysis and provide more specific results.

3D Point Cloud with ProfileArea3D | Profile View

The ProfileArea3D function also allows you to use an external ProfileFixture3D input, which ensures that the function measures the same profile area for each acquisition. The ProfileArea3D function can use the profile fixture to align the Profile Region and the Profile Line, and produce consistent results regardless of positioning inconsistencies in the acquisition.

The ProfileArea3D function produces a measurement value in square units, as well as Point3D structures for minimum and maximum points on both profile axes.

Inputs

The ProfileArea3D function has the following syntax:

ProfileArea3D(Profile3D, ProfileFixture3D, ExternalProfileFixture3D, ProfileRegion, AreaMeasurementMode, FillMarkedGaps, GapSizeThreshold, NudgeDistance, ProfileLine, ExternalLine, Show)

Parameter | Description
External Profile | Specifies the Profile3D structure to use.
Profile Fixture | Specifies the coordinates defining the profile fixture. It is offset from the profile origin in the following format with the following arguments: {Xp, Zp, Angle}
X | Offset on the X-axis from the profile origin.
Z | Offset on the Z-axis from the profile origin.
Angle | Specifies the in-plane rotation in degrees around the Y-axis of the profile origin. The value range is 0 to 180.
Note: This parameter is only available if you set External Profile Fixture to 0.
External Profile Fixture | Specifies a reference to a ProfileFixture3D structure defined in another cell. The function uses the ProfileFixture3D cell as the profile fixture of the function. Set to 0 (OFF) to use the internal profile fixture of the function instead.
Profile Region | Specifies the dimensions, offset and angle for the Profile Region of the function. The Profile Region is offset from the profile origin or the external fixture in the following format with the following arguments: {SizeXp, SizeZp, Xp, Zp, Angle}
SizeXp | The size of the Profile Region along the profile X-axis.
SizeZp | The size of the Profile Region along the profile Z-axis.
Xp | Offset on the X-axis from the profile origin.
Zp | Offset on the Z-axis from the profile origin.
Area Measurement Mode | Specifies the mode of measurement: Above(0) - measures the profile area above the profile line. Below(1) - measures the profile area below the profile line. Above plus Below(2) - measures the profile area both above and below the profile line. Above minus Below(3) - measures the profile area above the profile line, and subtracts the profile area below the profile line.
Fill Marked Gaps | Enables or disables filling gaps in the profile.
Gap Size Threshold | Specifies the maximum gap size threshold for filling gaps in the profile. Note: This parameter is only available if you enable Fill Marked Gaps.
Nudge Distance | Specifies a Zp-axis offset for the profile line.
Profile Line | Specifies the start and end point coordinates for the profile line to use:
Xp0 | X-axis coordinate value for the start point of the profile line in the profile coordinate space.
Zp0 | Z-axis coordinate value for the start point of the profile line in the profile coordinate space.
Xp1 | X-axis coordinate value for the end point of the profile line in the profile coordinate space.
Zp1 | Z-axis coordinate value for the end point of the profile line in the profile coordinate space.
Note: This parameter is available only if External Line is set to 0.
External Line | Specifies a reference to a Line3D structure defined in another cell. The function uses the Line3D structure as the profile line. Set to 0 (OFF) to manually define the profile line coordinates instead. Note: Profile Fixture and External Profile Fixture settings do not affect External Line references. Only manually defined profile lines use the profile fixture coordinates.
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 | An area measurement value, 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:
| Area | Min Xp Point | Max Xp Point | Min Zp Point | Max Zp Point
❒ProfileArea3D | GetArea(Profile3D) | ❒Point3D | ❒Point3D | ❒Point3D | ❒Point3D

Vision Data Access functions

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

Function | Description
GetArea(ProfileArea3D) | Returns the size of the profile area.
GetMinimumXPoint(ProfileArea3D) | Returns the point with the smallest X-axis value in the profile area.
GetMaximumXPoint(ProfileArea3D) | Returns the point with the largest X-axis value in the profile area.
GetMinimumZPoint(ProfileArea3D) | Returns the point with the smallest Z-axis value in the profile area.
GetMaximumZPoint(ProfileArea3D) | Returns the point with the largest Z-axis value in the profile area.