Skip to content

Commit 42b9825

Browse files
authored
docs: add document for lidarseg directory (#237)
* docs: add lidarseg document Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp> * docs: resolve warnings for mkdocstrings Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp> --------- Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
1 parent da414da commit 42b9825

2 files changed

Lines changed: 45 additions & 29 deletions

File tree

docs/schema/index.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

55
```shell
66
<DATASET_ID>/
7-
└── <DATASET_VERSION>
8-
├── annotation ...schema tables in JSON format
9-
├── data ...sensor raw data
10-
├── input_bag ...original ROS bag file
11-
├── map ...map files
12-
└── status.json ...dataset status information
7+
└── <DATASET_VERSION>/
8+
├── annotation/ ...schema tables in JSON format
9+
├── data/ ...sensor raw data
10+
├── input_bag/ ...original ROS bag file
11+
├── map/ ...map files
12+
├── lidarseg/ ...[OPTIONAL] LiDAR segmentation annotation
13+
└── status.json ...dataset status information
1314
```
1415

1516
## Schema Tables
@@ -32,8 +33,22 @@ It is structured as follows:
3233

3334
```shell
3435
map/
35-
├── lanelet2_map.osm
36-
└── pointcloud_map.pcd
36+
├── lanelet2_map.osm ...lanelet2 map file
37+
└── pointcloud_map.pcd/ ...pointcloud map directory
38+
```
39+
40+
## LiDAR Segmentation Annotation
41+
42+
T4 dataset can include 3D LiDAR segmentation annotation optionally.
43+
The format is exactly the same as the [nuScenes format](https://www.nuscenes.org/nuscenes) with one additional `lidarseg.json` file.
44+
45+
Note that every `<lidarseg_token>.bin` consists of category labels for every LiDAR pointcloud at a keyframe.
46+
47+
```shell
48+
lidarseg/
49+
└── annotation/
50+
├── <lidarseg_token>.bin ...category labels for every LiDAR pointcloud at a keyframe
51+
...
3752
```
3853

3954
## status.json

mkdocs.yaml

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -64,27 +64,28 @@ plugins:
6464
- https://numpy.org/doc/stable/objects.inv
6565
- https://ipython.readthedocs.io/en/stable/objects.inv
6666
options:
67-
# general
68-
filters: ["!^_"]
69-
show_bases: false
70-
show_source: true
71-
# headings
72-
heading_level: 2
73-
parameter_headings: false
74-
show_root_heading: true
75-
show_symbol_type_heading: true
76-
show_symbol_type_toc: true
77-
# members
78-
inherited_members: false
79-
members_order: source # The order of class members
80-
# docstrings
81-
docstring_style: google
82-
docstring_section_style: list # list spacy table
83-
merge_init_into_class: true
84-
# signatures
85-
separate_signature: true
86-
show_signature_annotations: true
87-
show_overload: true
67+
extra:
68+
# general
69+
filters: ["!^_"]
70+
show_bases: false
71+
show_source: true
72+
# headings
73+
heading_level: 2
74+
parameter_headings: false
75+
show_root_heading: true
76+
show_symbol_type_heading: true
77+
show_symbol_type_toc: true
78+
# members
79+
inherited_members: false
80+
members_order: source # The order of class members
81+
# docstrings
82+
docstring_style: google
83+
docstring_section_style: list # list spacy table
84+
merge_init_into_class: true
85+
# signatures
86+
separate_signature: true
87+
show_signature_annotations: true
88+
show_overload: true
8889

8990
markdown_extensions:
9091
- pymdownx.highlight:

0 commit comments

Comments
 (0)