Browse Source

r.stream.distance manual: minor sync with trunk; msg typo sync

git-svn-id: https://svn.osgeo.org/grass/grass/branches/releasebranch_7_0@61441 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 11 years ago
parent
commit
1f575b4eab
2 changed files with 24 additions and 23 deletions
  1. 1 1
      raster/r.stream.distance/main.c
  2. 23 22
      raster/r.stream.distance/r.stream.distance.html

+ 1 - 1
raster/r.stream.distance/main.c

@@ -119,7 +119,7 @@ int main(int argc, char *argv[])
 	exit(EXIT_FAILURE);
 	exit(EXIT_FAILURE);
 
 
     if (!out_diff_opt->answer && !out_dist_opt->answer)
     if (!out_diff_opt->answer && !out_dist_opt->answer)
-	G_fatal_error(_("You must select at least one output raster maps"));
+	G_fatal_error(_("You must select at least one output raster map"));
     if (out_diff_opt->answer && !in_elev_opt->answer)
     if (out_diff_opt->answer && !in_elev_opt->answer)
 	G_fatal_error(_("Output elevation difference raster map requires "
 	G_fatal_error(_("Output elevation difference raster map requires "
                         "input elevation raster map to be specified"));
                         "input elevation raster map to be specified"));

+ 23 - 22
raster/r.stream.distance/r.stream.distance.html

@@ -16,11 +16,11 @@ it is impossible to determine interchangeable path from any cell.
 
 
 <p>
 <p>
 The upstream method offers two alternative modes switched with <em>-n</em> 
 The upstream method offers two alternative modes switched with <em>-n</em> 
-flag: the <em>nearest local maximum/divide</em>: is the shortest path to 
-the local maximum (default option); and the <em>farthest maximum/divide</em>: 
-is the longest path. 
-In hydrological sense, the <em>nearest</em> option means the shortest path which a 
-particle of water must run from the divide to reach a particular pixel, 
+flag: the <em>nearest local maximum/divide</em> is the shortest path to 
+the local maximum; and the <em>farthest maximum/divide</em>
+is the longest path (default option). 
+In hydrological sense, the <em>nearest</em> option means the shortest path
+which a particle of water must run from the divide to reach a particular pixel,
 while the <em>farthest</em> option means the possible longest path.
 while the <em>farthest</em> option means the possible longest path.
 
 
 <p>
 <p>
@@ -34,7 +34,8 @@ it calculates the distance only for the outlet (downstream).
 If the <em>subbasin</em> option is set on, it calculates the distance to
 If the <em>subbasin</em> option is set on, it calculates the distance to
 outlet for every subbasin separately. The <em>subbasin</em> option acts 
 outlet for every subbasin separately. The <em>subbasin</em> option acts 
 similarly to a subbasin mask. The module <em>r.stream.basins</em> can be
 similarly to a subbasin mask. The module <em>r.stream.basins</em> can be
-used to prepare the stream network map taken in input by <em>r.stream.distance</em>.
+used to prepare the stream network map taken in input by
+<em>r.stream.distance</em>.
 In fact it can be used to individuate basins and subbasins.
 In fact it can be used to individuate basins and subbasins.
 
 
 <p>
 <p>
@@ -79,16 +80,16 @@ shall be of integer type (CELL). </dd>
 DCELL. </dd>
 DCELL. </dd>
 
 
 <dt><b>method</b></dt>
 <dt><b>method</b></dt>
-<dd>It is possible to calculate the distance with two method: <b>downstream</b> from
-any raster cell to the nearest stream cell / junction cell or outlet or
+<dd>It is possible to calculate the 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>
 
 
 <dt><b>difference</b></dt>
 <dt><b>difference</b></dt>
-<dd>Name of output map of elevation difference to the targer (outlet, node, 
+<dd>Name of output map of elevation difference to the target (outlet, node, 
 stream, divide, maximum) along watercoures. The map is of FCELL type.</dd>
 stream, divide, maximum) along watercoures. The map is of FCELL type.</dd>
 
 
 <dt><b>distance</b></dt>
 <dt><b>distance</b></dt>
-<dd>Name of output map of distance to the targer (outlet, node, stream, 
+<dd>Name of output map of distance to the target (outlet, node, stream, 
 divide, maximum) along watercoures. The map is of FCELL type.</dd>
 divide, maximum) along watercoures. The map is of FCELL type.</dd>
 </dl>
 </dl>
 
 
@@ -115,23 +116,25 @@ r.mapcalc expression = "dist_corrected = sqrt(distance^2 + elevation^2)"
 </pre></div>
 </pre></div>
 
 
 <p>
 <p>
-The module can work only if direction map, streams map and region have the same settings.
+The module can work only if direction map, streams map and region have the same
+settings.
 This is checked by default. If resolutions differ, the module informs about 
 This is checked by default. If resolutions differ, the module informs about 
 it and stops. Region boundary and maps boundary may differ but it may lead 
 it and stops. Region boundary and maps boundary may differ but it may lead 
 to unexpected results. The elevation map is not affected by this restriction 
 to unexpected results. The elevation map is not affected by this restriction 
 and can have whatever resolution.
 and can have whatever resolution.
 
 
 <p>
 <p>
-It is also required that <em>stream_rast</em> and <em>direction</em> maps come 
-from the same source, e.g. both from <em>r.stream.extract</em>. If the stream network 
-was generated with MFD method also MFD direction map must be used.
+It is also required that <em>stream_rast</em> and <em>direction</em> maps come
+from the same source, e.g. both from <em>r.stream.extract</em>. If the stream
+network was generated with MFD method also MFD direction map must be used.
 
 
 <p>
 <p>
-Probably one of the most important features of <em>r.stream.distance</em> is the ability to
-calculate the distance not only for streams generated by <em>r.stream.extract</em>, but also
-for any integer map, as long ast the resolution corresponds to that of <em>direction</em> map. 
-It can be a lake, swamp, depression and lake boundaries even divided into smaller fragments each
-with its own category.
+Probably one of the most important features of <em>r.stream.distance</em> is
+the ability to calculate the distance not only for streams generated by
+<em>r.stream.extract</em>, but also for any integer map, as long ast the
+resolution corresponds to that of <em>direction</em> map. 
+It can be a lake, swamp, depression and lake boundaries even divided into
+smaller fragments each with its own category.
 
 
 <h2>EXAMPLE</h2>
 <h2>EXAMPLE</h2>
 
 
@@ -165,9 +168,6 @@ r.stream.distance -o stream_rast=outlet direction=direction elevation=elevation
 
 
 <h2>SEE ALSO</h2>
 <h2>SEE ALSO</h2>
 <em>
 <em>
-<a href="r.stream.extract.html">r.stream.extract</a>,
-<a href="r.stream.order.html">r.stream.order</a>,
-<a href="r.stream.basins.html">r.stream.basins</a>,
 <a href="r.mapcalc.html">r.mapcalc</a>,
 <a href="r.mapcalc.html">r.mapcalc</a>,
 <a href="r.reclass.html">r.reclass</a>,
 <a href="r.reclass.html">r.reclass</a>,
 <a href="r.stream.channel.html">r.stream.channel</a>,
 <a href="r.stream.channel.html">r.stream.channel</a>,
@@ -186,6 +186,7 @@ also <a href="http://grasswiki.osgeo.org/wiki/R.stream.*_modules">r.streams.*
 modules</a> wiki page.
 modules</a> wiki page.
 
 
 <h2>AUTHOR</h2>
 <h2>AUTHOR</h2>
+
 Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
 Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
 Institute.
 Institute.