Skip to content

r3.colors

Creates/modifies the color table associated with a 3D raster map.

r3.colors [-rwldngae] [map=name [,name,...]] [file=name] [color=style] [raster=name] [raster_3d=name] [rules=name] [offset=float] [scale=float] [--verbose] [--quiet] [--qq] [--ui]

Example:

r3.colors map=name

grass.script.parse_command("r3.colors", map=None, file=None, color=None, raster=None, raster_3d=None, rules=None, offset=0, scale=1, flags=None, verbose=False, quiet=False, superquiet=False)

Example:

gs.parse_command("r3.colors", map="name")

Parameters

map=name [,name,...]
    Name of 3D raster map(s)
file=name
    Input file with one map name per line
    Input map names can be defined in an input file in case a large amount of maps must be specified. This option is mutual exclusive to the map option.
color=style
    Name of color table
    Allowed values: aspect, aspectcolr, bcyr, bgyr, blues, byg, byr, celsius, corine, curvature, differences, elevation, etopo2, evi, fahrenheit, forest_cover, gdd, grass, greens, grey, grey.eq, grey.log, grey1.0, grey255, gyr, haxby, inferno, kelvin, magma, ndvi, ndwi, nlcd, oranges, plasma, population, population_dens, precipitation, precipitation_daily, precipitation_monthly, rainbow, ramp, random, reds, roygbiv, rstcurv, ryb, ryg, sepia, slope, soilmoisture, srtm, srtm_percent, srtm_plus, terrain, viridis, water, wave
        aspect     aspect: aspect oriented grey colors [range: map values]
        aspectcolr     aspectcolr: aspect oriented rainbow colors [range: 0 to 360]
        bcyr     bcyr: blue through cyan through yellow to red [range: map values]
        bgyr     bgyr: blue through green through yellow to red [range: map values]
        blues     blues: white to blue [range: map values]
        byg     byg: blue through yellow to green [range: map values]
        byr     byr: blue through yellow to red [range: map values]
        celsius     celsius: blue to red for degree Celsius temperature [range: -80 to 80]
        corine     corine: EU Corine land cover colors [range: 111 to 995]
        curvature     curvature: for terrain curvatures (from v.surf.rst and r.slope.aspect) [range: map values]
        differences     differences: differences oriented colors [range: map values]
        elevation     elevation: maps relative ranges of raster values to elevation color ramp [range: map values]
        etopo2     etopo2: colors for ETOPO2 worldwide bathymetry/topography [range: -11000 to 8850]
        evi     evi: enhanced vegetative index colors [range: -1 to 1]
        fahrenheit     fahrenheit: blue to red for Fahrenheit temperature [range: -112 to 176]
        forest_cover     forest_cover: percentage of forest cover [range: 0 to 100]
        gdd     gdd: accumulated growing degree days [range: 0 to 6000]
        grass     grass: GRASS GIS green (perceptually uniform) [range: map values]
        greens     greens: white to green [range: map values]
        grey     grey: grey scale [range: map values]
        grey.eq     grey.eq: histogram-equalized grey scale [range: map values]
        grey.log     grey.log: histogram logarithmic transformed grey scale [range: map values]
        grey1.0     grey1.0: grey scale for raster values between 0.0-1.0 [range: 0 to 1]
        grey255     grey255: grey scale for raster values between 0-255 [range: 0 to 255]
        gyr     gyr: green through yellow to red [range: map values]
        haxby     haxby: relative colors for bathymetry or topography [range: map values]
        inferno     inferno: perceptually uniform sequential color table inferno [range: map values]
        kelvin     kelvin: blue to red for temperature in Kelvin scale [range: 193.15 to 353.15]
        magma     magma: perceptually uniform sequential color table magma [range: map values]
        ndvi     ndvi: Normalized Difference Vegetation Index colors [range: -1 to 1]
        ndwi     ndwi: Normalized Difference Water Index colors [range: -200 to 200]
        nlcd     nlcd: US National Land Cover Dataset colors [range: 0 to 95]
        oranges     oranges: white to orange [range: map values]
        plasma     plasma: perceptually uniform sequential color table plasma [range: map values]
        population     population: color table covering human population classification breaks [range: 0 to 2e+09]
        population_dens     population_dens: color table covering human population density classification breaks [range: 0 to 1e+09]
        precipitation     precipitation: precipitation color table (0..2000mm) [range: 0 to 7000]
        precipitation_daily     precipitation_daily: precipitation color table (0..1000mm) [range: 0 to 10000]
        precipitation_monthly     precipitation_monthly: precipitation color table (0..1000mm) [range: 0 to 1000]
        rainbow     rainbow: rainbow color table [range: map values]
        ramp     ramp: color ramp [range: map values]
        random     random: random color table [range: map values]
        reds     reds: white to red [range: map values]
        roygbiv     roygbiv: [range: map values]
        rstcurv     rstcurv: terrain curvature (from r.resamp.rst) [range: map values]
        ryb     ryb: red through yellow to blue [range: map values]
        ryg     ryg: red through yellow to green [range: map values]
        sepia     sepia: yellowish-brown through to white [range: map values]
        slope     slope: r.slope.aspect-type slope colors for raster values 0-90 [range: 0 to 90]
        soilmoisture     soilmoisture: soilmoisture color table (0.0-1.0) [range: 0 to 1]
        srtm     srtm: color palette for Shuttle Radar Topography Mission elevation [range: -11000 to 8850]
        srtm_percent     srtm_percent: color palette for Shuttle Radar Topography Mission using relative elevation [range: map values]
        srtm_plus     srtm_plus: color palette for Shuttle Radar Topography Mission elevation (with seafloor colors) [range: -11000 to 8850]
        terrain     terrain: global elevation color table covering -11000 to +8850m [range: -11000 to 8850]
        viridis     viridis: perceptually uniform sequential color table viridis [range: map values]
        water     water: water depth [range: map values]
        wave     wave: color wave [range: map values]
