Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refactoring integration pages #493

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ nav:
- Introduction: index.md
- installation
- tutorials
- integration
- how-to-guides
- design
- Reference HW: reference-hw
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
nav:
- index.md
- Integrating Autoware: integrating-autoware
- Open-source slam algorithms: open-source-slam
- Training Machine Learning Models: training-machine-learning-models
- others
4 changes: 2 additions & 2 deletions docs/how-to-guides/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# How-to guides

## Integrating Autoware
## Open source slam algorithms for pointcloud mapping

- [Overview](integrating-autoware/overview.md)
- [Open Source Slam Algorithms](open-source-slam/index.md)

## Training Machine Learning Models

Expand Down
168 changes: 0 additions & 168 deletions docs/how-to-guides/integrating-autoware/overview.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ nav:
- IA_LIO_SAM: ia-lio-slam
- iscloam: iscloam
- LeGO-LOAM-BOR: lego-loam-bor
- LIO-SAM: lio-sam
- Optimized-SC-F-LOAM: optimized-sc-f-loam
- SC-A-LOAM: sc-a-loam
- SC-LeGO-LOAM: sc-lego-loam
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,4 @@ Kenji Koide, Jun Miura, and Emanuele Menegatti, A Portable 3D LIDAR-based System
Kenji Koide, [email protected], [https://staff.aist.go.jp/k.koide](https://staff.aist.go.jp/k.koide)

[[Active Intelligent Systems Laboratory, Toyohashi University of Technology, Japan]](http://www.aisl.cs.tut.ac.jp)
[[Mobile Robotics Research Team, National Institute of Advanced Industrial Science and Technology (AIST), Japan]](https://unit.aist.go.jp/hcmrc/mr-rt/contact.html)
[[Mobile Robotics Research Team, National Institute of Advanced Industrial Science and Technology (AIST), Japan]](https://www.aist.go.jp/aist_e/contact/index.html)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
nav:
- overview.md
- index.md
- 1. Creating your Autoware repositories: creating-your-autoware-repositories
- 2. Creating vehicle and sensor model: creating-vehicle-and-sensor-model
- 3. Creating vehicle interface: creating-vehicle-interface-package
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nav:
- index.md
- Open-source SLAM algorithms: open-source-slam
- Creating pointcloud map with LIO-SAM: lio-sam
- Converting UTM map to MGRS map: converting-utm-to-mgrs-map
- Pointcloud map downsampling: pointcloud-map-downsampling
- Creating a vector map: creating-vector-map
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
At this page, we will explain how to create a simple lanelet on your point cloud map.
If you didn't have a point cloud map before,
please check
and follow the steps on the [LIO-SAM mapping page](../../open-source-slam/lio-sam)
and follow the steps on the [LIO-SAM mapping page](../../lio-sam)
for how to create a point cloud map for Autoware.

## Creating a Lanelet2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Creating maps

Autoware requires a pointcloud map and a vector map for the vehicle's operating environment. (Check the [map design documentation page](../../../design/autoware-architecture/map/index.md) for the detailed specification).
Autoware requires a pointcloud map and a vector map for the vehicle's operating environment. (Check the [map design documentation page](../../design/autoware-architecture/map/index.md) for the detailed specification).

This page explains how users can create maps that can be used for Autoware.

## Creating a point cloud map

Traditionally, a Mobile Mapping System (MMS) is used in order to create highly accurate large-scale point cloud maps. However, since a MMS requires high-end sensors for precise positioning, its operational cost can be very expensive and may not be suitable for a relatively small driving environment. Alternatively, a Simultaneous Localization And Mapping (SLAM) algorithm can be used to create a point cloud map from recorded LiDAR scans. Some of the useful open-source SLAM implementations are listed in this [page](open-source-slam/index.md).
Traditionally, a Mobile Mapping System (MMS) is used in order to create highly accurate large-scale point cloud maps. However, since a MMS requires high-end sensors for precise positioning, its operational cost can be very expensive and may not be suitable for a relatively small driving environment. Alternatively, a Simultaneous Localization And Mapping (SLAM) algorithm can be used to create a point cloud map from recorded LiDAR scans. Some of the useful open-source SLAM implementations are listed in this [page](../../how-to-guides/open-source-slam/index.md).

If you prefer proprietary software that is easy to use, you can try a fully automatic mapping tool from [MAP IV, Inc.](https://www.map4.jp/), [_MapIV Engine_](https://www.map4.jp/solutions/mapping-localization/map4-engine/). They currently provide a trial license for Autoware users free of charge.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Here is the video for demonstration of LIO-SAM mapping in our campus environment
The output map format is local UTM,
we will change local UTM map to MGRS format for tutorial_vehicle.
Also, if you want change UTM to MGRS for autoware,
please follow [convert-utm-to-mgrs-map](../../converting-utm-to-mgrs-map) page.
please follow [convert-utm-to-mgrs-map](../converting-utm-to-mgrs-map) page.

## Example Result

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ while using the same launch files with the same sensor model.

## Placing your `individual_parameters` repository inside Autoware

[Previously on this guide](../../creating-your-autoware-repositories/creating-autoware-repositories.md),
[Previously on this guide](../../creating-your-autoware-repositories/index.md),
we forked the `autoware_individual_params` repository
to create a [tutorial_vehicle_individual_params](https://github.com/leo-drive/tutorial_vehicle_individual_params) repository
which will be used as an example for this section of the guide.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This page introduces the following packages for the sensor model:
3. `<YOUR-VEHICLE-NAME>_sensor_kit_launch`

Previously,
we forked our vehicle model at the [creating autoware repositories](../../creating-your-autoware-repositories/creating-autoware-repositories.md) page step.
we forked our vehicle model at the [creating autoware repositories](../../creating-your-autoware-repositories/index.md) page step.
For instance,
we created [tutorial_vehicle_launch](https://github.com/leo-drive/tutorial_vehicle_launch)
as an implementation example for the said step.
Expand Down Expand Up @@ -177,7 +177,7 @@ This file defines the mounting positions and orientations of `sensor_kit_base_li
with `base_link` as the parent frame.
At Autoware, `base_link` is on projection of the rear-axle center onto the ground surface.
For more information,
you can check [vehicle dimension](../../../../design/autoware-interfaces/components/vehicle-dimensions.md) page.
you can check [vehicle dimension](../../../design/autoware-interfaces/components/vehicle-dimensions.md) page.
You can use CAD values for this, but we will fill the values with `0` for now.

```yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This page introduces the following packages for the vehicle model:
2. `<YOUR-VEHICLE-NAME>_vehicle_launch`

Previously,
we forked our vehicle model at the [creating autoware repositories](../../creating-your-autoware-repositories/creating-autoware-repositories.md) page step.
we forked our vehicle model at the [creating autoware repositories](../../creating-your-autoware-repositories/index.md) page step.
For instance,
we created [tutorial_vehicle_launch](https://github.com/leo-drive/tutorial_vehicle_launch)
as an implementation example for the said step.
Expand Down Expand Up @@ -105,7 +105,7 @@ Now, we will modify these files according to our vehicle design.
### mirror.param.yaml

This file describes your vehicle mirror dimension for
[CropBox filter](https://autowarefoundation.github.io/autoware.universe/main/sensing/pointcloud_preprocessor/docs/crop-box-filter/) of [PointCloudPreprocessor](../../../../design/autoware-architecture/sensing/data-types/point-cloud.md).
[CropBox filter](https://autowarefoundation.github.io/autoware.universe/main/sensing/pointcloud_preprocessor/docs/crop-box-filter/) of [PointCloudPreprocessor](../../../design/autoware-architecture/sensing/data-types/point-cloud.md).
This is important for cropping mirrors from your lidar's point cloud.

The `mirror.param.yaml` consist of the following parameters:
Expand Down Expand Up @@ -170,7 +170,7 @@ The file consists of these parameters:

This file stores the vehicle dimensions for Autoware modules.
Please update it with your vehicle information.
You can refer to the [vehicle dimensions](../../../../design/autoware-interfaces/components/vehicle-dimensions.md) page for detailed dimension demonstration.
You can refer to the [vehicle dimensions](../../../design/autoware-interfaces/components/vehicle-dimensions.md) page for detailed dimension demonstration.
Here is the `vehicle_info.param.yaml` for [sample_vehicle](https://github.com/autowarefoundation/sample_vehicle_launch/blob/main/sample_vehicle_description/config/vehicle_info.param.yaml):

```yaml
Expand Down Expand Up @@ -235,7 +235,7 @@ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release --package

If your vehicle interface is ready,
then you can add your vehicle_interface launch file in `vehicle_interface.launch.xml`.
Please check the [creating vehicle interface](../../creating-vehicle-interface-package/creating-a-vehicle-interface-for-an-ackermann-kinematic-model.md) page for more info.
Please check the [creating vehicle interface](../../creating-vehicle-interface-package/creating-vehicle-interface.md) page for more info.

### Launch planning simulator with your own vehicle

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
nav:
- Vehicle interface overview: vehicle-interface.md
- index.md
- creating-vehicle-interface.md
- ackermann-kinematic-model.md
- customizing-for-differential-drive-model.md
Loading
Loading