:py:mod:`hypso.classification.water`
====================================

.. py:module:: hypso.classification.water


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


Functions
~~~~~~~~~

.. autoapisummary::

   hypso.classification.water.ndwi_watermask
   hypso.classification.water.threshold_watermask



.. py:function:: ndwi_watermask(sat_obj, product_to_use = 'L1C')

   Compute the Water Mask using the Normalized Difference Water Index (NDWI). This method was originally developed by
   Mauricio Cordeiro (https://github.com/cordmaur/WaterDetect)

   :param sat_obj: Hypso satellite object
   :param product_to_use: String of product to use for calculating the water mask. Default and recommended: "L1C"

   :return: No Return


.. py:function:: threshold_watermask(sat_obj, threshold_val = 2.9)

   Simple Threshold WaterMask

   :param sat_obj: Hypso satellite object
   :param threshold_val: Threshold value for pixel contrast. Default is 2.9
   :return: