Skip to content

Commit

Permalink
Added examples to base_draper documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nilsbore committed Aug 27, 2020
1 parent d2aec23 commit 04494e0
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/base_draper.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
base_draper
===========

The `save_draping_result.py <https://github.com/nilsbore/auvlib/blob/base_draper/src/pydata_tools/scripts/save_draping_result.py>`_ script from **pybathy_maps**
demonstrates how to use the **BaseDraper** class to drape
sidescan onto a bathymetry mesh. You can use the
`display_draping_result.py <https://github.com/nilsbore/auvlib/blob/base_draper/src/pydata_tools/scripts/display_draping_result.py>`_ script to visualize the save data.

.. literalinclude:: ../src/pybathy_maps/scripts/save_draping_result.py
:language: python

.. automodule:: auvlib.bathy_maps.base_draper
:members:
:undoc-members:

0 comments on commit 04494e0

Please sign in to comment.