Skip to content

r.what.color

Queries colors for a raster map layer.

r.what.color [-i] input=string [value=float [,float,...]] [format=string] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.what.color input=string

grass.script.run_command("r.what.color", input, value=None, format="%d:%d:%d", flags=None, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.what.color", input="string")

Parameters

input=string [required]
    Name of existing raster map to query colors
value=float [,float,...]
    Values to query colors for
format=string
    Output format (printf-style)
    Default: %d:%d:%d
-i
    Read values from stdin
--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 existing raster map to query colors
    Used as: input, raster
value : float | list[float] | str, optional
    Values to query colors for
format : str, optional
    Output format (printf-style)
    Default: %d:%d:%d
flags : str, optional
    Allowed values: i
    i
        Read values from stdin
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.what.color outputs the color associated with user-specified category values in a raster input map.

Values may be specified either using the values= option, or by specifying the -i flag and passing the values on stdin, one per line.

For each value which is specified, a line of output will be generated consisting of the category value followed by the color, e.g.:

r.what.color input=elevation.dem value=1500
1500: 223:127:31

If the input map is an integer (CELL) map, the category will be written as an integer (no decimal point), otherwise it will be written in floating point format (printf("%.15g") format).

If the lookup fails for a value, the color will be output as an asterisk, e.g.:

r.what.color input=elevation.dem value=9999
9999: *

If a value cannot be parsed, both the value and the color will be output as an asterisk, e.g.:

r.what.color input=elevation.dem value=bogus
*: *

The format can be changed using the format= option. The value should be a printf()-style format string containing three conversion specifiers for the red, green and blue values respectively, e.g.:

r.what.color input=elevation.dem value=1500 format='%02x:%02x:%02x'
1500: df:7f:1f

If your system supports the %m\$ syntax, you can change the ordering of the components, e.g.:

r.what.color input=elevation.dem value=1500 format='%3$02x:%2$02x:%1$02x'
1500: 1f:7f:df

Common formats:

  • Tcl/Tk: format="#%02x%02x%02x"
  • WxPython: format='"#%02x%02x%02x"' or format='"(%d,%d,%d)"'

SEE ALSO

r.what

AUTHOR

Glynn Clements

SOURCE CODE

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