Skip to content

Commit 6d4d291

Browse files
author
Médéric RIBREUX
committed
Review ParameterNumber for r.* description files
1 parent 507af21 commit 6d4d291

Some content is hidden

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

47 files changed

+102
-157
lines changed

‎python/plugins/processing/algs/grass7/description/r.carve.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Takes vector stream data, transforms it to raster and subtracts depth from the o
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|raster|Elevation|None|False
55
QgsProcessingParameterVectorLayer|vector|Vector layer containing stream(s)|1|None|False
6-
QgsProcessingParameterNumber|width|Stream width (in meters). Default is raster cell width|QgsProcessingParameterNumber.Double|1|False|None|None
7-
QgsProcessingParameterNumber|depth|Additional stream depth (in meters)|QgsProcessingParameterNumber.Double|1|False|None|None
6+
QgsProcessingParameterNumber|width|Stream width (in meters). Default is raster cell width|QgsProcessingParameterNumber.Double|None|True|None|None
7+
QgsProcessingParameterNumber|depth|Additional stream depth (in meters)|QgsProcessingParameterNumber.Double|None|True|None|None
88
QgsProcessingParameterBoolean|-n|No flat areas allowed in flow direction|False
99
QgsProcessingParameterRasterDestination|output|Modified elevation
1010
QgsProcessingParameterVectorDestination|points|Adjusted stream points

‎python/plugins/processing/algs/grass7/description/r.circle.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ r.circle
22
Creates a raster map containing concentric rings around a given point.
33
Raster (r.*)
44
QgsProcessingParameterPoint|coordinates|The coordinate of the center (east,north)|0,0|False
5-
QgsProcessingParameterNumber|min|Minimum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|10.0|False|None|None
6-
QgsProcessingParameterNumber|max|Maximum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|20.0|False|None|None
7-
QgsProcessingParameterNumber|multiplier|Data value multiplier|QgsProcessingParameterNumber.Double|1.0|False|None|None
5+
QgsProcessingParameterNumber|min|Minimum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|None|True|None|None
6+
QgsProcessingParameterNumber|max|Maximum radius for ring/circle map (in meters)|QgsProcessingParameterNumber.Double|None|True|None|None
7+
QgsProcessingParameterNumber|multiplier|Data value multiplier|QgsProcessingParameterNumber.Double|None|True|None|None
88
QgsProcessingParameterBoolean|-b|Generate binary raster map|False
99
QgsProcessingParameterRasterDestination|output|Circles

‎python/plugins/processing/algs/grass7/description/r.composite.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ Raster (r.*)
44
QgsProcessingParameterRasterLayer|red|Red|None|False
55
QgsProcessingParameterRasterLayer|green|Green|None|False
66
QgsProcessingParameterRasterLayer|blue|Blue|None|False
7-
QgsProcessingParameterNumber|level_red|Number of levels to be used for <red>|QgsProcessingParameterNumber.Double|32|False|256|1
8-
QgsProcessingParameterNumber|level_green|Number of levels to be used for <green>|QgsProcessingParameterNumber.Double|32|False|256|1
9-
QgsProcessingParameterNumber|level_blue|Number of levels to be used for <blue>|QgsProcessingParameterNumber.Double|32|False|256|1
7+
QgsProcessingParameterNumber|levels|Number of levels to be used for each component|QgsProcessingParameterNumber.Integer|32|True|1|256
8+
QgsProcessingParameterNumber|level_red|Number of levels to be used for <red>|QgsProcessingParameterNumber.Integer|None|True|1|256
9+
QgsProcessingParameterNumber|level_green|Number of levels to be used for <green>|QgsProcessingParameterNumber.Integer|None|True|1|256
10+
QgsProcessingParameterNumber|level_blue|Number of levels to be used for <blue>|QgsProcessingParameterNumber.Integer|None|True|1|256
1011
QgsProcessingParameterBoolean|-d|Dither|False
1112
QgsProcessingParameterBoolean|-c|Use closest color|False
1213
QgsProcessingParameterRasterDestination|output|Composite

