← Back to branch summary

~ubuntu-branches/ubuntu/vivid/grass/vivid-proposed

« back to all changes in this revision

Viewing changes to raster/r.report/description.html

  • Committer: Package Import Robot
  • Author(s): Bas Couwenberg
  • Date: 2015-02-20 23:12:08 UTC
  • mfrom: (8.2.6 experimental)
  • Revision ID: package-import@ubuntu.com-20150220231208-1u6qvqm84v430b10
Tags: 7.0.0-1~exp1
* New upstream release.
* Update python-ctypes-ternary.patch to use if/else instead of and/or.
* Drop check4dev patch, rely on upstream check.
* Add build dependency on libpq-dev to grass-dev for libpq-fe.h.
* Drop patches applied upstream, refresh remaining patches.
* Update symlinks for images switched from jpg to png.

Show diffs side-by-side

added added

removed removed

Lines of Context:
raster/r.report/description.html
1
 
<h2>DESCRIPTION</h2>
2
 
 
3
 
<em>r.report</em> allows the user to set up a series of report parameters to
4
 
be applied to a raster map layer, and creates a report.  If invoked with
5
 
command line arguments, the report will print out to the screen only.
6
 
However, output may be redirected to a file or another program using the
7
 
UNIX redirection mechanism. If invoked without command line arguments, the
8
 
user is given the option of printing out each report and/or saving output to
9
 
a file.
10
 
 
11
 
<p>
12
 
The report itself consists of two parts, a header section and the main body
13
 
of the report.
14
 
 
15
 
<p>
16
 
The header section of the report identifies the raster map layer(s) (by map
17
 
layer name and TITLE), location, mapset, report date, and the region of
18
 
interest. The area of interest is described in two parts: the user's current
19
 
geographic region is presented, and the mask is presented (if any is used).
20
 
 
21
 
<p>
22
 
The main body of the report consists of from one to three tables which
23
 
present the statistics for each category and the totals for each unit
24
 
column.
25
 
 
26
 
<p>
27
 
Note that, unlike <em><a href="r.stats.html">r.stats</a></em>,
28
 
<em>r.report</em> allows the user to select the specific units of measure in
29
 
which statistics will be reported.
30
 
 
31
 
<p>
32
 
Following is the result of a <em>r.report</em> run on the raster map layer
33
 
<em>geology</em> (located in the Spearfish, SD sample data base), with the
34
 
units expressed in square miles and acres. Here, <em>r.report</em> output is
35
 
directed into the file <em>report.file</em>.
36
 
 
37
 
 
38
 
<h2>EXAMPLE:</h2>
39
 
<dl>
40
 
<dd>
41
 
<b>r.report map=</b><em>geology</em> <b>units=</b><em>miles,acres</em> &gt; <em>report.file </em>
42
 
</dl>
43
 
 
44
 
<pre>
45
 
 ____________________________________________________________
46
 
|                 RASTER MAP CATEGORY REPORT                 |
47
 
| LOCATION: spearfish                      Fri Sep 2 09:20:09|
48
 
|____________________________________________________________|
49
 
|           north:   4928000.00   east:   609000.00          |
50
 
| REGION:   south:   4914000.00   west:   590000.00          |
51
 
|           res:         100.00   res:       100.00          |
52
 
|____________________________________________________________|
53
 
| MASK:     none                                             |
54
 
|____________________________________________________________|
55
 
| MAP:      geology in PERMANENT                             |
56
 
|____________________________________________________________|
57
 
|         Category Information     |    Acres       Square   |
58
 
|    #      description            |                Miles    |
59
 
|________|_________________________|_________________________|
60
 
|    0   |  no data                |     415.13|      0.65   |
61
 
|    1   |  metamorphic            |    2597.02|      4.06   |
62
 
|    2   |  transition             |      32.12|      0.05   |
63
 
|    3   |  igneous                |    8117.24|     12.68   |
64
 
|    4   |  sandstone              |   16691.60|     26.08   |
65
 
|    5   |  limestone              |   13681.93|     21.38   |
66
 
|    6   |  shale                  |   10304.07|     16.10   |
67
 
|    7   |  sandy shale            |    2517.95|      3.93   |
68
 
|    8   |  claysand               |    3229.60|      5.05   |
69
 
|    9   |  sand                   |    8141.95|     12.72   |
70
 
|__________________________________|___________|_____________|
71
 
|                 TOTAL            |   65728.60|    102.70   |
72
 
|__________________________________|___________|_____________|
73
 
</pre>
74
 
 
75
 
 
76
 
<h2>NOTES</h2>
77
 
 
78
 
If the user runs <em>r.report</em> interactively and saves the report output
79
 
in a file, this file will be placed into the user's current working
80
 
directory.
81
 
 
82
 
<p>
83
 
If the user runs <em>r.report</em> non-interactively, report output can be
84
 
saved by redirecting it to a file or a printer using the UNIX redirection
85
 
mechanism.
86
 
 
87
 
<p>
88
 
To output computer-friendly data suitable for importing into a spreadsheet
89
 
use the <em>r.stats</em> module. In fact <em>r.report</em> is running
90
 
<em>r.stats</em> in the background and reformatting the results to be
91
 
more human-friendly.
92
 
 
93
 
 
94
 
<h2>SEE ALSO</h2>
95
 
 
96
 
<em><a href="g.region.html">g.region</a>,
97
 
<a href="r.coin.html">r.coin</a>,
98
 
<a href="r.describe.html">r.describe</a>,
99
 
<a href="r.info.html">r.info</a>,
100
 
<a href="r.stats.html">r.stats</a>,
101
 
<a href="r.univar.html">r.univar</a>
102
 
</em>
103
 
 
104
 
 
105
 
<h2>AUTHOR</h2>
106
 
 
107
 
Michael Shapiro,
108
 
U.S. Army Construction Engineering Research Laboratory
109
 
 
110
 
<p>
111
 
<i>Last changed: $Date: 2013-04-18 14:21:53 +0200 (Thu, 18 Apr 2013) $</i>