added improved descrition for r.* algorithms, provided by Markus Neteler

git-svn-id: http://sextante.googlecode.com/svn/trunk/soft/bindings/qgis-plugin@201 881b9c09-3ef8-f3c2-ec3d-21d735c97f4d

src/sextante/grass/description/nviz.txt

@@ -1,5 +1,8 @@
 nviz
 nviz
 Visualization(NVIZ)
-ParameterMultipleInput|elevation|elevation|3|False
-ParameterMultipleInput|vector|vector|-1|False
+ParameterMultipleInput|elevation|Name of elevation raster map|3|False
+ParameterMultipleInput|color|Name of raster map(s) for Color|-1|False
+ParameterMultipleInput|vector|Name of vector lines/areas overlay map(s)|-1|False
+ParameterMultipleInput|point|Name of vector points overlay file(s)|-1|False
+ParameterMultipleInput|volume|Name of existing 3d raster map|-1|False

src/sextante/grass/description/r.average.txt

@@ -1,7 +1,7 @@
 r.average
 r.average
 Raster (r.*)
-ParameterRaster|base|base|False
-ParameterRaster|cover|cover|False
-ParameterBoolean|-c|-c|True
-OutputRaster|output|output
+ParameterRaster|base|Name of base raster map|False
+ParameterRaster|cover|Name of cover raster map|False
+ParameterBoolean|-c|Cover values extracted from the category labels of the cover map|False
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.basins.fill.txt

@@ -1,7 +1,7 @@
 r.basins.fill
 r.basins.fill
 Raster (r.*)
-ParameterNumber|number|number|None|None|0.0
-ParameterRaster|c_map|c_map|False
-ParameterRaster|t_map|t_map|False
-OutputRaster|result|result
+ParameterRaster|c_map|Name of input coded stream network raster map|False
+ParameterRaster|t_map|Name of input thinned ridge network raster map|False
+ParameterNumber|number|Number of passes through the dataset|None|None|0.0
+OutputRaster|result|Name for output raster map

src/sextante/grass/description/r.bilinear.txt

@@ -1,7 +1,7 @@
 r.bilinear
 r.bilinear
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterNumber|north|north|None|None|0
-ParameterNumber|east|east|None|None|0
-OutputRaster|output|output
+ParameterRaster|input|Name of input raster map|False
+ParameterNumber|north|Specific input value to be assigned to the north and/or south poles for longitude-latitude grids|None|None|0
+ParameterNumber|east|Specific input value to be assigned to the north and/or south poles for longitude-latitude grids|None|None|0
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.bitpattern.txt

@@ -1,7 +1,7 @@
 r.bitpattern
 r.bitpattern
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterString|pattern|pattern|
-ParameterString|patval|patval|
-OutputRaster|output|output
+ParameterRaster|input|Name of input raster map|False
+ParameterString|pattern|Bit pattern position(s)|
+ParameterString|patval|Bit pattern value|
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.buffer.txt

@@ -1,9 +1,8 @@
 r.buffer
 r.buffer
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterString|distances|distances|100,200,300
-ParameterSelection|units|units|meters;kilometers;feet;miles;nautmiles
-ParameterBoolean|-z|-z|True
-ParameterBoolean|-q|-q|True
-OutputRaster|output|output
+ParameterRaster|input|Name of input raster map|False
+ParameterString|distances|Distance zone(s) (e.g. 100,200,300)|
+ParameterSelection|units|Units of distance|meters;kilometers;feet;miles;nautmiles
+ParameterBoolean|-z|Ignore zero (0) data cells instead of NULL cells|False
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.carve.txt

@@ -1,11 +1,10 @@
 r.carve
 r.carve
 Raster (r.*)
-ParameterRaster|rast|rast|False
-ParameterVector|vect|vect|1|False
-ParameterNumber|width|width|None|None|1
-ParameterNumber|depth|depth|None|None|1
-ParameterBoolean|-n|-n|True
-ParameterBoolean|-q|-q|True
-OutputRaster|output|output
-OutputVector|points|points
+ParameterRaster|rast|Name of input raster elevation map|False
+ParameterVector|vect|Name of vector input map containing stream(s)|1|False
+ParameterNumber|width|Stream width (in meters). Default is raster cell width|None|None|1
+ParameterNumber|depth|Additional stream depth (in meters)|None|None|1
+ParameterBoolean|-n|No flat areas allowed in flow direction|False
+OutputRaster|output|Name for output raster map
+OutputVector|points|ame for output vector map for adjusted stream points

src/sextante/grass/description/r.circle.txt

@@ -1,9 +1,9 @@
 r.circle
 r.circle
 Raster (r.*)
-ParameterString|coordinate|coordinate|0,0
-ParameterNumber|min|min|None|None|10
-ParameterNumber|max|max|None|None|20
-ParameterString|mult|mult|1
-ParameterBoolean|-b|-b|True
-OutputRaster|output|output
+ParameterString|coordinate|The coordinate of the center (east,north)|0,0
+ParameterNumber|min|Minimum radius for ring/circle map (in meters)|None|None|10
+ParameterNumber|max|Maximum radius for ring/circle map (in meters)|None|None|20
+ParameterString|mult|Data value multiplier|1
+ParameterBoolean|-b|Generate binary raster map|False
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.clump.txt

@@ -1,7 +1,6 @@
 r.clump
 r.clump
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterString|title|title|
-ParameterBoolean|-q|-q|True
-OutputRaster|output|output
+ParameterRaster|input|Name of input raster map|False
+ParameterString|title|Title for output raster map|
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.coin.txt

@@ -1,7 +1,7 @@
 r.coin
 r.coin
 Raster (r.*)
-ParameterRaster|map1|map1|False
-ParameterRaster|map2|map2|False
-ParameterSelection|units|units|c;p;x;y;a;h;k;m
-ParameterBoolean|-w|-w|True
+ParameterRaster|map1|Name of first raster map|False
+ParameterRaster|map2|Name of second raster map|False
+ParameterSelection|units|Unit of measure|c;p;x;y;a;h;k;m
+ParameterBoolean|-w|Wide report, 132 columns (default: 80)|False

src/sextante/grass/description/r.colors.txt

@@ -1,12 +1,11 @@
 r.colors
 r.colors
 Raster (r.*)
-ParameterRaster|map|map|False
-ParameterSelection|color|color|aspect;aspectcolr;bcyr;bgyr;byg;byr;celsius;corine;curvature;differences;elevation;etopo2;evi;gdd;grey;grey1.0;grey255;gyr;haxby;ndvi;population;precipitation;rainbow;ramp;rstcurv;ryb;ryg;sepia;slope;srtm;terrain;wave;random;grey.eq;grey.log;rules
-ParameterString|rules|rules|/file
-ParameterBoolean|-l|-l|True
-ParameterBoolean|-n|-n|True
-ParameterBoolean|-g|-g|True
-ParameterBoolean|-a|-a|True
-ParameterBoolean|-e|-e|True
-ParameterBoolean|-q|-q|True
+ParameterRaster|map|Name of input raster map|False
+ParameterSelection|color|Type of color table|aspect;aspectcolr;bcyr;bgyr;byg;byr;celsius;corine;curvature;differences;elevation;etopo2;evi;gdd;grey;grey1.0;grey255;gyr;haxby;ndvi;population;precipitation;rainbow;ramp;rstcurv;ryb;ryg;sepia;slope;srtm;terrain;wave;random;grey.eq;grey.log;rules
+ParameterString|rules|Path to rules file ("-" to read rules from stdin)|/file
+ParameterBoolean|-l|List available rules then exit|False
+ParameterBoolean|-n|Invert colors|False
+ParameterBoolean|-g|Logarithmic scaling|False
+ParameterBoolean|-a|Logarithmic-absolute scaling|False
+ParameterBoolean|-e|Histogram equalization|False

src/sextante/grass/description/r.composite.txt

@@ -1,16 +1,13 @@
 r.composite
 r.composite
 Raster (r.*)
-ParameterRaster|red|red|False
-ParameterRaster|green|green|False
-ParameterRaster|blue|blue|False
-ParameterNumber|levels|levels|1.0|256.0|32
-ParameterNumber|lev_red|lev_red|1.0|256.0|32
-ParameterNumber|lev_green|lev_green|1.0|256.0|32
-ParameterNumber|lev_blue|lev_blue|1.0|256.0|32
-ParameterString|lev_red|lev_red|
-ParameterString|lev_green|lev_green|
-ParameterString|lev_blue|lev_blue|
-ParameterBoolean|-d|-d|True
-ParameterBoolean|-c|-c|True
-OutputRaster|output|output
+ParameterRaster|red|Name of raster map to be used for <red>|False
+ParameterRaster|green|Name of raster map to be used for <green>|False
+ParameterRaster|blue|Name of raster map to be used for <blue>|False
+ParameterNumber|levels|Number of levels to be used for each component|1.0|256.0|32
+ParameterNumber|lev_red|Number of levels to be used for <red>|1.0|256.0|32
+ParameterNumber|lev_green|Number of levels to be used for <green>|1.0|256.0|32
+ParameterNumber|lev_blue|Number of levels to be used for <blue>|1.0|256.0|32
+ParameterBoolean|-d|Dither|False
+ParameterBoolean|-c|Use closest color|False
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.contour.txt

@@ -1,12 +1,11 @@
 r.contour
 r.contour
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterString|levels|levels|
-ParameterString|minlevel|minlevel|
-ParameterString|maxlevel|maxlevel|
-ParameterString|step|step|
-ParameterString|cut|cut|0
-ParameterBoolean|-q|-q|True
-ParameterBoolean|-n|-n|True
-OutputVector|output|output
+ParameterRaster|input|Name of input raster map|False
+ParameterString|levels|List of contour levels|
+ParameterString|minlevel|Minimum contour level|
+ParameterString|maxlevel|Maximum contour level|
+ParameterString|step|Increment between contour levels|
+ParameterString|cut|Minimum number of points for a contour line (0 -> no limit)|0
+ParameterBoolean|-n|Suppress single crossing error messages|False
+OutputVector|output|Name of output vector map

src/sextante/grass/description/r.cost.txt

@@ -1,9 +1,9 @@
 r.cost
 r.cost
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterVector|start_points|start_points|0|False
-ParameterVector|stop_points|stop_points|0|False
-ParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|True
-ParameterBoolean|-n|-n|True
-OutputRaster|output|output
+ParameterRaster|input|Name of raster map containing grid cell cost information|False
+ParameterVector|start_points|Name of starting vector points map|0|False
+ParameterVector|stop_points|Name of stop vector points map|0|False
+ParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|False
+ParameterBoolean|-n|Keep null values in output raster map|False
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.covar.txt

@@ -1,5 +1,5 @@
 r.covar
 r.covar
 Raster (r.*)
-ParameterMultipleInput|map|map|3.0|False
-ParameterBoolean|-r|-r|True
+ParameterMultipleInput|map|Name of input raster map(s)|3.0|False
+ParameterBoolean|-r|Print correlation matrix|True

src/sextante/grass/description/r.cross.txt

@@ -1,7 +1,6 @@
 r.cross
 r.cross
 Raster (r.*)
-ParameterMultipleInput|input|input|3.0|False
-ParameterBoolean|-z|-z|True
-ParameterBoolean|-q|-q|True
-OutputRaster|output|output
+ParameterMultipleInput|input|Names of 2-30 input raster maps|3.0|False
+ParameterBoolean|-z|Non-zero data only|False
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.describe.txt

@@ -1,12 +1,11 @@
 r.describe
 r.describe
 Raster (r.*)
-ParameterRaster|map|map|False
-ParameterString|nv|nv|*
-ParameterNumber|nsteps|nsteps|1.0|None|255
-ParameterBoolean|-1|-1|True
-ParameterBoolean|-r|-r|True
-ParameterBoolean|-n|-n|True
-ParameterBoolean|-d|-d|True
-ParameterBoolean|-i|-i|True
-ParameterBoolean|-q|-q|True
+ParameterRaster|map|Name of input raster map|False
+ParameterString|nv|String representing no data cell value|*
+ParameterNumber|nsteps|Number of quantization steps|1.0|None|255
+ParameterBoolean|-1|Print the output one value per line|False
+ParameterBoolean|-r|Only print the range of the data|False
+ParameterBoolean|-n|Suppress reporting of any NULLs|False
+ParameterBoolean|-d|Use the current region|False
+ParameterBoolean|-i|Read fp map as integer|False

src/sextante/grass/description/r.distance.txt

@@ -1,8 +1,7 @@
 r.distance
 r.distance
 Raster (r.*)
-ParameterRaster|maps|maps|False
-ParameterString|fs|fs|:
-ParameterBoolean|-l|-l|True
-ParameterBoolean|-o|-o|True
-ParameterBoolean|-q|-q|True
+ParameterRaster|maps|Maps for computing inter-class distances|False
+ParameterString|fs|Output field separator|:
+ParameterBoolean|-l|Include category labels in the output|False
+ParameterBoolean|-o|Report zero distance if rasters are overlapping|False

src/sextante/grass/description/r.drain.txt