raster=name
    Raster map from which to copy color table
raster_3d=name
    3D raster map from which to copy color table
rules=name
    Path to rules file
    "-" to read rules from stdin
offset=float
    Offset for color rule values
    New value = (old value + offset) * scale
    Default: 0
scale=float
    Scale for color rule values
    New value = (old value + offset) * scale
    Default: 1
-r
    Remove existing color table
-w
    Only write new color table if it does not already exist
-l
    List available rules then exit
-d
    List available rules with description then exit
    If a color rule is given, only this rule is listed
-n
    Invert colors
-g
    Logarithmic scaling
-a
    Logarithmic-absolute scaling
-e
    Histogram equalization
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

map : str | list[str], optional
    Name of 3D raster map(s)
    Used as: input, raster_3d, name
file : str, optional
    Input file with one map name per line
    Input map names can be defined in an input file in case a large amount of maps must be specified. This option is mutual exclusive to the map option.
    Used as: input, file, name
color : str, optional
    Name of color table
    Used as: input, colortable, style
    Allowed values: aspect, aspectcolr, bcyr, bgyr, blues, byg, byr, celsius, corine, curvature, differences, elevation, etopo2, evi, fahrenheit, forest_cover, gdd, grass, greens, grey, grey.eq, grey.log, grey1.0, grey255, gyr, haxby, inferno, kelvin, magma, ndvi, ndwi, nlcd, oranges, plasma, population, population_dens, precipitation, precipitation_daily, precipitation_monthly, rainbow, ramp, random, reds, roygbiv, rstcurv, ryb, ryg, sepia, slope, soilmoisture, srtm, srtm_percent, srtm_plus, terrain, viridis, water, wave
        aspect     aspect: aspect oriented grey colors [range: map values]
        aspectcolr     aspectcolr: aspect oriented rainbow colors [range: 0 to 360]
        bcyr     bcyr: blue through cyan through yellow to red [range: map values]
        bgyr     bgyr: blue through green through yellow to red [range: map values]
        blues     blues: white to blue [range: map values]
        byg     byg: blue through yellow to green [range: map values]
        byr     byr: blue through yellow to red [range: map values]
        celsius     celsius: blue to red for degree Celsius temperature [range: -80 to 80]
        corine     corine: EU Corine land cover colors [range: 111 to 995]
        curvature     curvature: for terrain curvatures (from v.surf.rst and r.slope.aspect) [range: map values]
        differences     differences: differences oriented colors [range: map values]
        elevation     elevation: maps relative ranges of raster values to elevation color ramp [range: map values]
        etopo2     etopo2: colors for ETOPO2 worldwide bathymetry/topography [range: -11000 to 8850]
        evi     evi: enhanced vegetative index colors [range: -1 to 1]
        fahrenheit     fahrenheit: blue to red for Fahrenheit temperature [range: -112 to 176]
        forest_cover     forest_cover: percentage of forest cover [range: 0 to 100]
        gdd     gdd: accumulated growing degree days [range: 0 to 6000]
        grass     grass: GRASS GIS green (perceptually uniform) [range: map values]
        greens     greens: white to green [range: map values]
        grey     grey: grey scale [range: map values]
        grey.eq     grey.eq: histogram-equalized grey scale [range: map values]
        grey.log     grey.log: histogram logarithmic transformed grey scale [range: map values]
        grey1.0     grey1.0: grey scale for raster values between 0.0-1.0 [range: 0 to 1]
        grey255     grey255: grey scale for raster values between 0-255 [range: 0 to 255]
        gyr     gyr: green through yellow to red [range: map values]
        haxby     haxby: relative colors for bathymetry or topography [range: map values]
        inferno     inferno: perceptually uniform sequential color table inferno [range: map values]
        kelvin     kelvin: blue to red for temperature in Kelvin scale [range: 193.15 to 353.15]
        magma     magma: perceptually uniform sequential color table magma [range: map values]
        ndvi     ndvi: Normalized Difference Vegetation Index colors [range: -1 to 1]
        ndwi     ndwi: Normalized Difference Water Index colors [range: -200 to 200]
        nlcd     nlcd: US National Land Cover Dataset colors [range: 0 to 95]
        oranges     oranges: white to orange [range: map values]
        plasma     plasma: perceptually uniform sequential color table plasma [range: map values]
        population     population: color table covering human population classification breaks [range: 0 to 2e+09]
        population_dens     population_dens: color table covering human population density classification breaks [range: 0 to 1e+09]
        precipitation     precipitation: precipitation color table (0..2000mm) [range: 0 to 7000]
        precipitation_daily     precipitation_daily: precipitation color table (0..1000mm) [range: 0 to 10000]
        precipitation_monthly     precipitation_monthly: precipitation color table (0..1000mm) [range: 0 to 1000]
        rainbow     rainbow: rainbow color table [range: map values]
        ramp     ramp: color ramp [range: map values]
        random     random: random color table [range: map values]
        reds     reds: white to red [range: map values]
        roygbiv     roygbiv: [range: map values]
        rstcurv     rstcurv: terrain curvature (from r.resamp.rst) [range: map values]
        ryb     ryb: red through yellow to blue [range: map values]
        ryg     ryg: red through yellow to green [range: map values]
        sepia     sepia: yellowish-brown through to white [range: map values]
        slope     slope: r.slope.aspect-type slope colors for raster values 0-90 [range: 0 to 90]
        soilmoisture     soilmoisture: soilmoisture color table (0.0-1.0) [range: 0 to 1]
        srtm     srtm: color palette for Shuttle Radar Topography Mission elevation [range: -11000 to 8850]
        srtm_percent     srtm_percent: color palette for Shuttle Radar Topography Mission using relative elevation [range: map values]
        srtm_plus     srtm_plus: color palette for Shuttle Radar Topography Mission elevation (with seafloor colors) [range: -11000 to 8850]
        terrain     terrain: global elevation color table covering -11000 to +8850m [range: -11000 to 8850]
        viridis     viridis: perceptually uniform sequential color table viridis [range: map values]
        water     water: water depth [range: map values]
        wave     wave: color wave [range: map values]
