Skip to content

Commit

Permalink
Review optional ParameterNumbers
Browse files Browse the repository at this point in the history
  • Loading branch information
Médéric RIBREUX committed Dec 16, 2017
1 parent f70032b commit 507af21
Show file tree
Hide file tree
Showing 18 changed files with 38 additions and 30 deletions.
Expand Up @@ -2,6 +2,6 @@ v.build.polylines
Builds polylines from lines or boundaries.
Vector (v.*)
QgsProcessingParameterVectorLayer|input|Name of input vector map|-1|None|False
QgsProcessingParameterEnum|cats|Category number mode|no;first;multi;same|False|0
QgsProcessingParameterEnum|cats|Category number mode|no;first;multi;same|False|0|True
QgsProcessingParameterEnum|type|Input feature type|line;boundary|True|0,1|True
QgsProcessingParameterVectorDestination|output|Polylines
2 changes: 2 additions & 0 deletions python/plugins/processing/algs/grass7/description/v.clean.txt
Expand Up @@ -5,5 +5,7 @@ QgsProcessingParameterVectorLayer|input|Layer to clean|-1|None|False
QgsProcessingParameterEnum|type|Input feature type|point;line;boundary;centroid;area;face;kernel|True|0,1,2,3,4,5,6|True
QgsProcessingParameterEnum|tool|Cleaning tool|break;snap;rmdangle;chdangle;rmbridge;chbridge;rmdupl;rmdac;bpol;prune;rmarea;rmline;rmsa|True|0|False
QgsProcessingParameterString|threshold|Threshold (comma separated for each tool)|None|False|True
*QgsProcessingParameterBoolean|-b|Do not build topology for the output vector|False
*QgsProcessingParameterBoolean|-c|Combine tools with recommended follow-up tools|False
QgsProcessingParameterVectorDestination|output|Cleaned
QgsProcessingParameterVectorDestination|error|Errors
Expand Up @@ -2,7 +2,10 @@ v.cluster
Performs cluster identification
Vector (v.*)
QgsProcessingParameterVectorLayer|input|Input layer|-1|None|False
QgsProcessingParameterNumber|distance|Maximum distance to neighbors|QgsProcessingParameterNumber.Double|None|False|None|None
QgsProcessingParameterNumber|min|Minimum number of points to create a cluster|QgsProcessingParameterNumber.Integer|1|False|0|None
QgsProcessingParameterNumber|distance|Maximum distance to neighbors|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|min|Minimum number of points to create a cluster|QgsProcessingParameterNumber.Integer|None|True|0|None
QgsProcessingParameterEnum|method|Clustering method|dbscan, dbscan2, density, optics, optics2|False|0|False
*QgsProcessingParameterBoolean|-2|Force 2D clustering|False
*QgsProcessingParameterBoolean|-b|Do not build topology|False
*QgsProcessingParameterBoolean|-t|Do not create attribute table|False
QgsProcessingParameterVectorDestination|output|Clustered
Expand Up @@ -4,7 +4,7 @@ Vector (v.*)
QgsProcessingParameterVectorLayer|map|Input vector map |-1|None|False
QgsProcessingParameterNumber|layer|Layer Number|QgsProcessingParameterNumber.Double|1|False|None|1
QgsProcessingParameterString|columns|Name of attribute column(s), comma separated|None|False|True
QgsProcessingParameterBoolean|-c|Do not include column names in output|False
*QgsProcessingParameterBoolean|-c|Do not include column names in output|False
QgsProcessingParameterString|separator|Output field separator|,|False|True
*QgsProcessingParameterString|where|WHERE conditions of SQL statement without 'where' keyword|None|True|True
*QgsProcessingParameterString|group|GROUP BY conditions of SQL statement without 'group by' keyword|None|True|True
Expand Down
Expand Up @@ -5,8 +5,8 @@ QgsProcessingParameterVectorLayer|from|'from' vector map|-1|None|False
*QgsProcessingParameterEnum|from_type|'from' feature type|point;line;boundary;area;centroid|True|0,1,3|True
QgsProcessingParameterVectorLayer|to|'to' vector map|-1|None|False
*QgsProcessingParameterEnum|to_type|'from' feature type|point;line;boundary;area;centroid|True|0,1,3|True
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
QgsProcessingParameterNumber|dmax|Maximum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|True|-1.0|None
QgsProcessingParameterNumber|dmin|Minimum distance or -1.0 for no limit|QgsProcessingParameterNumber.Double|-1.0|Truee|-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
Expand Up @@ -7,5 +7,5 @@ QgsProcessingParameterEnum|type|Input feature type|point;line;boundary;centroid|
QgsProcessingParameterRasterLayer|elevation|Elevation raster map for height extraction|None|False
QgsProcessingParameterEnum|method|Sampling method|nearest;bilinear;bicubic|False|0|True
QgsProcessingParameterNumber|scale|Scale factor sampled raster values|QgsProcessingParameterNumber.Double|1.0|True|None|None
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterVectorDestination|output|3D vector
Expand Up @@ -5,7 +5,9 @@ QgsProcessingParameterVectorLayer|input|Vector layer|-1|None|False
QgsProcessingParameterString|where|WHERE conditions of SQL statement without 'where' keyword|None|True|True
QgsProcessingParameterEnum|type|Input feature type|point;line;boundary;centroid;area;face|True|0,1,3,4,5,6|True
QgsProcessingParameterFile|file|Input text file with category numbers/number ranges to be extracted|0|txt|None|True
QgsProcessingParameterNumber|random|Number of random categories matching vector objects to extract|QgsProcessingParameterNumber.Integer|0|True|.0|None
QgsProcessingParameterNumber|new|Desired new category value (enter -1 to keep original categories)|QgsProcessingParameterNumber.Integer|-1|False|-1|None
QgsProcessingParameterBoolean|-d|Dissolve common boundaries|True
QgsProcessingParameterNumber|random|Number of random categories matching vector objects to extract|QgsProcessingParameterNumber.Integer|None|True|0|None
QgsProcessingParameterNumber|new|Desired new category value (enter -1 to keep original categories)|QgsProcessingParameterNumber.Integer|-1|True|-1|None
*QgsProcessingParameterBoolean|-d|Dissolve common boundaries|True
*QgsProcessingParameterBoolean|-t|Do not copy attributes|False
*QgsProcessingParameterBoolean|-r|Reverse selection|False
QgsProcessingParameterVectorDestination|output|Selected
Expand Up @@ -10,6 +10,6 @@ QgsProcessingParameterField|height_column|Name of attribute column with object h
QgsProcessingParameterRasterLayer|elevation|Elevation raster for height extraction|None|True
QgsProcessingParameterEnum|method|Sampling interpolation method|nearest;bilinear;bicubic|False|0|True
QgsProcessingParameterNumber|scale|Scale factor sampled raster values|QgsProcessingParameterNumber.Double|1.0|True|0.0|None
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|null_value|Height for sampled raster NULL values|QgsProcessingParameterNumber.Double|None|True|None|None
*QgsProcessingParameterBoolean|-t|Trace elevation|False
QgsProcessingParameterVectorDestination|output|3D Vector
Expand Up @@ -6,10 +6,10 @@ QgsProcessingParameterExtent|spatial|Import subregion only|None|True
QgsProcessingParameterRange|zrange|Filter range for z data|QgsProcessingParameterNumber.Double|None|True
QgsProcessingParameterEnum|return_filter|Only import points of selected return type|first;last;mid|True|None|True
QgsProcessingParameterString|class_filter|Only import points of selected class(es) (comma separated integers)|None|False|True
QgsProcessingParameterNumber|skip|Do not import every n-th point|QgsProcessingParameterNumber.Integer|0|True|1|None
QgsProcessingParameterNumber|preserve|Import only every n-th point|QgsProcessingParameterNumber.Integer|0|True|1|None
QgsProcessingParameterNumber|offset|Skip first n points|QgsProcessingParameterNumber.Integer|0|True|1|None
QgsProcessingParameterNumber|limit|Import only n points|QgsProcessingParameterNumber.Integer|1|True|1|None
QgsProcessingParameterNumber|skip|Do not import every n-th point|QgsProcessingParameterNumber.Integer|None|True|1|None
QgsProcessingParameterNumber|preserve|Import only every n-th point|QgsProcessingParameterNumber.Integer|None|True|1|None
QgsProcessingParameterNumber|offset|Skip first n points|QgsProcessingParameterNumber.Integer|None|True|1|None
QgsProcessingParameterNumber|limit|Import only n points|QgsProcessingParameterNumber.Integer|None|True|1|None
*QgsProcessingParameterBoolean|-t|Do not create attribute table|False
*QgsProcessingParameterBoolean|-c|Do not automatically add unique ID as category to each point|False
*QgsProcessingParameterBoolean|-b|Do not build topology|False
Expand Down
Expand Up @@ -5,5 +5,5 @@ QgsProcessingParameterString|url|GetFeature URL starting with 'http'|http://|Fal
QgsProcessingParameterCrs|srs|Alternate spatial reference system|None|True
QgsProcessingParameterString|name|Comma separated names of data layers to download|None|False|True
QgsProcessingParameterNumber|maximum_features|Maximum number of features to download|QgsProcessingParameterNumber.Integer|None|True|1|None
QgsProcessingParameterNumber|start_index|Skip earlier feature IDs and start downloading at this one|QgsProcessingParameterNumber.Integer|0|True|1|None
QgsProcessingParameterNumber|start_index|Skip earlier feature IDs and start downloading at this one|QgsProcessingParameterNumber.Integer|None|True|1|None
QgsProcessingParameterVectorDestination|output|Converted
Expand Up @@ -6,5 +6,6 @@ QgsProcessingParameterEnum|atype|Input layer (A) Type|area;line;auto|False|0|Tru
QgsProcessingParameterVectorLayer|binput|Input layer (B)|2|None|False
QgsProcessingParameterEnum|btype|Input layer (B) Type|area|False|0|True
QgsProcessingParameterEnum|operator|Operator to use|and;or;not;xor|False|0|False
QgsProcessingParameterNumber|snap|Snapping threshold for boundaries|QgsProcessingParameterNumber.Double|0.00000001|True|-1|None
QgsProcessingParameterBoolean|-t|Do not create attribute table|False
QgsProcessingParameterVectorDestination|output|Overlay
Expand Up @@ -3,10 +3,10 @@ Creates parallel line to input vector lines.
Vector (v.*)
QgsProcessingParameterVectorLayer|input|Input lines|1|None|False
QgsProcessingParameterNumber|distance|Offset along major axis in map units|QgsProcessingParameterNumber.Double|1.0|False|0.0|100000000.0
QgsProcessingParameterNumber|minordistance|Offset along minor axis in map units|QgsProcessingParameterNumber.Double|1.0|True|0.0|100000000.0
QgsProcessingParameterNumber|minordistance|Offset along minor axis in map units|QgsProcessingParameterNumber.Double|None|True|0.0|100000000.0
QgsProcessingParameterNumber|angle|Angle of major axis in degrees|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
QgsProcessingParameterEnum|side|Side|left;right;both|False|0|False
QgsProcessingParameterNumber|tolerance|Tolerance of arc polylines in map units|QgsProcessingParameterNumber.Double|1.0|True|0.0|100000000.0
QgsProcessingParameterNumber|tolerance|Tolerance of arc polylines in map units|QgsProcessingParameterNumber.Double|None|True|0.0|100000000.0
QgsProcessingParameterBoolean|-r|Make outside corners round|False
QgsProcessingParameterBoolean|-b|Create buffer-like parallel lines|False
QgsProcessingParameterVectorDestination|output|Parallel lines
Expand Up @@ -4,6 +4,6 @@ Vector (v.*)
QgsProcessingParameterVectorLayer|input|Vector points to be spatially perturbed|-1|None|False
QgsProcessingParameterEnum|distribution|Distribution of perturbation|uniform;normal|False|0|True
QgsProcessingParameterString|parameters|Parameter(s) of distribution (uniform: maximum; normal: mean and stddev)|None|False|True
QgsProcessingParameterNumber|minimum|Minimum deviation in map units|QgsProcessingParameterNumber.Double|0.0|False|None|None
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|0|False|None|None
QgsProcessingParameterNumber|minimum|Minimum deviation in map units|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|0|True|None|None
QgsProcessingParameterVectorDestination|output|Perturbed
Expand Up @@ -4,9 +4,9 @@ Vector (v.*)
QgsProcessingParameterNumber|npoints|Number of points to be created|QgsProcessingParameterNumber.Double|100|False|0|None
QgsProcessingParameterVectorLayer|restrict|Restrict points to areas in input vector|-1|None|True
QgsProcessingParameterString|where|WHERE conditions of SQL statement without 'where' keyword|None|True|True
QgsProcessingParameterNumber|zmin|Minimum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|False|None|None
QgsProcessingParameterNumber|zmax|Maximum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|False|None|None
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|0|False|None|None
QgsProcessingParameterNumber|zmin|Minimum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|zmax|Maximum z height for 3D output|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|seed|Seed for random number generation|QgsProcessingParameterNumber.Integer|None|True|None|None
QgsProcessingParameterString|column|Column for Z values|z|False|True
QgsProcessingParameterEnum|column_type|Type of column for z values|integer;double precision|False|0|True
QgsProcessingParameterBoolean|-z|Create 3D output|False|True
Expand Down
Expand Up @@ -4,7 +4,7 @@ Vector (v.*)
QgsProcessingParameterVectorLayer|input|Name of input vector map|-1|None|False
QgsProcessingParameterString|inline_points|Inline control points|None|True|True
QgsProcessingParameterFile|points|Name of input file with control points|0|txt|None|True
QgsProcessingParameterNumber|order|Rectification polynomial order|QgsProcessingParameterNumber.Integer|1|False|1|3
QgsProcessingParameterNumber|order|Rectification polynomial order|QgsProcessingParameterNumber.Integer|1|True|1|3
QgsProcessingParameterString|separator|Field separator for RMS report|pipe|False|True
*QgsProcessingParameterBoolean|-3|Perform 3D transformation|False
*QgsProcessingParameterBoolean|-o|Perform orthogonal 3D transformation|False
Expand Down
Expand Up @@ -4,6 +4,6 @@ Vector (v.*)
QgsProcessingParameterVectorLayer|input|Vector layer defining sample points|0|None|False
QgsProcessingParameterField|column|Vector layer attribute column to use for comparison|None|input|-1|False|False
QgsProcessingParameterRasterLayer|raster|Raster map to be sampled|None|False
QgsProcessingParameterNumber|zscale|Sampled raster values will be multiplied by this factor|QgsProcessingParameterNumber.Double|1.0|False|None|None
QgsProcessingParameterNumber|zscale|Sampled raster values will be multiplied by this factor|QgsProcessingParameterNumber.Double|1.0|True|None|None
QgsProcessingParameterEnum|method|Sampling interpolation method|nearest;bilinear;bicubic|False|0|True
QgsProcessingParameterVectorDestination|output|Sampled|QgsProcessing.TypeVectorPoint|None|True
Expand Up @@ -10,11 +10,11 @@ QgsProcessingParameterNumber|smooth|Smoothing parameter|QgsProcessingParameterNu
QgsProcessingParameterField|smooth_column|Name of the attribute column with smoothing parameters|None|input|-1|False|True
QgsProcessingParameterNumber|segmax|Maximum number of points in a segment|QgsProcessingParameterNumber.Integer|40|True|0|None
QgsProcessingParameterNumber|npmin|Minimum number of points for approximation in a segment (>segmax)|QgsProcessingParameterNumber.Integer|300|True|0|None
QgsProcessingParameterNumber|dmin|Minimum distance between points (to remove almost identical points)|QgsProcessingParameterNumber.Double|0.001|True|0.0|None
QgsProcessingParameterNumber|dmax|Maximum distance between points on isoline (to insert additional points)|QgsProcessingParameterNumber.Double|2.5|True|None|None
QgsProcessingParameterNumber|dmin|Minimum distance between points (to remove almost identical points)|QgsProcessingParameterNumber.Double|None|True|0.0|None
QgsProcessingParameterNumber|dmax|Maximum distance between points on isoline (to insert additional points)|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|zscale|Conversion factor for values used for approximation|QgsProcessingParameterNumber.Double|1.0|True|None|None
QgsProcessingParameterNumber|theta|Anisotropy angle (in degrees counterclockwise from East)|QgsProcessingParameterNumber.Double|0.0|True|0.0|360.0
QgsProcessingParameterNumber|scalex|Anisotropy scaling factor|QgsProcessingParameterNumber.Double|0.0|True|None|None
QgsProcessingParameterNumber|theta|Anisotropy angle (in degrees counterclockwise from East)|QgsProcessingParameterNumber.Double|None|True|0.0|360.0
QgsProcessingParameterNumber|scalex|Anisotropy scaling factor|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterBoolean|-c|Perform cross-validation procedure without raster approximation|False
QgsProcessingParameterBoolean|-t|Use scale dependent tension|False
QgsProcessingParameterBoolean|-d|Output partial derivatives instead of topographic parameters|False
Expand Down
Expand Up @@ -8,6 +8,6 @@ QgsProcessingParameterEnum|use|Source of raster values|attr;cat;va;z;dir|False|0
QgsProcessingParameterField|attribute_column|Name of column for 'attr' parameter (data type must be numeric)|None|input|0|False|True
QgsProcessingParameterField|rgb_column|Name of color definition column (with RRR:GGG:BBB entries)|None|input|0|False|True
QgsProcessingParameterField|label_column|Name of column used as raster category labels|None|input|0|False|True
QgsProcessingParameterNumber|value|Raster value (for use=val)|QgsProcessingParameterNumber.Double|None|True|None|None
QgsProcessingParameterNumber|value|Raster value (for use=val)|QgsProcessingParameterNumber.Double|1|True|None|None
QgsProcessingParameterNumber|memory|Maximum memory to be used (in MB)|QgsProcessingParameterNumber.Integer|300|True|1|None
QgsProcessingParameterRasterDestination|output|Rasterized

0 comments on commit 507af21

Please sign in to comment.