Skip to content

Commit 507af21

Browse files
author
Médéric RIBREUX
committed
Review optional ParameterNumbers
1 parent f70032b commit 507af21

18 files changed

+38
-30
lines changed

‎python/plugins/processing/algs/grass7/description/v.build.polylines.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ v.build.polylines
22
Builds polylines from lines or boundaries.
33
Vector (v.*)
44
QgsProcessingParameterVectorLayer|input|Name of input vector map|-1|None|False
5-
QgsProcessingParameterEnum|cats|Category number mode|no;first;multi;same|False|0
5+
QgsProcessingParameterEnum|cats|Category number mode|no;first;multi;same|False|0|True
66
QgsProcessingParameterEnum|type|Input feature type|line;boundary|True|0,1|True
77
QgsProcessingParameterVectorDestination|output|Polylines

‎python/plugins/processing/algs/grass7/description/v.clean.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@ QgsProcessingParameterVectorLayer|input|Layer to clean|-1|None|False
55
QgsProcessingParameterEnum|type|Input feature type|point;line;boundary;centroid;area;face;kernel|True|0,1,2,3,4,5,6|True
66
QgsProcessingParameterEnum|tool|Cleaning tool|break;snap;rmdangle;chdangle;rmbridge;chbridge;rmdupl;rmdac;bpol;prune;rmarea;rmline;rmsa|True|0|False
77
QgsProcessingParameterString|threshold|Threshold (comma separated for each tool)|None|False|True
8+
*QgsProcessingParameterBoolean|-b|Do not build topology for the output vector|False
9+
*QgsProcessingParameterBoolean|-c|Combine tools with recommended follow-up tools|False
810
QgsProcessingParameterVectorDestination|output|Cleaned
911
QgsProcessingParameterVectorDestination|error|Errors

‎python/plugins/processing/algs/grass7/description/v.cluster.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ v.cluster
22
Performs cluster identification
33
Vector (v.*)
44
QgsProcessingParameterVectorLayer|input|Input layer|-1|None|False
5-
QgsProcessingParameterNumber|distance|Maximum distance to neighbors|QgsProcessingParameterNumber.Double|None|False|None|None
6-
QgsProcessingParameterNumber|min|Minimum number of points to create a cluster|QgsProcessingParameterNumber.Integer|1|False|0|None
5+
QgsProcessingParameterNumber|distance|Maximum distance to neighbors|QgsProcessingParameterNumber.Double|None|True|None|None
6+
QgsProcessingParameterNumber|min|Minimum number of points to create a cluster|QgsProcessingParameterNumber.Integer|None|True|0|None
77
QgsProcessingParameterEnum|method|Clustering method|dbscan, dbscan2, density, optics, optics2|False|0|False
8+
*QgsProcessingParameterBoolean|-2|Force 2D clustering|False
9+
*QgsProcessingParameterBoolean|-b|Do not build topology|False
10+
*QgsProcessingParameterBoolean|-t|Do not create attribute table|False
811
QgsProcessingParameterVectorDestination|output|Clustered

‎python/plugins/processing/algs/grass7/description/v.db.select.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Vector (v.*)
44
QgsProcessingParameterVectorLayer|map|Input vector map |-1|None|False
55
QgsProcessingParameterNumber|layer|Layer Number|QgsProcessingParameterNumber.Double|1|False|None|1
66
QgsProcessingParameterString|columns|Name of attribute column(s), comma separated|None|False|True
7-
QgsProcessingParameterBoolean|-c|Do not include column names in output|False
7+
*QgsProcessingParameterBoolean|-c|Do not include column names in output|False
88
QgsProcessingParameterString|separator|Output field separator|,|False|True
99
*QgsProcessingParameterString|where|WHERE conditions of SQL statement without 'where' keyword|None|True|True
1010
*QgsProcessingParameterString|group|GROUP BY conditions of SQL statement without 'group by' keyword|None|True|True

