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

.. py:module:: statgis.gee.classification

.. autoapi-nested-parse::

   Classify pixels in images



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


Functions
~~~~~~~~~

.. autoapisummary::

   statgis.gee.classification.water_coverage
   statgis.gee.classification.vegetation_coverage



.. py:function:: water_coverage(image: ee.Image, blue: str, green: str, red: str, nir: str, swir: str) -> ee.Image

   Function to classify pixels as water based on Based on Zou et al. (2017) and
   Worder & Beurs (2020).

   :param image: Image to classify.
   :type image: ee.Image
   :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
   :param swir: Short-wave infrared band name.
   :type swir: str

   :returns: **image** -- Image with water coverage band classified where water pixels are 1 and
             no-water are 0.
   :rtype: ee.Image


.. py:function:: vegetation_coverage(image: ee.Image, blue: str, red: str, nir: str, swir: str) -> ee.Image

   Function to classify pixels as vegetation based on Based on Zou et al. (2017)
   and Worder & Beurs (2020).

   :param image: Image to classify.
   :type image: ee.Image
   :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
   :param swir: Short-wave infrared band name.
   :type swir: str

   :returns: **image** -- Image with vegetation coverage band classified where vegetation pixels
             are 1 and no-vegetation are 0.
   :rtype: ee.Image