Skip to content

Commit 35984e8

Browse files
authored
clean up localization docs (AtsushiSakai#570)
* clean up localization docs * clean up localization docs * clean up localization docs
1 parent 137e372 commit 35984e8

File tree

9 files changed

+28
-1504
lines changed

9 files changed

+28
-1504
lines changed

Localization/Kalmanfilter_basics.ipynb

Lines changed: 0 additions & 769 deletions
This file was deleted.

Localization/Kalmanfilter_basics_2.ipynb

Lines changed: 0 additions & 381 deletions
This file was deleted.

Localization/bayes_filter.png

-1.04 MB
Binary file not shown.
-110 KB
Binary file not shown.

Localization/extended_kalman_filter/extended_kalman_filter_localization.ipynb

Lines changed: 0 additions & 264 deletions
This file was deleted.

Localization/particle_filter/particle_filter.ipynb

Lines changed: 0 additions & 72 deletions
This file was deleted.

docs/modules/appendix/Kalmanfilter_basics.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,8 @@ described with two parameters, the mean (:math:`\mu`) and the variance
222222
223223
f(x, \mu, \sigma) = \frac{1}{\sigma\sqrt{2\pi}} \exp\big [{-\frac{(x-\mu)^2}{2\sigma^2} }\big ]
224224
225-
Range is
226225
227-
.. math:: [-\inf,\inf]
226+
Range is :math:`[-\inf,\inf]`
228227

229228
This is just a function of mean(\ :math:`\mu`) and standard deviation
230229
(:math:`\sigma`) and what gives the normal distribution the
@@ -279,7 +278,8 @@ New mean is
279278

280279
.. math:: \mu_\mathtt{new} = \frac{\sigma_z^2\bar\mu + \bar\sigma^2z}{\bar\sigma^2+\sigma_z^2}
281280

282-
New variance is
281+
282+
New variance is
283283

284284
.. math::
285285
@@ -336,7 +336,7 @@ of the two.
336336
.. math::
337337
338338
\begin{gathered}\mu_x = \mu_p + \mu_z \\
339-
\sigma_x^2 = \sigma_z^2+\sigma_p^2\, \square\end{gathered}
339+
\sigma_x^2 = \sigma_z^2+\sigma_p^2\, \end{gathered}
340340
341341
.. code-block:: ipython3
342342

docs/modules/localization/extended_kalman_filter_localization.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,6 @@
22
Extended Kalman Filter Localization
33
-----------------------------------
44

5-
.. code-block:: ipython3
6-
7-
from IPython.display import Image
8-
Image(filename="ekf.png",width=600)
9-
10-
11-
12-
135
.. image:: extended_kalman_filter_localization_files/extended_kalman_filter_localization_1_0.png
146
:width: 600px
157

@@ -18,8 +10,6 @@ Extended Kalman Filter Localization
1810
.. figure:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Localization/extended_kalman_filter/animation.gif
1911
:alt: EKF
2012

21-
EKF
22-
2313
This is a sensor fusion localization with Extended Kalman Filter(EKF).
2414

2515
The blue line is true trajectory, the black line is dead reckoning
@@ -127,7 +117,7 @@ The observation function states that
127117

128118
Its Jacobian matrix is
129119

130-
:math:`\begin{equation*} J_g = \begin{bmatrix} \frac{\partial x'}{\partial x} & \frac{\partial x'}{\partial y} & \frac{\partial x'}{\partial \phi} & \frac{\partial x'}{\partial v}\\ \frac{\partial y'}{\partial x}& \frac{\partial y'}{\partial y} & \frac{\partial y'}{\partial \phi} & \frac{\partial y'}{ \partialv}\\ \end{bmatrix} \end{equation*}`
120+
:math:`\begin{equation*} J_g = \begin{bmatrix} \frac{\partial x'}{\partial x} & \frac{\partial x'}{\partial y} & \frac{\partial x'}{\partial \phi} & \frac{\partial x'}{\partial v}\\ \frac{\partial y'}{\partial x}& \frac{\partial y'}{\partial y} & \frac{\partial y'}{\partial \phi} & \frac{\partial y'}{ \partial v}\\ \end{bmatrix} \end{equation*}`
131121

132122
:math:`\begin{equation*}  = \begin{bmatrix} 1& 0 & 0 & 0\\ 0 & 1 & 0 & 0\\ \end{bmatrix} \end{equation*}`
133123

docs/modules/localization/localization.rst

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ This is a sensor fusion localization with Unscented Kalman Filter(UKF).
1515

1616
The lines and points are same meaning of the EKF simulation.
1717

18-
Ref:
18+
References:
19+
~~~~~~~~~~~
1920

2021
- `Discriminatively Trained Unscented Kalman Filter for Mobile Robot
2122
Localization`_
@@ -37,9 +38,26 @@ It is assumed that the robot can measure a distance from landmarks
3738

3839
This measurements are used for PF localization.
3940

40-
Ref:
41+
How to calculate covariance matrix from particles
42+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43+
44+
The covariance matrix :math:`\Xi` from particle information is calculated by the following equation:
45+
46+
.. math:: \Xi_{j,k}=\frac{1}{1-\sum^N_{i=1}(w^i)^2}\sum^N_{i=1}w^i(x^i_j-\mu_j)(x^i_k-\mu_k)
47+
48+
- :math:`\Xi_{j,k}` is covariance matrix element at row :math:`i` and column :math:`k`.
49+
50+
- :math:`w^i` is the weight of the :math:`i` th particle.
51+
52+
- :math:`x^i_j` is the :math:`j` th state of the :math:`i` th particle.
53+
54+
- :math:`\mu_j` is the :math:`j` th mean state of particles.
55+
56+
References:
57+
~~~~~~~~~~~
4158

4259
- `PROBABILISTIC ROBOTICS`_
60+
- `Improving the particle filter in high dimensions using conjugate artificial process noise`_
4361

4462
Histogram filter localization
4563
-----------------------------
@@ -59,12 +77,14 @@ localization.
5977

6078
Initial position is not needed.
6179

62-
Ref:
80+
References:
81+
~~~~~~~~~~~
6382

6483
- `PROBABILISTIC ROBOTICS`_
6584

6685
.. _PROBABILISTIC ROBOTICS: http://www.probabilistic-robotics.org/
6786
.. _Discriminatively Trained Unscented Kalman Filter for Mobile Robot Localization: https://www.researchgate.net/publication/267963417_Discriminatively_Trained_Unscented_Kalman_Filter_for_Mobile_Robot_Localization
87+
.. _Improving the particle filter in high dimensions using conjugate artificial process noise: https://arxiv.org/pdf/1801.07000.pdf
6888

6989
.. |2| image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Localization/unscented_kalman_filter/animation.gif
7090
.. |3| image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Localization/particle_filter/animation.gif

0 commit comments

Comments
 (0)