Skip to content

Commit

Permalink
Review ParameterNumber for r.* description files
Browse files Browse the repository at this point in the history
  • Loading branch information
Médéric RIBREUX committed Dec 16, 2017
1 parent 507af21 commit 6d4d291
Show file tree
Hide file tree
Showing 47 changed files with 102 additions and 157 deletions.
4 changes: 2 additions & 2 deletions python/plugins/processing/algs/grass7/description/r.carve.txt
View file
Expand Up @@ -3,8 +3,8 @@ Takes vector stream data, transforms it to raster and subtracts depth from the o
Raster (r.*)
QgsProcessingParameterRasterLayer|raster|Elevation|None|False
QgsProcessingParameterVectorLayer|vector|Vector layer containing stream(s)|1|None|False
QgsProcessingParameterNumber|width|Stream width (in meters). Default is raster cell width|QgsProcessingParameterNumber.Double|1|False|None|None
QgsProcessingParameterNumber|depth|Additional stream depth (in meters)|QgsProcessingParameterNumber.Double|1|False|None|None
QgsProcessingParameterNumber|width|Stream width (in meters). Default is raster cell width|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|depth|Additional stream depth (in meters)|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterBoolean|-n|No flat areas allowed in flow direction|False
QgsProcessingParameterRasterDestination|output|Modified elevation
QgsProcessingParameterVectorDestination|points|Adjusted stream points
6 changes: 3 additions & 3 deletions python/plugins/processing/algs/grass7/description/r.circle.txt
View file
Expand Up @@ -2,8 +2,8 @@ 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|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
QgsProcessingParameterNumber|min|Minimum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|max|Maximum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|multiplier|Data value multiplier|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterBoolean|-b|Generate binary raster map|False
QgsProcessingParameterRasterDestination|output|Circles
7 changes: 4 additions & 3 deletions python/plugins/processing/algs/grass7/description/r.composite.txt
View file
Expand Up @@ -4,9 +4,10 @@ Raster (r.*)
QgsProcessingParameterRasterLayer|red|Red|None|False
QgsProcessingParameterRasterLayer|green|Green|None|False
QgsProcessingParameterRasterLayer|blue|Blue|None|False
QgsProcessingParameterNumber|level_red|Number of levels to be used for <red>|QgsProcessingParameterNumber.Double|32|False|256|1
QgsProcessingParameterNumber|level_green|Number of levels to be used for <green>|QgsProcessingParameterNumber.Double|32|False|256|1
QgsProcessingParameterNumber|level_blue|Number of levels to be used for <blue>|QgsProcessingParameterNumber.Double|32|False|256|1
QgsProcessingParameterNumber|levels|Number of levels to be used for each component|QgsProcessingParameterNumber.Integer|32|True|1|256
QgsProcessingParameterNumber|level_red|Number of levels to be used for <red>|QgsProcessingParameterNumber.Integer|None|True|1|256
QgsProcessingParameterNumber|level_green|Number of levels to be used for <green>|QgsProcessingParameterNumber.Integer|None|True|1|256
QgsProcessingParameterNumber|level_blue|Number of levels to be used for <blue>|QgsProcessingParameterNumber.Integer|None|True|1|256
QgsProcessingParameterBoolean|-d|Dither|False
QgsProcessingParameterBoolean|-c|Use closest color|False
QgsProcessingParameterRasterDestination|output|Composite
7 changes: 0 additions & 7 deletions python/plugins/processing/algs/grass7/description/r.contour.level.txt
View file

This file was deleted.

