mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-04-22 03:00:22 -04:00
Refactor module links and improve code documentation. (#1211)
* Refactor module links and improve code documentation. Updated documentation to rename "API" sections to "Code Link" for clarity and consistency. Enhanced docstrings for `circle_fitting` and `kmeans_clustering` functions, improving parameter descriptions and adding return value details. Fixed typos in function and file names in the ray casting grid map module. * Fix import typo in ray casting grid map test module. Corrected the import statement in the test file by updating the module's name to `ray_casting_grid_map` for consistency with the source file. This ensures proper functionality of the test suite.
This commit is contained in:
@@ -11,3 +11,7 @@ The red crosses are observations from a ranging sensor.
|
||||
|
||||
The red circle is the estimated object shape using circle fitting.
|
||||
|
||||
Code Link
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autofunction:: Mapping.circle_fitting.circle_fitting.circle_fitting
|
||||
|
||||
@@ -14,8 +14,8 @@ The algorithm is demonstrated on a simple 2D grid with obstacles:
|
||||
|
||||
.. image:: distance_map.png
|
||||
|
||||
API
|
||||
~~~
|
||||
Code Link
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autofunction:: Mapping.DistanceMap.distance_map.compute_sdf
|
||||
|
||||
|
||||
@@ -6,3 +6,9 @@ Gaussian grid map
|
||||
This is a 2D Gaussian grid mapping example.
|
||||
|
||||
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Mapping/gaussian_grid_map/animation.gif
|
||||
|
||||
Code Link
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autofunction:: Mapping.gaussian_grid_map.gaussian_grid_map.generate_gaussian_grid_map
|
||||
|
||||
|
||||
@@ -4,3 +4,9 @@ k-means object clustering
|
||||
This is a 2D object clustering with k-means algorithm.
|
||||
|
||||
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Mapping/kmeans_clustering/animation.gif
|
||||
|
||||
Code Link
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autofunction:: Mapping.kmeans_clustering.kmeans_clustering.kmeans_clustering
|
||||
|
||||
|
||||
@@ -196,3 +196,9 @@ Let’s use this flood fill on real data:
|
||||
|
||||
.. image:: lidar_to_grid_map_tutorial_14_1.png
|
||||
|
||||
Code Link
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autofunction:: Mapping.lidar_to_grid_map.lidar_to_grid_map.main
|
||||
|
||||
|
||||
|
||||
@@ -25,8 +25,8 @@ This is an example of normal vector calculation:
|
||||
|
||||
.. figure:: normal_vector_calc.png
|
||||
|
||||
API
|
||||
=====
|
||||
Code Link
|
||||
==========
|
||||
|
||||
.. autofunction:: Mapping.normal_vector_estimation.normal_vector_estimation.calc_normal_vector
|
||||
|
||||
@@ -67,8 +67,8 @@ This is an example of RANSAC based normal vector estimation:
|
||||
|
||||
.. figure:: ransac_normal_vector_estimation.png
|
||||
|
||||
API
|
||||
=====
|
||||
Code Link
|
||||
==========
|
||||
|
||||
.. autofunction:: Mapping.normal_vector_estimation.normal_vector_estimation.ransac_normal_vector_estimation
|
||||
|
||||
|
||||
@@ -27,8 +27,8 @@ This method determines which each point is in a grid, and replaces the point
|
||||
clouds that are in the same Voxel with their average to reduce the number of
|
||||
points.
|
||||
|
||||
API
|
||||
=====
|
||||
Code Link
|
||||
==========
|
||||
|
||||
.. autofunction:: Mapping.point_cloud_sampling.point_cloud_sampling.voxel_point_sampling
|
||||
|
||||
@@ -61,8 +61,8 @@ Although this method does not have good performance comparing the Farthest
|
||||
distance sample where each point is distributed farther from each other,
|
||||
this is suitable for real-time processing because of its fast computation time.
|
||||
|
||||
API
|
||||
=====
|
||||
Code Link
|
||||
==========
|
||||
|
||||
.. autofunction:: Mapping.point_cloud_sampling.point_cloud_sampling.poisson_disk_sampling
|
||||
|
||||
|
||||
@@ -3,4 +3,9 @@ Ray casting grid map
|
||||
|
||||
This is a 2D ray casting grid mapping example.
|
||||
|
||||
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Mapping/raycasting_grid_map/animation.gif
|
||||
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Mapping/raycasting_grid_map/animation.gif
|
||||
|
||||
Code Link
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autofunction:: Mapping.ray_casting_grid_map.ray_casting_grid_map.generate_ray_casting_grid_map
|
||||
|
||||
@@ -57,8 +57,8 @@ This evaluation function uses the squreed distances between the edges of the rec
|
||||
Calculating the squared error is the same as calculating the variance.
|
||||
The smaller this variance, the more it signifies that the points fit within the rectangle.
|
||||
|
||||
API
|
||||
~~~~~~
|
||||
Code Link
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: Mapping.rectangle_fitting.rectangle_fitting.LShapeFitting
|
||||
:members:
|
||||
|
||||
Reference in New Issue
Block a user