Skip to content

i.theilsen

Computes Theil-Sen estimator from spectrum.

i.theilsen group=name subgroup=name output=name mannkendall=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

i.theilsen group=name subgroup=name output=name mannkendall=name

grass.script.run_command("i.theilsen", group, subgroup, output, mannkendall, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("i.theilsen", group="name", subgroup="name", output="name", mannkendall="name")

grass.tools.Tools.i_theilsen(group, subgroup, output, mannkendall, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.i_theilsen(group="name", subgroup="name", output="name", mannkendall="name")

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

Parameters

group=name [required]
    Name of imagery group
subgroup=name [required]
    Name of imagery subgroup
output=name [required]
    Name of Theil-Sen slope map
mannkendall=name [required]
    Name of Mann-Kendall test map
--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

group : str, required
    Name of imagery group
    Used as: input, group, name
subgroup : str, required
    Name of imagery subgroup
    Used as: input, subgroup, name
output : str, required
    Name of Theil-Sen slope map
    Used as: output, raster, name
mannkendall : str, required
    Name of Mann-Kendall test map
    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

group : str, required
    Name of imagery group
    Used as: input, group, name
subgroup : str, required
    Name of imagery subgroup
    Used as: input, subgroup, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name of Theil-Sen slope map
    Used as: output, raster, name
mannkendall : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name of Mann-Kendall test map
    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

Returns:

result : grass.tools.support.ToolResult | np.ndarray | tuple[np.ndarray] | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None will be returned. If an array type (e.g., np.ndarray) is used for one of the raster outputs, the result will be an array and will have the shape corresponding to the computational region. If an array type is used for more than one raster output, the result will be a tuple of arrays.

DESCRIPTION

i.theilsen A method for robust linear regression. Output is the median slope from all pairs slopes. It is known for its resistance to outliers.

NOTES

REFERENCES

https://en.wikipedia.org/wiki/Theil-Sen_estimator

AUTHOR

Yann Chemin, IWMI, Sri Lanka.

SOURCE CODE

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