raster : str, optional
    Raster map from which to copy color table
    Used as: input, raster, name
raster_3d : str, optional
    3D raster map from which to copy color table
    Used as: input, raster_3d, name
rules : str, optional
    Path to rules file
    "-" to read rules from stdin
    Used as: input, file, name
offset : float, optional
    Offset for color rule values
    New value = (old value + offset) * scale
    Default: 0
scale : float, optional
    Scale for color rule values
    New value = (old value + offset) * scale
    Default: 1
flags : str, optional
    Allowed values: r, w, l, d, n, g, a, e
    r
        Remove existing color table
    w
        Only write new color table if it does not already exist
    l
        List available rules then exit
    d
        List available rules with description then exit
        If a color rule is given, only this rule is listed
    n
        Invert colors
    g
        Logarithmic scaling
    a
        Logarithmic-absolute scaling
    e
        Histogram equalization
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.colors has exactly the same functionality as r.colors but for 3D raster maps. Please refer to r.colors.

EXAMPLES

r3.colors map=volume_1 color=gyr

SEE ALSO

r.colors, r.colors.out, r3.colors.out, v.colors, v.colors.out

See also wiki page Color tables (from GRASS User Wiki)

ColorBrewer is an online tool designed to help people select good color schemes for maps and other graphics.

AUTHORS

Michael Shapiro and David Johnson
Support for 3D rasters by Soeren Gebbert

SOURCE CODE

Available at: r3.colors source code (history)
Latest change: Wednesday Mar 05 15:56:01 2025 in commit da3981a