Skip to content

r.area

Calculates area of clumped areas and remove areas smaller or greater than given threshold.

r.area [-b] input=name output=name [lesser=integer] [greater=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.area input=name output=name

grass.script.run_command("r.area", input, output, lesser=0, greater=-1, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.area", input="name", output="name")

grass.tools.Tools.r_area(input, output, lesser=0, greater=-1, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_area(input="name", output="name")

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

Parameters

input=name [required]
    Name of cell category map, e.g., maps created with r.clump
output=name [required]
    Name of output raster with categories representing area size (in cells)
lesser=integer
    Remove areas with number of cells lower than given value (0 for none):
    Default: 0
greater=integer
    Remove areas with number of cells greater than given value (-1 for none):
    Default: -1
-b
    Binary output
--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

input : str, required
    Name of cell category map, e.g., maps created with r.clump
    Used as: input, raster, name
output : str, required
    Name of output raster with categories representing area size (in cells)
    Used as: output, raster, name
lesser : int, optional
    Remove areas with number of cells lower than given value (0 for none):
    Default: 0
greater : int, optional
    Remove areas with number of cells greater than given value (-1 for none):
    Default: -1
flags : str, optional
    Allowed values: b
    b
        Binary output
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

input : str | np.ndarray, required
    Name of cell category map, e.g., maps created with r.clump
    Used as: input, raster, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name of output raster with categories representing area size (in cells)
    Used as: output, raster, name
lesser : int, optional
    Remove areas with number of cells lower than given value (0 for none):
    Default: 0
greater : int, optional
    Remove areas with number of cells greater than given value (-1 for none):
    Default: -1
flags : str, optional
    Allowed values: b
    b
        Binary output
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

Module r.area reclassifies raster areas (created typically with r.clump) to values representing their size (in cells). Additionally, it can be used to remove areas smaller or greater than a threshold.

NOTE

If areas belonging to a certain category are not continuous every area belonging to the same category has the same area value.

SEE ALSO

r.clump, r.mapcalc, r.reclass.area

AUTHOR

Jarek Jasiewicz

SOURCE CODE

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