:py:mod:`geovista.geometry`
===========================

.. py:module:: geovista.geometry

.. autoapi-nested-parse::

   Provide Natural Earth geometry support.

   Notes
   -----
   .. versionadded:: 0.1.0

   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   geovista.geometry.coastlines
   geovista.geometry.load_coastline_geometries
   geovista.geometry.load_coastlines



.. py:function:: coastlines(resolution = None, radius = None, zlevel = None, zscale = None)

   
   Create or fetch the cached mesh of the coastlines.


   :Parameters:

       **resolution** : :class:`python:str`, optional
           The resolution of the Natural Earth coastlines, which may be either
           ``110m``, ``50m``, or ``10m``. Defaults to
           :data:`geovista.common.COASTLINES_RESOLUTION`.

       **radius** : :class:`python:float`, optional
           The radius of the sphere. Defaults to :data:`geovista.common.RADIUS`.

       **zlevel** : :class:`python:int`, default=1
           The z-axis level. Used in combination with the `zscale` to offset the
           `radius` by a proportional amount i.e., ``radius * zlevel * zscale``.

       **zscale** : :class:`python:float`, optional
           The proportional multiplier for z-axis `zlevel`. Defaults to
           :data:`geovista.common.ZLEVEL_SCALE`.



   :Returns:

       :obj:`PolyData <pyvista.PolyData>`
           A mesh of the coastlines.








   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!

.. py:function:: load_coastline_geometries(resolution = None)

   
   Download Natural Earth coastline shapefile for the required `resolution`.

   If the geometries are not already available within the cartopy cache, then
   they will be downloaded.

   The 2-D longitude (``φ``) and latitude (``λ``) ``xy`` coastline geometries will be
   unpacked as 3-D ``xy0`` coordinates i.e., ``φλ0``.

   :Parameters:

       **resolution** : :class:`python:str`, optional
           The resolution of the Natural Earth coastlines, which may be either
           ``110m``, ``50m`` or ``10m``. Defaults to
           :data:`geovista.common.COASTLINES_RESOLUTION`.



   :Returns:

       :class:`python:list` of :obj:`np.ndarray <numpy.ndarray>`
           A list containing one or more coastline ``xy0`` geometries.








   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!

.. py:function:: load_coastlines(resolution = None, radius = None, zlevel = None, zscale = None)

   
   Create a mesh of coastline geometries at the specified `resolution`.


   :Parameters:

       **resolution** : :class:`python:str`, optional
           The resolution of the Natural Earth coastlines, which may be either
           ``110m``, ``50m``, or ``10m``. Default to
           :data:`geovista.common.COASTLINES_RESOLUTION`.

       **radius** : :class:`python:float`, optional
           The radius of the sphere. Defaults to :data:`geovista.common.RADIUS`.

       **zlevel** : :class:`python:int`, default=0
           The z-axis level. Used in combination with the `zscale` to offset the
           `radius` by a proportional amount i.e., ``radius * zlevel * zscale``.

       **zscale** : :class:`python:float`, optional
           The proportional multiplier for z-axis `zlevel`. Defaults to
           :data:`geovista.common.ZLEVEL_SCALE`.



   :Returns:

       :obj:`PolyData <pyvista.PolyData>`
           A mesh of the coastlines.








   .. rubric:: Notes

   .. versionadded:: 0.1.0

   Calls :func:`load_coastline_geometries` to download the original coastline
   geometries.



   ..
       !! processed by numpydoc !!