From fd8463b9503c61ccff9d350e4eb8e8d58c40f2f3 Mon Sep 17 00:00:00 2001 From: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com> Date: Tue, 24 May 2022 21:57:31 +0900 Subject: [PATCH] docs: update link style and fix typos (#950) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat(state_rviz_plugin): add GateMode and PathChangeApproval Button (#894) * feat(state_rviz_plugin): add GateMode and PathChangeApproval Button * ci(pre-commit): autofix Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * docs: update link style Signed-off-by: Shumpei Wakabayashi * chore: fix link Signed-off-by: Shumpei Wakabayashi * feat(map_tf_generator): accelerate the 'viewer' coordinate calculation (#890) * add random point sampling function to quickly calculate the 'viewer' coordinate Signed-off-by: IshitaTakeshi Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * docs(obstacle_stop_planner): update documentation (#880) Signed-off-by: satoshi-ota Signed-off-by: Shumpei Wakabayashi * docs(tier4_traffic_light_rviz_plugin): update documentation (#905) Signed-off-by: satoshi-ota Signed-off-by: Shumpei Wakabayashi * fix(accel_brake_map_calibrator): rviz panel type (#895) * fixed panel type Signed-off-by: Mamoru Sobue * modified instruction for rosbag replay case Signed-off-by: Mamoru Sobue * modified update_map_dir service name Signed-off-by: Mamoru Sobue Signed-off-by: Shumpei Wakabayashi * fix(behavior velocity planner): skipping emplace back stop reason if it is empty (#898) * skipping emplace back stop reason if it is empty Signed-off-by: TakumiKozaka-T4 * add braces Signed-off-by: TakumiKozaka-T4 * ci(pre-commit): autofix Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Takagi, Isamu <43976882+isamu-takagi@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * feat(behavior_path_planner): weakened noise filtering of drivable area (#838) * feat(behavior_path_planner): Weakened noise filtering of drivable area Signed-off-by: Takayuki Murooka * fix lanelet's longitudinal disconnection Signed-off-by: Takayuki Murooka * add comments of erode/dilate process Signed-off-by: Takayuki Murooka Signed-off-by: Shumpei Wakabayashi * refactor(vehicle-cmd-gate): using namespace for msgs (#913) * refactor(vehicle-cmd-gate): using namespace for msgs Signed-off-by: Takamasa Horibe * for clang Signed-off-by: Takamasa Horibe Signed-off-by: Shumpei Wakabayashi * feat(pose_initializer): introduce an array copy function (#900) Signed-off-by: IshitaTakeshi Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * feat: add lidar point filter when debug (#865) * feat: add lidar point filter when debug Signed-off-by: suchang * ci(pre-commit): autofix Co-authored-by: suchang Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * feat(component_interface_utils): add interface classes (#899) * feat(component_interface_utils): add interface classes Signed-off-by: Takagi, Isamu * feat(default_ad_api): apply the changes of interface utils Signed-off-by: Takagi, Isamu * fix(component_interface_utils): remove old comment Signed-off-by: Takagi, Isamu * fix(component_interface_utils): add client log Signed-off-by: Takagi, Isamu * fix(component_interface_utils): remove unimplemented message Signed-off-by: Takagi, Isamu * docs(component_interface_utils): add design policy Signed-off-by: Takagi, Isamu * docs(component_interface_utils): add comment Signed-off-by: Takagi, Isamu Signed-off-by: Shumpei Wakabayashi * refactor(vehicle_cmd_gate): change namespace in launch file (#927) Signed-off-by: Berkay Co-authored-by: Berkay Signed-off-by: Shumpei Wakabayashi * feat: visualize lane boundaries (#923) * feat: visualize lane boundaries * fix: start_bound * ci(pre-commit): autofix Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * fix(system_monitor): fix truncation warning in strncpy (#872) * fix(system_monitor): fix truncation warning in strncpy * Use std::string constructor to copy char array * Fixed typo Signed-off-by: Shumpei Wakabayashi * fix(behavior_velocity_planner.stopline): extend following and previous search range to avoid no collision (#917) * fix: extend following and previous search range to avoid no collision * chore: add debug marker * fix: simplify logic * chore: update debug code Signed-off-by: h-ohta * fix: delete space * fix: some fix * ci(pre-commit): autofix * fix: delete debug code Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * docs(surround obstacle checker): update documentation (#878) * docs(surround_obstacle_checker): update pub/sub topics & params Signed-off-by: satoshi-ota * docs(surround_obstacle_checker): remove unused files Signed-off-by: satoshi-ota * docs(surround_obstacke_checker): update purpose Signed-off-by: satoshi-ota Signed-off-by: Shumpei Wakabayashi * feat(tier4_autoware_utils): add vehicle state checker (#896) * feat(tier4_autoware_utils): add vehicle state checker Signed-off-by: satoshi-ota * fix(tier4_autoware_utils): use absolute value Signed-off-by: satoshi-ota * feat(tier4_autoware_utils): divide into two classies Signed-off-by: satoshi-ota * test(tier4_autoware_utils): add unit test for vehicle_state checker Signed-off-by: satoshi-ota * fix(tier4_autoware_utils): impl class inheritance Signed-off-by: satoshi-ota * docs(tier4_autoware_utils): add vehicle_state_checker document Signed-off-by: satoshi-ota * fix(tier4_autoware_utils): into same loop Signed-off-by: satoshi-ota * fix(tier4_autoware_utils): fix variables name Signed-off-by: satoshi-ota * fix(tier4_autoware_utils): remove redundant codes Signed-off-by: satoshi-ota Signed-off-by: Shumpei Wakabayashi * fix(motion_velocity_smoother): fix overwriteStopPoint using backward point (#816) * fix(motion_velocity_smoother): fix overwriteStopPoint using backward point Signed-off-by: kosuke55 * Modify overwriteStopPoint input and output Signed-off-by: kosuke55 Signed-off-by: Shumpei Wakabayashi * feat(obstacle_avoidance_planner): explicitly insert zero velocity (#906) * feat(obstacle_avoidance_planner) fix bug of stop line unalignment Signed-off-by: Takayuki Murooka * fix bug of unsorted output points Signed-off-by: Takayuki Murooka * move calcVelocity in node.cpp Signed-off-by: Takayuki Murooka * fix build error Signed-off-by: Takayuki Murooka Signed-off-by: Shumpei Wakabayashi * feat(behavior_velocity): find occlusion more efficiently (#829) Signed-off-by: tanaka3 Signed-off-by: Shumpei Wakabayashi * fix(system_monitor): add some smart information to diagnostics (#708) Signed-off-by: kk-inoue-esol Signed-off-by: Shumpei Wakabayashi * feat(obstacle_avoidance_planner): dealt with close lane change (#921) * feat(obstacle_avoidance_planner): dealt with close lane change Signed-off-by: Takayuki Murooka * fix bug of right lane change Signed-off-by: Takayuki Murooka Signed-off-by: Shumpei Wakabayashi * feat(obstacle_avoidance_planner): some fix for narrow driving (#916) * use car like constraints in mpt * use not widest bounds for the first bounds Signed-off-by: Takayuki Murooka * organized params Signed-off-by: Takayuki Murooka * fix format Signed-off-by: Takayuki Murooka * prepare rear_drive and uniform_circle constraints Signed-off-by: Takayuki Murooka * fix param callback Signed-off-by: Takayuki Murooka * update config Signed-off-by: Takayuki Murooka * remove unnecessary files Signed-off-by: Takayuki Murooka * update tier4_planning_launch params Signed-off-by: Takayuki Murooka Signed-off-by: Shumpei Wakabayashi * chore(obstacle_avoidance_planner): removed obsolete obstacle_avoidance_planner doc in Japanese (#919) Signed-off-by: Takayuki Murooka Signed-off-by: Shumpei Wakabayashi * chore(behavior_velocity_planner.stopline): add debug marker for stopline collision check (#932) * chore(behavior_velocity_planner.stopline): add debug marker for stopline collision check * feat: use marker helper Signed-off-by: h-ohta Signed-off-by: Shumpei Wakabayashi * feat(map_loader): visualize center line by points (#931) * feat: visualize center line points * fix: delete space * feat: visualize center line by arrow * revert insertMarkerArray * fix: delete space Signed-off-by: Shumpei Wakabayashi * feat: add RTC interface (#765) * feature(rtc_interface): add files Signed-off-by: Fumiya Watanabe * feature(rtc_interface): implement functions Signed-off-by: Fumiya Watanabe * feature(rtc_interface): reimprement functions to use CooperateCommands and write README.md Signed-off-by: Fumiya Watanabe * feature(rtc_interface): fix README Signed-off-by: Fumiya Watanabe * feature(rtc_interface): add getModuleType() Signed-off-by: Fumiya Watanabe * feature(rtc_interface): fix definition of constructor Signed-off-by: Fumiya Watanabe * feature(rtc_interface): fix time stamp Signed-off-by: Fumiya Watanabe * feature(rtc_interface): fix README Signed-off-by: Fumiya Watanabe * feature(rtc_interface): add isRegistered and clearCooperateStatus Signed-off-by: Fumiya Watanabe * ci(pre-commit): autofix Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * chore: sync files (#911) Signed-off-by: GitHub Co-authored-by: kenji-miyake Signed-off-by: Shumpei Wakabayashi * fix: replace boost::mutex::scoped_lock to std::scoped_lock (#907) * fix: replace boost::mutex::scoped_lock to std::scoped_lock * fix: replace boost::mutex to std::mutex Signed-off-by: Shumpei Wakabayashi * feat(tensorrt_yolo): add multi gpu support to tensorrt_yolo node (#885) * feat(tensorrt_yolo): add multi gpu support to tensorrt_yolo node Signed-off-by: Kaan Colak * feat(tensorrt_yolo): update arg Signed-off-by: Kaan Colak Co-authored-by: Kaan Colak Signed-off-by: Shumpei Wakabayashi * feat(tier4_planning_launch): create parameter yaml for behavior_velocity_planner (#887) * feat(tier4_planning_launch): create parameter yaml for behavior_velocity_planner * Update launch/tier4_planning_launch/config/scenario_planning/lane_driving/behavior_planning/behavior_velocity_planner/behavior_velocity_planner.param.yaml Co-authored-by: taikitanaka3 <65527974+taikitanaka3@users.noreply.github.com> * feat: add param.yaml in behavior_velocity_planner package * some fix Co-authored-by: taikitanaka3 <65527974+taikitanaka3@users.noreply.github.com> Signed-off-by: Shumpei Wakabayashi * fix(map_loader): use std::filesystem to load pcd files in pointcloud_map_loader (#942) * fix(map_loader): use std::filesystem to load pcd files in pointcloud_map_loader Signed-off-by: RyuYamamoto * fix(map_loader): remove c_str Signed-off-by: RyuYamamoto * fix(map_loader): replace c_str to string Signed-off-by: RyuYamamoto Signed-off-by: Shumpei Wakabayashi * fix: relative link Signed-off-by: Shumpei Wakabayashi * fix: relative links Signed-off-by: Shumpei Wakabayashi * fix: relative links Signed-off-by: Shumpei Wakabayashi * fix: relative links Signed-off-by: Shumpei Wakabayashi * fix: typo Signed-off-by: Shumpei Wakabayashi * fix relative links Signed-off-by: Kenji Miyake Signed-off-by: Shumpei Wakabayashi * docs: ignore rare unknown words Signed-off-by: Shumpei Wakabayashi * ci(pre-commit): autofix Signed-off-by: Shumpei Wakabayashi * docs: ignore unknown words one by one Signed-off-by: Shumpei Wakabayashi * ci(pre-commit): autofix Co-authored-by: Hiroki OTA Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Takeshi Ishita Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Co-authored-by: Satoshi OTA <44889564+satoshi-ota@users.noreply.github.com> Co-authored-by: Mamoru Sobue Co-authored-by: TakumiKozaka-T4 <70260442+TakumiKozaka-T4@users.noreply.github.com> Co-authored-by: Takagi, Isamu <43976882+isamu-takagi@users.noreply.github.com> Co-authored-by: Takayuki Murooka Co-authored-by: Takamasa Horibe Co-authored-by: storrrrrrrrm <103425473+storrrrrrrrm@users.noreply.github.com> Co-authored-by: suchang Co-authored-by: Berkay Co-authored-by: Berkay Co-authored-by: ito-san <57388357+ito-san@users.noreply.github.com> Co-authored-by: Kosuke Takeuchi Co-authored-by: taikitanaka3 <65527974+taikitanaka3@users.noreply.github.com> Co-authored-by: kk-inoue-esol <76925382+kk-inoue-esol@users.noreply.github.com> Co-authored-by: Fumiya Watanabe Co-authored-by: awf-autoware-bot[bot] <94889083+awf-autoware-bot[bot]@users.noreply.github.com> Co-authored-by: kenji-miyake Co-authored-by: RyuYamamoto Co-authored-by: Kaan Çolak Co-authored-by: Kaan Colak Co-authored-by: Kenji Miyake --- common/autoware_auto_common/design/comparisons.md | 2 +- common/autoware_auto_geometry/design/interval.md | 2 +- .../design/polygon_intersection_2d-design.md | 2 +- .../design/spatial-hash-design.md | 6 ++++-- .../design/autoware-auto-tf2-design.md | 8 ++++---- .../autoware_testing/design/autoware_testing-design.md | 2 +- common/fake_test_node/design/fake_test_node-design.md | 2 +- common/osqp_interface/design/osqp_interface-design.md | 2 +- .../design/vehicle_constants_manager-design.md | 4 ++-- .../design/trajectory_follower-design.md | 6 +++--- .../design/trajectory_follower-mpc-design.md | 4 ++-- .../design/trajectory_follower-pid-design.md | 2 +- .../design/lateral_controller-design.md | 4 ++-- .../design/latlon_muxer-design.md | 2 +- .../design/longitudinal_controller-design.md | 2 +- .../design/trajectory_follower-design.md | 10 +++++----- perception/tensorrt_yolo/README.md | 2 ++ .../behavior_velocity_planner/occlusion-spot-design.md | 2 +- .../design/simple_planning_simulator-design.md | 2 +- 19 files changed, 35 insertions(+), 31 deletions(-) diff --git a/common/autoware_auto_common/design/comparisons.md b/common/autoware_auto_common/design/comparisons.md index d8c1ef6de17e..f3a7eb5e5842 100644 --- a/common/autoware_auto_common/design/comparisons.md +++ b/common/autoware_auto_common/design/comparisons.md @@ -1,4 +1,4 @@ -# Comparisons {#helper-comparisons} +# Comparisons The `float_comparisons.hpp` library is a simple set of functions for performing approximate numerical comparisons. There are separate functions for performing comparisons using absolute bounds and relative bounds. Absolute comparison checks are prefixed with `abs_` and relative checks are prefixed with `rel_`. diff --git a/common/autoware_auto_geometry/design/interval.md b/common/autoware_auto_geometry/design/interval.md index f586d4c19607..26260ba8d8e6 100644 --- a/common/autoware_auto_geometry/design/interval.md +++ b/common/autoware_auto_geometry/design/interval.md @@ -1,4 +1,4 @@ -# Interval {#geometry-interval} +# Interval The interval is a standard 1D real-valued interval. The class implements a representation and operations on the interval type and guarantees interval validity on construction. diff --git a/common/autoware_auto_geometry/design/polygon_intersection_2d-design.md b/common/autoware_auto_geometry/design/polygon_intersection_2d-design.md index 4b4f900bb6cd..98b5d045f2d0 100644 --- a/common/autoware_auto_geometry/design/polygon_intersection_2d-design.md +++ b/common/autoware_auto_geometry/design/polygon_intersection_2d-design.md @@ -1,4 +1,4 @@ -# 2D Convex Polygon Intersection {#convex-polygon-intersection-2d} +# 2D Convex Polygon Intersection Two convex polygon's intersection can be visualized on the image below as the blue area: diff --git a/common/autoware_auto_geometry/design/spatial-hash-design.md b/common/autoware_auto_geometry/design/spatial-hash-design.md index 469da747329f..58eecf3ee841 100644 --- a/common/autoware_auto_geometry/design/spatial-hash-design.md +++ b/common/autoware_auto_geometry/design/spatial-hash-design.md @@ -1,4 +1,4 @@ -# Spatial Hash {#geometry-spatial-hash} +# Spatial Hash The spatial hash is a data structure designed for efficient fixed-radius near-neighbor queries in low dimensions. @@ -35,9 +35,11 @@ The spatial hash works as follows: Under the hood, an `std::unordered_multimap` is used, where the key is a bin/voxel index. The bin size was computed to be the same as the lookup distance. + + In addition, this data structure can support 2D or 3D queries. This is determined during configuration, and baked into the data structure via the configuration class. The purpose of -this was to avoid if statements in tight loops. The configuration class specializations themself +this was to avoid if statements in tight loops. The configuration class specializations themselves use CRTP (Curiously Recurring Template Patterns) to do "static polymorphism", and avoid a dispatching call. diff --git a/common/autoware_auto_tf2/design/autoware-auto-tf2-design.md b/common/autoware_auto_tf2/design/autoware-auto-tf2-design.md index 0d8ed4e76319..3befe575e3e7 100644 --- a/common/autoware_auto_tf2/design/autoware-auto-tf2-design.md +++ b/common/autoware_auto_tf2/design/autoware-auto-tf2-design.md @@ -1,4 +1,4 @@ -# autoware_auto_tf2 {#autoware-auto-tf2-design} +# autoware_auto_tf2 This is the design document for the `autoware_auto_tf2` package. @@ -110,7 +110,7 @@ inline void doTransform( const geometry_msgs::msg::TransformStamped & transform) ``` -- `Quarternion32` (`autoware_auto_msgs`) +- `Quaternion32` (`autoware_auto_msgs`) ```cpp inline void doTransform( @@ -169,7 +169,7 @@ inline std::string getFrameId(const BoundingBoxArray & t) ## Challenges -- `tf2_geometry_msgs` does not implement `doTransform` for any non-stamped datatypes, but it is +- `tf2_geometry_msgs` does not implement `doTransform` for any non-stamped data types, but it is possible with the same function template. It is needed when transforming sub-data, with main data that does have a stamp and can call doTransform on the sub-data with the same transform. Is this a useful upstream contribution? - `tf2_geometry_msgs` does not have `Point`, `Point32`, does not seem it needs one, also the @@ -177,7 +177,7 @@ inline std::string getFrameId(const BoundingBoxArray & t) - `BoundingBox` uses 32-bit float like `Quaternion32` and `Point32` to save space, as they are used repeatedly in `BoundingBoxArray`. While transforming is it better to convert to 64-bit `Quaternion`, `Point`, or `PoseStamped`, to re-use existing implementation of `doTransform`, or does it need to be - implemented? Templatization may not be simple. + implemented? It may not be simple to template. diff --git a/common/autoware_testing/design/autoware_testing-design.md b/common/autoware_testing/design/autoware_testing-design.md index d1290bef41da..e50f7c801a62 100644 --- a/common/autoware_testing/design/autoware_testing-design.md +++ b/common/autoware_testing/design/autoware_testing-design.md @@ -1,4 +1,4 @@ -# autoware_testing {#autoware_testing-package-design} +# autoware_testing This is the design document for the `autoware_testing` package. diff --git a/common/fake_test_node/design/fake_test_node-design.md b/common/fake_test_node/design/fake_test_node-design.md index ff83a2fd0f58..c9c040881664 100644 --- a/common/fake_test_node/design/fake_test_node-design.md +++ b/common/fake_test_node/design/fake_test_node-design.md @@ -1,4 +1,4 @@ -# Fake Test Node {#fake-test-node-design} +# Fake Test Node ## What this package provides diff --git a/common/osqp_interface/design/osqp_interface-design.md b/common/osqp_interface/design/osqp_interface-design.md index fcd0f81667f2..8fd6ab28a659 100644 --- a/common/osqp_interface/design/osqp_interface-design.md +++ b/common/osqp_interface/design/osqp_interface-design.md @@ -1,4 +1,4 @@ -# Interface for the OSQP library {#osqp_interface-package-design} +# Interface for the OSQP library This is the design document for the `osqp_interface` package. diff --git a/common/vehicle_constants_manager/design/vehicle_constants_manager-design.md b/common/vehicle_constants_manager/design/vehicle_constants_manager-design.md index 0c3dcd1fe1bf..88ba34967565 100644 --- a/common/vehicle_constants_manager/design/vehicle_constants_manager-design.md +++ b/common/vehicle_constants_manager/design/vehicle_constants_manager-design.md @@ -1,4 +1,4 @@ -# vehicle_constants_manager {#vehicle-constants-manager-package-design} +# vehicle_constants_manager This is the design document for the `vehicle_constants_manager` package. @@ -83,7 +83,7 @@ vehicle: inertia_yaw_kg_m_2: ``` -## Inputs / Outputs / API {#vehicle-constants-manager-package-design-inputs} +## Inputs / Outputs / API + yolov3 Redmon, J., & Farhadi, A. (2018). Yolov3: An incremental improvement. arXiv preprint arXiv:1804.02767. diff --git a/planning/behavior_velocity_planner/occlusion-spot-design.md b/planning/behavior_velocity_planner/occlusion-spot-design.md index 3cce4365e4de..b4670eef0345 100644 --- a/planning/behavior_velocity_planner/occlusion-spot-design.md +++ b/planning/behavior_velocity_planner/occlusion-spot-design.md @@ -100,7 +100,7 @@ obstacle that can run out from occlusion should have free space until intersecti ##### Possible Collision -obstacle that can run out from occlusion is interruped by moving vehicle. +obstacle that can run out from occlusion is interrupted by moving vehicle. ![brief](./docs/occlusion_spot/raycast_shadow.drawio.svg) #### Module Parameters diff --git a/simulator/simple_planning_simulator/design/simple_planning_simulator-design.md b/simulator/simple_planning_simulator/design/simple_planning_simulator-design.md index 63112315e055..c8b72fd71f1a 100644 --- a/simulator/simple_planning_simulator/design/simple_planning_simulator-design.md +++ b/simulator/simple_planning_simulator/design/simple_planning_simulator-design.md @@ -1,4 +1,4 @@ -# simple_planning_simulator {#simple_planning_simulator-package-design} +# simple_planning_simulator ## Purpose / Use cases