Skip to content

Commit 4d60c3c

Browse files
AtsushiSakaiAtsushiSakai
authored
update docs (AtsushiSakai#589)
* update docs * update docs
1 parent 2c07722 commit 4d60c3c

File tree

32 files changed

+493
-409
lines changed

32 files changed

+493
-409
lines changed

‎docs/modules/path_planning/bezier_path_planning/Figure_1.png‎ renamed to ‎docs/modules/path_planning/bezier_path/Figure_1.png‎

File renamed without changes.

‎docs/modules/path_planning/bezier_path_planning/Figure_2.png‎ renamed to ‎docs/modules/path_planning/bezier_path/Figure_2.png‎

File renamed without changes.

‎docs/modules/path_planning/bezier_path/bezier_path.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Bezier path planning
2+
--------------------
3+
4+
A sample code of Bezier path planning.
5+
6+
It is based on 4 control points Beizer path.
7+
8+
.. image:: Bezier_path/Figure_1.png
9+
10+
If you change the offset distance from start and end point,
11+
12+
You can get different Beizer course:
13+
14+
.. image:: Bezier_path/Figure_2.png
15+
16+
Ref:
17+
18+
- `Continuous Curvature Path Generation Based on Bezier Curves for
19+
Autonomous
20+
Vehicles <http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.294.6438&rep=rep1&type=pdf>`__

‎docs/modules/path_planning/bspline_path/bspline_path.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
B-Spline planning
2+
-----------------
3+
4+
.. image:: bspline_path/Figure_1.png
5+
6+
This is a path planning with B-Spline curse.
7+
8+
If you input waypoints, it generates a smooth path with B-Spline curve.
9+
10+
The final course should be on the first and last waypoints.
11+
12+
Ref:
13+
14+
- `B-spline - Wikipedia <https://en.wikipedia.org/wiki/B-spline>`__

‎docs/modules/path_planning/bugplanner/bugplanner.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Bug planner
2+
-----------
3+
4+
This is a 2D planning with Bug algorithm.
5+
6+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/BugPlanner/animation.gif
7+
8+
- `ECE452 Bug Algorithms <https://sites.google.com/site/ece452bugalgorithms/>`_

‎docs/modules/path_planning/coverage_path/coverage_path.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Coverage path planner
2+
---------------------
3+
4+
Grid based sweep
5+
~~~~~~~~~~~~~~~~
6+
7+
This is a 2D grid based sweep coverage path planner simulation:
8+
9+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/GridBasedSweepCPP/animation.gif
10+
11+
Spiral Spanning Tree
12+
~~~~~~~~~~~~~~~~~~~~
13+
14+
This is a 2D grid based spiral spanning tree coverage path planner simulation:
15+
16+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/SpiralSpanningTreeCPP/animation1.gif
17+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/SpiralSpanningTreeCPP/animation2.gif
18+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/SpiralSpanningTreeCPP/animation3.gif
19+
20+
- `Spiral-STC: An On-Line Coverage Algorithm of Grid Environments by a Mobile Robot <https://ieeexplore.ieee.org/abstract/document/1013479>`_
21+
22+
23+
Wavefront path
24+
~~~~~~~~~~~~~~
25+
26+
This is a 2D grid based wavefront coverage path planner simulation:
27+
28+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/WavefrontCPP/animation1.gif
29+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/WavefrontCPP/animation2.gif
30+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/WavefrontCPP/animation3.gif
31+
32+
- `Planning paths of complete coverage of an unstructured environment by a mobile robot <http://pinkwink.kr/attachment/[email protected]>`_
33+
34+

‎docs/modules/path_planning/cubic_spline/cubic_spline.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Cubic spline planning
2+
---------------------
3+
4+
A sample code for cubic path planning.
5+
6+
This code generates a curvature continuous path based on x-y waypoints
7+
with cubic spline.
8+
9+
Heading angle of each point can be also calculated analytically.
10+
11+
.. image:: cubic_spline/Figure_1.png
12+
.. image:: cubic_spline/Figure_2.png
13+
.. image:: cubic_spline/Figure_3.png

‎docs/modules/path_planning/dubins_path/dubins_path.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Dubins path planning
2+
--------------------
3+
4+
A sample code for Dubins path planning.
5+
6+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/DubinsPath/animation.gif?raw=True
7+
8+
Ref:
9+
10+
- `Dubins path -
11+
Wikipedia <https://en.wikipedia.org/wiki/Dubins_path>`__

‎docs/modules/path_planning/dynamic_window_approach/dynamic_window_approach.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Dynamic Window Approach
2+
-----------------------
3+
4+
This is a 2D navigation sample code with Dynamic Window Approach.
5+
6+
- `The Dynamic Window Approach to Collision
7+
Avoidance <https://www.ri.cmu.edu/pub_files/pub1/fox_dieter_1997_1/fox_dieter_1997_1.pdf>`__
8+
9+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/DynamicWindowApproach/animation.gif

‎docs/modules/path_planning/eta3_spline/eta3_spline.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _eta^3-spline-path-planning:
2+
3+
Eta^3 Spline path planning
4+
--------------------------
5+
6+
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathPlanning/Eta3SplinePath/animation.gif
7+
8+
This is a path planning with Eta^3 spline.
9+
10+
Ref:
11+
12+
- `\\eta^3-Splines for the Smooth Path Generation of Wheeled Mobile
13+
Robots <https://ieeexplore.ieee.org/document/4339545/>`__

0 commit comments

Comments
 (0)