/usr/share/doc/grass-doc/html/r.coin.html is in grass-doc 6.4.3-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>GRASS GIS manual: r.coin</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">
<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
<h2>NAME</h2>
<em><b>r.coin</b></em> - Tabulates the mutual occurrence (coincidence) of categories for two raster map layers.
<h2>KEYWORDS</h2>
raster, statistics
<h2>SYNOPSIS</h2>
<b>r.coin</b><br>
<b>r.coin help</b><br>
<b>r.coin</b> [-<b>w</b>] <b>map1</b>=<em>string</em> <b>map2</b>=<em>string</em> <b>units</b>=<em>string</em> [--<b>verbose</b>] [--<b>quiet</b>]
<h3>Flags:</h3>
<DL>
<DT><b>-w</b></DT>
<DD>Wide report, 132 columns (default: 80)</DD>
<DT><b>--verbose</b></DT>
<DD>Verbose module output</DD>
<DT><b>--quiet</b></DT>
<DD>Quiet module output</DD>
</DL>
<h3>Parameters:</h3>
<DL>
<DT><b>map1</b>=<em>string</em></DT>
<DD>Name of first raster map</DD>
<DT><b>map2</b>=<em>string</em></DT>
<DD>Name of second raster map</DD>
<DT><b>units</b>=<em>string</em></DT>
<DD>Unit of measure</DD>
<DD>c(ells), p(ercent), x(percent of category [column]), y(percent of category [row]), a(cres), h(ectares), k(square kilometers), m(square miles)</DD>
<DD>Options: <em>c,p,x,y,a,h,k,m</em></DD>
</DL>
<h2>DESCRIPTION</h2>
<em>r.coin</em> tabulates the mutual occurrence of two
raster map layers' categories with respect to one another.
This analysis program respects the current geographic
region and mask settings.
<p>
<em>r.coin</em>
tabulates the coincidence of category values among the two
map layers and prepares the basic table from which the
report is to be created. This tabulation is followed by an
indication of how long the coincidence table will be. If
the table is extremely long, the user may decide that
viewing it is not so important after all, and may cancel
the request at this point. Assuming the user continues,
<em>r.coin</em> then allows the user to choose one of eight
units of measure in which the report results can be given.
These units are:
<p>
<dl>
<dt><em>c</em> <dd>cells
<dt><em>p</em> <dd>percent cover of region
<dt><em>x</em> <dd>percent of <map name> category (column)
<dt><em>y</em> <dd>percent of <map name> category (row)
<dt><em>a</em> <dd>acres
<dt><em>h</em> <dd>hectares
<dt><em>k</em> <dd>square kilometers
<dt><em>m</em> <dd>square miles
</dl>
<p>
Note that three of these options give results as percentage
values: "p" is based on the grand total number of cells;
"x" is based on only column totals; and "y" is based on
only row totals. Only one unit of measure can be selected
per report output. Type in just one of the letters
designating a unit of measure followed by a
<RETURN>. The report will be printed to the screen
for review. After reviewing the report on the screen, the
user is given several options. The report may be saved to
a file and/or sent to a printer. If printed, it may be
printed with either 80 or 132 columns. Finally, the user
is given the option to rerun the coincidence tabulation
using a different unit of measurement.
<p>
<h2>NOTES</h2>
It is <b>not</b> a good idea to run <em>r.coin</em> on a
map layer which has a monstrous number of categories (e.g.,
unreclassed elevation). Because <em>r.coin</em> reports
information for each and every category, it is better to
reclassify those categories (using <em>r.reclass</em>)
into a more manageable number prior to running
<em>r.coin</em> on the reclassed raster map layer.
<p>
<h2>EXAMPLE</h2>
Below is a sample of tabular output produced by
<em>r.coin</em>. Here, map output is stated in units of
square miles. The report tabulates the coincidence of the
Spearfish sample database's <em>owner</em> and
<em>road</em> raster map layers' categories. The
<em>owner</em> categories in this case refer to whether the
land is in private hands (category 1) or is owned by the
U.S. Forest Service (category 2). The <em>roads</em> map
layer categories refer to various types of roads (with the
exception of category value "0", which indicates "no data";
i.e., map locations at which no roads exist).
<em>r.coin</em> does not report category labels. The user
should run
<em><a href="r.report.html">r.report</a></em> or
<em><a href="r.category.html">r.category</a></em>
to obtain this information.
<p>
The body of the report is arranged in panels. The map layer
with the most categories is arranged along the vertical
axis of the table; the other, along the horizontal axis.
Each panel has a maximum of 5 categories (9 if printed)
across the top. In addition, the last two columns reflect a
cross total of each column for each row. All of the
categories of the map layer arranged along the vertical
axis are included in each panel. There is a total at the
bottom of each column representing the sum of all the rows
in that column. A second total represents the sum of all
the non-zero category rows. A cross total (Table Row Total)
of all columns for each row appears in a separate panel.
<p>
Note how the following information may be obtained from the sample report.
<p>
In the Spearfish data base, in area not owned by the Forest Service, there
are 50.63 square miles of land not used for roads. Roads make up 9.27 square
miles of land in this area.
<p>
Of the total 102.70 square miles in Spearfish, 42.80
square miles is owned by the Forest Service.
<br>
In total, there are 14.58 square miles of roads.
<p>
There are more category 2 roads outside Forest Service land
(2.92 mi. sq.)
than there are inside Forest land boundaries (0.72 mi. sq.).
<p>
Following is a sample report.
<pre>
+------------------------------------------------------------+
| COINCIDENCE TABULATION REPORT |
|------------------------------------------------------------|
|Location: spearfish Mapset: PERMANENT Date: Wed Jun 1 |
| |
| Layer 1: owner -- Ownership |
| Layer 2: roads -- Roads |
| Mask: none |
| |
| Units: square miles |
|------------------------------------------------------------|
| Window: North: 4928000.00 |
| West: 590000.00 East: 609000.00 |
| South: 4914000.00 |
+------------------------------------------------------------+
Panel #1 of 1
+--------------------------------------------------------+
| | owner | Panel Row Total |
| cat# | 1 | 2 | w cat 0 | w/o cat 0 |
|--------------------------------------------------------|
|r 0 | 50.63 | 37.49 | 88.12 | 88.12 |
|o 1 | 1.53 | 0.68 | 2.21 | 2.21 |
|a 2 | 2.92 | 0.72 | 3.64 | 3.64 |
|d 3 | 3.97 | 2.57 | 6.54 | 6.54 |
|s 4 | 0.65 | 1.36 | 2.00 | 2.00 |
| 5 | 0.19 | 0.00 | 0.19 | 0.19 |
|--------------------------------------------------------|
|Total | | | | |
|with 0 | 59.90 | 42.80 | 102.70 | 102.70 |
|--------------------------------------------------------|
|w/o 0 | 9.27 | 5.32 | 14.58 | 14.58 |
+--------------------------------------------------------+
+--------------------------------+
| | Table Row Total |
| cat# | w cat 0 | w/o cat 0 |
|--------------------------------|
|r 0 | 88.12 | 88.12 |
|o 1 | 2.21 | 2.21 |
|a 2 | 3.64 | 3.64 |
|d 3 | 6.54 | 6.54 |
|s 4 | 2.00 | 2.00 |
| 5 | 0.19 | 0.19 |
|--------------------------------|
|Total | | |
|with 0 | 102.70 | 102.70 |
|--------------------------------|
|w/o 0 | 14.58 | 14.58 |
+--------------------------------+
</pre>
<p>
<em>r.coin</em> calculates the coincidence of two raster
map layers. Although <em>r.coin</em> allows the user to
rerun the report using different units, it is not possible
to simply rerun the report with different map layers. In
order to choose new map layers, it is necessary to rerun
<em>r.coin.</em>
<h2>SEE ALSO</h2>
<em>
<a href="g.region.html">g.region</a>,
<!-- not ported to GRASS 6 <a href="m.ipf.html">m.ipf</a>, -->
<a href="r.category.html">r.category</a>,
<a href="r.describe.html">r.describe</a>,
<a href="r.reclass.html">r.reclass</a>,
<a href="r.report.html">r.report</a>,
<a href="r.stats.html">r.stats</a>
</em>
<h2>AUTHORS</h2>
Michael O'Shea,
<br>
Michael Shapiro, <br>
U.S. Army Construction Engineering Research Laboratory
<p>
<i>Last changed: $Date: 2008-05-16 12:09:06 -0700 (Fri, 16 May 2008) $</i>
<HR>
<P><a href="index.html">Main index</a> - <a href="raster.html">raster index</a> - <a href="full_index.html">Full index</a></P>
<P>© 2003-2013 <a href="http://grass.osgeo.org">GRASS Development Team</a></p>
</body>
</html>
|