‎python/plugins/processing/algs/grass7/description/v.distance.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ QgsProcessingParameterVectorLayer|from|'from' vector map|-1|None|False
55
*QgsProcessingParameterEnum|from_type|'from' feature type|point;line;boundary;area;centroid|True|0,1,3|True
66
QgsProcessingParameterVectorLayer|to|'to' vector map|-1|None|False
77
*QgsProcessingParameterEnum|to_type|'from' feature type|point;line;boundary;area;centroid|True|0,1,3|True
8-
QgsProcessingParameterNumber|dmax|Maximum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|False|-1.0|None
9-
QgsProcessingParameterNumber|dmin|Minimum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|False|-1.0|None
8+
QgsProcessingParameterNumber|dmax|Maximum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|True|-1.0|None
9+
QgsProcessingParameterNumber|dmin|Minimum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|Truee|-1.0|None
1010
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
1111
QgsProcessingParameterString|column|Column name(s) where values specified by 'upload' option will be uploaded|None|False|True
1212
QgsProcessingParameterField|to_column|Column name of nearest feature (used with upload=to_attr)|None|to|-1|False|True

‎python/plugins/processing/algs/grass7/description/v.drape.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ QgsProcessingParameterEnum|type|Input feature type|point;line;boundary;centroid|
77
QgsProcessingParameterRasterLayer|elevation|Elevation raster map for height extraction|None|False
88
QgsProcessingParameterEnum|method|Sampling method|nearest;bilinear;bicubic|False|0|True
99
QgsProcessingParameterNumber|scale|Scale factor sampled raster values|QgsProcessingParameterNumber.Double|1.0|True|None|None
10-
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|0.0|True|None|None
10+
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|None|True|None|None
1111
QgsProcessingParameterVectorDestination|output|3D vector

‎python/plugins/processing/algs/grass7/description/v.extract.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ QgsProcessingParameterVectorLayer|input|Vector layer|-1|None|False
55
QgsProcessingParameterString|where|WHERE conditions of SQL statement without 'where' keyword|None|True|True
66
QgsProcessingParameterEnum|type|Input feature type|point;line;boundary;centroid;area;face|True|0,1,3,4,5,6|True
77
QgsProcessingParameterFile|file|Input text file with category numbers/number ranges to be extracted|0|txt|None|True
8-
QgsProcessingParameterNumber|random|Number of random categories matching vector objects to extract|QgsProcessingParameterNumber.Integer|0|True|.0|None
9-
QgsProcessingParameterNumber|new|Desired new category value (enter -1 to keep original categories)|QgsProcessingParameterNumber.Integer|-1|False|-1|None
10-
QgsProcessingParameterBoolean|-d|Dissolve common boundaries|True
8+
QgsProcessingParameterNumber|random|Number of random categories matching vector objects to extract|QgsProcessingParameterNumber.Integer|None|True|0|None
9+
QgsProcessingParameterNumber|new|Desired new category value (enter -1 to keep original categories)|QgsProcessingParameterNumber.Integer|-1|True|-1|None
10+
*QgsProcessingParameterBoolean|-d|Dissolve common boundaries|True
11+
*QgsProcessingParameterBoolean|-t|Do not copy attributes|False
12+
*QgsProcessingParameterBoolean|-r|Reverse selection|False
1113
QgsProcessingParameterVectorDestination|output|Selected

‎python/plugins/processing/algs/grass7/description/v.extrude.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ QgsProcessingParameterField|height_column|Name of attribute column with object h
1010
QgsProcessingParameterRasterLayer|elevation|Elevation raster for height extraction|None|True
1111
QgsProcessingParameterEnum|method|Sampling interpolation method|nearest;bilinear;bicubic|False|0|True
1212
QgsProcessingParameterNumber|scale|Scale factor sampled raster values|QgsProcessingParameterNumber.Double|1.0|True|0.0|None
13-
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|0.0|True|None|None
13+
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|None|True|None|None
1414
*QgsProcessingParameterBoolean|-t|Trace elevation|False
1515
QgsProcessingParameterVectorDestination|output|3D Vector

