1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>r.describe - GRASS GIS manual</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="grassdocs.css" type="text/css">
</head>
<body bgcolor="white">
<div id="container">
<a href="index.html"><img src="grass_logo.png" alt="GRASS logo"></a>
<hr class="header">
<h2>NAME</h2>
<em><b>r.describe</b></em> - Prints terse list of category values found in a raster map layer.
<h2>KEYWORDS</h2>
<a href="raster.html">raster</a>, <a href="topic_metadata.html">metadata</a>
<h2>SYNOPSIS</h2>
<div id="name"><b>r.describe</b><br></div>
<b>r.describe --help</b><br>
<div id="synopsis"><b>r.describe</b> [-<b>1rndi</b>] <b>map</b>=<em>name</em> [<b>null_value</b>=<em>string</em>] [<b>nsteps</b>=<em>integer</em>] [--<b>help</b>] [--<b>verbose</b>] [--<b>quiet</b>] [--<b>ui</b>]
</div>
<div id="flags">
<h3>Flags:</h3>
<dl>
<dt><b>-1</b></dt>
<dd>Print the output one value per line</dd>
<dt><b>-r</b></dt>
<dd>Only print the range of the data</dd>
<dt><b>-n</b></dt>
<dd>Suppress reporting of any NULLs</dd>
<dt><b>-d</b></dt>
<dd>Use the current region</dd>
<dt><b>-i</b></dt>
<dd>Read floating-point map as integer</dd>
<dt><b>--help</b></dt>
<dd>Print usage summary</dd>
<dt><b>--verbose</b></dt>
<dd>Verbose module output</dd>
<dt><b>--quiet</b></dt>
<dd>Quiet module output</dd>
<dt><b>--ui</b></dt>
<dd>Force launching GUI dialog</dd>
</dl>
</div>
<div id="parameters">
<h3>Parameters:</h3>
<dl>
<dt><b>map</b>=<em>name</em> <b>[required]</b></dt>
<dd>Name of raster map</dd>
<dt><b>null_value</b>=<em>string</em></dt>
<dd>String representing NULL value</dd>
<dd>Default: <em>*</em></dd>
<dt><b>nsteps</b>=<em>integer</em></dt>
<dd>Number of quantization steps</dd>
<dd>Default: <em>255</em></dd>
</dl>
</div>
<div class="toc">
<h4 class="toc">Table of contents</h4>
<ul class="toc">
<li class="toc"><a href="#description" class="toc">DESCRIPTION</a></li>
<li class="toc"><a href="#notes" class="toc">NOTES</a>
<ul class="toc">
<li class="toc"><a href="#flags" class="toc">FLAGS</a></li>
</ul></li>
<li class="toc"><a href="#examples" class="toc">EXAMPLES</a></li>
<li class="toc"><a href="#see-also" class="toc">SEE ALSO</a></li>
<li class="toc"><a href="#author" class="toc">AUTHOR</a></li>
</ul>
</div>
<h2><a name="description">DESCRIPTION</a></h2>
<em><b>r.describe</b></em> prints a terse listing of category values found in
a user-specified raster map layer.
<p>
<em><b>r.describe</b></em> ignores the current geographic region and mask, and
reads the full extent of the input raster map. This functionality is useful if the
user intends to <em>reclassify</em> or <em>rescale</em> the data,
since these functions (<em><a href="r.reclass.html">r.reclass</a></em> and
<em><a href="r.rescale.html">r.rescale</a></em>)
also ignore the current <em>geographic region</em>
and <em>mask</em>.
<p>The <em><b>nv</b></em> parameter sets the string to be used to represent <tt>NULL</tt>
values in the module output; the default is '*'.
<p>The <em><b>nsteps</b></em> parameter sets the number of quantisation steps to divide into
the input raster map.
<h2><a name="notes">NOTES</a></h2>
<h3><a name="flags">FLAGS</a></h3>
If the user selects the <b>-r</b> flag, a range of category values found in
the raster map layer will be printed. The range is divided into three groups:
negative, positive, and zero. If negative values occur, the minimum and maximum
negative values will be printed. If positive values occur, the minimum and maximum
positive values will be printed. If zero occurs, this will be indicated. The range
report will generally run faster than the full list (the default output).
<p>
The <b>-d</b> flag can be used to force <em>r.describe</em> to respect the current region
extents when repoting raster map categories. The default behavior is to read the full
extent of the input raster map.
<p>If the <b>-1</b> flag is specified, the output appears with one category value/range per line.
<p>The <b>-n</b> flag suppresses the reporting of <tt>NULL</tt> values.
<h2><a name="examples">EXAMPLES</a></h2>
The following examples are from the Spearfish60 sample Location:
<p>
# Print the full list of raster map categories:
<div class="code"><pre>
r.describe landcover.30m
* 11 21-23 31 32 41-43 51 71 81-83 85 91 92
</pre></div>
<p>
# Print the raster range only:
<div class="code"><pre>
r.describe -r landcover.30m
11 thru 92
*
</pre></div>
# Print raster map category range, suppressing nulls:
<div class="code"><pre>
r.describe -n landcover.30m
11 21-23 31 32 41-43 51 71 81-83 85 91 92
</pre></div>
<p>
# Print raster map categories, one category per line:
<div class="code"><pre>
r.describe -1 geology
*
1
2
3
4
5
6
7
8
9
</pre></div>
<p>
<h2><a name="see-also">SEE ALSO</a></h2>
<em>
<a href="g.region.html">g.region</a>,
<a href="r.mask.html">r.mask</a>,
<a href="r.reclass.html">r.reclass</a>,
<a href="r.report.html">r.report</a>,
<a href="r.rescale.html">r.rescale</a>,
<a href="r.stats.html">r.stats</a>,
<a href="r.univar.html">r.univar</a>
</em>
<h2><a name="author">AUTHOR</a></h2>
Michael Shapiro, U.S. Army Construction Engineering Research Laboratory
<!--
<p>
<i>Last changed: $Date$</i>
--><h2>SOURCE CODE</h2>
<p>Available at: <a href="https://github.com/OSGeo/grass/tree/master/raster/r.describe">r.describe source code</a> (<a href="https://github.com/OSGeo/grass/commits/master/raster/r.describe">history</a>)</p>
<hr class="header">
<p>
<a href="index.html">Main index</a> |
<a href="raster.html">Raster index</a> |
<a href="topics.html">Topics index</a> |
<a href="keywords.html">Keywords index</a> |
<a href="graphical_index.html">Graphical index</a> |
<a href="full_index.html">Full index</a>
</p>
<p>
© 2003-2020
<a href="http://grass.osgeo.org">GRASS Development Team</a>,
GRASS GIS 7.8.5 Reference Manual
</p>
</div>
</body>
</html>