r.mode

Finds the mode of values in a cover map within areas assigned the same category value in a user-specified base map.

Command linePython (grass.script)

r.mode base=string cover=string output=string [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.mode base=string cover=string output=string

grass.script.run_command("r.mode", base, cover, output, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.mode", base="string", cover="string", output="string")

Parameters

Command linePython (grass.script)

base=string [required]
    Base map to be reclassified
cover=string [required]
    Coverage map
output=string [required]
    Output 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

base : str, required
    Base map to be reclassified
    Used as: input, raster
cover : str, required
    Coverage map
    Used as: input, raster
output : str, required
    Output map
    Used as: output, raster
overwrite: bool, optional
    Allow output files to overwrite existing files
    Default: False
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

DESCRIPTION

r.mode calculates the most frequently occurring value (i. e., mode) of data contained in a cover raster map layer for areas assigned the same category value in the user-specified base raster map layer. These modes are stored in the new output map layer.

The output map is actually a reclass of the base map.

The base parameter defines an existing raster map layer in the user's current mapset search path. For each group of cells assigned the same category value in the base map, the mode of the values assigned these cells in the cover map will be computed.

The cover parameter defines an existing raster map layer containing the values to be used to compute the mode within each category of the base map.

NOTES

The user should use the results of r.mode with care. Since this utility assigns a value to each cell which is based on global information (i.e., information at spatial locations other than just the location of the cell itself), the resultant map layer is only valid if the geographic region and mask settings are the same as they were at the time that the result map was created.

Results are affected by the current region settings and mask.

EXAMPLE

Mode of K-factor (erosion) for Spearfish fields:

g.region raster=fields -p
r.mode base=fields cover=soils.Kfactor output=K.by.farm.mode
r.univar K.by.farm.mode

AUTHOR

Michael Shapiro, U.S.Army Construction Engineering Research Laboratory

SOURCE CODE

Available at: r.mode source code (history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f