9 changes: 5 additions & 4 deletions ...lgs/grass7/description/r.contour.step.txt → ...ing/algs/grass7/description/r.contour.txt
View file
@@ -1,9 +1,10 @@
r.contour
r.contour.step - Create vector contours from raster at specified steps
Produces a vector map of specified contours from a raster map.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input raster|None|False
QgsProcessingParameterNumber|minlevel|Minimum contour level|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|maxlevel|Maximum contour level|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|step|Increment between contour levels|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|step|Increment between contour levels|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterString|levels|List of contour levels|None|False
QgsProcessingParameterNumber|minlevel|Minimum contour level|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|maxlevel|Maximum contour level|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|cut|Minimum number of points for a contour line (0 -> no limit)|QgsProcessingParameterNumber.Integer|0|True|0|None
QgsProcessingParameterVectorDestination|output|Contours
13 changes: 0 additions & 13 deletions python/plugins/processing/algs/grass7/description/r.cost.points.txt
View file

This file was deleted.

12 changes: 0 additions & 12 deletions python/plugins/processing/algs/grass7/description/r.cost.raster.txt
View file

This file was deleted.

12 changes: 8 additions & 4 deletions ...grass7/description/r.cost.coordinates.txt → ...essing/algs/grass7/description/r.cost.txt
View file
@@ -1,13 +1,17 @@
r.cost
r.cost.coordinates - Creates a raster layer of cumulative cost of moving across a raster layer whose cell values represent cost.
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|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.Integer|300|False|1|None
QgsProcessingParameterVectorLayer|start_points|Start points|0|None|True
QgsProcessingParameterVectorLayer|stop_points|Stop points|0|None|True
QgsProcessingParameterRasterLayer|start_raster|Name of starting raster points map|None|True
QgsProcessingParameterNumber|max_cost|Maximum cumulative cost|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|null_cost|Cost assigned to null cells. By default, null cells are excluded|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|True|1|None
QgsProcessingParameterRasterDestination|output|Cumulative cost
QgsProcessingParameterRasterDestination|nearest|Cost allocation map
QgsProcessingParameterRasterDestination|outdir|Movement directions
2 changes: 1 addition & 1 deletion python/plugins/processing/algs/grass7/description/r.describe.txt
View file
Expand Up @@ -3,7 +3,7 @@ Prints terse list of category values found in a raster layer.
Raster (r.*)
QgsProcessingParameterRasterLayer|map|input raster layer|None|False
QgsProcessingParameterString|null_value|String representing NULL value|*|False|True
QgsProcessingParameterNumber|nsteps|Number of quantization steps|QgsProcessingParameterNumber.Integer|255|False|1|None
QgsProcessingParameterNumber|nsteps|Number of quantization steps|QgsProcessingParameterNumber.Integer|255|True|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
Expand Down
4 changes: 2 additions & 2 deletions python/plugins/processing/algs/grass7/description/r.fillnulls.txt
View file
Expand Up @@ -3,8 +3,8 @@ 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|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|tension|Spline tension parameter|QgsProcessingParameterNumber.Double|40.0|True|None|None
QgsProcessingParameterNumber|smooth|Spline smoothing parameter|QgsProcessingParameterNumber.Double|0.1|True|None|None
QgsProcessingParameterNumber|edge|Width of hole edge used for interpolation (in cells)|QgsProcessingParameterNumber.Integer|3|True|2|100
QgsProcessingParameterNumber|npmin|Minimum number of points for approximation in a segment (>segmax)|QgsProcessingParameterNumber.Integer|600|True|2|10000
QgsProcessingParameterNumber|segmax|Maximum number of points in a segment|QgsProcessingParameterNumber.Integer|300|True|2|10000
Expand Down
4 changes: 2 additions & 2 deletions python/plugins/processing/algs/grass7/description/r.flow.txt
View file
Expand Up @@ -4,8 +4,8 @@ Raster (r.*)
QgsProcessingParameterRasterLayer|elevation|Elevation|None|False
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
QgsProcessingParameterNumber|skip|Number of cells between flowlines|QgsProcessingParameterNumber.Integer|None|True|None|None
QgsProcessingParameterNumber|bound|Maximum number of segments per flowline|QgsProcessingParameterNumber.Integer|None|True|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
Expand Down
6 changes: 3 additions & 3 deletions python/plugins/processing/algs/grass7/description/r.grow.txt
View file
Expand Up @@ -2,9 +2,9 @@ r.grow
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
QgsProcessingParameterNumber|radius|Radius of buffer in raster cells|QgsProcessingParameterNumber.Double|1.01|True|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
QgsProcessingParameterNumber|old|Value to write for input cells which are non-NULL (-1 => NULL)|QgsProcessingParameterNumber.Integer|None|True|None|None
QgsProcessingParameterNumber|new|Value to write for "grown" cells|QgsProcessingParameterNumber.Integer|None|True|None|None
*QgsProcessingParameterBoolean|-m|Radius is in map units rather than cells|False
QgsProcessingParameterRasterDestination|output|Expanded
12 changes: 6 additions & 6 deletions python/plugins/processing/algs/grass7/description/r.horizon.height.txt
View file
Expand Up @@ -3,15 +3,15 @@ r.horizon.height - Horizon angle computation from a digital elevation model.
Raster (r.*)
QgsProcessingParameterRasterLayer|elevation|Name of input elevation raster map|None|False
QgsProcessingParameterPoint|coordinates|Coordinate for which you want to calculate the horizon|0,0
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
QgsProcessingParameterNumber|step|Angle step size for multidirectional horizon|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
QgsProcessingParameterNumber|start|Start angle for multidirectional horizon|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
QgsProcessingParameterNumber|end|End angle for multidirectional horizon|QgsProcessingParameterNumber.Double|360.0|True|0.0|360.0
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|e_buff|For horizon rasters, read from the DEM an extra buffer eastward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|w_buff|For horizon rasters, read from the DEM an extra buffer westward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|n_buff|For horizon rasters, read from the DEM an extra buffer northward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|s_buff|For horizon rasters, read from the DEM an extra buffer southward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|e_buff|For horizon rasters, read from the DEM an extra buffer eastward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|w_buff|For horizon rasters, read from the DEM an extra buffer westward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|n_buff|For horizon rasters, read from the DEM an extra buffer northward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|s_buff|For horizon rasters, read from the DEM an extra buffer southward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|distance|Sampling distance step coefficient|QgsProcessingParameterNumber.Double|1.0|True|0.5|1.5
QgsProcessingParameterBoolean|-d|Write output in degrees (default is radians)|False
Expand Down
12 changes: 6 additions & 6 deletions python/plugins/processing/algs/grass7/description/r.horizon.txt
View file
Expand Up @@ -2,15 +2,15 @@ r.horizon
Horizon angle computation from a digital elevation model.
Raster (r.*)
QgsProcessingParameterRasterLayer|elevation|Name of input elevation raster map|None|False
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
QgsProcessingParameterNumber|step|Angle step size for multidirectional horizon|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
QgsProcessingParameterNumber|start|Start angle for multidirectional horizon|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
QgsProcessingParameterNumber|end|End angle for multidirectional horizon|QgsProcessingParameterNumber.Double|360.0|True|0.0|360.0
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|e_buff|For horizon rasters, read from the DEM an extra buffer eastward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|w_buff|For horizon rasters, read from the DEM an extra buffer westward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|n_buff|For horizon rasters, read from the DEM an extra buffer northward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|s_buff|For horizon rasters, read from the DEM an extra buffer southward the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|e_buff|For horizon rasters, read from the DEM an extra buffer eastward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|w_buff|For horizon rasters, read from the DEM an extra buffer westward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|n_buff|For horizon rasters, read from the DEM an extra buffer northward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|s_buff|For horizon rasters, read from the DEM an extra buffer southward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|distance|Sampling distance step coefficient|QgsProcessingParameterNumber.Double|1.0|True|0.5|1.5
QgsProcessingParameterBoolean|-d|Write output in degrees (default is radians)|False
Expand Down
8 changes: 0 additions & 8 deletions python/plugins/processing/algs/grass7/description/r.lake.coords.txt
View file

This file was deleted.

0 comments on commit 6d4d291

Please sign in to comment.