1r.report(1) Grass User's Manual r.report(1)
2
3
4
6 r.report - Reports statistics for raster map layers.
7
9 raster, statistics
10
12 r.report
13 r.report help
14 r.report [-qhfenNCi] map=name[,name,...] [units=string[,string,...]]
15 [null=string] [pl=integer] [pw=integer] [output=string]
16 [nsteps=integer] [--verbose] [--quiet]
17
18 Flags:
19 -q
20 Quiet
21
22 -h
23 Suppress page headers
24
25 -f
26 Use formfeeds between pages
27
28 -e
29 Scientific format
30
31 -n
32 Filter out all no data cells
33
34 -N
35 Filter out cells where all maps have no data
36
37 -C
38 Report for cats fp ranges (fp maps only)
39
40 -i
41 Read fp map as integer (use map's quant rules)
42
43 --verbose
44 Verbose module output
45
46 --quiet
47 Quiet module output
48
49 Parameters:
50 map=name[,name,...]
51 Raster map(s) to report on
52
53 units=string[,string,...]
54 mi(les),me(ters),k(ilome‐
55 ters),a(cres),h(ectares),c(ell_counts),p(ercent_cover)
56 Options: mi,me,k,a,h,c,p
57
58 null=string
59 Character representing no data cell value
60 Default: *
61
62 pl=integer
63 Page length (default: 0 lines)
64
65 pw=integer
66 Page width (default: 79 characters)
67
68 output=string
69 Name of an output file to hold the report
70
71 nsteps=integer
72 Number of fp subranges to collect stats from
73 Default: 255
74
76 r.report allows the user to set up a series of report parameters to be
77 applied to a raster map layer, and creates a report. If invoked with
78 command line arguments, the report will print out to the screen only.
79 However, output may be redirected to a file or another program using
80 the UNIX redirection mechanism. If invoked without command line argu‐
81 ments, the user is given the option of printing out each report and/or
82 saving output to a file.
83
84 The report itself consists of two parts, a header section and the main
85 body of the report.
86
87 The header section of the report identifies the raster map layer(s) (by
88 map layer name and TITLE), location, mapset, report date, and the
89 region of interest. The area of interest is described in two parts: the
90 user's current geographic region is presented, and the mask is pre‐
91 sented (if any is used).
92
93 The main body of the report consists of from one to three tables which
94 present the statistics for each category and the totals for each unit
95 column.
96
97 Note that, unlike r.stats, r.report allows the user to select the spe‐
98 cific units of measure in which statistics will be reported.
99
100 Following is the result of a r.report run on the raster map layer geol‐
101 ogy (located in the Spearfish, SD sample data base), with the units
102 expressed in square miles and acres. Here, r.report output is directed
103 into the file report.file.
104
106 r.report map=geology units=miles,acres > report.file
107
108
109 ____________________________________________________________
110 | RASTER MAP CATEGORY REPORT |
111 | LOCATION: spearfish Fri Sep 2 09:20:09|
112 |____________________________________________________________|
113 | north: 4928000.00 east: 609000.00 |
114 | REGION: south: 4914000.00 west: 590000.00 |
115 | res: 100.00 res: 100.00 |
116 |____________________________________________________________|
117 | MASK: none |
118 |____________________________________________________________|
119 | MAP: geology in PERMANENT |
120 |____________________________________________________________|
121 | Category Information | Acres Square |
122 | # description | Miles |
123 |________|_________________________|_________________________|
124 | 0 | no data | 415.13| 0.65 |
125 | 1 | metamorphic | 2597.02| 4.06 |
126 | 2 | transition | 32.12| 0.05 |
127 | 3 | igneous | 8117.24| 12.68 |
128 | 4 | sandstone | 16691.60| 26.08 |
129 | 5 | limestone | 13681.93| 21.38 |
130 | 6 | shale | 10304.07| 16.10 |
131 | 7 | sandy shale | 2517.95| 3.93 |
132 | 8 | claysand | 3229.60| 5.05 |
133 | 9 | sand | 8141.95| 12.72 |
134 |__________________________________|___________|_____________|
135 | TOTAL | 65728.60| 102.70 |
136 |__________________________________|___________|_____________|
137
138
140 If the user runs r.report interactively and saves the report output in
141 a file, this file will be placed into the user's current working direc‐
142 tory.
143
144 If the user runs r.report non-interactively, report output can be saved
145 by redirecting it to a file or a printer using the UNIX redirection
146 mechanism.
147
149 g.region, r.coin, r.describe, r.info, r.stats, r.univar
150
152 Michael Shapiro, U.S. Army Construction Engineering Research Laboratory
153
154 Last changed: $Date: 2007-12-17 14:53:55 +0100 (Mon, 17 Dec 2007) $
155
156 Full index
157
158 © 2003-2008 GRASS Development Team
159
160
161
162GRASS 6.3.0 r.report(1)