Skip to content
Permalink
Browse files
Merge pull request #5603 from medspx/ProcessingGrassFixDescR
[processing] GRASS7 provider: review and update all r.* description files.
  • Loading branch information
alexbruy committed Nov 15, 2017
2 parents c321700 + 662c2cf commit b95588cf58e0dab6957f34818ac1d2c1df485a1d
Show file tree
Hide file tree
Showing 82 changed files with 283 additions and 244 deletions.
@@ -3,5 +3,5 @@ Generates watershed subbasins raster map.
Raster (r.*)
QgsProcessingParameterRasterLayer|cnetwork|Input coded stream network raster layer|None|False
QgsProcessingParameterRasterLayer|tnetwork|Input thinned ridge network raster layer|None|False
QgsProcessingParameterNumber|number|Number of passes through the dataset|QgsProcessingParameterNumber.Double|1|False|None|None
QgsProcessingParameterNumber|number|Number of passes through the dataset|QgsProcessingParameterNumber.Integer|1|False|1|None
QgsProcessingParameterRasterDestination|output|Watersheds
@@ -1,9 +1,9 @@
r.circle
Creates a raster map containing concentric rings around a given point.
Raster (r.*)
QgsProcessingParameterPoint|coordinates|The coordinate of the center (east,north)|0,0
QgsProcessingParameterNumber|min|Minimum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|10|False|None|None
QgsProcessingParameterNumber|max|Maximum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|20|False|None|None
QgsProcessingParameterPoint|coordinates|The coordinate of the center (east,north)|0,0|False
QgsProcessingParameterNumber|min|Minimum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|10.0|False|None|None
QgsProcessingParameterNumber|max|Maximum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|20.0|False|None|None
QgsProcessingParameterNumber|multiplier|Data value multiplier|QgsProcessingParameterNumber.Double|1.0|False|None|None
QgsProcessingParameterBoolean|-b|Generate binary raster map|False
QgsProcessingParameterRasterDestination|output|Circles
@@ -2,6 +2,6 @@ r.clump
Recategorizes data in a raster map by grouping cells that form physically discrete areas into unique categories.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input layer|None|False
QgsProcessingParameterString|title|Title for output raster map|
QgsProcessingParameterString|title|Title for output raster map|None|True
*QgsProcessingParameterBoolean|-d|Clump also diagonal cells|False
QgsProcessingParameterRasterDestination|output|Clumps
@@ -2,6 +2,6 @@ r.contour
r.contour.level - Create vector contour from raster at specified levels
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input raster|None|False
QgsProcessingParameterString|levels|List of contour levels|
QgsProcessingParameterString|levels|List of contour levels|None|False
QgsProcessingParameterNumber|cut|Minimum number of points for a contour line (0 -> no limit)|QgsProcessingParameterNumber.Integer|0|True|0|None
QgsProcessingParameterVectorDestination|output|Contours
@@ -2,12 +2,12 @@ r.cost
r.cost.coordinates - Creates a raster layer of cumulative cost of moving across a raster layer whose cell values represent cost.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Unit cost layer|None|False
QgsProcessingParameterPoint|start_coordinates|Coordinates of starting point(s) (E,N)|0,0
QgsProcessingParameterPoint|stop_coordinates|Coordinates of stopping point(s) (E,N)|0,0
QgsProcessingParameterPoint|start_coordinates|Coordinates of starting point(s) (E,N)|0,0|False
QgsProcessingParameterPoint|stop_coordinates|Coordinates of stopping point(s) (E,N)|0,0|False
QgsProcessingParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|False
QgsProcessingParameterBoolean|-n|Keep null values in output raster layer|True
QgsProcessingParameterNumber|max_cost|Maximum cumulative cost|QgsProcessingParameterNumber.Double|0.0|False|None|None
QgsProcessingParameterNumber|null_cost|Cost assigned to null cells. By default, null cells are excluded|QgsProcessingParameterNumber.Double|0.0|False|None|None
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Double|300|False|None|0
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|False|1|None
QgsProcessingParameterRasterDestination|output|Cumulative cost
QgsProcessingParameterRasterDestination|nearest|Cost allocation map
@@ -8,6 +8,6 @@ QgsProcessingParameterBoolean|-k|Use the 'Knight's move'; slower, but more accur
QgsProcessingParameterBoolean|-n|Keep null values in output raster layer|True
QgsProcessingParameterNumber|max_cost|Maximum cumulative cost|QgsProcessingParameterNumber.Double|0.0|False|None|None
QgsProcessingParameterNumber|null_cost|Cost assigned to null cells. By default, null cells are excluded|QgsProcessingParameterNumber.Double|0.0|False|None|None
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Double|300|False|None|0
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|False|1|None
QgsProcessingParameterRasterDestination|output|Cumulative cost
QgsProcessingParameterRasterDestination|nearest|Cost allocation map
@@ -7,6 +7,6 @@ QgsProcessingParameterBoolean|-k|Use the 'Knight's move'; slower, but more accur
QgsProcessingParameterBoolean|-n|Keep null values in output raster layer|True
QgsProcessingParameterNumber|max_cost|Maximum cumulative cost|QgsProcessingParameterNumber.Double|0|False|None|0
QgsProcessingParameterNumber|null_cost|Cost assigned to null cells. By default, null cells are excluded|QgsProcessingParameterNumber.Double|0|False|None|None
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Double|300|False|None|0
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|False|1|None
QgsProcessingParameterRasterDestination|output|Cumulative cost
QgsProcessingParameterRasterDestination|nearest|Cost allocation map
@@ -2,8 +2,9 @@ r.describe
Prints terse list of category values found in a raster layer.
Raster (r.*)
QgsProcessingParameterRasterLayer|map|input raster layer|None|False
QgsProcessingParameterNumber|nv|No-data cell value|QgsProcessingParameterNumber.Double|0|False|None|None
QgsProcessingParameterNumber|nsteps|Number of quantization steps|QgsProcessingParameterNumber.Double|255|False|None|1.0
QgsProcessingParameterString|null_value|String representing NULL value|*|False|True
QgsProcessingParameterNumber|nsteps|Number of quantization steps|QgsProcessingParameterNumber.Integer|255|False|1|None
QgsProcessingParameterEnum|sort|Sort output by distance|asc;desc|False|0|True
QgsProcessingParameterBoolean|-r|Only print the range of the data|False
QgsProcessingParameterBoolean|-n|Suppress reporting of any NULLs|False
QgsProcessingParameterBoolean|-d|Use the current region|False
@@ -2,7 +2,8 @@ r.fill.dir
Filters and generates a depressionless elevation layer and a flow direction layer from a given elevation raster layer.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Elevation|None|False
QgsProcessingParameterEnum|format|Output aspect direction format|grass;agnps;answers
QgsProcessingParameterEnum|format|Output aspect direction format|grass;agnps;answers|False|0|True
*QgsProcessingParameterBoolean|-f|Find unresolved areas only|False
QgsProcessingParameterRasterDestination|output|Depressionless DEM
QgsProcessingParameterRasterDestination|direction|Flow direction
QgsProcessingParameterRasterDestination|areas|Problem areas
@@ -2,7 +2,7 @@ r.fillnulls
Fills no-data areas in raster maps using spline interpolation.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input raster layer to fill|None|False
QgsProcessingParameterEnum|method|Interpolation method to use|bilinear;bicubic;rst|False|2
QgsProcessingParameterEnum|method|Interpolation method to use|bilinear;bicubic;rst|False|2|False
QgsProcessingParameterNumber|tension|Spline tension parameter|QgsProcessingParameterNumber.Double|40.0|False|None|None
QgsProcessingParameterNumber|smooth|Spline smoothing parameter|QgsProcessingParameterNumber.Double|0.1|False|None|None
QgsProcessingParameterNumber|edge|Width of hole edge used for interpolation (in cells)|QgsProcessingParameterNumber.Integer|3|True|2|100

This file was deleted.

This file was deleted.

This file was deleted.

@@ -2,8 +2,10 @@ r.flow
Construction of flowlines, flowpath lengths, and flowaccumulation (contributing areas) from a raster digital elevation model (DEM).
Raster (r.*)
QgsProcessingParameterRasterLayer|elevation|Elevation|None|False
QgsProcessingParameterNumber|skip|Number of cells between flowlines|QgsProcessingParameterNumber.Double|7|False|None|None
QgsProcessingParameterNumber|bound|Maximum number of segments per flowline|QgsProcessingParameterNumber.Double|1609|False|None|None
QgsProcessingParameterRasterLayer|aspect|Aspect|None|True
QgsProcessingParameterRasterLayer|barrier|Barrier|None|True
QgsProcessingParameterNumber|skip|Number of cells between flowlines|QgsProcessingParameterNumber.Integer|7|False|None|None
QgsProcessingParameterNumber|bound|Maximum number of segments per flowline|QgsProcessingParameterNumber.Integer|1609|False|None|None
QgsProcessingParameterBoolean|-u|Compute upslope flowlines instead of default downhill flowlines|False
QgsProcessingParameterBoolean|-3|3-D lengths instead of 2-D|False
*QgsProcessingParameterBoolean|-m|Use less memory, at a performance penalty|False
@@ -2,6 +2,8 @@ r.grow.distance
Generates a raster layer of distance to features in input layer.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input input raster layer|None|False
QgsProcessingParameterEnum|metric|Metric|euclidean;squared;maximum;manhattan
QgsProcessingParameterEnum|metric|Metric|euclidean;squared;maximum;manhattan|False|0|True
*QgsProcessingParameterBoolean|-m|Output distances in meters instead of map units|False
*QgsProcessingParameterBoolean|-|Calculate distance to nearest NULL cell|False
QgsProcessingParameterRasterDestination|distance|Distance
QgsProcessingParameterRasterDestination|value|Value of nearest cell
@@ -3,7 +3,8 @@ Generates a raster layer with contiguous areas grown by one cell.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|input raster layer|None|False
QgsProcessingParameterNumber|radius|Radius of buffer in raster cells|QgsProcessingParameterNumber.Double|1.01|False|None|None
QgsProcessingParameterEnum|metric|Metric|euclidean;maximum;manhattan
QgsProcessingParameterNumber|old|Value to write for input cells which are non-NULL (-1 => NULL)|QgsProcessingParameterNumber.Double|0|False|None|None
QgsProcessingParameterNumber|new|Value to write for "grown" cells|QgsProcessingParameterNumber.Double|1|False|None|None
QgsProcessingParameterEnum|metric|Metric|euclidean;maximum;manhattan|False|0|True
QgsProcessingParameterNumber|old|Value to write for input cells which are non-NULL (-1 => NULL)|QgsProcessingParameterNumber.Integer|0|False|None|None
QgsProcessingParameterNumber|new|Value to write for "grown" cells|QgsProcessingParameterNumber.Integer|1|False|None|None
*QgsProcessingParameterBoolean|-m|Radius is in map units rather than cells|False
QgsProcessingParameterRasterDestination|output|Expanded
@@ -1,25 +1,28 @@
r.gwflow
Numerical calculation program for transient, confined and unconfined groundwater flow in two dimensions.
Raster (r.*)
QgsProcessingParameterString|phead|The initial piezometric head in [m]|
QgsProcessingParameterString|status|Boundary condition status, 0-inactive, 1-active, 2-dirichlet|
QgsProcessingParameterString|hc_x|X-part of the hydraulic conductivity tensor in [m/s]|
QgsProcessingParameterString|hc_y|Y-part of the hydraulic conductivity tensor in [m/s]|
QgsProcessingParameterString|q|Water sources and sinks in [m^3/s]|
QgsProcessingParameterString|s|Specific yield in [1/m]|
QgsProcessingParameterString|r|Recharge map e.g: 6*10^-9 per cell in [m^3/s*m^2]|
QgsProcessingParameterString|top|Top surface of the aquifer in [m]|
QgsProcessingParameterString|bottom|Bottom surface of the aquifer in [m]|
QgsProcessingParameterEnum|type|The type of groundwater flow|confined;unconfined
QgsProcessingParameterString|river_bed|The height of the river bed in [m]|
QgsProcessingParameterString|river_head|Water level (head) of the river with leakage connection in [m]|
QgsProcessingParameterString|river_leak|The leakage coefficient of the river bed in [1/s]|
QgsProcessingParameterString|drain_bed|The height of the drainage bed in [m]|
QgsProcessingParameterString|drain_leak|The leakage coefficient of the drainage bed in [1/s]|
QgsProcessingParameterNumber|dt|The calculation time in seconds|QgsProcessingParameterNumber.Double|86400.0|False|None|None
QgsProcessingParameterNumber|maxit|Maximum number of iteration used to solver the linear equation system|QgsProcessingParameterNumber.Double|100000.0|False|None|None
QgsProcessingParameterNumber|error|Error break criteria for iterative solvers (jacobi, sor, cg or bicgstab)|QgsProcessingParameterNumber.Double|1e-10|False|None|None
QgsProcessingParameterEnum|solver|The type of solver which should solve the symmetric linear equation system|gauss;lu;cholesky;jacobi;sor;cg;bicgstab;pcg
QgsProcessingParameterRasterLayer|phead|The initial piezometric head in [m]|None|False
QgsProcessingParameterRasterLayer|status|Boundary condition status, 0-inactive, 1-active, 2-dirichlet|None|False
QgsProcessingParameterRasterLayer|hc_x|X-part of the hydraulic conductivity tensor in [m/s]|None|False
QgsProcessingParameterRasterLayer|hc_y|Y-part of the hydraulic conductivity tensor in [m/s]|None|False
QgsProcessingParameterRasterLayer|q|Water sources and sinks in [m^3/s]|None|True
QgsProcessingParameterRasterLayer|s|Specific yield in [1/m]|None|False
QgsProcessingParameterRasterLayer|recharge|Recharge map e.g: 6*10^-9 per cell in [m^3/s*m^2]|None|True
QgsProcessingParameterRasterLayer|top|Top surface of the aquifer in [m]|None|False
QgsProcessingParameterRasterLayer|bottom|Bottom surface of the aquifer in [m]|None|False
QgsProcessingParameterEnum|type|The type of groundwater flow|confined;unconfined|False|0|False
QgsProcessingParameterRasterLayer|river_bed|The height of the river bed in [m]|None|True
QgsProcessingParameterRasterLayer|river_head|Water level (head) of the river with leakage connection in [m]|None|True
QgsProcessingParameterRasterLayer|river_leak|The leakage coefficient of the river bed in [1/s]|None|True
QgsProcessingParameterRasterLayer|drain_bed|The height of the drainage bed in [m]|None|True
QgsProcessingParameterRasterLayer|drain_leak|The leakage coefficient of the drainage bed in [1/s]|None|True
QgsProcessingParameterNumber|dtime|The calculation time in seconds|QgsProcessingParameterNumber.Double|86400.0|False|0.0|None
QgsProcessingParameterNumber|maxit|Maximum number of iteration used to solver the linear equation system|QgsProcessingParameterNumber.Integer|100000|True|1|None
QgsProcessingParameterNumber|error|Error break criteria for iterative solvers (jacobi, sor, cg or bicgstab)|QgsProcessingParameterNumber.Double|0.000001|True|None|None
QgsProcessingParameterEnum|solver|The type of solver which should solve the symmetric linear equation system|cg;pcg;cholesky|False|0|True
QgsProcessingParameterString|relax|The relaxation parameter used by the jacobi and sor solver for speedup or stabilizing|1
QgsProcessingParameterBoolean|-s|Use a sparse matrix, only available with iterative solvers|False
QgsProcessingParameterBoolean|-f|Allocate a full quadratic linear equation system, default is a sparse linear equation system|False
QgsProcessingParameterRasterDestination|output|Groundwater flow
QgsProcessingParameterRasterDestination|vx|Groundwater filter velocity vector part in x direction [m/s]
QgsProcessingParameterRasterDestination|vy|Groundwater filter velocity vector part in y direction [m/s]
QgsProcessingParameterRasterDestination|budget|Groundwater budget for each cell [m^3/s]
@@ -4,6 +4,7 @@ Raster (r.*)
QgsProcessingParameterRasterLayer|hue|Hue|None|False
QgsProcessingParameterRasterLayer|intensity|Intensity|None|False
QgsProcessingParameterRasterLayer|saturation|Saturation|None|False
QgsProcessingParameterString|bgcolor|Color to use instead of NULL values. Either a standard color name, R:G:B triplet, or "none"|'none'|False|True
QgsProcessingParameterBoolean|-c|Use colors from color tables for NULL values|False
QgsProcessingParameterRasterDestination|red|Red
QgsProcessingParameterRasterDestination|green|Green

0 comments on commit b95588c

Please sign in to comment.