mecheye.area_scan_3d_camera.Frame3D¶

class mecheye.area_scan_3d_camera.Frame3D(*args)¶

SDK Frame3D object, serialized for regular and free-threaded Python.

image_size()¶: Return the frame’s image Size in pixels.

frame_id()¶: Return the SDK capture frame identifier.

is_empty()¶: Return whether the SDK reports that the frame has no data.

clear()¶: Release the data held by this frame.

get_untextured_point_cloud()¶: Return the frame’s organized UntexturedPointCloud in the selected SDK unit.

get_untextured_point_cloud_with_normals()¶: Return the organized UntexturedPointCloudWithNormals container.

get_depth_map()¶: Return the frame’s DepthMap container with per-pixel Z coordinates.

get_orthogonal_depth_map()¶

Return [depth_map, x_scale, y_scale, x_offset, y_offset].

The SDK supplies an orthogonal depth grid and its scale and offset values.

save_untextured_point_cloud(fileFormat, fileName, isOrganized=False)¶

Export this frame’s point cloud with the SDK.

Parameters:

fileFormat – A FileFormat_PLY, FileFormat_PCD, or FileFormat_CSV value.
fileName – Destination filename.
isOrganized – Preserve the image grid when the format supports it.

Returns:

ErrorStatus; file errors are returned rather than printed.

save_untextured_point_cloud_with_normals(fileFormat, fileName, isOrganized=False)¶

Export this frame’s point cloud with the SDK.

Parameters:

fileFormat – A FileFormat_PLY, FileFormat_PCD, or FileFormat_CSV value.
fileName – Destination filename.
isOrganized – Preserve the image grid when the format supports it.

Returns:

ErrorStatus; file errors are returned rather than printed.

static save_point_cloud(*args)¶

Export an explicit point-cloud container without capturing a frame.

Arguments are (pointCloud, fileFormat, fileName, isOrganized=False, pointCloudUnit=CoordinateUnit_Millimeter). Pass the matching cloud type, including normals when using save_point_cloud_with_normals(). :return: ErrorStatus from the SDK file writer.

static save_point_cloud_with_normals(*args)¶

Export an explicit point-cloud container without capturing a frame.