Skip to content
Permalink
Browse files

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
  • Loading branch information
volayaf
volayaf committed Jun 1, 2012
1 parent 0a0cb3b commit f56be03b6320f188daedabdcb563fcc3b826350f
Showing with 600 additions and 612 deletions.
  1. +5 −2 src/sextante/grass/description/nviz.txt
  2. +4 −4 src/sextante/grass/description/r.average.txt
  3. +4 −4 src/sextante/grass/description/r.basins.fill.txt
  4. +4 −4 src/sextante/grass/description/r.bilinear.txt
  5. +4 −4 src/sextante/grass/description/r.bitpattern.txt
  6. +5 −6 src/sextante/grass/description/r.buffer.txt
  7. +7 −8 src/sextante/grass/description/r.carve.txt
  8. +6 −6 src/sextante/grass/description/r.circle.txt
  9. +3 −4 src/sextante/grass/description/r.clump.txt
  10. +4 −4 src/sextante/grass/description/r.coin.txt
  11. +8 −9 src/sextante/grass/description/r.colors.txt
  12. +10 −13 src/sextante/grass/description/r.composite.txt
  13. +8 −9 src/sextante/grass/description/r.contour.txt
  14. +6 −6 src/sextante/grass/description/r.cost.txt
  15. +2 −2 src/sextante/grass/description/r.covar.txt
  16. +3 −4 src/sextante/grass/description/r.cross.txt
  17. +8 −9 src/sextante/grass/description/r.describe.txt
  18. +4 −5 src/sextante/grass/description/r.distance.txt
  19. +7 −7 src/sextante/grass/description/r.drain.txt
  20. +6 −6 src/sextante/grass/description/r.fill.dir.txt
  21. +4 −4 src/sextante/grass/description/r.fillnulls.txt
  22. +11 −10 src/sextante/grass/description/r.flow.txt
  23. +4 −4 src/sextante/grass/description/r.grow.distance.txt
  24. +6 −7 src/sextante/grass/description/r.grow.txt
  25. +22 −21 src/sextante/grass/description/r.gwflow.txt
  26. +7 −7 src/sextante/grass/description/r.his.txt
  27. +13 −13 src/sextante/grass/description/r.horizon.txt
  28. +10 −10 src/sextante/grass/description/r.info.txt
  29. +6 −6 src/sextante/grass/description/r.kappa.txt
  30. +7 −7 src/sextante/grass/description/r.lake.txt
  31. +7 −7 src/sextante/grass/description/r.los.txt
  32. +2 −2 src/sextante/grass/description/r.mapcalculator.txt
  33. +3 −3 src/sextante/grass/description/r.median.txt
  34. +6 −5 src/sextante/grass/description/r.mfilter.fp.txt
  35. +6 −7 src/sextante/grass/description/r.mfilter.txt
  36. +3 −3 src/sextante/grass/description/r.mode.txt
  37. +5 −5 src/sextante/grass/description/r.neighbors.txt
  38. +5 −5 src/sextante/grass/description/r.out.arc.txt
  39. +9 −9 src/sextante/grass/description/r.out.ascii.txt
  40. +2 −3 src/sextante/grass/description/r.out.gridatb.txt
  41. +3 −4 src/sextante/grass/description/r.out.ppm.txt
  42. +4 −4 src/sextante/grass/description/r.out.vrml.txt
  43. +9 −9 src/sextante/grass/description/r.param.scale.txt
  44. +3 −4 src/sextante/grass/description/r.patch.txt
  45. +7 −7 src/sextante/grass/description/r.plane.txt
  46. +8 −8 src/sextante/grass/description/r.profile.txt
  47. +6 −6 src/sextante/grass/description/r.quant.txt
  48. +4 −4 src/sextante/grass/description/r.quantile.txt
  49. +3 −3 src/sextante/grass/description/r.random.cells.txt
  50. +5 −5 src/sextante/grass/description/r.random.txt
  51. +4 −3 src/sextante/grass/description/r.reclass.area.txt
  52. +3 −3 src/sextante/grass/description/r.reclass.txt
  53. +6 −6 src/sextante/grass/description/r.recode.txt
  54. +5 −5 src/sextante/grass/description/r.regression.line.txt
  55. +12 −13 src/sextante/grass/description/r.report.txt
  56. +3 −3 src/sextante/grass/description/r.resamp.interp.txt
  57. +6 −5 src/sextante/grass/description/r.resamp.rst.txt
  58. +5 −5 src/sextante/grass/description/r.resamp.stats.txt
  59. +2 −2 src/sextante/grass/description/r.resample.txt
  60. +4 −5 src/sextante/grass/description/r.rescale.eq.txt
  61. +4 −4 src/sextante/grass/description/r.rescale.txt
  62. +2 −2 src/sextante/grass/description/r.ros.txt
  63. +7 −7 src/sextante/grass/description/r.shaded.relief.txt
  64. +18 −18 src/sextante/grass/description/r.sim.sediment.txt
  65. +21 −21 src/sextante/grass/description/r.sim.water.txt
  66. +15 −16 src/sextante/grass/description/r.slope.aspect.txt
  67. +1 −1 src/sextante/grass/description/r.spread.txt
  68. +1 −1 src/sextante/grass/description/r.spreadpath.txt
  69. +4 −4 src/sextante/grass/description/r.statistics.txt
  70. +18 −18 src/sextante/grass/description/r.stats.txt
  71. +1 −1 src/sextante/grass/description/r.sum.txt
  72. +30 −31 src/sextante/grass/description/r.sun.txt
  73. +1 −1 src/sextante/grass/description/r.sunmask.txt
  74. +2 −2 src/sextante/grass/description/r.surf.area.txt
  75. +2 −3 src/sextante/grass/description/r.surf.contour.txt
  76. +3 −3 src/sextante/grass/description/r.surf.gauss.txt
  77. +4 −4 src/sextante/grass/description/r.surf.idw.txt
  78. +3 −3 src/sextante/grass/description/r.surf.idw2.txt
  79. +4 −4 src/sextante/grass/description/r.surf.random.txt
  80. +8 −9 src/sextante/grass/description/r.terraflow.short.txt
  81. +8 −7 src/sextante/grass/description/r.terraflow.txt
  82. +19 −19 src/sextante/grass/description/r.texture.txt
  83. +3 −3 src/sextante/grass/description/r.thin.txt
  84. +8 −8 src/sextante/grass/description/r.to.vect.txt
  85. +2 −2 src/sextante/grass/description/r.topidx.txt
  86. +15 −15 src/sextante/grass/description/r.topmodel.txt
  87. +3 −3 src/sextante/grass/description/r.transect.txt
  88. +4 −3 src/sextante/grass/description/r.univar.txt
  89. +4 −4 src/sextante/grass/description/r.volume.txt
  90. +17 −17 src/sextante/grass/description/r.walk.txt
  91. +4 −4 src/sextante/grass/description/r.water.outlet.txt
  92. +16 −16 src/sextante/grass/description/r.watershed.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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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

0 comments on commit f56be03

Please sign in to comment.
You can’t perform that action at this time.