‎python/plugins/processing/algs/grass7/description/v.in.lidar.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ QgsProcessingParameterExtent|spatial|Import subregion only|None|True
66
QgsProcessingParameterRange|zrange|Filter range for z data|QgsProcessingParameterNumber.Double|None|True
77
QgsProcessingParameterEnum|return_filter|Only import points of selected return type|first;last;mid|True|None|True
88
QgsProcessingParameterString|class_filter|Only import points of selected class(es) (comma separated integers)|None|False|True
9-
QgsProcessingParameterNumber|skip|Do not import every n-th point|QgsProcessingParameterNumber.Integer|0|True|1|None
10-
QgsProcessingParameterNumber|preserve|Import only every n-th point|QgsProcessingParameterNumber.Integer|0|True|1|None
11-
QgsProcessingParameterNumber|offset|Skip first n points|QgsProcessingParameterNumber.Integer|0|True|1|None
12-
QgsProcessingParameterNumber|limit|Import only n points|QgsProcessingParameterNumber.Integer|1|True|1|None
9+
QgsProcessingParameterNumber|skip|Do not import every n-th point|QgsProcessingParameterNumber.Integer|None|True|1|None
10+
QgsProcessingParameterNumber|preserve|Import only every n-th point|QgsProcessingParameterNumber.Integer|None|True|1|None
11+
QgsProcessingParameterNumber|offset|Skip first n points|QgsProcessingParameterNumber.Integer|None|True|1|None
12+
QgsProcessingParameterNumber|limit|Import only n points|QgsProcessingParameterNumber.Integer|None|True|1|None
1313
*QgsProcessingParameterBoolean|-t|Do not create attribute table|False
1414
*QgsProcessingParameterBoolean|-c|Do not automatically add unique ID as category to each point|False
1515
*QgsProcessingParameterBoolean|-b|Do not build topology|False

‎python/plugins/processing/algs/grass7/description/v.in.wfs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ QgsProcessingParameterString|url|GetFeature URL starting with 'http'|http://|Fal
55
QgsProcessingParameterCrs|srs|Alternate spatial reference system|None|True
66
QgsProcessingParameterString|name|Comma separated names of data layers to download|None|False|True
77
QgsProcessingParameterNumber|maximum_features|Maximum number of features to download|QgsProcessingParameterNumber.Integer|None|True|1|None
8-
QgsProcessingParameterNumber|start_index|Skip earlier feature IDs and start downloading at this one|QgsProcessingParameterNumber.Integer|0|True|1|None
8+
QgsProcessingParameterNumber|start_index|Skip earlier feature IDs and start downloading at this one|QgsProcessingParameterNumber.Integer|None|True|1|None
99
QgsProcessingParameterVectorDestination|output|Converted

‎python/plugins/processing/algs/grass7/description/v.overlay.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ QgsProcessingParameterEnum|atype|Input layer (A) Type|area;line;auto|False|0|Tru
66
QgsProcessingParameterVectorLayer|binput|Input layer (B)|2|None|False
77
QgsProcessingParameterEnum|btype|Input layer (B) Type|area|False|0|True
88
QgsProcessingParameterEnum|operator|Operator to use|and;or;not;xor|False|0|False
9+
QgsProcessingParameterNumber|snap|Snapping threshold for boundaries|QgsProcessingParameterNumber.Double|0.00000001|True|-1|None
910
QgsProcessingParameterBoolean|-t|Do not create attribute table|False
1011
QgsProcessingParameterVectorDestination|output|Overlay

