Skip to content

r3.support

Allows creation and/or modification of 3D raster map layer support files.

r3.support [-s] map=name [title=phrase] [history=phrase] [unit=string] [vunit=string] [source1=phrase] [source2=phrase] [description=phrase] [raster=string] [loadhistory=name] [savehistory=name] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r3.support map=name

grass.script.run_command("r3.support", map, title=None, history=None, unit=None, vunit=None, source1=None, source2=None, description=None, raster=None, loadhistory=None, savehistory=None, flags=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r3.support", map="name")

Parameters

map=name [required]
    Name of 3D raster map
title=phrase
    Text to use for map title
history=phrase
    Text to append to the next line of the map's metadata file
unit=string
    The map data unit
vunit=string
    The vertical unit of the map
source1=phrase
    Text to use for data source, line 1
source2=phrase
    Text to use for data source, line 2
description=phrase
    Text to use for data description or keyword(s)
raster=string
    Raster map from which to copy category table
loadhistory=name
    Text file from which to load history
savehistory=name
    Text file in which to save history
-s
    Update range
--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

map : str, required
    Name of 3D raster map
    Used as: input, raster_3d, name
title : str, optional
    Text to use for map title
    Used as: phrase
history : str, optional
    Text to append to the next line of the map's metadata file
    Used as: phrase
unit : str, optional
    The map data unit
vunit : str, optional
    The vertical unit of the map
source1 : str, optional
    Text to use for data source, line 1
    Used as: phrase
source2 : str, optional
    Text to use for data source, line 2
    Used as: phrase
description : str, optional
    Text to use for data description or keyword(s)
    Used as: phrase
raster : str, optional
    Raster map from which to copy category table
    Used as: input, raster
loadhistory : str, optional
    Text file from which to load history
    Used as: input, file, name
savehistory : str, optional
    Text file in which to save history
    Used as: output, file, name
flags : str, optional
    Allowed values: s
    s
        Update range
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

r3.support allows the user to create and/or edit raster3d map support information. Editing of raster3d map units, history, description and title is supported.

NOTES

Freeform metadata information is stored in a "hist" file which may be appended to by using the history option. Currently this is limited to text with a maximum line length of 78 characters. Any input larger than this will be wrapped to the next line. All other metadata strings available as standard options are limited to 79 characters.

SEE ALSO

r.info, r.timestamp

AUTHORS

Soeren Gebbert, vTI/AK, soerengebbert gmooglemail.com
Based on r.support written by Micharl Shapiro, CERL and others

SOURCE CODE

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