hypso.classification.water

Module Contents

Functions

ndwi_watermask(sat_obj[, product_to_use])

Compute the Water Mask using the Normalized Difference Water Index (NDWI). This method was originally developed by

threshold_watermask(sat_obj[, threshold_val])

Simple Threshold WaterMask
hypso.classification.water.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)

Parameters:

  • sat_obj – Hypso satellite object

  • product_to_use (Literal[L1C, L1B, L2-ACOLITE, L2-6SV1]) – String of product to use for calculating the water mask. Default and recommended: “L1C”

Returns:

No Return

Return type:

None

hypso.classification.water.threshold_watermask(sat_obj, threshold_val=2.9)

Simple Threshold WaterMask

Parameters:

  • sat_obj – Hypso satellite object

  • threshold_val (float) – Threshold value for pixel contrast. Default is 2.9

Returns:

Return type:

None