Update API reference docs

Author: Vaibhav Balloli

docs/conf.py

@@ -114,4 +114,4 @@
 
 autodoc_mock_imports = ['alabaster', 'amqp', 'anacondaclient', 'anacondaproject', 'anyjson', 'apscheduler', 'asncrypto', 'astroid', 'astropy', 'atomicwrites', 'attrs', 'autobahn', 'automat', 'babel', 'backcall', 'backportsos', 'backportsshutilgetterminalsize', 'bcrypt', 'beautifulsoup', 'billiard', 'bitarray', 'bkcharts', 'bleach', 'bokeh', 'boto', 'bottleneck', 'celery', 'celluloid', 'certifi', 'cffi', 'chardet', 'click', 'cloudpickle', 'clyent', 'cognitiveface', 'colorama', 'comtypes', 'constantly', 'contextlib', 'cryptography', 'cycler', 'cython', 'cytoolz', 'dask', 'decorator', 'defusedxml', 'distributed', 'dlib', 'dnspython', 'docutils', 'entrypoints', 'etxmlfile', 'eventlet', 'fastcache', 'filelock', 'filterpy', 'flask', 'flaskbcrypt', 'flasklogin', 'flaskmarshmallow', 'flasksession', 'flasksqlacodegen', 'flasksqlalchemy', 'flaskwkhtmltopdf', 'gevent', 'greenlet', 'hpy', 'haversine', 'heapdict', 'hexdump', 'hkdf', 'htmllib', 'humanize', 'hyperlink', 'idna', 'imageio', 'imagesize', 'importlibmetadata', 'incremental', 'inflect', 'ipykernel', 'ipython', 'ipythongenutils', 'ipywidgets', 'isort', 'itsdangerous', 'jdcal', 'jedi', 'jinja', 'jsonschema', 'jupyter', 'jupyterclient', 'jupyterconsole', 'jupytercore', 'jupyterlab', 'jupyterlabserver', 'keyring', 'kiwisolver', 'kombu', 'laika', 'lazyobjectproxy', 'libusb', 'llvmlite', 'locket', 'lxml', 'markupsafe', 'marshmallow', 'marshmallowsqlalchemy', 'matplotlib', 'mccabe', 'menuinst', 'mistune', 'mklfft', 'mklrandom', 'monotonic', 'moreitertools', 'mpmath', 'msgpack', 'multipledispatch', 'mysqlconnector', 'nbconvert', 'nbformat', 'networkx', 'nltk', 'nose', 'notebook', 'numba', 'numexpr', 'numpy', 'numpydoc', 'olefile', 'opencvcontribpython', 'openpyxl', 'packaging', 'pandas', 'pandocfilters', 'parso', 'partd', 'pathpy', 'pathlib', 'patsy', 'pdfkit', 'pep', 'pickleshare', 'pillow', 'pip', 'pluggy', 'ply', 'prometheusclient', 'prompttoolkit', 'psutil', 'py', 'pycodestyle', 'pycosat', 'pycparser', 'pycrypto', 'pycurl', 'pyflakes', 'pygments', 'pyhamcrest', 'pylint', 'pymysql', 'pynacl', 'pyodbc', 'pyopenssl', 'pyparsing', 'pyquaternion', 'pyreadline', 'pyrsistent', 'pysocks', 'pytest', 'pytestarraydiff', 'pytestastropy', 'pytestdoctestplus', 'pytestopenfiles', 'pytestremotedata', 'pythondateutil', 'pytz', 'pywavelets', 'pywin', 'pywinctypes', 'pywinpty', 'pyyaml', 'pyzmq', 'qtawesome', 'qtconsole', 'qtpy', 'redis', 'requests', 'rope', 'ruamelyaml', 'scikitimage', 'scikitlearn', 'scipy', 'seaborn', 'sendtrash', 'setuptools', 'shapelypost', 'simplegeneric', 'singledispatch', 'six', 'snowballstemmer', 'sortedcollections', 'sortedcontainers', 'soupsieve', 'sphinx', 'sphinxcontribwebsupport', 'spyder', 'spyderkernels', 'sqlalchemy', 'statsmodels', 'sympy', 'tables', 'tblib', 'terminado', 'testpath', 'toolz', 'tornado', 'tqdm', 'traitlets', 'txaio', 'typedast', 'tzlocal', 'unicodecsv', 'urllib', 'vine', 'wcwidth', 'webencodings', 'werkzeug', 'wfastcgi', 'wheel', 'widgetsnbextension', 'wincertstore', 'wininetpton', 'winunicodeconsole', 'wrapt', 'xlrd', 'xlsxwriter', 'xlwings', 'xlwt', 'zict', 'zipp', 'zopeinterface', 'mysql']
 
-autodoc_mock_imports += ['ffmpeg', 'flask_sqlalchemy', 'flask_bcrypt', 'flask_cors', 'flask_session', 'sqlalchemy_utils', 'cv2', 'PIL', 'torch', 'torchvision', 'reporter', 'cognitive_face', 'shapely', 'sklearn', 'moviepy', 'natsort' ,'decord', 'hydra', 'typer', 'omegaconf', 'mapping_cli']
+autodoc_mock_imports += ['ffmpeg', 'flask_sqlalchemy', 'flask_bcrypt', 'flask_cors', 'flask_session', 'sqlalchemy_utils', 'cv2', 'PIL', 'torch', 'torchvision', 'reporter', 'cognitive_face', 'shapely', 'sklearn', 'moviepy', 'natsort' ,'decord', 'hydra', 'typer', 'omegaconf']

docs/mapping_cli/mapping_cli.calibration.rst

@@ -0,0 +1,29 @@
+mapping\_cli.calibration
+========================
+
+.. automodule:: mapping_cli.calibration
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      camera_calibration
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.config.config.rst

@@ -0,0 +1,29 @@
+mapping\_cli.config.config
+==========================
+
+.. automodule:: mapping_cli.config.config
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      Config
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.config.rst

@@ -0,0 +1,31 @@
+mapping\_cli.config
+===================
+
+.. automodule:: mapping_cli.config
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   mapping_cli.config.config
+

docs/mapping_cli/mapping_cli.halts.rst

@@ -0,0 +1,32 @@
+mapping\_cli.halts
+==================
+
+.. automodule:: mapping_cli.halts
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      debug_halt_visualize
+      get_halts
+      get_halts_worker
+      smooth_halt_signal
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.locator.rst

@@ -0,0 +1,35 @@
+mapping\_cli.locator
+====================
+
+.. automodule:: mapping_cli.locator
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      black_out
+      generate_trajectory_from_photos
+      get_locations
+      parse_marker_set
+      plot_markers
+      save_box_coords
+      save_line_coords
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.maneuvers.face_verification.rst

@@ -0,0 +1,37 @@
+mapping\_cli.maneuvers.face\_verification
+=========================================
+
+.. automodule:: mapping_cli.maneuvers.face_verification
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      main
+      verify_two_videos
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      FaceVerification
+      Person
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.maneuvers.forward_eight.rst

@@ -0,0 +1,35 @@
+mapping\_cli.maneuvers.forward\_eight
+=====================================
+
+.. automodule:: mapping_cli.maneuvers.forward_eight
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      get_marker_from_frame
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      ForwardEight
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.maneuvers.gaze.rst

@@ -0,0 +1,39 @@
+mapping\_cli.maneuvers.gaze
+===========================
+
+.. automodule:: mapping_cli.maneuvers.gaze
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      classify_gaze
+      get_eucledian_distances
+      kmeans_clustering
+      run_openface
+      start_calib
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      Gaze
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.maneuvers.incline.rst

@@ -0,0 +1,44 @@
+mapping\_cli.maneuvers.incline
+==============================
+
+.. automodule:: mapping_cli.maneuvers.incline
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      get_line
+      get_side_of_marker_from_line
+      incline_rollback_logic
+      percentage_of_points_behind_line
+      plot_legend
+      plot_limits
+      plot_markers
+      plot_traj
+      post_process_direction_vector
+      select_traj_pts_by_direction
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      Incline
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.maneuvers.maneuver.rst

@@ -0,0 +1,29 @@
+mapping\_cli.maneuvers.maneuver
+===============================
+
+.. automodule:: mapping_cli.maneuvers.maneuver
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      Maneuver
+   
+   
+
+   
+   
+   
+
+
+

docs/mapping_cli/mapping_cli.maneuvers.marker_sequence.rst

@@ -0,0 +1,35 @@
+mapping\_cli.maneuvers.marker\_sequence
+=======================================
+
+.. automodule:: mapping_cli.maneuvers.marker_sequence
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      get_marker_from_frame
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      MarkerSequence
+   
+   
+
+   
+   
+   
+
+
+