[GRASS-SVN] r59354 - grass-addons/grass7/raster/r.stream.distance
svn_grass at osgeo.org
svn_grass at osgeo.org
Wed Mar 26 04:22:52 PDT 2014
Author: madi
Date: 2014-03-26 04:22:52 -0700 (Wed, 26 Mar 2014)
New Revision: 59354
Modified:
grass-addons/grass7/raster/r.stream.distance/main.c
grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html
Log:
small typos editing
Modified: grass-addons/grass7/raster/r.stream.distance/main.c
===================================================================
--- grass-addons/grass7/raster/r.stream.distance/main.c 2014-03-26 11:11:46 UTC (rev 59353)
+++ grass-addons/grass7/raster/r.stream.distance/main.c 2014-03-26 11:22:52 UTC (rev 59354)
@@ -47,8 +47,8 @@
module = G_define_module();
module->description =
- _("Calculate distance to and alavation above streams \
- and outlets according user' input. It can work in stream mode where target are streams and outlets mode \
+ _("Calculate distance to and elevation above streams \
+ and outlets according user's input. It can work in stream mode where target are streams and outlets mode \
where targets are outlets");
G_add_keyword(_("raster"));
Modified: grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html
===================================================================
--- grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html 2014-03-26 11:11:46 UTC (rev 59353)
+++ grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html 2014-03-26 11:22:52 UTC (rev 59354)
@@ -1,26 +1,26 @@
<h2>OPTIONS</h2>
<dl>
<dt><b>-o</b></dt>
-<dd>Outlets. Downstream method only. Calculate distance and relative elevation
-to basin outlets instead of streams. It choose only last outlets in the network
+<dd>Outlets. Downstream method only. Calculate distance and relative elevation
+to basin outlets instead of streams. It chooses only last outlets in the network
ignoring nodes.</dd>
<dt><b>-s</b></dt>
<dd>Subbasins. Downstream method only. Calculate distance and elevation to
-stream nodes instead of streams. It create distance and elevation parameters not
+stream nodes instead of streams. It creates distance and elevation parameters not
for whole basins but for all elementary subbasins.</dd>
<dt><b>-n</b></dt>
<dd>Near. For upstream method only. Calculate distance and elevation to the
nearest local maximum/divide. With the default option distance/elevation is
-calculated to the farthest possible maximum/divide
+calculated to the farthest possible maximum/divide.
</dd>
<dt><b>streams</b></dt>
-<dd>Stream network: name of input stream map on which ordering will be performed
+<dd>Stream network: name of input stream map on which ordering will be performed,
produced by r.watershed or r.stream.extract. Because streams network produced by
r.watershed and r.stream.extract may slighty differ in detail it is required to
use both stream and direction map produced by the same module. Stream background
shall have NULL value or zero value. Background values of NULL are by default
produced by r.watershed and r.stream.extract. If not 0 or NULL use <a
-href="r.mapcalc.html">r.mapcalc</a> to set background values to null.
+href="r.mapcalc.html">r.mapcalc</a> to set background values to NULL.
</dd>
<dt><b>dirs</b></dt>
<dd>Flow direction: name of input direction map produced by r.watershed or
@@ -30,7 +30,7 @@
East in steps of 45 degrees). Direction map shall be of type CELL values. Region
resolution and map resoultion must be the same. Also <em>stream</em> network map
must have the same resolution. It is checked by default. If resolutions differ
-the module informs about it and stops. Region boundary and maps boundary may be
+the module informs about it and stops. Region boundary and maps boundary may
differ but it may lead to unexpected results.</dd>
<dt><b>elevation</b></dt>
<dd>Elevation: name of input elevation map. Map can be of type CELL, FCELL or
@@ -39,17 +39,17 @@
<dt><b>method</b></dt>
<dd>It is possible to calculate distance with two method: <b>downstream</b> from
any raster cell to the nearest stream cell/ junction cell or outlet or
-<b>upstream</b> from any cell upstream to the nearest maximum or divide</dd>
+<b>upstream</b> from any cell upstream to the nearest maximum or divide.</dd>
</dl>
<h2>OUTPUTS</h2>
<dl>
<dt><b>difference</b></dt>
<dd>Returns elevation difference to the targer (outlet, node, stream, divide,
-maximum) along watercoures. The map is of FCELL type</dd>
+maximum) along watercoures. The map is of FCELL type.</dd>
<dt><b>distance</b></dt>
<dd>Returns distance to the targer (outlet, node, stream, divide, maximum) along
-watercoures. The map is of FCELL type</dd>
+watercoures. The map is of FCELL type.</dd>
</dl>
<h2>DESCRIPTION</h2>
@@ -57,7 +57,7 @@
Module r.stream.distance may calculate distance using two methods: downstream
and upstream.
<p>
-The default is downstream method when it calculate distance to streams and
+The default is downstream method when it calculates distance to streams and
outlets and relative elevation to streams and outlets. The distance and
elevation is calculated along watercourses. In outlets mode it can also
calculate parameters for subbasins.
@@ -67,43 +67,43 @@
possibilities. If subbasin is off it calculate parameters only for last point of
last (downstream) CELL. In subbasin mode it calculates parameters for every
subbasin separately. Subbasin mode acts similar to subbasin mask. Streams file
-prepared to create basins and subbasins with r.stream.basins can use to to
+prepared to create basins and subbasins with r.stream.basins can be used to
calculate distance and elevation parameters.
<p>
-With upstream method it calculate distance to the local maximum or divide.
+With upstream method it calculates distance to the local maximum or divide.
Opposite to downstream method, where every cell has one and only one downstream
cell in upstream method every cell has usually more than one upstream cell. So
it is impossible to determine interchangeable path from any cell. The upstream
method offers two alternative modes switched with -n flag: nearest local
maximum/divide: means the shortest path to local maximum and default option
-farthest maximum/divide means the longest path. In hydrological sense nearest
-mode means the shortest path which particle of water must run from divide to
+farthest maximum/divide means the longest path. In hydrological sense, nearest
+mode means the shortest path which a particle of water must run from divide to
reach particular cell, while farthest mode means the possible longest path.
<h2>NOTES</h2>
<p>
-If there are more than one point or one stream networks and some separate points
+If there are more than one point or one stream network and some separate points
or separate streams networks are in catchment area defined by others it will
-results as in subbasin mode. In stream mode subbasin options is ommited. Input
-maps must be in CELL format (default output of r.watershed, r.stream.order and
+results as in subbasin mode. In stream mode subbasin options is ommited. Input
+maps must be in CELL format (default output of r.watershed, r.stream.order and
r.stream.extract).
The distance are calculated in meters both for planimeters and
Latitude-Longitude projections. The distance is calculated for flat areas not
corrected by topography. Distance correction by topography may be done with
-following mapcalc formula:
+following r.mapcalc formula:
<p>
-<code>echo 'dist_corrected = sqrt(distance^2 + elevation ^2)'|r.mapcalc</code>
+<code>echo 'dist_corrected = sqrt(distance^2 + elevation^2)' | r.mapcalc</code>
<p>
-Module can work only if direction map, stream map and region has same settings.
-It is also required that stream map and direction map come from the same source.
-For lots of reason this limitation probably cannot be omitted. this means if
+The module can work only if direction map, streams map and region have the same settings.
+It is also required that streams map and direction map come from the same source.
+For lots of reason this limitation probably cannot be omitted. This means that if
stream map comes from r.stream.extract also direction map from r.stream.extract
must be used. If stream network was generated with MFD method also MFD direction
map must be used.
<p>
-Probably one of the most imortant features of r.stream.extract is the ability to
-calculate distnace not only for streams generated with r.stream.order, but also
-to any CELL map with resoultion coresponding to dirs map. It can be a lake,
+Probably one of the most imortant features of r.stream.distance is the ability to
+calculate distance not only for streams generated with r.stream.extract, but also
+to any CELL map with resolution corresponding to dirs map. It can be a lake,
swamp, depression and lake boundaries even divided into smaller fragments each
with its own category.
More information about the grass-commit
mailing list