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(start_planner): update start planner docs #4019

Merged
merged 2 commits into from
Jun 20, 2023

Conversation

kosuke55
Copy link
Contributor

@kosuke55 kosuke55 commented Jun 20, 2023

Description

update start planner docs

Related links

Tests performed

just add usecase of road_lane, will update contents related logic(pull out with acceleration) in other PR

Notes for reviewers

Interface changes

none

Effects on system behavior

none

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

  • The PR follows the pull request guidelines.
  • The PR has been properly tested.
  • The PR has been reviewed by the code owners.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.
  • The PR is ready for merge.

After all checkboxes are checked, anyone who has write access can merge the PR.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:planning Route planning, decision-making, and navigation. (auto-assigned) labels Jun 20, 2023
@kosuke55 kosuke55 force-pushed the docs/update_start_planner_docs branch from 8d45027 to 5698a98 Compare June 20, 2023 08:00
@kosuke55 kosuke55 force-pushed the docs/update_start_planner_docs branch from 10636b7 to 49d954a Compare June 20, 2023 08:03
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
@kosuke55 kosuke55 force-pushed the docs/update_start_planner_docs branch from 26ae353 to fbfdd40 Compare June 20, 2023 08:10
@@ -58,10 +67,10 @@ PullOutPath --o PullOutPlannerBase
| collision_check_margin | [m] | double | Obstacle collision check margin | 1.0 |
| collision_check_distance_from_end | [m] | double | collision check distance from end point. currently only for pull out | 15.0 |

## **Safe check with obstacles in shoulder lane**
## **Safe check with obstacles**

1. Calculate ego-vehicle's footprint on pull out path between from current position to pull out end point. (Illustrated by blue frame)
Copy link
Contributor

@kyoichi-sugahara kyoichi-sugahara Jun 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's suggestion for my implementing function though, but how about putting the title below?

with static obstacles

And how about adding the title below after explanation about safe check with static obstacles?

with dynamic obstacles

WIP

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, nice! fixed in 9821b0a

@codecov
Copy link

codecov bot commented Jun 20, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (652d246) 14.43% compared to head (9821b0a) 14.43%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4019   +/-   ##
=======================================
  Coverage   14.43%   14.43%           
=======================================
  Files        1462     1462           
  Lines      102964   102964           
  Branches    29876    29876           
=======================================
  Hits        14866    14866           
  Misses      71865    71865           
  Partials    16233    16233           
Flag Coverage Δ *Carryforward flag
differential 12.75% <ø> (?)
total 14.43% <ø> (ø) Carriedforward from fbfdd40

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@@ -2,7 +2,16 @@

## Purpose / Role

Pull out from the shoulder lane without colliding with objects.
Start Planner is designed for safe path generation from the current ego position to the driving lane and transition to lane following. This module is activated when a new route is received.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This description is my proposal but I get used not to accepted so please feel free to ignore 😭

The Start Planner module is designed to generate a path from the current ego position to the driving lane, avoiding static obstacles and implementing safety checks against dynamic obstacles.
(Note: The feature of safety checks against dynamic obstacles is currently a work in progress.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

used the proposal in 9821b0a

Copy link
Contributor

@kyoichi-sugahara kyoichi-sugahara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some minor coments but LGTM without reflecting them 🙆‍♂️

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
@kosuke55 kosuke55 merged commit 113ca28 into main Jun 20, 2023
@kosuke55 kosuke55 deleted the docs/update_start_planner_docs branch June 20, 2023 10:25
zulfaqar-azmi-t4 pushed a commit to zulfaqar-azmi-t4/autoware.universe that referenced this pull request Jun 21, 2023
* docs(start_planner): update start planner docs

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>

* fix from sugahara-san review

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>

---------

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
kosuke55 added a commit to tier4/autoware.universe that referenced this pull request Jul 20, 2023
* docs(start_planner): update start planner docs

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>

* fix from sugahara-san review

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>

---------

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:planning Route planning, decision-making, and navigation. (auto-assigned) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants