[GRASS-SVN] r62315 - in grass-addons/grass7/vector: v.centerline v.isochrones

[svn_grass at osgeo.org]

Author: neteler
Date: 2014-10-21 06:03:45 -0700 (Tue, 21 Oct 2014)
New Revision: 62315

Modified:
   grass-addons/grass7/vector/v.centerline/v.centerline.html
   grass-addons/grass7/vector/v.isochrones/v.isochrones.html
Log:
v.centerline/v.isochrones: fix formatting to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs

Modified: grass-addons/grass7/vector/v.centerline/v.centerline.html
===================================================================
--- grass-addons/grass7/vector/v.centerline/v.centerline.html	2014-10-21 13:01:49 UTC (rev 62314)
+++ grass-addons/grass7/vector/v.centerline/v.centerline.html	2014-10-21 13:03:45 UTC (rev 62315)
@@ -1,10 +1,23 @@
 <h2>DESCRIPTION</h2>
 
-<p><em>v.centerline</em> creates a new map with a line representing an approximation of the central tendency of a series of input lines. This can for example, be the central line of a river represented by its two sides, or a line representing the general direction of a series of flight paths, etc.
+<em>v.centerline</em> creates a new map with a line representing an 
+approximation of the central tendency of a series of input lines. This 
+can for example, be the central line of a river represented by its two 
+sides, or a line representing the general direction of a series of 
+flight paths, etc.
 
-<p>Two algorithms are proposed in the module, both based on the idea of using a reference line, creating a series of reference points along this line and then finding the coordinates of corresponding points on all the input lines. The default algorithm uses closest distance to identify corresponding points, while the second algorithm (<b>t</b> flag) draws perpendicular transversals at the reference points and uses the intersections of these transversals with the other lines as corresponding points.
+<p>
+Two algorithms are proposed in the module, both based on the idea of 
+using a reference line, creating a series of reference points along 
+this line and then finding the coordinates of corresponding points on 
+all the input lines. The default algorithm uses closest distance to 
+identify corresponding points, while the second algorithm (<b>t</b> 
+flag) draws perpendicular transversals at the reference points and uses 
+the intersections of these transversals with the other lines as 
+corresponding points.
 
-<p>In detail, the default algorithm goes as follows: 
+<p>
+In detail, the default algorithm goes as follows: 
 <ul>
 	<li>choose one of the input lines as reference line</li>
 	<li>create a series of points at regular intervals on this line</li>
@@ -18,7 +31,8 @@
 	<li>use the calculated means (or medians) as vertices of the new line</li>
 </ul>
 
-<p>The transversals algorithm goes as follows: 
+<p>
+The transversals algorithm goes as follows: 
 <ul>
 	<li>choose one of the input lines as reference line</li>
 	<li>create a series of perpendicular (transversal) lines at regular intervals on this line</li>
@@ -32,21 +46,42 @@
 	<li>use the calculated means (or medians) as vertices of the new line</li>
 </ul>
 
-<p>The user can change three parameters in the algorithms: the choice of the reference line (<b>refline</b>), the number of vertices to calculate (<b>vertices</b>) and the search range (<b>range</b>), i.e. for the default algorithm the maximum distance of corresponding points from the reference line and for the second algorithm the length of the transversals on each side of the reference line.
+<p>The user can change three parameters in the algorithms: the choice 
+of the reference line (<b>refline</b>), the number of vertices to 
+calculate (<b>vertices</b>) and the search range (<b>range</b>), i.e. 
+for the default algorithm the maximum distance of corresponding points 
+from the reference line and for the second algorithm the length of the 
+transversals on each side of the reference line.
 
-<p>If no reference line is given the module choses the reference line by determining the mean distance of the midpoint of each line to the midpoints of all other lines. The line with the lowest mean distance is then chosen as the reference line. If no range is given, the module uses the mean of the above mean distances as the range for the transversals algorithm, and an unlimited search range for the default algorithm.
+<p>If no reference line is given the module choses the reference line 
+by determining the mean distance of the midpoint of each line to the 
+midpoints of all other lines. The line with the lowest mean distance is 
+then chosen as the reference line. If no range is given, the module 
+uses the mean of the above mean distances as the range for the 
+transversals algorithm, and an unlimited search range for the default 
+algorithm.
 
-<p>If the <b>m</b> flag is set and there are more than 2 lines in the input file, the module calculates the mathematical median of the x and of the y coordinates.
+<p>If the <b>m</b> flag is set and there are more than 2 lines in the 
+input file, the module calculates the mathematical median of the x and 
+of the y coordinates.
 	
 <h2>NOTES</h2>
 
-<p>This module is more of a proof of concept showing that an approximate solution to the problem is possible with existing GRASS modules. A C-based solution would probably be much more efficient.
+This module is more of a proof of concept showing that an approximate 
+solution to the problem is possible with existing GRASS modules. A 
+C-based solution would probably be much more efficient.
 
