:py:mod:`statgis.gee.river_analysis`
====================================

.. py:module:: statgis.gee.river_analysis

.. autoapi-nested-parse::

   Analyze rivers with satellite images



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


Functions
~~~~~~~~~

.. autoapisummary::

   statgis.gee.river_analysis.plume_characterization



.. py:function:: plume_characterization(image: ee.Image, sample_region: ee.Geometry, blue: str, green: str, red: str, nir: str) -> ee.Image

   Extract river plume from an image based on the colors in a sample region.

   :param Image: Image to be classified.
   :type Image: ee.Image
   :param sample_region: Polygon that encloses a region of the Image that the user identified as
                         river plume.
   :type sample_region: ee.Geometry
   :param blue: Blue band name.
   :type blue: str
   :param green: Green band name.
   :type green: str
   :param red: Red band name.
   :type red: str
   :param nir: Near infrared band name.
   :type nir: str

   :returns: **image** -- Plume characterized in the three color bands.
   :rtype: ee.Image