vyperdatum.utils.spatial_utils
==============================

.. py:module:: vyperdatum.utils.spatial_utils


Attributes
----------

.. autoapisummary::

   vyperdatum.utils.spatial_utils.logger


Functions
---------

.. autoapisummary::

   vyperdatum.utils.spatial_utils.get_grid_list
   vyperdatum.utils.spatial_utils.get_region_polygons
   vyperdatum.utils.spatial_utils.overlapping_regions
   vyperdatum.utils.spatial_utils.overlapping_extents


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

.. py:data:: logger

.. py:function:: get_grid_list(vdatum_directory: str)

   Return all gtx files in the vdatum directory.

   :param vdatum_directory: absolute folder path to the vdatum directory

   :returns: * *dict* -- dictionary of {grid name: grid path, ...}
             * *list* -- list of vdatum regions


.. py:function:: get_region_polygons(datums_directory: str, extension: str = 'kml') -> dict

   "
   Search the datums directory to find all geometry files.
   All datums are assumed to reside in a subfolder.

   :param datums_directory: absolute folder path to the vdatum directory
   :type datums_directory: str
   :param extension: the geometry file extension to search for
   :type extension: str

   :returns: dictionary of {kml name: kml path, ...}
   :rtype: dict


.. py:function:: overlapping_regions(datums_directory: str, lon_min: float, lat_min: float, lon_max: float, lat_max: float) -> list[str]

   Return the region names that intersect with the provided bound.
   The input coordinate reference system is expected to be
   NAD83(2011) geographic.

   :param lon_min: the minimum longitude of the area of interest
   :param lat_min: the minimum latitude of the area of interest
   :param lon_max: the maximum longitude of the area of interest
   :param lat_max: the maximum latitude of the area of interest

   :rtype: list[str]


.. py:function:: overlapping_extents(lon_min: float, lat_min: float, lon_max: float, lat_max: float) -> Union[Optional[list], Optional[pandas.DataFrame]]

   Return database predefined extents that intersect with an area of interest.
   The results are sorted by coverage ratios.

   :param lon_min: the minimum longitude of the area of interest
   :param lat_min: the minimum latitude of the area of interest
   :param lon_max: the maximum longitude of the area of interest
   :param lat_max: the maximum latitude of the area of interest