Skip to content

i.water

Water detection from satellite data derived indices, 1 if found, 0 if not

i.water ndvi=name [albedo=name] [modref7=name] output=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

i.water ndvi=name output=name

grass.script.run_command("i.water", ndvi, albedo=None, modref7=None, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("i.water", ndvi="name", output="name")

grass.tools.Tools.i_water(ndvi, albedo=None, modref7=None, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.i_water(ndvi="name", output="name")

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

Parameters

ndvi=name [required]
    Name of the NDVI layer [-]
albedo=name
    Name of the Albedo layer [-]
modref7=name
    Name of the Modis surface reflectance band 7 layer [-]
output=name [required]
    Name of the output water layer [0/1]
--overwrite
    Allow output files to overwrite existing files
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

ndvi : str, required
    Name of the NDVI layer [-]
    Used as: input, raster, name
albedo : str, optional
    Name of the Albedo layer [-]
    Used as: input, raster, name
modref7 : str, optional
    Name of the Modis surface reflectance band 7 layer [-]
    Used as: input, raster, name
output : str, required
    Name of the output water layer [0/1]
    Used as: output, raster, name
overwrite: bool, optional
    Allow output files to overwrite existing files
    Default: None
verbose: bool, optional
    Verbose module output
    Default: None
quiet: bool, optional
    Quiet module output
    Default: None
superquiet: bool, optional
    Very quiet module output
    Default: None

ndvi : str, required
    Name of the NDVI layer [-]
    Used as: input, raster, name
albedo : str, optional
    Name of the Albedo layer [-]
    Used as: input, raster, name
modref7 : str, optional
    Name of the Modis surface reflectance band 7 layer [-]
    Used as: input, raster, name
output : str, required
    Name of the output water layer [0/1]
    Used as: output, raster, name
overwrite: bool, optional
    Allow output files to overwrite existing files
    Default: None
verbose: bool, optional
    Verbose module output
    Default: None
quiet: bool, optional
    Quiet module output
    Default: None
superquiet: bool, optional
    Very quiet module output
    Default: None

DESCRIPTION

i.water calculates a water layer after Xiao et al (2005) and Roy et al (2005). If input is albedo and ndvi, it will process in generic mode. If input is ndvi and MODIS Band 7 reflectance, it will process in MODIS mode.

NOTES

REFERENCES

Xiao X., Boles S., Liu J., Zhuang D., Frokling S., Li C., Salas W., Moore III B. (2005). Mapping paddy rice agriculture in southern China using multi-temporal MODIS images. Remote Sensing of Environment 95:480-492. Roy D.P., Jin Y., Lewis P.E., Justice C.O. (2005). Prototyping a global algorithm for systematic fire-affected area mapping using MODIS time series data. Remote Sensing of Environment 97:137-162.

SEE ALSO

i.vi, i.albedo i.wi

AUTHOR

Yann Chemin, International Rice Research Insitute, The Philippines

SOURCE CODE

Available at: i.water source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819