Skip to content

Commit f56be03

Browse files
author
volayaf
committed
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
1 parent 0a0cb3b commit f56be03

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+600
-612
lines changed

‎src/sextante/grass/description/nviz.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
nviz
22
nviz
33
Visualization(NVIZ)
4-
ParameterMultipleInput|elevation|elevation|3|False
5-
ParameterMultipleInput|vector|vector|-1|False
4+
ParameterMultipleInput|elevation|Name of elevation raster map|3|False
5+
ParameterMultipleInput|color|Name of raster map(s) for Color|-1|False
6+
ParameterMultipleInput|vector|Name of vector lines/areas overlay map(s)|-1|False
7+
ParameterMultipleInput|point|Name of vector points overlay file(s)|-1|False
8+
ParameterMultipleInput|volume|Name of existing 3d raster map|-1|False

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
r.average
22
r.average
33
Raster (r.*)
4-
ParameterRaster|base|base|False
5-
ParameterRaster|cover|cover|False
6-
ParameterBoolean|-c|-c|True
7-
OutputRaster|output|output
4+
ParameterRaster|base|Name of base raster map|False
5+
ParameterRaster|cover|Name of cover raster map|False
6+
ParameterBoolean|-c|Cover values extracted from the category labels of the cover map|False
7+
OutputRaster|output|Name for output raster map

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
r.basins.fill
22
r.basins.fill
33
Raster (r.*)
4-
ParameterNumber|number|number|None|None|0.0
5-
ParameterRaster|c_map|c_map|False
6-
ParameterRaster|t_map|t_map|False
7-
OutputRaster|result|result
4+
ParameterRaster|c_map|Name of input coded stream network raster map|False
5+
ParameterRaster|t_map|Name of input thinned ridge network raster map|False
6+
ParameterNumber|number|Number of passes through the dataset|None|None|0.0
7+
OutputRaster|result|Name for output raster map

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
r.bilinear
22
r.bilinear
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterNumber|north|north|None|None|0
6-
ParameterNumber|east|east|None|None|0
7-
OutputRaster|output|output
4+
ParameterRaster|input|Name of input raster map|False
5+
ParameterNumber|north|Specific input value to be assigned to the north and/or south poles for longitude-latitude grids|None|None|0
6+
ParameterNumber|east|Specific input value to be assigned to the north and/or south poles for longitude-latitude grids|None|None|0
7+
OutputRaster|output|Name for output raster map

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
r.bitpattern
22
r.bitpattern
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterString|pattern|pattern|
6-
ParameterString|patval|patval|
7-
OutputRaster|output|output
4+
ParameterRaster|input|Name of input raster map|False
5+
ParameterString|pattern|Bit pattern position(s)|
6+
ParameterString|patval|Bit pattern value|
7+
OutputRaster|output|Name for output raster map

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
r.buffer
22
r.buffer
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterString|distances|distances|100,200,300
6-
ParameterSelection|units|units|meters;kilometers;feet;miles;nautmiles
7-
ParameterBoolean|-z|-z|True
8-
ParameterBoolean|-q|-q|True
9-
OutputRaster|output|output
4+
ParameterRaster|input|Name of input raster map|False
5+
ParameterString|distances|Distance zone(s) (e.g. 100,200,300)|
6+
ParameterSelection|units|Units of distance|meters;kilometers;feet;miles;nautmiles
7+
ParameterBoolean|-z|Ignore zero (0) data cells instead of NULL cells|False
8+
OutputRaster|output|Name for output raster map

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
r.carve
22
r.carve
33
Raster (r.*)
4-
ParameterRaster|rast|rast|False
5-
ParameterVector|vect|vect|1|False
6-
ParameterNumber|width|width|None|None|1
7-
ParameterNumber|depth|depth|None|None|1
8-
ParameterBoolean|-n|-n|True
9-
ParameterBoolean|-q|-q|True
10-
OutputRaster|output|output
11-
OutputVector|points|points
4+
ParameterRaster|rast|Name of input raster elevation map|False
5+
ParameterVector|vect|Name of vector input map containing stream(s)|1|False
6+
ParameterNumber|width|Stream width (in meters). Default is raster cell width|None|None|1
7+
ParameterNumber|depth|Additional stream depth (in meters)|None|None|1
8+
ParameterBoolean|-n|No flat areas allowed in flow direction|False
9+
OutputRaster|output|Name for output raster map
10+
OutputVector|points|ame for output vector map for adjusted stream points

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
r.circle
22
r.circle
33
Raster (r.*)
4-
ParameterString|coordinate|coordinate|0,0
5-
ParameterNumber|min|min|None|None|10
6-
ParameterNumber|max|max|None|None|20
7-
ParameterString|mult|mult|1
8-
ParameterBoolean|-b|-b|True
9-
OutputRaster|output|output
4+
ParameterString|coordinate|The coordinate of the center (east,north)|0,0
5+
ParameterNumber|min|Minimum radius for ring/circle map (in meters)|None|None|10
6+
ParameterNumber|max|Maximum radius for ring/circle map (in meters)|None|None|20
7+
ParameterString|mult|Data value multiplier|1
8+
ParameterBoolean|-b|Generate binary raster map|False
9+
OutputRaster|output|Name for output raster map

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
r.clump
22
r.clump
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterString|title|title|
6-
ParameterBoolean|-q|-q|True
7-
OutputRaster|output|output
4+
ParameterRaster|input|Name of input raster map|False
5+
ParameterString|title|Title for output raster map|
6+
OutputRaster|output|Name for output raster map

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
r.coin
22
r.coin
33
Raster (r.*)
4-
ParameterRaster|map1|map1|False
5-
ParameterRaster|map2|map2|False
6-
ParameterSelection|units|units|c;p;x;y;a;h;k;m
7-
ParameterBoolean|-w|-w|True
4+
ParameterRaster|map1|Name of first raster map|False
5+
ParameterRaster|map2|Name of second raster map|False
6+
ParameterSelection|units|Unit of measure|c;p;x;y;a;h;k;m
7+
ParameterBoolean|-w|Wide report, 132 columns (default: 80)|False

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
r.colors
22
r.colors
33
Raster (r.*)
4-
ParameterRaster|map|map|False
5-
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
6-
ParameterString|rules|rules|/file
7-
ParameterBoolean|-l|-l|True
8-
ParameterBoolean|-n|-n|True
9-
ParameterBoolean|-g|-g|True
10-
ParameterBoolean|-a|-a|True
11-
ParameterBoolean|-e|-e|True
12-
ParameterBoolean|-q|-q|True
4+
ParameterRaster|map|Name of input raster map|False
5+
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
6+
ParameterString|rules|Path to rules file ("-" to read rules from stdin)|/file
7+
ParameterBoolean|-l|List available rules then exit|False
8+
ParameterBoolean|-n|Invert colors|False
9+
ParameterBoolean|-g|Logarithmic scaling|False
10+
ParameterBoolean|-a|Logarithmic-absolute scaling|False
11+
ParameterBoolean|-e|Histogram equalization|False

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

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
r.composite
22
r.composite
33
Raster (r.*)
4-
ParameterRaster|red|red|False
5-
ParameterRaster|green|green|False
6-
ParameterRaster|blue|blue|False
7-
ParameterNumber|levels|levels|1.0|256.0|32
8-
ParameterNumber|lev_red|lev_red|1.0|256.0|32
9-
ParameterNumber|lev_green|lev_green|1.0|256.0|32
10-
ParameterNumber|lev_blue|lev_blue|1.0|256.0|32
11-
ParameterString|lev_red|lev_red|
12-
ParameterString|lev_green|lev_green|
13-
ParameterString|lev_blue|lev_blue|
14-
ParameterBoolean|-d|-d|True
15-
ParameterBoolean|-c|-c|True
16-
OutputRaster|output|output
4+
ParameterRaster|red|Name of raster map to be used for <red>|False
5+
ParameterRaster|green|Name of raster map to be used for <green>|False
6+
ParameterRaster|blue|Name of raster map to be used for <blue>|False
7+
ParameterNumber|levels|Number of levels to be used for each component|1.0|256.0|32
8+
ParameterNumber|lev_red|Number of levels to be used for <red>|1.0|256.0|32
9+
ParameterNumber|lev_green|Number of levels to be used for <green>|1.0|256.0|32
10+
ParameterNumber|lev_blue|Number of levels to be used for <blue>|1.0|256.0|32
11+
ParameterBoolean|-d|Dither|False
12+
ParameterBoolean|-c|Use closest color|False
13+
OutputRaster|output|Name for output raster map

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
r.contour
22
r.contour
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterString|levels|levels|
6-
ParameterString|minlevel|minlevel|
7-
ParameterString|maxlevel|maxlevel|
8-
ParameterString|step|step|
9-
ParameterString|cut|cut|0
10-
ParameterBoolean|-q|-q|True
11-
ParameterBoolean|-n|-n|True
12-
OutputVector|output|output
4+
ParameterRaster|input|Name of input raster map|False
5+
ParameterString|levels|List of contour levels|
6+
ParameterString|minlevel|Minimum contour level|
7+
ParameterString|maxlevel|Maximum contour level|
8+
ParameterString|step|Increment between contour levels|
9+
ParameterString|cut|Minimum number of points for a contour line (0 -> no limit)|0
10+
ParameterBoolean|-n|Suppress single crossing error messages|False
11+
OutputVector|output|Name of output vector map

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
r.cost
22
r.cost
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterVector|start_points|start_points|0|False
6-
ParameterVector|stop_points|stop_points|0|False
7-
ParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|True
8-
ParameterBoolean|-n|-n|True
9-
OutputRaster|output|output
4+
ParameterRaster|input|Name of raster map containing grid cell cost information|False
5+
ParameterVector|start_points|Name of starting vector points map|0|False
6+
ParameterVector|stop_points|Name of stop vector points map|0|False
7+
ParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|False
8+
ParameterBoolean|-n|Keep null values in output raster map|False
9+
OutputRaster|output|Name for output raster map

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r.covar
22
r.covar
33
Raster (r.*)
4-
ParameterMultipleInput|map|map|3.0|False
5-
ParameterBoolean|-r|-r|True
4+
ParameterMultipleInput|map|Name of input raster map(s)|3.0|False
5+
ParameterBoolean|-r|Print correlation matrix|True

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
r.cross
22
r.cross
33
Raster (r.*)
4-
ParameterMultipleInput|input|input|3.0|False
5-
ParameterBoolean|-z|-z|True
6-
ParameterBoolean|-q|-q|True
7-
OutputRaster|output|output
4+
ParameterMultipleInput|input|Names of 2-30 input raster maps|3.0|False
5+
ParameterBoolean|-z|Non-zero data only|False
6+
OutputRaster|output|Name for output raster map

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
r.describe
22
r.describe
33
Raster (r.*)
4-
ParameterRaster|map|map|False
5-
ParameterString|nv|nv|*
6-
ParameterNumber|nsteps|nsteps|1.0|None|255
7-
ParameterBoolean|-1|-1|True
8-
ParameterBoolean|-r|-r|True
9-
ParameterBoolean|-n|-n|True
10-
ParameterBoolean|-d|-d|True
11-
ParameterBoolean|-i|-i|True
12-
ParameterBoolean|-q|-q|True
4+
ParameterRaster|map|Name of input raster map|False
5+
ParameterString|nv|String representing no data cell value|*
6+
ParameterNumber|nsteps|Number of quantization steps|1.0|None|255
7+
ParameterBoolean|-1|Print the output one value per line|False
8+
ParameterBoolean|-r|Only print the range of the data|False
9+
ParameterBoolean|-n|Suppress reporting of any NULLs|False
10+
ParameterBoolean|-d|Use the current region|False
11+
ParameterBoolean|-i|Read fp map as integer|False

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
r.distance
22
r.distance
33
Raster (r.*)
4-
ParameterRaster|maps|maps|False
5-
ParameterString|fs|fs|:
6-
ParameterBoolean|-l|-l|True
7-
ParameterBoolean|-o|-o|True
8-
ParameterBoolean|-q|-q|True
4+
ParameterRaster|maps|Maps for computing inter-class distances|False
5+
ParameterString|fs|Output field separator|:
6+
ParameterBoolean|-l|Include category labels in the output|False
7+
ParameterBoolean|-o|Report zero distance if rasters are overlapping|False

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
r.drain
22
r.drain
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterString|coordinate|coordinate(E,N)|
6-
ParameterMultipleInput|vector_points|vector_points|0.0|False
7-
ParameterBoolean|-c|-c|True
8-
ParameterBoolean|-a|-a|True
9-
ParameterBoolean|-n|-n|True
10-
OutputRaster|output|output
4+
ParameterRaster|input|Name of elevation raster map|False
5+
ParameterString|coordinate|Map coordinates of starting point(s) (E,N)|
6+
ParameterMultipleInput|vector_points|Name of vector map(s) containing starting point(s)|0.0|False
7+
ParameterBoolean|-c|Copy input cell values on output|False
8+
ParameterBoolean|-a|Accumulate input values along the path|False
9+
ParameterBoolean|-n|Count cell numbers along the path|False
10+
OutputRaster|output|Name for output raster map

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
r.fill.dir
22
r.fill.dir
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterString|type|type|grass
6-
ParameterBoolean|-f|-f|True
7-
OutputRaster|elevation|elevation
8-
OutputRaster|direction|direction
9-
OutputRaster|areas|areas
4+
ParameterRaster|input|Name of existing raster map containing elevation surface|False
5+
ParameterSelection|type|Output aspect direction format|grass;agnps;answers
6+
ParameterBoolean|-f|Find unresolved areas only|False
7+
OutputRaster|elevation|Output elevation raster map after filling
8+
OutputRaster|direction|Output direction raster map
9+
OutputRaster|areas|Output raster map of problem areas

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
r.fillnulls
22
r.fillnulls
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterNumber|tension|tension|None|None|40.0
6-
ParameterNumber|smooth|smooth|None|None|0.1
7-
OutputRaster|output|output
4+
ParameterRaster|input|Name of input raster map in which to fill nulls|False
5+
ParameterNumber|tension|Spline tension parameter|None|None|40.0
6+
ParameterNumber|smooth|Spline smoothing parameter|None|None|0.1
7+
OutputRaster|output|Name for output raster map with nulls filled by interpolation

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
r.flow
22
r.flow
33
Raster (r.*)
4-
ParameterRaster|elevin|elevin|False
5-
ParameterRaster|aspin|aspin|False
6-
ParameterRaster|barin|barin|False
7-
ParameterNumber|skip|skip|None|None|1.0
8-
ParameterNumber|bound|bound|None|None|5.0
9-
ParameterBoolean|-u|-u|True
10-
ParameterBoolean|-3|-3|True
11-
ParameterBoolean|-m|-m|True
12-
OutputRaster|lgout|lgout
13-
OutputRaster|dsout|dsout
4+
ParameterRaster|elevin|Input elevation raster map|False
5+
ParameterRaster|aspin|Input aspect raster map|False
6+
ParameterRaster|barin|Input barrier raster map|False
7+
ParameterNumber|skip|Number of cells between flowlines|None|None|1.0
8+
ParameterNumber|bound|Maximum number of segments per flowline|None|None|5.0
9+
ParameterBoolean|-u|Compute upslope flowlines instead of default downhill flowlines|False
10+
ParameterBoolean|-3|3-D lengths instead of 2-D|False
11+
ParameterBoolean|-m|Use less memory, at a performance penalty|False
12+
OutputRaster|flout|Output flowline vector map
13+
OutputRaster|lgout|Output flowpath length raster map
14+
OutputRaster|dsout|Output flowline density raster map

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
r.grow.distance
22
r.grow.distance
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterSelection|metric|metric|euclidean;squared;maximum;manhattan
6-
OutputRaster|distance|distance
7-
OutputRaster|value|value
4+
ParameterRaster|input|Name of input raster map|False
5+
ParameterSelection|metric|Metric|euclidean;squared;maximum;manhattan
6+
OutputRaster|distance|Name for distance output map
7+
OutputRaster|value|Name for value output map

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
r.grow
22
r.grow
33
Raster (r.*)
4-
ParameterRaster|input|input|False
5-
ParameterNumber|radius|radius|None|None|1.01
6-
ParameterSelection|metric|metric|euclidean;maximum;manhattan
7-
ParameterNumber|old|old|None|None|0
8-
ParameterNumber|new|new|None|None|1
9-
ParameterBoolean|-q|-q|True
10-
OutputRaster|output|output
4+
ParameterRaster|input|Name of input raster map|False
5+
ParameterNumber|radius|Radius of buffer in raster cells|None|None|1.01
6+
ParameterSelection|metric|Metric|euclidean;maximum;manhattan
7+
ParameterNumber|old|Value to write for input cells which are non-NULL (-1 => NULL)|None|None|0
8+
ParameterNumber|new|Value to write for "grown" cells|None|None|1
9+
OutputRaster|output|Name for output raster map

0 commit comments

Comments
 (0)