Skip to content

Commit 2d19d0e

Browse files
mojomexmojomex
committed
docs: correct field types
1 parent d632287 commit 2d19d0e

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

‎docs/point_types.md

+31-31
Original file line numberDiff line numberDiff line change
@@ -7,42 +7,42 @@ These definitions can be found in the `nebula_common/include/point_types.hpp`.
77

88
## PointXYZIR
99

10-
| Field | Type | Units | Description |
11-
| ------------- | ------- | ----- | --------------------------------------------------------------------------- |
12-
| `x` | `float` | `m` | The point's cartesian x coordinate. |
13-
| `y` | `float` | `m` | The point's cartesian y coordinate. |
14-
| `z` | `float` | `m` | The point's cartesian z coordinate. |
15-
| padding | 4 bytes | | |
16-
| `intensity` | `uint8` | | The intensity of the return as reported by the sensor. |
17-
| `return type` | `uint8` | | Whether the point was the first, strongest, last, etc. of multiple returns. |
10+
| Field | Type | Units | Description |
11+
| ----------- | -------- | ----- | ---------------------------------------------------------------------------- |
12+
| `x` | `float` | `m` | The point's cartesian x coordinate. |
13+
| `y` | `float` | `m` | The point's cartesian y coordinate. |
14+
| `z` | `float` | `m` | The point's cartesian z coordinate. |
15+
| padding | 4 bytes | | |
16+
| `intensity` | `float` | | The intensity of the return as reported by the sensor. |
17+
| `ring` | `uint16` | | The ID of the ring the point is part of. Only defined for rotational LiDARs. |
1818

1919
## PointXYZICATR
2020

21-
| Field | Type | Units | Description |
22-
| ------------- | ------- | --------- | --------------------------------------------------------------------------- |
23-
| `x` | `float` | `m` | The point's cartesian x coordinate. |
24-
| `y` | `float` | `m` | The point's cartesian y coordinate. |
25-
| `z` | `float` | `m` | The point's cartesian z coordinate. |
26-
| padding | 4 bytes | | |
27-
| `intensity` | `uint8` | | The intensity of the return as reported by the sensor. |
28-
| `channel` | `uint8` | | The ID of the laser channel that produced the point. |
29-
| `azimuth` | `float` | `degrees` | azimuth in polar coordinates. |
30-
| `timestamp` | `float` | `ns` | The time the point was detected relative to the pointcloud timestamp. |
31-
| `return type` | `uint8` | | Whether the point was the first, strongest, last, etc. of multiple returns. |
21+
| Field | Type | Units | Description |
22+
| ------------- | -------- | --------- | --------------------------------------------------------------------------- |
23+
| `x` | `float` | `m` | The point's cartesian x coordinate. |
24+
| `y` | `float` | `m` | The point's cartesian y coordinate. |
25+
| `z` | `float` | `m` | The point's cartesian z coordinate. |
26+
| padding | 4 bytes | | |
27+
| `intensity` | `uint8` | | The intensity of the return as reported by the sensor. |
28+
| `channel` | `uint16` | | The ID of the laser channel that produced the point. |
29+
| `azimuth` | `float` | `degrees` | azimuth in polar coordinates. |
30+
| `timestamp` | `uint32` | `ns` | The time the point was detected relative to the pointcloud timestamp. |
31+
| `return type` | `uint8` | | Whether the point was the first, strongest, last, etc. of multiple returns. |
3232

3333
## PointXYZIRADT
3434

35-
| Field | Type | Units | Description |
36-
| ------------- | ------- | --------- | --------------------------------------------------------------------------- |
37-
| `x` | `float` | `m` | The point's cartesian x coordinate. |
38-
| `y` | `float` | `m` | The point's cartesian y coordinate. |
39-
| `z` | `float` | `m` | The point's cartesian z coordinate. |
40-
| padding | 4 bytes | | |
41-
| `intensity` | `uint8` | | The intensity of the return as reported by the sensor. |
42-
| `return type` | `uint8` | | Whether the point was the first, strongest, last, etc. of multiple returns. |
43-
| `azimuth` | `float` | `degrees` | The point's azimuth in polar coordinates. |
44-
| `distance` | `float` | `m` | The point's distance from the sensor origin. |
45-
| `timestamp` | `float` | `ns` | The time the point was detected relative to the pointcloud timestamp. |
35+
| Field | Type | Units | Description |
36+
| ------------- | -------- | --------- | --------------------------------------------------------------------------- |
37+
| `x` | `float` | `m` | The point's cartesian x coordinate. |
38+
| `y` | `float` | `m` | The point's cartesian y coordinate. |
39+
| `z` | `float` | `m` | The point's cartesian z coordinate. |
40+
| padding | 4 bytes | | |
41+
| `intensity` | `float` | | The intensity of the return as reported by the sensor. |
42+
| `return type` | `uint8` | | Whether the point was the first, strongest, last, etc. of multiple returns. |
43+
| `azimuth` | `float` | `degrees` | The point's azimuth in polar coordinates. |
44+
| `distance` | `float` | `m` | The point's distance from the sensor origin. |
45+
| `timestamp` | `double` | `ns` | The time the point was detected relative to the pointcloud timestamp. |
4646

4747
## NebulaPoint = PointXYZIRCAEDT
4848

@@ -57,4 +57,4 @@ These definitions can be found in the `nebula_common/include/point_types.hpp`.
5757
| `azimuth` | `float` | `rad` | The point's azimuth in polar coordinates. |
5858
| `elevation` | `float` | `rad` | The point's elevation in polar coordinates. |
5959
| `distance` | `float` | `m` | The point's distance from the sensor origin. |
60-
| `timestamp` | `float` | `ns` | The time the point was detected relative to the pointcloud timestamp. |
60+
| `timestamp` | `uint32` | `ns` | The time the point was detected relative to the pointcloud timestamp. |

0 commit comments

Comments
 (0)