r.report(1)

1r.report(1)                   Grass User's Manual                  r.report(1)
2
3
4

NAME

6       r.report  - Reports statistics for raster map layers.
7

KEYWORDS

9       raster
10

SYNOPSIS

12       r.report
13       r.report help
14       r.report               [-hfqenNCi]              map=string[,string,...]
15       [units=string[,string,...]]   [null=string]   [pl=integer]    [pw=inte‐
16       ger]   [output=string]   [nsteps=integer]
17
18   Flags:
19       -h  Suppress page headers
20
21       -f  Use formfeeds between pages
22
23       -q  Quiet
24
25       -e  Scientific format
26
27       -n  Filter out all no data cells
28
29       -N  Filter out cells where all maps have no data
30
31       -C  Report for cats fp ranges (fp maps only)
32
33       -i  Read fp map as integer (use map's quant rules
34
35   Parameters:
36       map=string[,string,...]
37           Raster map(s) to report on
38
39       units=string[,string,...]
40           mi(les),me(ters),k(ilome‐
41           ters),a(cres),h(ectares),c(ell_counts),p(ercent_cover)
42
43       null=string
44           Character representing no data cell value Default: *
45
46       pl=integer
47           Page length (default: 0 lines)
48
49       pw=integer
50           Page width (default: 79 characters)
51
52       output=string
53           Name of an output file to hold the report
54
55       nsteps=integer
56           Number of fp subranges to collect stats from Default: 255
57

DESCRIPTION

59       r.report allows the user to set up a series of report parameters to  be
60       applied  to  a raster map layer, and creates a report.  If invoked with
61       command line arguments, the report will print out to the  screen  only.
62       However,  output  may  be redirected to a file or another program using
63       the UNIX redirection mechanism. If invoked without command  line  argu‐
64       ments,  the user is given the option of printing out each report and/or
65       saving output to a file.
66
67       The report itself consists of two parts, a header section and the  main
68       body of the report.
69
70       The header section of the report identifies the raster map layer(s) (by
71       map layer name and TITLE),  location,  mapset,  report  date,  and  the
72       region of interest. The area of interest is described in two parts: the
73       user's current geographic region is presented, and  the  mask  is  pre‐
74       sented (if any is used).
75
76       The  main body of the report consists of from one to three tables which
77       present the statistics for each category and the totals for  each  unit
78       column.
79
80       Note  that, unlike r.stats, r.report allows the user to select the spe‐
81       cific units of measure in which statistics will be reported.
82
83       Following is the result of a r.report run on the raster map layer geol‐
84       ogy  (located  in  the  Spearfish, SD sample data base), with the units
85       expressed in square miles and acres. Here, r.report output is  directed
86       into the file report.file.
87

EXAMPLE:

89       r.report map=geology units=miles,acres > report.file
90
91
92        ____________________________________________________________
93       |                 RASTER MAP CATEGORY REPORT                 |
94       | LOCATION: spearfish                      Fri Sep 2 09:20:09|
95       |____________________________________________________________|
96       |           north:   4928000.00   east:   609000.00          |
97       | REGION:   south:   4914000.00   west:   590000.00          |
98       |           res:         100.00   res:       100.00          |
99       |____________________________________________________________|
100       | MASK:     none                                             |
101       |____________________________________________________________|
102       | MAP:      geology in PERMANENT                             |
103       |____________________________________________________________|
104       |         Category Information     |    Acres       Square   |
105       |    #      description            |                Miles    |
106       |________|_________________________|_________________________|
107       |    0   |  no data                |     415.13|      0.65   |
108       |    1   |  metamorphic            |    2597.02|      4.06   |
109       |    2   |  transition             |      32.12|      0.05   |
110       |    3   |  igneous                |    8117.24|     12.68   |
111       |    4   |  sandstone              |   16691.60|     26.08   |
112       |    5   |  limestone              |   13681.93|     21.38   |
113       |    6   |  shale                  |   10304.07|     16.10   |
114       |    7   |  sandy shale            |    2517.95|      3.93   |
115       |    8   |  claysand               |    3229.60|      5.05   |
116       |    9   |  sand                   |    8141.95|     12.72   |
117       |__________________________________|___________|_____________|
118       |                 TOTAL            |   65728.60|    102.70   |
119       |__________________________________|___________|_____________|
120
121

NOTES

123       If  the user runs r.report interactively and saves the report output in
124       a file, this file will be placed into the user's current working direc‐
125       tory.
126
127       If the user runs r.report non-interactively, report output can be saved
128       by redirecting it to a file or a printer  using  the  UNIX  redirection
129       mechanism.
130

AUTHOR

135       Michael Shapiro, U.S. Army Construction Engineering Research Laboratory
136
137       Last changed: $Date: 2006/04/13 19:01:37 $
138
139       Full index
140
141
142
143GRASS 6.2.2                                                        r.report(1)