@@ -1,10 +1,10 @@
 r.drain
 r.drain
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterString|coordinate|coordinate(E,N)|
-ParameterMultipleInput|vector_points|vector_points|0.0|False
-ParameterBoolean|-c|-c|True
-ParameterBoolean|-a|-a|True
-ParameterBoolean|-n|-n|True
-OutputRaster|output|output
+ParameterRaster|input|Name of elevation raster map|False
+ParameterString|coordinate|Map coordinates of starting point(s) (E,N)|
+ParameterMultipleInput|vector_points|Name of vector map(s) containing starting point(s)|0.0|False
+ParameterBoolean|-c|Copy input cell values on output|False
+ParameterBoolean|-a|Accumulate input values along the path|False
+ParameterBoolean|-n|Count cell numbers along the path|False
+OutputRaster|output|Name for output raster map

src/sextante/grass/description/r.fill.dir.txt

@@ -1,9 +1,9 @@
 r.fill.dir
 r.fill.dir
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterString|type|type|grass
-ParameterBoolean|-f|-f|True
-OutputRaster|elevation|elevation
-OutputRaster|direction|direction
-OutputRaster|areas|areas
+ParameterRaster|input|Name of existing raster map containing elevation surface|False
+ParameterSelection|type|Output aspect direction format|grass;agnps;answers
+ParameterBoolean|-f|Find unresolved areas only|False
+OutputRaster|elevation|Output elevation raster map after filling
+OutputRaster|direction|Output direction raster map
+OutputRaster|areas|Output raster map of problem areas

src/sextante/grass/description/r.fillnulls.txt

@@ -1,7 +1,7 @@
 r.fillnulls
 r.fillnulls
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterNumber|tension|tension|None|None|40.0
-ParameterNumber|smooth|smooth|None|None|0.1
-OutputRaster|output|output
+ParameterRaster|input|Name of input raster map in which to fill nulls|False
+ParameterNumber|tension|Spline tension parameter|None|None|40.0
+ParameterNumber|smooth|Spline smoothing parameter|None|None|0.1
+OutputRaster|output|Name for output raster map with nulls filled by interpolation

src/sextante/grass/description/r.flow.txt

@@ -1,13 +1,14 @@
 r.flow
 r.flow
 Raster (r.*)
-ParameterRaster|elevin|elevin|False
-ParameterRaster|aspin|aspin|False
-ParameterRaster|barin|barin|False
-ParameterNumber|skip|skip|None|None|1.0
-ParameterNumber|bound|bound|None|None|5.0
-ParameterBoolean|-u|-u|True
-ParameterBoolean|-3|-3|True
-ParameterBoolean|-m|-m|True
-OutputRaster|lgout|lgout
-OutputRaster|dsout|dsout
+ParameterRaster|elevin|Input elevation raster map|False
+ParameterRaster|aspin|Input aspect raster map|False
+ParameterRaster|barin|Input barrier raster map|False
+ParameterNumber|skip|Number of cells between flowlines|None|None|1.0
+ParameterNumber|bound|Maximum number of segments per flowline|None|None|5.0
+ParameterBoolean|-u|Compute upslope flowlines instead of default downhill flowlines|False
+ParameterBoolean|-3|3-D lengths instead of 2-D|False
+ParameterBoolean|-m|Use less memory, at a performance penalty|False
+OutputRaster|flout|Output flowline vector map
+OutputRaster|lgout|Output flowpath length raster map
+OutputRaster|dsout|Output flowline density raster map

src/sextante/grass/description/r.grow.distance.txt

@@ -1,7 +1,7 @@
 r.grow.distance
 r.grow.distance
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterSelection|metric|metric|euclidean;squared;maximum;manhattan
-OutputRaster|distance|distance
-OutputRaster|value|value
+ParameterRaster|input|Name of input raster map|False
+ParameterSelection|metric|Metric|euclidean;squared;maximum;manhattan
+OutputRaster|distance|Name for distance output map
+OutputRaster|value|Name for value output map

src/sextante/grass/description/r.grow.txt

@@ -1,10 +1,9 @@
 r.grow
 r.grow
 Raster (r.*)
-ParameterRaster|input|input|False
-ParameterNumber|radius|radius|None|None|1.01
-ParameterSelection|metric|metric|euclidean;maximum;manhattan
-ParameterNumber|old|old|None|None|0
-ParameterNumber|new|new|None|None|1
-ParameterBoolean|-q|-q|True
-OutputRaster|output|output
+ParameterRaster|input|Name of input raster map|False
+ParameterNumber|radius|Radius of buffer in raster cells|None|None|1.01
+ParameterSelection|metric|Metric|euclidean;maximum;manhattan
+ParameterNumber|old|Value to write for input cells which are non-NULL (-1 => NULL)|None|None|0
+ParameterNumber|new|Value to write for "grown" cells|None|None|1
+OutputRaster|output|Name for output raster map