‎python/plugins/processing/algs/grass7/description/v.parallel.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ Creates parallel line to input vector lines.
33
Vector (v.*)
44
QgsProcessingParameterVectorLayer|input|Input lines|1|None|False
55
QgsProcessingParameterNumber|distance|Offset along major axis in map units|QgsProcessingParameterNumber.Double|1.0|False|0.0|100000000.0
6-
QgsProcessingParameterNumber|minordistance|Offset along minor axis in map units|QgsProcessingParameterNumber.Double|1.0|True|0.0|100000000.0
6+
QgsProcessingParameterNumber|minordistance|Offset along minor axis in map units|QgsProcessingParameterNumber.Double|None|True|0.0|100000000.0
77
QgsProcessingParameterNumber|angle|Angle of major axis in degrees|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
88
QgsProcessingParameterEnum|side|Side|left;right;both|False|0|False
9-
QgsProcessingParameterNumber|tolerance|Tolerance of arc polylines in map units|QgsProcessingParameterNumber.Double|1.0|True|0.0|100000000.0
9+
QgsProcessingParameterNumber|tolerance|Tolerance of arc polylines in map units|QgsProcessingParameterNumber.Double|None|True|0.0|100000000.0
1010
QgsProcessingParameterBoolean|-r|Make outside corners round|False
1111
QgsProcessingParameterBoolean|-b|Create buffer-like parallel lines|False
1212
QgsProcessingParameterVectorDestination|output|Parallel lines

‎python/plugins/processing/algs/grass7/description/v.perturb.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Vector (v.*)
44
QgsProcessingParameterVectorLayer|input|Vector points to be spatially perturbed|-1|None|False
55
QgsProcessingParameterEnum|distribution|Distribution of perturbation|uniform;normal|False|0|True
66
QgsProcessingParameterString|parameters|Parameter(s) of distribution (uniform: maximum; normal: mean and stddev)|None|False|True
7-
QgsProcessingParameterNumber|minimum|Minimum deviation in map units|QgsProcessingParameterNumber.Double|0.0|False|None|None
8-
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|0|False|None|None
7+
QgsProcessingParameterNumber|minimum|Minimum deviation in map units|QgsProcessingParameterNumber.Double|0.0|True|None|None
8+
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|0|True|None|None
99
QgsProcessingParameterVectorDestination|output|Perturbed

‎python/plugins/processing/algs/grass7/description/v.random.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Vector (v.*)
44
QgsProcessingParameterNumber|npoints|Number of points to be created|QgsProcessingParameterNumber.Double|100|False|0|None
55
QgsProcessingParameterVectorLayer|restrict|Restrict points to areas in input vector|-1|None|True
66
QgsProcessingParameterString|where|WHERE conditions of SQL statement without 'where' keyword|None|True|True
7-
QgsProcessingParameterNumber|zmin|Minimum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|False|None|None
8-
QgsProcessingParameterNumber|zmax|Maximum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|False|None|None
9-
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|0|False|None|None
7+
QgsProcessingParameterNumber|zmin|Minimum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|True|None|None
8+
QgsProcessingParameterNumber|zmax|Maximum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|True|None|None
9+
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|None|True|None|None
1010
QgsProcessingParameterString|column|Column for Z values|z|False|True
1111
QgsProcessingParameterEnum|column_type|Type of column for z values|integer;double precision|False|0|True
1212
QgsProcessingParameterBoolean|-z|Create 3D output|False|True

‎python/plugins/processing/algs/grass7/description/v.rectify.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Vector (v.*)
44
QgsProcessingParameterVectorLayer|input|Name of input vector map|-1|None|False
55
QgsProcessingParameterString|inline_points|Inline control points|None|True|True
66
QgsProcessingParameterFile|points|Name of input file with control points|0|txt|None|True
7-
QgsProcessingParameterNumber|order|Rectification polynomial order|QgsProcessingParameterNumber.Integer|1|False|1|3
7+
QgsProcessingParameterNumber|order|Rectification polynomial order|QgsProcessingParameterNumber.Integer|1|True|1|3
88
QgsProcessingParameterString|separator|Field separator for RMS report|pipe|False|True
99
*QgsProcessingParameterBoolean|-3|Perform 3D transformation|False
1010
*QgsProcessingParameterBoolean|-o|Perform orthogonal 3D transformation|False

