[GRASS-SVN] r49396 - in grass-addons/raster/r.pi: r.pi.enn.iter
r.pi.fnn
svn_grass at osgeo.org
svn_grass at osgeo.org
Sun Nov 27 12:06:09 EST 2011
Author: wegmann
Date: 2011-11-27 09:06:09 -0800 (Sun, 27 Nov 2011)
New Revision: 49396
Modified:
grass-addons/raster/r.pi/r.pi.enn.iter/description.html
grass-addons/raster/r.pi/r.pi.fnn/description.html
Log:
fixed and extended manual pages and added various further examples
Modified: grass-addons/raster/r.pi/r.pi.enn.iter/description.html
===================================================================
--- grass-addons/raster/r.pi/r.pi.enn.iter/description.html 2011-11-27 16:33:21 UTC (rev 49395)
+++ grass-addons/raster/r.pi/r.pi.enn.iter/description.html 2011-11-27 17:06:09 UTC (rev 49396)
@@ -2,54 +2,39 @@
Patch relevance for Euclidean Nearest Neighbor patches.
-<em>r.pi.enn.iter</em> is part of the patch based fragmentation analysis
-package r.pi.* (Patch Index). It computes distance and area
+<em>r.pi.enn.iter</em> computes distance and area
differences for the first NN after removal of patch i.
<h2>NOTES</h2>
-The user must specify the names of the raster map layers to
-be used for <em>input</em> and <em>output</em>, the <em>keyval</em> the
-<em>method</em> (e.g. distance, area) and <em>statmethod</em> used (i.e., average).
-<p>
-
-Within <em>r.fragment.NN</em> the following setting have to be set:
-
-<h3>keyval setting:</h3>
-
The <em>keyval</em> operator determines which category value is taken for
the Patch Index analysis.
-<h3>Method setting:</h3>
-
The <em>method</em> operators determine what measure is applied
-on the nth NN.
+on the nth NN (area or distance).
-<h2>Output</h2>
+Differences of distance/area after removal of patch i are provided as output as well as
+the amount of patches to be affected by its removal (percent) (PP) and
+the amount of area in these patches (PA - Percent Area)
-Differences of distance/area after removal of patch i.<br>
-Amount of patches to be affected by removal (percent) (PP)<br>
-Amount of area in these patches (PA - Percent Area)
-
<h2>EXAMPLE</h2>
An example for the North Carolina sample dataset:
+Analysing the differences (average) in distance when patch i of class 5 is removed:
<div class="code"><pre>
-g.region -d
-...
+r.pi.enn.iter input=landclass96 output=dist_iter keyval=5 method=distance statmethod=average
</pre></div>
<h2>SEE ALSO</h2>
<em>
<a href="r.pi.index.html">r.pi.index</a>,
-<a href="r.fragment.dist.html">r.fragment.dist</a>,
<a href="r.pi.enn.html">r.pi.enn</a>,
-<a href="r.fragment.neighbors.html">r.fragment.neighbors</a>,
-<a href="r.fragment.nn.html">r.fragment.nn</a>,
-<a href="r.li.setup.html">r.li</a>
+<a href="r.pi.fnn.html">r.pi.fnn</a>,
+<a href="r.pi.searchtime.iter.html">r.pi.searchtime.iter</a>,
+
</em>
<h2>AUTHORS</h2>
Modified: grass-addons/raster/r.pi/r.pi.fnn/description.html
===================================================================
--- grass-addons/raster/r.pi/r.pi.fnn/description.html 2011-11-27 16:33:21 UTC (rev 49395)
+++ grass-addons/raster/r.pi/r.pi.fnn/description.html 2011-11-27 17:06:09 UTC (rev 49396)
@@ -7,24 +7,12 @@
<h2>NOTES</h2>
-The user must specify the names of the raster map layers to
-be used for <em>input</em> <em> costmap </em> and <em>output</em>, the
-<em>method</em> used (i.e., distance), the <em>keyval</em>, the
-<em>number</em> and the <em>statmethod</em>.
-
-
-<h3>Input</h3>
-
-<h4>Input</h4>
-
The calculation of the ecolgogical nearest neighbour is based on a raster
with start patches. The actual map can be categorical or continuous but
the value defined in <em>keyval</em> will be the basis for the patches
to calculate the methods defined below. These patches will also be in
the output map.
-<h4>costmap</h4>
-
The calculation of the ecolgogical nearest neighbour is based on a costmap
(* and 1-infinite) - this map can be binary or continous - high values
are considered to have high cost issues and the shortest path is the
@@ -33,21 +21,13 @@
will result in "0" distance.
<p>
-e.g. if a binary map(1 and 2) is used, the ENN is the path with the
-lowest amount of "1"
+e.g. if a binary map(1 and 2) is used, the the path with the
+lowest amount of "1" is chosen
-<h3>Methods:</h3>
-The <em>method</em> and the <em>number</em> operators determine what
-algorithm and setting is applied
-on the patches.
-
-<p>
-
The <em>number</em> is the amount of nearest neighbours to be taken and
the calculated distances are processed as assigned in <em>statmethod</em>
-<h4>Operations to perform</h4>
-r.pi.enn can perform the following operations:
+Operations which <em>r.pi.fnn</em> can perform are:
<p>
@@ -82,7 +62,6 @@
distance patch. It is based on <em>Distance</em> not on <em> path Distance</em>.
-<h4>Statsmethod setting:</h4>
The <em>statsmethod</em> operators determine calculation is done on the
distance. <em>Average</em>, <em>Variance</em>,<em>Stddev</em> and
<em>value</em> can be used.
@@ -110,8 +89,6 @@
<em>Average</em> gives the average of the area of 1-5th NN.
-<h4>Number of nearest neighbors to analyse:</h4>
-
The input options are either one NN: <em>1</em> or several NN separated
by <em>,</em>: 1,2,5,8 or a range of NN: 1-6.
@@ -124,20 +101,17 @@
An example for the North Carolina sample dataset:
+Computing the functional or ecological distance to the first to nth nearest neighrbours using a cost matrix:
<div class="code"><pre>
-g.region -d
-...
+r.mapcalc "cost_raster = if(landclass96==5,1,if(landclass96 == 1, 10, if (landclass96==3,2, if(landclass96==4,1,if(landclass96==6,100)))))"
+r.pi.fnn input=landclass96 keyval=5 costmap=cost_raster output=fnn1 method=distance number=10 statmethod=average
</pre></div>
<h2>SEE ALSO</h2>
<em>
-<a href="r.pi.index.html">r.pi.index</a>,
-<a href="r.fragment.dist.html">r.fragment.dist</a>,
-<a href="r.pi.enn.iter.html">r.pi.enn.iter</a>,
-<a href="r.fragment.neighbors.html">r.fragment.neighbors</a>,
-<a href="r.fragment.nn.html">r.fragment.nn</a>,
-<a href="r.pi.html">r.pi</a>
+<a href="r.pi.enn.html">r.pi.enn</a>,
+<a href="r.pi.index.html">r.pi.index</a>
</em>
<h2>AUTHORS</h2>
More information about the grass-commit
mailing list