Skip to content

Commit

Permalink
[PYTHON][DOC] Added ukf examples in Python documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rlagneau committed May 22, 2024
1 parent 451aa4c commit 9e1dd1c
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 0 deletions.
15 changes: 15 additions & 0 deletions modules/python/doc/rst/tutorials/misc/ukf-linear.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Example on a linear case study on how to use Unscented Kalman filter
=======================================================================

This example shows how to use an Unscented Kalman filter in Python.

This example is a linear case study. It is not what is intended for the Unscented
Kalman filter, but it permits to get familiar with the different classes that
are used.

The state vector and measurements are explained in the `C++ example <https://visp-doc.inria.fr/doxygen/visp-daily/ukf-linear-example_8cpp-example.html>`_.



.. literalinclude:: /examples/ukf-linear-example.py
:language: python
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Example on a complex non-linear case study on how to use Unscented Kalman filter
=======================================================================

This example shows how to use an Unscented Kalman filter in Python.

This example is a complex non-linear case study.

The state vector and measurements are explained in the `C++ example <https://visp-doc.inria.fr/doxygen/visp-daily/ukf-nonlinear-complex-example_8cpp-example.html>`_.



.. literalinclude:: /examples/ukf-nonlinear-complex-example.py
:language: python
13 changes: 13 additions & 0 deletions modules/python/doc/rst/tutorials/misc/ukf-nonlinear-linear.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Example on a non-linear case study on how to use Unscented Kalman filter
=======================================================================

This example shows how to use an Unscented Kalman filter in Python.

This example is a non-linear case study.

The state vector and measurements are explained in the `C++ example <https://visp-doc.inria.fr/doxygen/visp-daily/ukf-nonlinear-example_8cpp-example.html>`_.



.. literalinclude:: /examples/ukf-nonlinear-example.py
:language: python
39 changes: 39 additions & 0 deletions modules/python/doc/rst/tutorials/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,42 @@ Tracking
:maxdepth: 2

tracking/*



.. _Examples:

Examples
====================


Visual servoing
-----------------------

.. toctree::
:glob:
:maxdepth: 2

vs/*



Tracking
-----------------------

.. toctree::
:glob:
:maxdepth: 2

tracking/*



Other tools
-----------------------

.. toctree::
:glob:
:maxdepth: 2

misc/*

0 comments on commit 9e1dd1c

Please sign in to comment.