[GRASS-SVN] r30290 -
grass/branches/releasebranch_6_3/raster/r.neighbors
svn_grass at osgeo.org
svn_grass at osgeo.org
Fri Feb 22 11:29:39 EST 2008
Author: epatton
Date: 2008-02-22 11:29:39 -0500 (Fri, 22 Feb 2008)
New Revision: 30290
Modified:
grass/branches/releasebranch_6_3/raster/r.neighbors/description.html
Log:
Backported manpage updates from TRUNK
Modified: grass/branches/releasebranch_6_3/raster/r.neighbors/description.html
===================================================================
--- grass/branches/releasebranch_6_3/raster/r.neighbors/description.html 2008-02-22 16:28:25 UTC (rev 30289)
+++ grass/branches/releasebranch_6_3/raster/r.neighbors/description.html 2008-02-22 16:29:39 UTC (rev 30290)
@@ -21,7 +21,7 @@
arguments. In this case, the user will be prompted for
flag settings and parameter values.
-<H2>OPTIONS</H2>
+<H3>OPTIONS</H3>
The user must specify the names of the raster map layers to
be used for <EM>input</EM> and <EM>output</EM>, the
@@ -33,7 +33,7 @@
to not align the resolution of the output with that of the
input (the <EM>-a</EM> option), run <EM>r.neighbors</EM> with
a custom matrix weights with the <EM>weight</EM> option, and
-elect to run<EM>r.neighbors</EM> quietly (the <EM>-q</EM> option).
+elect to run <EM>r.neighbors</EM> quietly (the <EM>-q</EM> option).
These options are described further below.
@@ -50,8 +50,8 @@
<P>
+<DL>
-
<DT><B>average</B>
<DD>The average value within the neighborhood.
@@ -125,13 +125,13 @@
<BR>
The result is rounded to the nearest integer (in this case 64).
-ERROR .RE
-
+</DL>
<P>
+<BR>
<EM>Neighborhood Size:</EM>
-The neighborhood <EM>size</EM> specifies which cells surrounding any given
+<DD>The neighborhood <EM>size</EM> specifies which cells surrounding any given
cell fall into the neighborhood for that cell.
The size must be an odd integer.
For example,
@@ -142,11 +142,11 @@
|_|_|_|
</PRE>
-
+</DD>
<P>
-<EM>Matrix weights: </EM>
-A custom matrix can be used if none of the neighborhood operation
+<EM>Matrix weights:</EM>
+<DD>A custom matrix can be used if none of the neighborhood operation
methods are desirable by using the <EM>weight</EM>. This option must
be used in conjunction with the <EM>size</EM> option to specify the
matrix size. The weights desired are to be entered into a text file.
@@ -176,6 +176,7 @@
<P>
+<H3>FLAGS</H3>
<DT><B>-a</B>
@@ -186,14 +187,49 @@
of the geographic region be the same as that of the raster map layer.
By default, if unspecified,
<EM>r.neighbors</EM> will align these geographic region settings.
+<p>
+<DT><B>-c</B>
+<DD>
+This flag will use a circular neighborhood for the moving analysis window,
+centered on the current cell.
+
+<p>
+The exact masks for the first few neighborhood sizes are as follows:
+<div class="code"><PRE>
+3x3 . X . 5x5 . . X . . 7x7 . . . X . . .
+ X O X . X X X . . X X X X X .
+ . X . X X O X X . X X X X X .
+ . X X X . X X X O X X X
+ . . X . . . X X X X X .
+ . X X X X X .
+ . . . X . . .
+
+9x9 . . . . X . . . . 11x11 . . . . . X . . . . .
+ . . X X X X X . . . . X X X X X X X . .
+ . X X X X X X X . . X X X X X X X X X .
+ . X X X X X X X . . X X X X X X X X X .
+ X X X X O X X X X . X X X X X X X X X .
+ . X X X X X X X . X X X X X O X X X X X
+ . X X X X X X X . . X X X X X X X X X .
+ . . X X X X X . . . X X X X X X X X X .
+ . . . . X . . . . . X X X X X X X X X .
+ . . X X X X X X X . .
+ . . . . . X . . . . .
+</PRE></div>
+
+
+
+<p>
+
<DT><B>-q</B>
<DD>If specified, <EM>r.neighbors</EM> will run relatively quietly
(i.e., without printing to standard output notes on the program's progress).
If unspecified, the program will print messages to standard output by default.
+</DD>
-</DL>
+
<H2>NOTES</H2>
The <EM>r.neighbors</EM> program works in the current geographic region
@@ -204,9 +240,21 @@
original input and output resolutions which are not aligned by specifying
this (e.g., using the <EM>-a</EM> option).
-
<P>
+With the <b>-c</b> flag, differently-shaped neighborhood analysis windows may be achieved by
+using the <em>weight=</em> parameter to specify a weights file where all values
+are equal (for <em>method</em>=sum, the sum of the weights should be 1). The user
+can also vary the weights at the edge of the neighborhood according to
+the proportion of the cell that lies inside the neighborhood circle,
+effectively anti-aliasing the analysis mask.
+<p>
+For aggregates where a weighted calculation isn't meaningful
+(specifically: minimum, maximum, diversity and interspersion), the
+weights are used to create a binary mask, where zero causes the cell
+to be ignored and any non-zero value causes the cell to be used.
+<p>
+
<EM>r.neighbors</EM> copies the GRASS <EM>color</EM> files associated with
the input raster map layer for those output map layers that are based
on the neighborhood average, median, mode, minimum, and maximum.
@@ -214,7 +262,7 @@
rather than direct correspondents to input values,
no <EM>color</EM> files are copied for these map layers.
(The user should note that although the <EM>color</EM> file is copied
-for <EM>average</EM>d neighborhood function output,
+for <EM>average</EM> neighborhood function output,
whether or not the color file makes sense for the output
will be dependent on the input data values.)
@@ -232,4 +280,13 @@
Michael Shapiro,
U.S.Army Construction Engineering Research Laboratory
-<p><i>Last changed: $Date$</i>
+<p><i>Last changed: $Date$</i>
+
+
+
+
+
+
+
+
+
More information about the grass-commit
mailing list