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

feat(trajectory): add API description, nomenclature, illustration, rename functions to align with nomenclature #292

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

soblin
Copy link
Contributor

@soblin soblin commented Mar 19, 2025

Description

Read this : https://autowarefoundation.github.io/autoware_core/pr-292/common/autoware_trajectory/

  • rename get_internal_base to get_underlying_base to align with nomenclature
  • compute the curvature as signed value following nomenclature definition
  • add methods to compute() taking vector as input and return vector as output for uitlity
  • add method to compute yaw for utility
  • compute base distance in 3D manner following nomenclature defintion

Related links

Parent Issue:

  • Link

How was this PR tested?

unit test passes

Notes for reviewers

None.

Interface changes

add following member functions to trajectory_class. They will be 100% used when planning node starts using this class

  • compute(vector<double>)
  • curvature(vector<double>)

Effects on system behavior

None.

Copy link

github-actions bot commented Mar 19, 2025

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@soblin soblin added run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) labels Mar 19, 2025
Copy link

github-actions bot commented Mar 19, 2025

@soblin soblin force-pushed the feat/trajectory-API-documentation branch 5 times, most recently from d189a93 to 3b383b3 Compare March 21, 2025 04:16
Copy link

codecov bot commented Mar 21, 2025

Codecov Report

Attention: Patch coverage is 8.24176% with 167 lines in your changes missing coverage. Please review.

Project coverage is 32.24%. Comparing base (4cb18f5) to head (c250ead).
Report is 133 commits behind head on main.

Files with missing lines Patch % Lines
...on/autoware_trajectory/examples/example_readme.cpp 0.00% 111 Missing ⚠️
common/autoware_trajectory/src/point.cpp 20.00% 12 Missing ⚠️
testing/autoware_pyplot/src/axes.cpp 21.42% 10 Missing and 1 partial ⚠️
common/autoware_trajectory/src/path_point.cpp 0.00% 7 Missing ⚠️
...e_trajectory/include/autoware/trajectory/point.hpp 0.00% 6 Missing ⚠️
...utoware_trajectory/src/path_point_with_lane_id.cpp 25.00% 6 Missing ⚠️
common/autoware_trajectory/src/pose.cpp 14.28% 6 Missing ⚠️
...ommon/autoware_trajectory/src/trajectory_point.cpp 28.57% 5 Missing ⚠️
testing/autoware_pyplot/src/figure.cpp 0.00% 2 Missing ⚠️
...ectory/include/autoware/trajectory/utils/shift.hpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #292       +/-   ##
===========================================
- Coverage   78.75%   32.24%   -46.52%     
===========================================
  Files          11      182      +171     
  Lines         193    11406    +11213     
  Branches       73     4238     +4165     
===========================================
+ Hits          152     3678     +3526     
- Misses         11     7242     +7231     
- Partials       30      486      +456     
Flag Coverage Δ
differential 32.24% <8.24%> (?)
total ?

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@soblin soblin force-pushed the feat/trajectory-API-documentation branch from 3b383b3 to c66a039 Compare March 21, 2025 07:09
@soblin soblin force-pushed the feat/trajectory-API-documentation branch 2 times, most recently from 33352f0 to c70c4e6 Compare March 21, 2025 09:28
@soblin soblin marked this pull request as ready for review March 24, 2025 02:18
@soblin soblin requested review from yhisaki, a team and takayuki5168 as code owners March 24, 2025 02:18
@soblin soblin force-pushed the feat/trajectory-API-documentation branch from d185f0e to c6f7878 Compare March 26, 2025 07:03
…name functions to align with nomenclature

Signed-off-by: Mamoru Sobue <mamoru.sobue@tier4.jp>
@soblin soblin force-pushed the feat/trajectory-API-documentation branch from dfa217c to c250ead Compare March 28, 2025 03:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) run:deploy-docs Mark for deploy-docs action generation. (used-by-ci)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants