.. OpenVSLAM documentation master file, created by
   sphinx-quickstart on Sun May 19 18:46:30 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: ./img/logo.png
    :width: 435px
    :align: center

|

.. raw:: html

    <div style="position: relative; padding-bottom: 56.25%;">
    <iframe style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;" src="https://www.youtube.com/embed/Ro_s3Lbx5ms" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
    </div>

|

This is the `OpenVSLAM <https://github.com/xdspacelab/openvslam>`_ documentation.

Contents
--------

.. toctree::
    :maxdepth: 2

    ./overview
    ./installation
    ./simple_tutorial
    ./example
    ./docker
    ./ros_package
    ./trouble_shooting

Cite Us
-------

If you use OpenVSLAM for a publication, please cite it as:

.. code-block:: bibtex

    @inproceedings{openvslam2019,
      author = {Sumikura, Shinya and Shibuya, Mikiya and Sakurada, Ken},
      title = {{OpenVSLAM: A Versatile Visual SLAM Framework}},
      booktitle = {Proceedings of the 27th ACM International Conference on Multimedia},
      series = {MM '19},
      year = {2019},
      isbn = {978-1-4503-6889-6},
      location = {Nice, France},
      pages = {2292--2295},
      numpages = {4},
      url = {http://doi.acm.org/10.1145/3343031.3350539},
      doi = {10.1145/3343031.3350539},
      acmid = {3350539},
      publisher = {ACM},
      address = {New York, NY, USA}
    }