‎python/plugins/processing/algs/grass7/description/r.contour.level.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎python/plugins/processing/algs/grass7/description/r.contour.step.txt renamed to ‎python/plugins/processing/algs/grass7/description/r.contour.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
r.contour
2-
r.contour.step - Create vector contours from raster at specified steps
2+
Produces a vector map of specified contours from a raster map.
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|input|Input raster|None|False
5-
QgsProcessingParameterNumber|minlevel|Minimum contour level|QgsProcessingParameterNumber.Double|0.0|True|None|None
6-
QgsProcessingParameterNumber|maxlevel|Maximum contour level|QgsProcessingParameterNumber.Double|0.0|True|None|None
7-
QgsProcessingParameterNumber|step|Increment between contour levels|QgsProcessingParameterNumber.Double|0.0|True|None|None
5+
QgsProcessingParameterNumber|step|Increment between contour levels|QgsProcessingParameterNumber.Double|None|True|None|None
6+
QgsProcessingParameterString|levels|List of contour levels|None|False
7+
QgsProcessingParameterNumber|minlevel|Minimum contour level|QgsProcessingParameterNumber.Double|None|True|None|None
8+
QgsProcessingParameterNumber|maxlevel|Maximum contour level|QgsProcessingParameterNumber.Double|None|True|None|None
89
QgsProcessingParameterNumber|cut|Minimum number of points for a contour line (0 -> no limit)|QgsProcessingParameterNumber.Integer|0|True|0|None
910
QgsProcessingParameterVectorDestination|output|Contours

‎python/plugins/processing/algs/grass7/description/r.cost.points.txt

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎python/plugins/processing/algs/grass7/description/r.cost.raster.txt

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎python/plugins/processing/algs/grass7/description/r.cost.coordinates.txt renamed to ‎python/plugins/processing/algs/grass7/description/r.cost.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
r.cost
2-
r.cost.coordinates - Creates a raster layer of cumulative cost of moving across a raster layer whose cell values represent cost.
2+
Creates a raster layer of cumulative cost of moving across a raster layer whose cell values represent cost.
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|input|Unit cost layer|None|False
55
QgsProcessingParameterPoint|start_coordinates|Coordinates of starting point(s) (E,N)|0,0|False
66
QgsProcessingParameterPoint|stop_coordinates|Coordinates of stopping point(s) (E,N)|0,0|False
77
QgsProcessingParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|False
88
QgsProcessingParameterBoolean|-n|Keep null values in output raster layer|True
9-
QgsProcessingParameterNumber|max_cost|Maximum cumulative cost|QgsProcessingParameterNumber.Double|0.0|False|None|None
10-
QgsProcessingParameterNumber|null_cost|Cost assigned to null cells. By default, null cells are excluded|QgsProcessingParameterNumber.Double|0.0|False|None|None
11-
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|False|1|None
9+
QgsProcessingParameterVectorLayer|start_points|Start points|0|None|True
10+
QgsProcessingParameterVectorLayer|stop_points|Stop points|0|None|True
11+
QgsProcessingParameterRasterLayer|start_raster|Name of starting raster points map|None|True
12+
QgsProcessingParameterNumber|max_cost|Maximum cumulative cost|QgsProcessingParameterNumber.Double|0.0|True|None|None
13+
QgsProcessingParameterNumber|null_cost|Cost assigned to null cells. By default, null cells are excluded|QgsProcessingParameterNumber.Double|None|True|None|None
14+
QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|True|1|None
1215
QgsProcessingParameterRasterDestination|output|Cumulative cost
1316
QgsProcessingParameterRasterDestination|nearest|Cost allocation map
17+
QgsProcessingParameterRasterDestination|outdir|Movement directions

