:py:mod:`uavfpy.planner.plots`
==============================

.. py:module:: uavfpy.planner.plots

.. autoapi-nested-parse::

   
   ..
       !! processed by numpydoc !!


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   uavfpy.planner.plots.plot_surface_3d
   uavfpy.planner.plots.plot_surface_2d



.. py:function:: plot_surface_3d(ax: mpl_toolkits.mplot3d.axes3d.Axes3D, X, Y, Hground, Hsheet, zsquash=0.5, sheetcmap='gist_earth', groundcmap='bone', sheet_alpha=0.4, wireframe=False, wirecount=20)

   
   Put surfaces from `Hground` (the "ground") and `Hsheet` (the "sheet") onto an `ax.` `ax` must
   be a 3d axis.


   :Parameters:

       **ax** : Axes3D
           the axis on which to place the surfaces.

       **X** : np.ndarray
           MxN x coordinate information of the grid

       **Y** : np.ndarray
           MxN y coordinate information of the grid

       **Hground** : np.ndarray
           MxN "ground" height.

       **Hsheet** : np.ndarray
           MxN "sheet" height

       **zsquash** : float, optional
           by default, the 3d projection will render a cube. But this can make obstacles
           appear very tall. So we can squish the grid a bit to make it more like a 3d map and
           less like a cube., by default 0.5

       **sheetcmap** : str, optional
           colormap of the sheet, by default "ocean"

       **groundcmap** : str, optional
           colormap of the ground, by default "copper"

       **sheet_alpha** : float, optional
           alpha of the sheet. 1.0 is completely opaque, 0.0 is not visible, by default 0.4

       **wireframe** : bool, optional
           whether to draw wireframe or surface

   :Returns:

       Axes3D
           ax containing the new plots the `ax` object passed in is altered in place, so
           you don't necessarily need to do anything with this (just calling the function on `ax` is
           enough to alter the object)













   ..
       !! processed by numpydoc !!

.. py:function:: plot_surface_2d(ax, X, Y, Hsheet, cmap='coolwarm', levels=20)

   
   Plot contours of a 3-D surface in 2-d.


   :Parameters:

       **ax** : plt.Axes
           The axis on which to draw the plot. Must be 2D.

       **X** : np.ndarray
           MxN array of grid X-points.

       **Y** : np.ndarray
           MxN array of grid Y-points.

       **Hsheet** : np.ndarray
           MxN array of grid Z-points.

       **cmap** : str, optional
           name of matplotlib colormap.
           See: https://matplotlib.org/stable/tutorials/colors/colormaps.html,
           by default "coolwarm"

       **levels** : int, optional
           Number of contour levels, by default 20

   :Returns:

       plt.Axes
           The plot axes object. Note: plot axes are altered in place by
           this function, so you don't need to assign it.













   ..
       !! processed by numpydoc !!