‎python/plugins/processing/algs/grass7/description/v.sample.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Vector (v.*)
44
QgsProcessingParameterVectorLayer|input|Vector layer defining sample points|0|None|False
55
QgsProcessingParameterField|column|Vector layer attribute column to use for comparison|None|input|-1|False|False
66
QgsProcessingParameterRasterLayer|raster|Raster map to be sampled|None|False
7-
QgsProcessingParameterNumber|zscale|Sampled raster values will be multiplied by this factor|QgsProcessingParameterNumber.Double|1.0|False|None|None
7+
QgsProcessingParameterNumber|zscale|Sampled raster values will be multiplied by this factor|QgsProcessingParameterNumber.Double|1.0|True|None|None
88
QgsProcessingParameterEnum|method|Sampling interpolation method|nearest;bilinear;bicubic|False|0|True
99
QgsProcessingParameterVectorDestination|output|Sampled|QgsProcessing.TypeVectorPoint|None|True

‎python/plugins/processing/algs/grass7/description/v.surf.rst.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ QgsProcessingParameterNumber|smooth|Smoothing parameter|QgsProcessingParameterNu
1010
QgsProcessingParameterField|smooth_column|Name of the attribute column with smoothing parameters|None|input|-1|False|True
1111
QgsProcessingParameterNumber|segmax|Maximum number of points in a segment|QgsProcessingParameterNumber.Integer|40|True|0|None
1212
QgsProcessingParameterNumber|npmin|Minimum number of points for approximation in a segment (>segmax)|QgsProcessingParameterNumber.Integer|300|True|0|None
13-
QgsProcessingParameterNumber|dmin|Minimum distance between points (to remove almost identical points)|QgsProcessingParameterNumber.Double|0.001|True|0.0|None
14-
QgsProcessingParameterNumber|dmax|Maximum distance between points on isoline (to insert additional points)|QgsProcessingParameterNumber.Double|2.5|True|None|None
13+
QgsProcessingParameterNumber|dmin|Minimum distance between points (to remove almost identical points)|QgsProcessingParameterNumber.Double|None|True|0.0|None
14+
QgsProcessingParameterNumber|dmax|Maximum distance between points on isoline (to insert additional points)|QgsProcessingParameterNumber.Double|None|True|None|None
1515
QgsProcessingParameterNumber|zscale|Conversion factor for values used for approximation|QgsProcessingParameterNumber.Double|1.0|True|None|None
16-
QgsProcessingParameterNumber|theta|Anisotropy angle (in degrees counterclockwise from East)|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
17-
QgsProcessingParameterNumber|scalex|Anisotropy scaling factor|QgsProcessingParameterNumber.Double|0.0|True|None|None
16+
QgsProcessingParameterNumber|theta|Anisotropy angle (in degrees counterclockwise from East)|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
17+
QgsProcessingParameterNumber|scalex|Anisotropy scaling factor|QgsProcessingParameterNumber.Double|None|True|None|None
1818
QgsProcessingParameterBoolean|-c|Perform cross-validation procedure without raster approximation|False
1919
QgsProcessingParameterBoolean|-t|Use scale dependent tension|False
2020
QgsProcessingParameterBoolean|-d|Output partial derivatives instead of topographic parameters|False

‎python/plugins/processing/algs/grass7/description/v.to.rast.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ QgsProcessingParameterEnum|use|Source of raster values|attr;cat;va;z;dir|False|0
88
QgsProcessingParameterField|attribute_column|Name of column for 'attr' parameter (data type must be numeric)|None|input|0|False|True
99
QgsProcessingParameterField|rgb_column|Name of color definition column (with RRR:GGG:BBB entries)|None|input|0|False|True
1010
QgsProcessingParameterField|label_column|Name of column used as raster category labels|None|input|0|False|True
11-
QgsProcessingParameterNumber|value|Raster value (for use=val)|QgsProcessingParameterNumber.Double|None|True|None|None
11+
QgsProcessingParameterNumber|value|Raster value (for use=val)|QgsProcessingParameterNumber.Double|1|True|None|None
1212
QgsProcessingParameterNumber|memory|Maximum memory to be used (in MB)|QgsProcessingParameterNumber.Integer|300|True|1|None
1313
QgsProcessingParameterRasterDestination|output|Rasterized

0 commit comments

Comments
 (0)