1r.describe(1) GRASS GIS User's Manual r.describe(1)
2
6 r.describe - Prints terse list of category values found in a raster
7 map layer.
8
10 raster, metadata
11
13 r.describe
14 r.describe --help
15 r.describe [-1rndi] map=name [null_value=string] [nsteps=integer]
16 [--help] [--verbose] [--quiet] [--ui]
17 Flags:
19 -1
20 Print the output one value per line
21 -r
23 Only print the range of the data
24 -n
26 Suppress reporting of any NULLs
27 -d
29 Use the current region
30 -i
32 Read floating-point map as integer
33 --help
35 Print usage summary
36 --verbose
38 Verbose module output
39 --quiet
41 Quiet module output
42 --ui
44 Force launching GUI dialog
45 Parameters:
47 map=name [required]
48 Name of raster map
49 null_value=string
51 String representing NULL value
52 Default: *
53 nsteps=integer
55 Number of quantization steps
56 Default: 255
57
59 r.describe prints a terse listing of category values found in a
60 user-specified raster map layer.
61 r.describe ignores the current geographic region and mask, and reads
63 the full extent of the input raster map. This functionality is useful
64 if the user intends to reclassify or rescale the data, since these
65 functions (r.reclass and r.rescale) also ignore the current geographic
66 region and mask.
67 The nv parameter sets the string to be used to represent NULL values in
69 the module output; the default is ’*’.
70 The nsteps parameter sets the number of quantisation steps to divide
72 into the input raster map.
73
75 FLAGS
76 If the user selects the -r flag, a range of category values found in
77 the raster map layer will be printed. The range is divided into three
78 groups: negative, positive, and zero. If negative values occur, the
79 minimum and maximum negative values will be printed. If positive values
80 occur, the minimum and maximum positive values will be printed. If zero
81 occurs, this will be indicated. The range report will generally run
82 faster than the full list (the default output).
83 The -d flag can be used to force r.describe to respect the current re‐
85 gion extents when repoting raster map categories. The default behavior
86 is to read the full extent of the input raster map.
87 If the -1 flag is specified, the output appears with one category
89 value/range per line.
90 The -n flag suppresses the reporting of NULL values.
92
94 The following examples are from the Spearfish60 sample Location:
95 # Print the full list of raster map categories:
97 r.describe landcover.30m
98 * 11 21-23 31 32 41-43 51 71 81-83 85 91 92
99 # Print the raster range only:
101 r.describe -r landcover.30m
102 11 thru 92
103 *
104 # Print raster map category range, suppressing nulls:
105 r.describe -n landcover.30m
106 11 21-23 31 32 41-43 51 71 81-83 85 91 92
107 # Print raster map categories, one category per line:
109 r.describe -1 geology
110 *
111 1
112 2
113 3
114 4
115 5
116 6
117 7
118 8
119 9
120
122 g.region, r.mask, r.reclass, r.report, r.rescale, r.stats, r.univar
123
125 Michael Shapiro, U.S. Army Construction Engineering Research Laboratory
126
128 Available at: r.describe source code (history)
129 Accessed: Saturday Oct 28 18:17:30 2023
131 Main index | Raster index | Topics index | Keywords index | Graphical
133 index | Full index
134 © 2003-2023 GRASS Development Team, GRASS GIS 8.3.1 Reference Manual
136GRASS 8.3.1 r.describe(1)