Skip to content

Commit

Permalink
Finish fixing description files (no more errors on startup)
Browse files Browse the repository at this point in the history
  • Loading branch information
Médéric Ribreux committed Nov 4, 2017
1 parent 7369c4d commit 9eff16f
Show file tree
Hide file tree
Showing 25 changed files with 46 additions and 57 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ i.topo.corr
i.topo.coor.ill - Creates illumination model for topographic correction of reflectance.
Imagery (i.*)
QgsProcessingParameterRasterLayer|basemap|Name of elevation raster map|None|False
QgsProcessingParameterNumber|zenith|Solar zenith in degrees|QgsProcessingParameterNumber.Double|0.0|False|False|0.0|360.0
QgsProcessingParameterNumber|zenith|Solar zenith in degrees|QgsProcessingParameterNumber.Double|0.0|False|0.0|360.0
QgsProcessingParameterNumber|azimuth|Solar azimuth in degrees|QgsProcessingParameterNumber.Double|0.0|False|0.0|360.0
Hardcoded|-i
QgsProcessingParameterRasterDestination|output|Illumination Model
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Creates a raster map layer showing buffer zones surrounding cells that contain n
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input raster layer|None|False
QgsProcessingParameterString|distances|Distance zone(s) (e.g. 100,200,300)|None|False|False
QgsProcessingParameterEnum|units|Units of distance|meters;kilometers;feet;miles;nautmiles|False|False
QgsProcessingParameterEnum|units|Units of distance|meters;kilometers;feet;miles;nautmiles|False|0|False
QgsProcessingParameterBoolean|-z|Ignore zero (0) data cells instead of NULL cells|False
QgsProcessingParameterRasterDestination|output|Buffer
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Creates a raster map layer showing buffer zones surrounding cells that contain n
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input raster layer|None|False
QgsProcessingParameterString|distances|Distance zone(s) (e.g. 100,200,300)|None|False|False
QgsProcessingParameterEnum|units|Units of distance|meters;kilometers;feet;miles;nautmiles|False|False
QgsProcessingParameterEnum|units|Units of distance|meters;kilometers;feet;miles;nautmiles|False|0|False
QgsProcessingParameterBoolean|-z|Ignore zero (0) data cells instead of NULL cells|False
QgsProcessingParameterRasterDestination|output|Buffer
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r.covar
Outputs a covariance/correlation matrix for user-specified raster layer(s).
Raster (r.*)
QgsProcessingParameterMultipleLayers|map|Input layers|3.0|None|False
QgsProcessingParameterMultipleLayers|map|Input layers|3|None|False
QgsProcessingParameterBoolean|-r|Print correlation matrix|True
OutputHTML|html|Covariance report
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r.cross
Creates a cross product of the category values from multiple raster map layers.
Raster (r.*)
QgsProcessingParameterMultipleLayers|input|Input raster layers|3.0|None|False
QgsProcessingParameterMultipleLayers|input|Input raster layers|3|None|False
QgsProcessingParameterBoolean|-z|Non-zero data only|False
QgsProcessingParameterRasterDestination|output|Cross product
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
r.mask
r.mask.vect - Creates a MASK for limiting raster operation with a vector layer.
Raster (r.*)
QgsProcessingParameterVectorLayer|vector|Name of vector map to use as mask|1,2|None|False
QgsProcessingParameterVectorLayer|vector|Name of vector map to use as mask|1;2|None|False
QgsProcessingParameterRasterLayer|input|Name of raster map to which apply the mask|None|False
*QgsProcessingParameterString|cats|Category values. Example: 1,3,7-9,13|None|False|True
*QgsProcessingParameterString|where|WHERE conditions of SQL statement without 'where' keyword|None|True|True
Expand Down
8 changes: 4 additions & 4 deletions python/plugins/processing/algs/grass7/description/r.quant.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
r.quant
Produces the quantization file for a floating-point map.
Raster (r.*)
QgsProcessingParameterMultipleLayers|input|Raster layer(s) to be quantized|1.0|None|False
QgsProcessingParameterMultipleLayers|input|Raster layer(s) to be quantized|1|None|False
QgsProcessingParameterRasterLayer|basemap|Base layer to take quant rules from|None|False
QgsProcessingParameterRange|fprange|Floating point range: dmin,dmax|0,1
QgsProcessingParameterRange|range|Integer range: min,max|1,255
QgsProcessingParameterRange|fprange|Floating point range: dmin,dmax|QgsProcessingParameterNumber.Double|None|True
QgsProcessingParameterRange|range|Integer range: min,max|QgsProcessingParameterNumber.Integer|None|True
QgsProcessingParameterBoolean|-t|Truncate floating point data|False
QgsProcessingParameterBoolean|-r|Round floating point data|False
QgsProcessingParameterBoolean|-r|Round floating point data|False
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
r.report
Reports statistics for raster layers.
Raster (r.*)
QgsProcessingParameterMultipleLayers|map|Raster layer(s) to report on|3.0|None|False
QgsProcessingParameterEnum|units|Units|mi;me;k;a;h;c;p
QgsProcessingParameterString|null_value|Character representing no data cell value|*
QgsProcessingParameterNumber|nsteps|Number of fp subranges to collect stats from|QgsProcessingParameterNumber.Double|255|False|None|1
QgsProcessingParameterMultipleLayers|map|Raster layer(s) to report on|3|None|False
QgsProcessingParameterEnum|units|Units|mi;me;k;a;h;c;p|False|1|True
QgsProcessingParameterString|null_value|Character representing no data cell value|*|True
QgsProcessingParameterNumber|nsteps|Number of fp subranges to collect stats from|QgsProcessingParameterNumber.Double|255|True|1|None
QgsProcessingParameterBoolean|-h|Suppress page headers|True
QgsProcessingParameterBoolean|-f|Use formfeeds between pages|True
QgsProcessingParameterBoolean|-e|Scientific format|True
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Performs bilinear or bicubic spline interpolation with Tykhonov regularization.
Raster (r.*)
QgsProcessingParameterRasterLayer|input|Input raster layer|None|False
QgsProcessingParameterRasterLayer|mask|Name of raster map to use for masking. Only cells that are not NULL and not zero are interpolated|None|True
QgsProcessingParameterEnum|method|Sampling interpolation method|bilinear;bicubic|1|False|False
QgsProcessingParameterEnum|method|Sampling interpolation method|bilinear;bicubic|False|1|False
QgsProcessingParameterNumber|ew_step|Length (float) of each spline step in the east-west direction|QgsProcessingParameterNumber.Double|1.0|True|0.0|None
QgsProcessingParameterNumber|ns_step|Length (float) of each spline step in the north-south direction|QgsProcessingParameterNumber.Double|1.0|True|0.0|None
QgsProcessingParameterNumber|lambda|Tykhonov regularization parameter (affects smoothing)|QgsProcessingParameterNumber.Double|0.01|True|0.0|None
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
r.series.accumulate
Makes each output cell value an accumulation function of the values assigned to the corresponding cells in the input raster map layers.
Raster (r.*)
QgsProcessingParameterMultipleLayers|input|Input raster layer(s)|3.0|None|False
QgsProcessingParameterEnum|method|This method will be applied to compute the accumulative values from the input maps|gdd;bedd;huglin;mean|False|0
QgsProcessingParameterMultipleLayers|input|Input raster layer(s)|3|None|False
QgsProcessingParameterEnum|method|This method will be applied to compute the accumulative values from the input maps|gdd;bedd;huglin;mean|False|0|False
QgsProcessingParameterNumber|scale|Scale factor for input|QgsProcessingParameterNumber.Double|1.0|True|0.0|None
QgsProcessingParameterNumber|shift|Shift factor for input|QgsProcessingParameterNumber.Double|0.0|True|0.0|None
QgsProcessingParameterRange|range|Ignore values outside this range (min,max)|QgsProcessingParameterNumber.Double|None|True
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
r.series.interp
Interpolates raster maps located (temporal or spatial) in between input raster maps at specific sampling positions.
Raster (r.*)
QgsProcessingParameterMultipleLayers|input|Input raster layer(s)|3.0|None|False
QgsProcessingParameterMultipleLayers|input|Input raster layer(s)|3|None|False
QgsProcessingParameterString|datapos|Data point position for each input map|None|True|True
QgsProcessingParameterFile|infile|Input file with one input raster map name and data point position per line, field separator between name and sample point is '|'|True
QgsProcessingParameterString|output|Name for output raster map (comma separated list if multiple|None|False|True
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
r.series
Makes each output cell value a function of the values assigned to the corresponding cells in the input raster layers.
Raster (r.*)
QgsProcessingParameterMultipleLayers|input|Input raster layer(s)|3.0|None|False
QgsProcessingParameterMultipleLayers|input|Input raster layer(s)|3|None|False
QgsProcessingParameterBoolean|-n|Propagate NULLs|False
QgsProcessingParameterEnum|method|Aggregate operation|average;count;median;mode;minimum;min_raster;maximum;max_raster;stddev;range;sum;variance;diversity;slope;offset;detcoeff;quart1;quart3;perc90;skewness;kurtosis
*QgsProcessingParameterString|range|Ignore values outside this range (lo,hi)|-10000000000,10000000000
*QgsProcessingParameterRange|range|Ignore values outside this range (lo,hi)|QgsProcessingParameterNumber.Double|None|True
QgsProcessingParameterRasterDestination|output|Aggregated
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Drapes a color raster over an shaded relief or aspect map.
Raster (r.*)
QgsProcessingParameterRasterLayer|shade|Name of shaded relief or aspect raster map|None|False
QgsProcessingParameterRasterLayer|color|Name of raster to drape over relief raster map|None|False
QgsProcessingParameterNumber|brighten|Percent to brighten|-99|QgsProcessingParameterNumber.Double|True|False|0|99
QgsProcessingParameterNumber|brighten|Percent to brighten|QgsProcessingParameterNumber.Double|0.0|True|-100.0|100.0
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|output|Shaded
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
r.stats
Generates area statistics for raster layers.
Raster (r.*)
QgsProcessingParameterMultipleLayers|input|Name of input raster map|3.0|None|False
QgsProcessingParameterMultipleLayers|input|Name of input raster map|3|None|False
QgsProcessingParameterString|separator|Output field separator|space
QgsProcessingParameterString|nv|String representing no data cell value|*
QgsProcessingParameterString|nsteps|Number of fp subranges to collect stats from|255
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Raster (r.*)
QgsProcessingParameterNumber|year|Year|QgsProcessingParameterNumber.Integer|2017|False|1950|None
QgsProcessingParameterNumber|month|Month|QgsProcessingParameterNumber.Integer|1|True|1|12
QgsProcessingParameterNumber|day|Day|QgsProcessingParameterNumber.Integer|1|False|1|31
QgsProcessingParameterNumber|hour|Hour|0|QgsProcessingParameterNumber.Integer|12|True|1|24
QgsProcessingParameterNumber|hour|Hour|QgsProcessingParameterNumber.Integer|12|True|1|24
QgsProcessingParameterNumber|minute|Minutes|QgsProcessingParameterNumber.Integer|0|True|0|60
QgsProcessingParameterNumber|second|Seconds|QgsProcessingParameterNumber.Integer|0|True|0|60
QgsProcessingParameterString|percentile|Percentile to calculate (comma separated list if multiple) (requires extended statistics flag)|None|False|True
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ QgsProcessingParameterNumber|lambda|Lambda coefficients for combining walking en
QgsProcessingParameterNumber|slope_factor|Slope factor determines travel energy cost per height step|QgsProcessingParameterNumber.Double|-0.2125|True|None|None
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|False|1|None
*QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|True|1|None
*QgsProcessingParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|False
*QgsProcessingParameterBoolean|-n|Keep null values in output raster layer|False
QgsProcessingParameterRasterDestination|output|Cumulative cost
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ QgsProcessingParameterNumber|lambda|Lambda coefficients for combining walking en
QgsProcessingParameterNumber|slope_factor|Slope factor determines travel energy cost per height step|QgsProcessingParameterNumber.Double|-0.2125|True|None|None
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|False|1|None
*QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|True|1|None
*QgsProcessingParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|False
*QgsProcessingParameterBoolean|-n|Keep null values in output raster layer|False
QgsProcessingParameterRasterDestination|output|Cumulative cost
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ QgsProcessingParameterNumber|lambda|Lambda coefficients for combining walking en
QgsProcessingParameterNumber|slope_factor|Slope factor determines travel energy cost per height step|QgsProcessingParameterNumber.Double|-0.2125|True|None|None
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|False|1|None
*QgsProcessingParameterNumber|memory|Maximum memory to be used in MB|QgsProcessingParameterNumber.Integer|300|True|1|None
*QgsProcessingParameterBoolean|-k|Use the 'Knight's move'; slower, but more accurate|False
*QgsProcessingParameterBoolean|-n|Keep null values in output raster layer|False
QgsProcessingParameterRasterDestination|output|Cumulative cost
Expand Down
23 changes: 0 additions & 23 deletions python/plugins/processing/algs/grass7/description/todo.lst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ v.clean
v.clean.advanced - Toolset for cleaning topology of vector map (Advanced).
Vector (v.*)
QgsProcessingParameterVectorLayer|input|Layer to clean|-1|None|False
QgsProcessingParameterString|tool|Cleaning tools (comma separated)|break
QgsProcessingParameterString|threshold|Threshold (comma separated)|None|None|0.0001
QgsProcessingParameterString|tool|Cleaning tools (comma separated)|break|False|True
QgsProcessingParameterString|threshold|Threshold (comma separated)|None|False|True
QgsProcessingParameterVectorDestination|output|Cleaned
QgsProcessingParameterVectorDestination|error|Errors
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ QgsProcessingParameterVectorLayer|from|'from' vector map|-1|None|False
*QgsProcessingParameterString|from_type|'from' feature type (point,line,boundary,centroid,area)|point,line,area|False|False
QgsProcessingParameterVectorLayer|to|'to' vector map|-1|None|False
*QgsProcessingParameterString|to_type|'to' feature type (point,line,boundary,centroid,area)|point,line,area|False|False
QgsProcessingParameterNumber|dmax|Maximum distance or -1.0 for no limit|-1.0|QgsProcessingParameterNumber.Double|False|False|-1.0|None
QgsProcessingParameterNumber|dmin|Minimum distance or -1.0 for no limit|-1.0|QgsProcessingParameterNumber.Double|False|False|-1.0|None
QgsProcessingParameterNumber|dmax|Maximum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|False|-1.0|None
QgsProcessingParameterNumber|dmin|Minimum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|False|-1.0|None
QgsProcessingParameterString|upload|'upload': Values describing the relation between two nearest features (cat,dist,to_x,to_y,to_along,to_angle,to_attr)|cat|False|True
QgsProcessingParameterString|column|Column name(s) where values specified by 'upload' option will be uploaded|None|False|True
QgsProcessingParameterField|to_column|Column name of nearest feature (used with upload=to_attr)|None|to|-1|False|True
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ v.net.components
Computes strongly and weakly connected components in the network.
Vector (v.*)
QgsProcessingParameterVectorLayer|input|Input vector line layer (network)|1|None|False
QgsProcessingParameterEnum|method|Type of components|weak;strong|0|False|False
QgsProcessingParameterEnum|method|Type of components|weak;strong|False|0|False
*QgsProcessingParameterField|arc_column|Arc forward/both direction(s) cost column (number)|None|input|0|False|True
*QgsProcessingParameterField|arc_backward_column|Arc backward direction cost column (number)|None|input|0|False|True
*QgsProcessingParameterBoolean|-a|Add points on nodes|True|True
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ v.out.ascii
Exports a vector map to a GRASS ASCII vector representation.
Vector (v.*)
QgsProcessingParameterVectorLayer|input|Name of input vector map|-1|None|False
QgsProcessingParameterEnum|format|Output format|point;standard;wkt|False|False
QgsProcessingParameterEnum|separator|Field separator|pipe;comma;space;tab;newline|False|False
QgsProcessingParameterEnum|format|Output format|point;standard;wkt|False|0|False
QgsProcessingParameterEnum|separator|Field separator|pipe;comma;space;tab;newline|False|0|False
QgsProcessingParameterNumber|precision|Number of significant digits (floating point only)|QgsProcessingParameterNumber.Integer|8|True|0|32
*QgsProcessingParameterBoolean|-o|Create old (version 4) ASCII file|False
*QgsProcessingParameterBoolean|-c|Include column names in output (points mode)|False
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
v.patch
Create a new vector map layer by combining other vector map layers.
Vector (v.*)
QgsProcessingParameterMultipleLayers|input|Input layers|-1.0|None|False
QgsProcessingParameterMultipleLayers|input|Input layers|-1|None|False
QgsProcessingParameterBoolean|-e|Copy also attribute table|True
QgsProcessingParameterVectorDestination|output|Combined
QgsProcessingParameterVectorDestination|bbox|Bounding boxes
12 changes: 12 additions & 0 deletions python/plugins/processing/core/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,11 @@
QgsProcessingParameterRasterLayer,
QgsProcessingParameterVectorLayer,
QgsProcessingParameterBoolean,
QgsProcessingParameterCrs,
QgsProcessingParameterRange,
QgsProcessingParameterPoint,
QgsProcessingParameterEnum,
QgsProcessingParameterExtent,
QgsProcessingParameterMatrix,
QgsProcessingParameterFile,
QgsProcessingParameterField,
Expand Down Expand Up @@ -605,11 +608,20 @@ def getParameterFromString(s):
params[2] = True if params[2].lower() == 'true' else False
if len(params) > 3:
params[3] = True if params[3].lower() == 'true' else False
elif clazz == QgsProcessingParameterPoint:
if len(params) > 3:
params[3] = True if params[3].lower() == 'true' else False
elif clazz == QgsProcessingParameterCrs:
if len(params) > 3:
params[3] = True if params[3].lower() == 'true' else False
elif clazz == QgsProcessingParameterRange:
if len(params) > 2:
params[2] = QgsProcessingParameterNumber.Integer if params[2].lower().endswith('integer') else QgsProcessingParameterNumber.Double
if len(params) > 4:
params[4] = True if params[4].lower() == 'true' else False
elif clazz == QgsProcessingParameterExtent:
if len(params) > 3:
params[3] = True if params[3].lower() == 'true' else False
elif clazz == QgsProcessingParameterEnum:
if len(params) > 2:
params[2] = params[2].split(';')
Expand Down

0 comments on commit 9eff16f

Please sign in to comment.