‎python/plugins/processing/algs/grass7/description/r.describe.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Prints terse list of category values found in a raster layer.
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|map|input raster layer|None|False
55
QgsProcessingParameterString|null_value|String representing NULL value|*|False|True
6-
QgsProcessingParameterNumber|nsteps|Number of quantization steps|QgsProcessingParameterNumber.Integer|255|False|1|None
6+
QgsProcessingParameterNumber|nsteps|Number of quantization steps|QgsProcessingParameterNumber.Integer|255|True|1|None
77
QgsProcessingParameterEnum|sort|Sort output by distance|asc;desc|False|0|True
88
QgsProcessingParameterBoolean|-r|Only print the range of the data|False
99
QgsProcessingParameterBoolean|-n|Suppress reporting of any NULLs|False

‎python/plugins/processing/algs/grass7/description/r.fillnulls.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Fills no-data areas in raster maps using spline interpolation.
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|input|Input raster layer to fill|None|False
55
QgsProcessingParameterEnum|method|Interpolation method to use|bilinear;bicubic;rst|False|2|False
6-
QgsProcessingParameterNumber|tension|Spline tension parameter|QgsProcessingParameterNumber.Double|40.0|False|None|None
7-
QgsProcessingParameterNumber|smooth|Spline smoothing parameter|QgsProcessingParameterNumber.Double|0.1|False|None|None
6+
QgsProcessingParameterNumber|tension|Spline tension parameter|QgsProcessingParameterNumber.Double|40.0|True|None|None
7+
QgsProcessingParameterNumber|smooth|Spline smoothing parameter|QgsProcessingParameterNumber.Double|0.1|True|None|None
88
QgsProcessingParameterNumber|edge|Width of hole edge used for interpolation (in cells)|QgsProcessingParameterNumber.Integer|3|True|2|100
99
QgsProcessingParameterNumber|npmin|Minimum number of points for approximation in a segment (>segmax)|QgsProcessingParameterNumber.Integer|600|True|2|10000
1010
QgsProcessingParameterNumber|segmax|Maximum number of points in a segment|QgsProcessingParameterNumber.Integer|300|True|2|10000

‎python/plugins/processing/algs/grass7/description/r.flow.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Raster (r.*)
44
QgsProcessingParameterRasterLayer|elevation|Elevation|None|False
55
QgsProcessingParameterRasterLayer|aspect|Aspect|None|True
66
QgsProcessingParameterRasterLayer|barrier|Barrier|None|True
7-
QgsProcessingParameterNumber|skip|Number of cells between flowlines|QgsProcessingParameterNumber.Integer|7|False|None|None
8-
QgsProcessingParameterNumber|bound|Maximum number of segments per flowline|QgsProcessingParameterNumber.Integer|1609|False|None|None
7+
QgsProcessingParameterNumber|skip|Number of cells between flowlines|QgsProcessingParameterNumber.Integer|None|True|None|None
8+
QgsProcessingParameterNumber|bound|Maximum number of segments per flowline|QgsProcessingParameterNumber.Integer|None|True|None|None
99
QgsProcessingParameterBoolean|-u|Compute upslope flowlines instead of default downhill flowlines|False
1010
QgsProcessingParameterBoolean|-3|3-D lengths instead of 2-D|False
1111
*QgsProcessingParameterBoolean|-m|Use less memory, at a performance penalty|False

‎python/plugins/processing/algs/grass7/description/r.grow.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ r.grow
22
Generates a raster layer with contiguous areas grown by one cell.
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|input|input raster layer|None|False
5-
QgsProcessingParameterNumber|radius|Radius of buffer in raster cells|QgsProcessingParameterNumber.Double|1.01|False|None|None
5+
QgsProcessingParameterNumber|radius|Radius of buffer in raster cells|QgsProcessingParameterNumber.Double|1.01|True|None|None
66
QgsProcessingParameterEnum|metric|Metric|euclidean;maximum;manhattan|False|0|True
7-
QgsProcessingParameterNumber|old|Value to write for input cells which are non-NULL (-1 => NULL)|QgsProcessingParameterNumber.Integer|0|False|None|None
8-
QgsProcessingParameterNumber|new|Value to write for "grown" cells|QgsProcessingParameterNumber.Integer|1|False|None|None
7+
QgsProcessingParameterNumber|old|Value to write for input cells which are non-NULL (-1 => NULL)|QgsProcessingParameterNumber.Integer|None|True|None|None
8+
QgsProcessingParameterNumber|new|Value to write for "grown" cells|QgsProcessingParameterNumber.Integer|None|True|None|None
99
*QgsProcessingParameterBoolean|-m|Radius is in map units rather than cells|False
1010
QgsProcessingParameterRasterDestination|output|Expanded