-<p>The median in this module is <b>not</b> the geometric median, but the simple mathematical median respectively of the x and the y coordinates.
+<p>The median in this module is <b>not</b> the geometric median, but 
+the simple mathematical median respectively of the x and the y 
+coordinates.
 
-<p>The transversals algorithm is very sensitive to the range parameter. The user might want to play around with this parameter to find the best value.
+<p>The transversals algorithm is very sensitive to the range parameter. 
+The user might want to play around with this parameter to find the best 
+value.
 
-<p>Increasing the number of vertices should have a smoothing effect on the resulting line, but in the case of the transversals algorithm it can possibly lead to more instability.
+<p>Increasing the number of vertices should have a smoothing effect on 
+the resulting line, but in the case of the transversals algorithm it 
+can possibly lead to more instability.
 
 <h2>EXAMPLE</h2>
 
@@ -77,7 +112,8 @@
 <h2>SEE ALSO</h2>
 
 <em>
-	<a href="v.segment">v.segment</a>, <a href="v.distance">v.distance</a>
+<a href="v.segment">v.segment</a>,
+<a href="v.distance">v.distance</a>
 </em>
 <br>
 Similar addons:
@@ -86,6 +122,6 @@
 </em>
 
 <h2>AUTHOR</h2>
- Moritz Lennert
+Moritz Lennert
 
 <p><i>Last changed: $Date$</i>

Modified: grass-addons/grass7/vector/v.isochrones/v.isochrones.html
===================================================================
--- grass-addons/grass7/vector/v.isochrones/v.isochrones.html	2014-10-21 13:01:49 UTC (rev 62314)
+++ grass-addons/grass7/vector/v.isochrones/v.isochrones.html	2014-10-21 13:03:45 UTC (rev 62315)
@@ -1,14 +1,27 @@
 <h2>DESCRIPTION</h2>
 
-<p><em>v.isochrones</em> creates a vector polygon map of isochrones (<b>isochrones</b>) based on a roads map (<b>map</b>) with speed attribute (<b>speed_column</b>), one or several starting points (<b>start_points</b>) and time steps for the isochrones (<b>time_steps</b>). Optionally, the module can create a raster map with continuous time from the starting points (<b>timemap</b>).
+<em>v.isochrones</em> creates a vector polygon map of isochrones 
+(<b>isochrones</b>) based on a roads map (<b>map</b>) with speed 
+attribute (<b>speed_column</b>), one or several starting points 
+(<b>start_points</b>) and time steps for the isochrones 
+(<b>time_steps</b>). Optionally, the module can create a raster map 
+with continuous time from the starting points (<b>timemap</b>).
 
-<p>The user can define the speed to use in offroad areas (<b>offroad_speed</b>) and the time unit of the output and the time steps (<b>unit</b>).
+<p>
+The user can define the speed to use in offroad areas 
+(<b>offroad_speed</b>) and the time unit of the output and the time 
+steps (<b>unit</b>).
 
 <h2>NOTES</h2>
 
-<p>The module is a front-end to <em><a href="r.cost.html">r.cost</a></em>. It transforms the roads to raster, calculates time cost from the starting points and then transforms the result into discrete vector polygons based on the time steps chosen.
+The module is a front-end to <em><a href="r.cost.html">r.cost</a></em>. 
+It transforms the roads to raster, calculates time cost from the 
+starting points and then transforms the result into discrete vector 
+polygons based on the time steps chosen.
 
-<p>Current region settings are used to define the maximal extension and the resolution at which the cost map is calculated.
+<p>
+Current region settings are used to define the maximal extension and 
+the resolution at which the cost map is calculated.
 
 <h2>EXAMPLE</h2>
 
@@ -19,11 +32,11 @@
 v.db.update roads col=speed value=90 where="(ROAD_NAME like 'US%' AND ROAD_NAME <> 'US-1') OR ROAD_NAME like 'I-%'"
 v.db.update roads col=speed value=50 where="speed is null"
 
-g.region vect=roads res=100 -a
+g.region vect=roads res=100 -a -p
 
 echo "634637|224663" | v.in.ascii input=- output=start x=1 y=2
 
-v.isochrones.py map=roads speed_col=speed start_points=start isochrones=isochrones30_60_120 time_steps=30,60,120
+v.isochrones map=roads speed_col=speed start_points=start isochrones=isochrones30_60_120 time_steps=30,60,120
 </pre></div>
 
 <center>
@@ -35,10 +48,11 @@
 <h2>SEE ALSO</h2>
 
 <em>
-<a href="r.cost">r.cost</a>, <a href="v.net.iso">v.net.iso</a> 
+<a href="r.cost">r.cost</a>,
+<a href="v.net.iso">v.net.iso</a> 
 </em>
 
 <h2>AUTHOR</h2>
- Moritz Lennert
+Moritz Lennert
 
 <p><i>Last changed: $Date$</i>