Skip to content

Commit

Permalink
Merge branch '174-list-of-available-buffer-wrong-in-doc' into 'main'
Browse files Browse the repository at this point in the history 
Add forgotten buffer to documentation

Closes #326, #285, and #280

See merge request syntron/support/csr/ifm3d/ifm3d!395
  • Loading branch information
@lola-masson
lola-masson committed Aug 1, 2024
2 parents 70d8f0d + aa15ed8 commit 8b59e86
Showing 1 changed file with 19 additions and 18 deletions.
37 changes: 19 additions & 18 deletions doc/sphinx/content/manip_images/buffer_ids.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,25 @@ In this tables, the NA abbreviation stands for "Not Applicable."

## O3D Available buffers

| `buffer_id` | Description | Native or calculated in ifm3d |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `AMPLITUDE_IMAGE` | 2D image containing amplitude information for each pixel. | Native |
| `CARTESIAN_X_COMPONENT` | Cartesian coordinate along X axis. | Calculated |
| `CARTESIAN_Y_COMPONENT` | Cartesian coordinate along Y axis. | Calculated |
| `CARTESIAN_Z_COMPONENT` | Cartesian coordinate along Z axis. | Calculated |
| `CONFIDENCE_IMAGE` | 2D image containing information about each pixel status. | Native |
| `DIAGNOSTIC` | Provides some diagnostic information. See [details below](#diagnostic-buffer). | Native |
| `EXPOSURE_TIME` | Exposure times used for the last frame. | Calculated |
| `EXTRINSIC_CALIB` | Current values of the optical system to user coordinate transformation for the port currently targeted by the `FrameGrabber`. | Calculated |
| `INTRINSIC_CALIB` | The intrinsic parameters for the port or camera currently targeted by the`FrameGrabber`. | Native |
| `INVERSE_INTRINSIC_CALIBRATION` | The inverse intrinsic parameters for the port or camera currently targeted by the`FrameGrabber`. | Native |
| `JSON_DIAGNOSTIC` | Diagnostic information in JSON format. | Native |
| `JSON_MODEL` | For internal use only. | ?? |
| `NORM_AMPLITUDE_IMAGE` | The normalized amplitude image. | Native |
| `RADIAL_DISTANCE_IMAGE` | 2D image containing the radial distance value for each pixel. | Native |
| `UNIT_VECTOR_ALL` | Unit vectors that can be used to calculate the point cloud directly from the distance image. | Native |
| `XYZ` | The point cloud in Cartesian coordinates. | Calculated |
| `buffer_id` | Description | Native or calculated in ifm3d |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `AMPLITUDE_IMAGE` | 2D image containing amplitude information for each pixel. | Native |
| `CARTESIAN_X_COMPONENT` | Cartesian coordinate along X axis. | Calculated |
| `CARTESIAN_Y_COMPONENT` | Cartesian coordinate along Y axis. | Calculated |
| `CARTESIAN_Z_COMPONENT` | Cartesian coordinate along Z axis. | Calculated |
| `CONFIDENCE_IMAGE` | 2D image containing information about each pixel status. | Native |
| `DIAGNOSTIC` | Provides some diagnostic information. See [details below](#diagnostic-buffer). | Native |
| `EXPOSURE_TIME` | Exposure times used for the last frame. | Calculated |
| `EXTRINSIC_CALIB` | Current values of the optical system to user coordinate transformation for the port currently targeted by the `FrameGrabber`. | Calculated |
| `ILLUMINATION_TEMP` | The temperature of the illumination module | Native |
| `INTRINSIC_CALIB` | The intrinsic parameters for the port or camera currently targeted by the`FrameGrabber`. | Native |
| `INVERSE_INTRINSIC_CALIBRATION` | The inverse intrinsic parameters for the port or camera currently targeted by the`FrameGrabber`. | Native |
| `JSON_DIAGNOSTIC` | Diagnostic information in JSON format. | Native |
| `JSON_MODEL` | For internal use only. | ?? |
| `NORM_AMPLITUDE_IMAGE` | The normalized amplitude image. | Native |
| `RADIAL_DISTANCE_IMAGE` | 2D image containing the radial distance value for each pixel. | Native |
| `UNIT_VECTOR_ALL` | Unit vectors that can be used to calculate the point cloud directly from the distance image. | Native |
| `XYZ` | The point cloud in Cartesian coordinates. | Calculated |

:::{note}
The `CARTESIAN_ALL` buffer is deprecated, and the `XYZ` buffer should be used instead.
Expand Down

0 comments on commit 8b59e86

Please sign in to comment.