‎python/plugins/processing/algs/grass7/description/r.horizon.height.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ r.horizon.height - Horizon angle computation from a digital elevation model.
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|elevation|Name of input elevation raster map|None|False
55
QgsProcessingParameterPoint|coordinates|Coordinate for which you want to calculate the horizon|0,0
6-
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
6+
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
77
QgsProcessingParameterNumber|step|Angle step size for multidirectional horizon|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
88
QgsProcessingParameterNumber|start|Start angle for multidirectional horizon|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
99
QgsProcessingParameterNumber|end|End angle for multidirectional horizon|QgsProcessingParameterNumber.Double|360.0|True|0.0|360.0
10-
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
11-
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
12-
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
13-
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
14-
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
10+
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
11+
QgsProcessingParameterNumber|e_buff|For horizon rasters, read from the DEM an extra buffer eastward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
12+
QgsProcessingParameterNumber|w_buff|For horizon rasters, read from the DEM an extra buffer westward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
13+
QgsProcessingParameterNumber|n_buff|For horizon rasters, read from the DEM an extra buffer northward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
14+
QgsProcessingParameterNumber|s_buff|For horizon rasters, read from the DEM an extra buffer southward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
1515
QgsProcessingParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|None
1616
QgsProcessingParameterNumber|distance|Sampling distance step coefficient|QgsProcessingParameterNumber.Double|1.0|True|0.5|1.5
1717
QgsProcessingParameterBoolean|-d|Write output in degrees (default is radians)|False

‎python/plugins/processing/algs/grass7/description/r.horizon.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ r.horizon
22
Horizon angle computation from a digital elevation model.
33
Raster (r.*)
44
QgsProcessingParameterRasterLayer|elevation|Name of input elevation raster map|None|False
5-
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
5+
QgsProcessingParameterNumber|direction|Direction in which you want to know the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
66
QgsProcessingParameterNumber|step|Angle step size for multidirectional horizon|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
77
QgsProcessingParameterNumber|start|Start angle for multidirectional horizon|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
88
QgsProcessingParameterNumber|end|End angle for multidirectional horizon|QgsProcessingParameterNumber.Double|360.0|True|0.0|360.0
9-
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
10-
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
11-
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
12-
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
13-
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
9+
QgsProcessingParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
10+
QgsProcessingParameterNumber|e_buff|For horizon rasters, read from the DEM an extra buffer eastward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
11+
QgsProcessingParameterNumber|w_buff|For horizon rasters, read from the DEM an extra buffer westward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
12+
QgsProcessingParameterNumber|n_buff|For horizon rasters, read from the DEM an extra buffer northward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
13+
QgsProcessingParameterNumber|s_buff|For horizon rasters, read from the DEM an extra buffer southward the present region|QgsProcessingParameterNumber.Double|None|True|0.0|None
1414
QgsProcessingParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|QgsProcessingParameterNumber.Double|None|True|0.0|None
1515
QgsProcessingParameterNumber|distance|Sampling distance step coefficient|QgsProcessingParameterNumber.Double|1.0|True|0.5|1.5
1616
QgsProcessingParameterBoolean|-d|Write output in degrees (default is radians)|False

‎python/plugins/processing/algs/grass7/description/r.lake.coords.txt

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)