pytopomap.plot_3d
=================

.. py:module:: pytopomap.plot_3d

.. autoapi-nested-parse::

   "This" is my example-script
   ===========================

   This example doesn't do much, it just makes a simple plot



Functions
---------

.. autoapisummary::

   pytopomap.plot_3d.plot_topo_3D
   pytopomap.plot_3d.plot_imshow_3D
   pytopomap.plot_3d.plot_data_on_topo_3D


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

.. py:function:: plot_topo_3D(z: numpy.ndarray, x: numpy.ndarray, y: numpy.ndarray, ndv: int | float = -9999, vert_exag: float = 1, light_source: tuple[int, int] = None, add_walls: bool = True, add_floor: bool = True, saving_path: str = None, auto_open: bool = False) -> plotly.graph_objs._figure.Figure

   Plot 3D topography with hillshading.

   :param z: 2D array of elevation values.
   :type z: np.ndarray
   :param x: 1D array of X coordinates.
   :type x: np.ndarray
   :param y: 1D array of Y coordinates.
   :type y: np.ndarray
   :param ndv: No-data value in the elevation array. The default is -9999.
   :type ndv: int or float, optional
   :param vert_exag: Vertical exaggeration factor. The default is 1.
   :type vert_exag: float, optional
   :param light_source: Light source direction for shading (azimuth, degrees from North and altitude, degrees from horizon). The default is None.
   :type light_source: tuple[int], optional
   :param add_walls: If True, add walls under the figure. The default is True
   :type add_walls: bool, optional
   :param add_floor: If True, add floor under the figure. The default is True
   :type add_floor: bool, optional
   :param saving_path: Folder path to save the html file. If None file saved in source folder. The default is None.
   :type saving_path: str, optional
   :param auto_open: If True, open the result. The default is False.
   :type auto_open: bool, optional

   :rtype: None


.. py:function:: plot_imshow_3D(x: numpy.ndarray, y: numpy.ndarray, data: numpy.ndarray, cmap: str = None, minval: int | float = None, maxval: int | float = None, minval_abs: float = None, vert_exag: float = 1.0, saving_path: str = None, auto_open: bool = False) -> plotly.graph_objs._figure.Figure

   3D imshow data

   jfdqsjf

   :param x: 1D array of X coordinates.
   :type x: np.ndarray
   :param y: 1D array of Y coordinates.
   :type y: np.ndarray
   :param data: 2D array of data values.
   :type data: np.ndarray
   :param cmap: Name of the colormap to use. If None, use "Hot" or "Rdbu. The default is None.
   :type cmap: str, optional
   :param minval: Minimum value to display. The default is None.
   :type minval: int or float, optional
   :param maxval: Maximum value to display. The default is None.
   :type maxval: int or float, optional
   :param minval_abs: If set, masks values with absolute magnitude below this threshold. The default is None.
   :type minval_abs: float, optional
   :param vert_exag: Vertical exaggeration factor. The default is 1.
   :type vert_exag: float, optional
   :param saving_path: Folder path to save the html file. If None file saved in source folder. The default is None.
   :type saving_path: str, optional
   :param auto_open: If True, open the result. The default is False.
   :type auto_open: bool, optional

   :returns: _description_
   :rtype: _type_


.. py:function:: plot_data_on_topo_3D(x: numpy.ndarray, y: numpy.ndarray, z: numpy.ndarray, data: numpy.ndarray, ndv: int | float = -9999, vert_exag: float = 1, light_source: tuple[int, int] = None, cmap: str = None, minval: int | float = None, maxval: int | float = None, minval_abs: float = None, add_walls: bool = True, add_floor: bool = True, saving_path: str = None, auto_open: bool = False) -> plotly.graph_objs._figure.Figure

   Plot 3D array data on topo.

   :param x: 1D array of X coordinates.
   :type x: np.ndarray
   :param y: 1D array of Y coordinates.
   :type y: np.ndarray
   :param z: 2D array of elevation values.
   :type z: np.ndarray
   :param data: 2D array of data values.
   :type data: np.ndarray
   :param ndv: No-data value in the elevation array. The default is -9999.
   :type ndv: int or float, optional
   :param light_source: Light source direction for shading (azimuth, degrees from North and altitude, degrees from horizon). The default is None.
   :type light_source: tuple[int], optional
   :param cmap: Name of the colormap to use. If None, use "Hot" or "Rdbu. The default is None.
   :type cmap: str, optional
   :param minval: Minimum value to display. The default is None.
   :type minval: int or float, optional
   :param maxval: Maximum value to display. The default is None.
   :type maxval: int or float, optional
   :param minval_abs: If set, masks values with absolute magnitude below this threshold. The default is None.
   :type minval_abs: float, optional
   :param add_walls: If True, add walls under the figure. The default is True
   :type add_walls: bool, optional
   :param add_floor: If True, add floor under the figure. The default is True
   :type add_floor: bool, optional
   :param saving_path: Folder path to save the html file. If None file saved in source folder. The default is None.
   :type saving_path: str, optional
   :param auto_open: If True, open the result. The default is False.
   :type auto_open: bool, optional

   :rtype: None