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(behavior_path_planner): update doc of safety check feature fot start planner #5240

Conversation

kyoichi-sugahara
Copy link
Contributor

Description

update document of safety check feature fot start planner.
I will add other feature in the different PR

Tests performed

Not applicable.

Effects on system behavior

Not applicable.

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.

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.

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

Signed-off-by: kyoichi-sugahara <[email protected]>
@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 Oct 5, 2023
@kyoichi-sugahara kyoichi-sugahara changed the title doc(behavior_path_planner): update doc of safety check feature fot start planner docs(behavior_path_planner): update doc of safety check feature fot start planner Oct 7, 2023
@kyoichi-sugahara kyoichi-sugahara added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Oct 11, 2023
@codecov
Copy link

codecov bot commented Oct 12, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (744d48d) 14.87% compared to head (ffffdd6) 14.85%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5240      +/-   ##
==========================================
- Coverage   14.87%   14.85%   -0.02%     
==========================================
  Files        1649     1649              
  Lines      114317   114256      -61     
  Branches    35403    35373      -30     
==========================================
- Hits        17001    16978      -23     
- Misses      78129    78132       +3     
+ Partials    19187    19146      -41     
Flag Coverage Δ *Carryforward flag
differential 12.56% <ø> (?)
total 14.84% <ø> (-0.03%) ⬇️ Carriedforward from 108f603

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

see 19 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

| Name | Unit | Type | Description | Default value |
| :-------------------------- | :---- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------ |
| enable_geometric_pull_out | [-] | bool | flag whether to enable geometric pull out | true |
| divide_pull_out_path | [-] | bool | flag whether to divide arc paths.  The path is assumed to be divided because the curvature is not continuous. But it requires a stop during the departure. | false |
Copy link
Contributor

Choose a reason for hiding this comment

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

flag whether to divide arc paths.  The path is assumed to be divided because the curvature is not continuous.
too many space

| maximum_curvature | [m] | double | maximum curvature. The pull out distance is calculated so that the curvature is smaller than this value. |

| 0.07 |
| maximum_curvature | [m] | double | maximum curvature. The pull out distance is calculated so that the curvature is smaller than this value. | 0.07 |
Copy link
Contributor

Choose a reason for hiding this comment

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

oh, thanks!


During backward movement, no safety check is performed. Safety check begins at the point where the backward movement ends.

![collision_check_range](../image/start_planner/collision_check_range.drawio.svg)
Copy link
Contributor

Choose a reason for hiding this comment

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

will replace the image with rotated footprint one in the future?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed in b6a72ab

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

Copy link
Contributor

@kosuke55 kosuke55 left a comment

Choose a reason for hiding this comment

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

LGTM! thanks!!

@kyoichi-sugahara kyoichi-sugahara merged commit bcfae36 into autowarefoundation:main Oct 13, 2023
23 of 25 checks passed
@kyoichi-sugahara kyoichi-sugahara deleted the doc/update_safety_check_feature_start_planner branch October 13, 2023 04:07
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) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants