Skip to content

r.in.gridatb

Imports GRIDATB.FOR map file (TOPMODEL) into a GRASS raster map.

r.in.gridatb input=name output=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.in.gridatb input=name output=name

grass.script.run_command("r.in.gridatb", input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

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

grass.tools.Tools.r_in_gridatb(input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_in_gridatb(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]
    GRIDATB i/o map file
output=name [required]
    Name for output raster 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

input : str, required
    GRIDATB i/o map file
    Used as: input, file, name
output : str, required
    Name for output raster 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

input : str | io.StringIO, required
    GRIDATB i/o map file
    Used as: input, file, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name for output raster 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

r.in.gridatb imports GRIDATB.FOR map file (TOPMODEL) into GRASS raster map.

SEE ALSO

r.topmodel, r.out.gridatb

AUTHOR

Huidae Cho based on code from Keith Beven

SOURCE CODE

Available at: r.in.gridatb source code (history)
Latest change: Monday Aug 11 16:55:15 2025 in commit d0e1472