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: update link style and fix typos #950

Merged
merged 45 commits into from
May 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
b9530c2
feat(state_rviz_plugin): add GateMode and PathChangeApproval Button (…
h-ohta May 13, 2022
833890b
docs: update link style
shmpwk May 24, 2022
70ae277
chore: fix link
shmpwk May 24, 2022
f9245bb
feat(map_tf_generator): accelerate the 'viewer' coordinate calculatio…
IshitaTakeshi May 13, 2022
a288e86
docs(obstacle_stop_planner): update documentation (#880)
satoshi-ota May 13, 2022
67ead59
docs(tier4_traffic_light_rviz_plugin): update documentation (#905)
satoshi-ota May 16, 2022
6481fb7
fix(accel_brake_map_calibrator): rviz panel type (#895)
soblin May 16, 2022
c09ca55
fix(behavior velocity planner): skipping emplace back stop reason if …
TakumiKozaka-T4 May 17, 2022
7c3af6b
feat(behavior_path_planner): weakened noise filtering of drivable are…
takayuki5168 May 17, 2022
e3250f9
refactor(vehicle-cmd-gate): using namespace for msgs (#913)
TakaHoribe May 18, 2022
de88594
feat(pose_initializer): introduce an array copy function (#900)
IshitaTakeshi May 18, 2022
1c0c53e
feat: add lidar point filter when debug (#865)
storrrrrrrrm May 18, 2022
6f4c53a
feat(component_interface_utils): add interface classes (#899)
isamu-takagi May 18, 2022
44c3088
refactor(vehicle_cmd_gate): change namespace in launch file (#927)
brkay54 May 19, 2022
cd69d73
feat: visualize lane boundaries (#923)
h-ohta May 19, 2022
bd9494f
fix(system_monitor): fix truncation warning in strncpy (#872)
ito-san May 19, 2022
834e19b
fix(behavior_velocity_planner.stopline): extend following and previou…
h-ohta May 19, 2022
646ea94
docs(surround obstacle checker): update documentation (#878)
satoshi-ota May 19, 2022
fb3d710
feat(tier4_autoware_utils): add vehicle state checker (#896)
satoshi-ota May 19, 2022
7cd2177
fix(motion_velocity_smoother): fix overwriteStopPoint using backward …
kosuke55 May 19, 2022
7f3a630
feat(obstacle_avoidance_planner): explicitly insert zero velocity (#906)
takayuki5168 May 19, 2022
a4e0134
feat(behavior_velocity): find occlusion more efficiently (#829)
taikitanaka3 May 20, 2022
4b3b534
fix(system_monitor): add some smart information to diagnostics (#708)
kk-inoue-esol May 20, 2022
1766f3f
feat(obstacle_avoidance_planner): dealt with close lane change (#921)
takayuki5168 May 20, 2022
c4cfee9
feat(obstacle_avoidance_planner): some fix for narrow driving (#916)
takayuki5168 May 20, 2022
3e46db5
chore(obstacle_avoidance_planner): removed obsolete obstacle_avoidanc…
takayuki5168 May 20, 2022
422e236
chore(behavior_velocity_planner.stopline): add debug marker for stopl…
h-ohta May 20, 2022
470d67c
feat(map_loader): visualize center line by points (#931)
h-ohta May 20, 2022
5e54418
feat: add RTC interface (#765)
rej55 May 20, 2022
2e389d7
chore: sync files (#911)
awf-autoware-bot[bot] May 21, 2022
fd74302
fix: replace boost::mutex::scoped_lock to std::scoped_lock (#907)
RyuYamamoto May 23, 2022
3e1d544
feat(tensorrt_yolo): add multi gpu support to tensorrt_yolo node (#885)
kaancolak May 23, 2022
a2cfbf1
feat(tier4_planning_launch): create parameter yaml for behavior_veloc…
h-ohta May 23, 2022
b9f68cb
fix(map_loader): use std::filesystem to load pcd files in pointcloud_…
RyuYamamoto May 23, 2022
ed667ce
fix: relative link
shmpwk May 24, 2022
ce80814
fix: relative links
shmpwk May 24, 2022
9bf8e17
fix: relative links
shmpwk May 24, 2022
dcce194
fix: relative links
shmpwk May 24, 2022
e42dcac
fix: typo
shmpwk May 24, 2022
9111ee7
fix relative links
May 24, 2022
d6c7f25
docs: ignore rare unknown words
shmpwk May 24, 2022
23cc1fb
ci(pre-commit): autofix
pre-commit-ci[bot] May 24, 2022
2c5a121
docs: ignore unknown words one by one
shmpwk May 24, 2022
5d4b005
Merge branch 'main' into docs/update_link
kenji-miyake May 24, 2022
12f1778
ci(pre-commit): autofix
pre-commit-ci[bot] May 24, 2022
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
2 changes: 1 addition & 1 deletion common/autoware_auto_common/design/comparisons.md
Original file line number Diff line number Diff line change
@@ -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_`.
Expand Down
2 changes: 1 addition & 1 deletion common/autoware_auto_geometry/design/interval.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
6 changes: 4 additions & 2 deletions common/autoware_auto_geometry/design/spatial-hash-design.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.

<!-- cspell:ignore CRTP -->

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.

Expand Down
8 changes: 4 additions & 4 deletions common/autoware_auto_tf2/design/autoware-auto-tf2-design.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -169,15 +169,15 @@ 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
implementation of non-standard `toMsg` would not help the convert.
- `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.

<!-- # Related issues -->
<!-- Required -->
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# autoware_testing {#autoware_testing-package-design}
# autoware_testing

This is the design document for the `autoware_testing` package.

Expand Down
2 changes: 1 addition & 1 deletion common/fake_test_node/design/fake_test_node-design.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fake Test Node {#fake-test-node-design}
# Fake Test Node

## What this package provides

Expand Down
2 changes: 1 addition & 1 deletion common/osqp_interface/design/osqp_interface-design.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -83,7 +83,7 @@ vehicle:
inertia_yaw_kg_m_2:
```

## Inputs / Outputs / API {#vehicle-constants-manager-package-design-inputs}
## Inputs / Outputs / API

<!-- Required -->
<!-- Things to consider:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Trajectory Follower {#trajectory_follower-package-design}
# Trajectory Follower

This is the design document for the `trajectory_follower` package.

Expand All @@ -12,9 +12,9 @@ This package provides the library code used by the nodes of the `trajectory_foll
Mainly, it implements two algorithms:

- Model-Predictive Control (MPC) for the computation of lateral steering commands.
- @subpage trajectory_follower-mpc-design
- [trajectory_follower-mpc-design](trajectory_follower-mpc-design.md)
- PID control for the computation of velocity and acceleration commands.
- @subpage trajectory_follower-pid-design
- [trajectory_follower-pid-design](trajectory_follower-pid-design.md)

## Related issues

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MPC (Trajectory Follower) {#trajectory_follower-mpc-design}
# MPC (Trajectory Follower)

This is the design document for the MPC implemented in the `trajectory_follower` package.

Expand Down Expand Up @@ -34,7 +34,7 @@ Different vehicle models are implemented:

The `kinematics` model is being used by default. Please see the reference [1] for more details.

For the optimization, a Quadratric Programming (QP) solver is used
For the optimization, a Quadratic Programming (QP) solver is used
with two options are currently implemented:

- `unconstraint` : use least square method to solve unconstraint QP with eigen.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PID (Trajectory Follower) {#trajectory_follower-pid-design}
# PID (Trajectory Follower)

This is the design document for the PID implemented in the `trajectory_follower` package.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Lateral Controller {#lateral-controller-design}
# Lateral Controller

This is the design document for the lateral controller node
in the `trajectory_follower_nodes` package.
Expand All @@ -23,7 +23,7 @@ The MPC uses a model of the vehicle to simulate the trajectory resulting from th
The optimization of the control command is formulated as a Quadratic Program (QP).

These functionalities are implemented in the `trajectory_follower` package
(see @subpage trajectory_follower-mpc-design)
(see [trajectory_follower-mpc-design](../../trajectory_follower/design/trajectory_follower-mpc-design.md#mpc-trajectory-follower))

### Assumptions / Known limits

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Lateral/Longitudinal Control Muxer {#latlon-muxer-design}
# Lateral/Longitudinal Control Muxer

## Purpose

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Longitudinal Controller {#longitudinal-controller-design}
# Longitudinal Controller

## Purpose / Use cases

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Trajectory Follower Nodes {#trajectory_follower_nodes-package-design}
# Trajectory Follower Nodes

## Purpose

Expand All @@ -8,12 +8,12 @@ Generate control commands to follow a given Trajectory.

This functionality is decomposed into three nodes.

- @subpage lateral-controller-design : generates lateral control messages.
- @subpage longitudinal-controller-design : generates longitudinal control messages.
- @subpage latlon-muxer-design : combines the lateral and longitudinal control commands
- [lateral-controller-design](lateral_controller-design.md) : generates lateral control messages.
- [longitudinal-controller-design](longitudinal_controller-design.md) : generates longitudinal control messages.
- [latlon-muxer-design](latlon_muxer-design.md) : combines the lateral and longitudinal control commands
into a single control command.

Core functionalities are implemented in the @subpage trajectory_follower-package-design package.
Core functionalities are implemented in the [trajectory_follower](../../trajectory_follower/design/trajectory_follower-design.md#trajectory-follower) package.

@image html images/trajectory_follower-diagram.png "Overview of the Trajectory Follower package"

Expand Down
2 changes: 2 additions & 0 deletions perception/tensorrt_yolo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This package detects 2D bounding boxes for target objects e.g., cars, trucks, bi

### Cite

<!-- cspell:ignore Redmon, Farhadi, Bochkovskiy, Jocher, ultralytics, Roboflow, Zenodo -->

yolov3

Redmon, J., & Farhadi, A. (2018). Yolov3: An incremental improvement. arXiv preprint arXiv:1804.02767.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# simple_planning_simulator {#simple_planning_simulator-package-design}
# simple_planning_simulator

## Purpose / Use cases

Expand Down