diff --git a/python/plugins/processing/algs/help/qgis.yaml b/python/plugins/processing/algs/help/qgis.yaml index 554c6e3eb0f..bf6f18e09b9 100755 --- a/python/plugins/processing/algs/help/qgis.yaml +++ b/python/plugins/processing/algs/help/qgis.yaml @@ -71,19 +71,19 @@ qgis:convexhull: > If a field is specified, it will divide the features into classes based on that field, and compute a separate convex hull for the features in each class. qgis:countpointsinpolygon: > - This algorithms takes a points layer and a polygon layer and counts the number of points from the first one in each polygons of the second one. + This algorithm takes a points layer and a polygon layer and counts the number of points from the first one in each polygons of the second one. A new polygons layer is generated, with the exact same content as the input polygons layer, but containing an additional field with the points count corresponding to each polygon. qgis:countpointsinpolygonweighted: > - This algorithms takes a points layer and a polygon layer and counts the number of points from the first one in each polygons of the second one. + This algorithm takes a points layer and a polygon layer and counts the number of points from the first one in each polygon of the second one. An attribute is used in the points layer to assign weights to each point. A new polygons layer is generated, with the exact same content as the input polygons layer, but containing an additional field with the points count corresponding to each polygon. qgis:countuniquepointsinpolygon: > - This algorithms takes a points layer and a polygon layer and counts the number of points from the first one in each polygons of the second one. + This algorithm takes a points layer and a polygon layer and counts the number of points from the first one in each polygon of the second one. Points are classified based on an attribute, and if several points with the same attribute value are within the extent of the polygon, only one of them is counted. The final count of point in a polygon is, therefore, the count of different classes that are found in it. @@ -93,7 +93,7 @@ qgis:createattributeindex: > Creates an index to speed up queries made against a field in a table. Support for index creation is dependent on the layer's data provider and the field type. qgis:createconstantrasterlayer: > - Given an input raster layer an a value, this algorithm generates a new layer with the same extent and cell size as the input one, and all cells with the specified value. + Given an input raster layer and a value, this algorithm generates a new layer with the same extent and cell size as the input one, and all cells with the specified value. qgis:creategridlines: > This algorithm creates a line vector layer with a grid covering a given extent. @@ -110,7 +110,7 @@ qgis:creategridpolygon: > The CRS of the output layer must be defined. The grid extent and the spacing values must be expressed in the coordinates and units of this CRS. qgis:createpointsalonglines: > - This algorithms creates a points layer, with points distributed along the lines of an input vector layer. the distance between points (measured along the line) is defined as a parameter. + This algorithm creates a points layer, with points distributed along the lines of an input vector layer. the distance between points (measured along the line) is defined as a parameter. Start and end points can be defined, so the first and last point do not fall on the line first and last node. Start and end points are defined as distances, measured from the first and last nodes of the lines, in the units of the projection used by the lines layer. @@ -118,13 +118,13 @@ qgis:createspatialindex: > Creates an index to speed up access to the features in a layer based on their spatial location. Support for spatial index creation is dependent on the layer's data provider. qgis:delaunaytriangulation: > - This algorithm creates a polygon layer with the delaunay triangulation corresponding to a points layer. + This algorithm creates a polygon layer with the delaunay triangulation corresponding to a points layer. qgis:deletecolumn: > This algorithm takes a vector layer and generates a new one that has the exact same content but without the selected columns. qgis:deleteduplicategeometries: > - This algorithm finds duplicated geometries and removes them. Attributes are not checked, so in case two feature have identical geometries but different attributes, only one of them will be added to the result layer. + This algorithm finds duplicated geometries and removes them. Attributes are not checked, so in case two features have identical geometries but different attributes, only one of them will be added to the result layer. qgis:deleteholes: > This algorithm takes a polygon layer and removes holes in polygons. It creates a new vector layer in which polygons with holes have been replaced by polygons with only their external ring. Attributes are not modified. @@ -150,7 +150,7 @@ qgis:densifygeometriesgivenaninterval: > qgis:difference: > This algorithm extracts features from the Input layer that fall outside, or partially overlap, features in the Difference layer. Input layer features that partially overlap the difference layer feature(s) are split along the boundary of the difference layer feature(s) and only the portions outside the difference layer features are retained. - Attributes are not modified + Attributes are not modified. qgis:dissolve: > This algorithm takes a polygon or line vector layer and combines their geometries into new geometries. One or more attributes can be specified to dissolve only geometries belonging to the same class (having the same value for the specified attributes), alternatively all geometries can be dissolved. @@ -173,7 +173,7 @@ qgis:eliminateselectedpolygons: > Eliminate is normally used to get rid of sliver polygons, i.e. tiny polygons that are a result of polygon intersection processes where boundaries of the inputs are similar but not identical. qgis:explodelines: > - This algorithm takes a lines layer and creates a new one in which each line is replaced is replaced by a set of lines representing the segments in the original line. Each line in the resulting layer contains only a start and an end point, with no intermediate nodes between them. + This algorithm takes a lines layer and creates a new one in which each line is replaced by a set of lines representing the segments in the original line. Each line in the resulting layer contains only a start and an end point, with no intermediate nodes between them. qgis:exportaddgeometrycolumns: > This algorithm computes geometric properties of the features in a vector layer. It generates a new vector layer with the same content as the input one, but with additional attributes in its attributes table, containing geometric measurements. @@ -181,18 +181,18 @@ qgis:exportaddgeometrycolumns: > Depending on the geometry type of the vector layer, the attributes added to the table will be different. qgis:extendlines: > - This algorithms extends line geometries by a specified amount at the start and end of the line. Lines are extended using the bearing of the first and last segment in the line. + This algorithm extends line geometries by a specified amount at the start and end of the line. Lines are extended using the bearing of the first and last segment in the line. qgis:extractbyattribute: > - This algorithms creates a new vector layer that only contains matching features from an input layer. The criteria for adding features to the resulting layer is defined based on the values of an attribute from the input layer. + This algorithm creates a new vector layer that only contains matching features from an input layer. The criteria for adding features to the resulting layer is defined based on the values of an attribute from the input layer. qgis:extractbyexpression: > - This algorithms creates a new vector layer that only contains matching features from an input layer. The criteria for adding features to the resulting layer is based on a QGIS expression. + This algorithm creates a new vector layer that only contains matching features from an input layer. The criteria for adding features to the resulting layer is based on a QGIS expression. For more information about expressions see the user manual qgis:extractbylocation: > - This algorithms creates a new vector layer that only contains matching features from an input layer. The criteria for adding features to the resulting layer is defined based on the spatial relationship between each feature and the features in an additional layer. + This algorithm creates a new vector layer that only contains matching features from an input layer. The criteria for adding features to the resulting layer is defined based on the spatial relationship between each feature and the features in an additional layer. qgis:extractnodes: > This algorithm takes a line or polygon layer and generates a point layer with points representing the nodes in the input lines or polygons. The attributes associated to each point are the same ones associated to the line or polygon that the point belongs to. @@ -233,7 +233,7 @@ qgis:fixgeometries: > NOTE: M values will be dropped from the output. qgis:frequencyanalysis: > - This algorithms generates a table with frequency analysis of the values of a selected attribute from an input vector layer + This algorithm generates a table with frequency analysis of the values of a selected attribute from an input vector layer qgis:geometrybyexpression: > This algorithm updates existing geometries (or creates new geometries) for input features by use of a QGIS expression. This allows complex geometry modifications which can utilize all the flexibility of the QGIS expression engine to manipulate and create geometries for output features. @@ -253,36 +253,36 @@ qgis:hypsometriccurves: > This algorithm computes hypsometric curves for an input Digital Elevation Model. Curves are produced as table files in an output folder specified by the user. qgis:importintospatialite: > - This algorithms imports a vector layer into a Spatialite database, creating a new table. + This algorithm imports a vector layer into a Spatialite database, creating a new table. qgis:importintopostgis: > - This algorithms imports a vector layer into a PostGIS database, creating a new table. + This algorithm imports a vector layer into a PostGIS database, creating a new table. Prior to this a connection between QGIS and the PostGIS database has to be created (for example with the DB Manager). qgis:intersection: > This algorithm extracts the overlapping portions of features in the Input and Intersect layers. Features in the Intersection layer are assigned the attributes of the overlapping features from both the Input and Intersect layers. - Attributes are not modified + Attributes are not modified. qgis:joinattributesbylocation: > This algorithm takes an input vector layer and creates a new vector layer that is an extended version of the input one, with additional attributes in its attribute table. - The additional attributes and their values are taken from a second vector layer. A spatial criteria is applied to select the values from the second layer that are added to each feature from the first layer in the resulting one. + The additional attributes and their values are taken from a second vector layer. A spatial criteria is applied to select the values from the second layer that are added to each feature from the first layer in the resulting one. qgis:joinattributestable: > This algorithm takes an input vector layer and creates a new vector layer that is an extended version of the input one, with additional attributes in its attribute table. - The additional attributes and their values are taken from a second vector layer. An attribute is selected in each of them to define the join criteria. + The additional attributes and their values are taken from a second vector layer. An attribute is selected in each of them to define the join criteria. qgis:keepnbiggestparts: > - This algorithms takes a polygon layer and creates a new polygon layer in which multipart geometries have been removed, leaving only the n largest (in terms of area) parts + This algorithms takes a polygon layer and creates a new polygon layer in which multipart geometries have been removed, leaving only the n largest (in terms of area) parts. qgis:lineintersections: > This algorithm creates point features where the lines in the Intersect layer intersect the lines in the Input layer. - An ID field is specified for each of the input layers. Each point in the resulting layer will have the ID's of both input layer, allowing to identify them. + An ID field is specified for each of the input layers. Each point in the resulting layer will have the ID's of both input layers, allowing to identify them. If no Input Unique and Intersect Unique ID fields are specified then the point features are given the values of the last field (i.e. the last field/column in the attribute table) of the intersecting lines. @@ -302,7 +302,7 @@ qgis:meancoordinates: > An attribute can be specified as containing weights to be applied to each feature when computing the center of mass. - If an attribute is selected in the parameters, features will be grouped according to values in this field. Instead of a single point with the center of mass of the whole layer, the output layer will contain a center of mass for the features in each category. + If an attribute is selected in the parameters, features will be grouped according to values in this field. Instead of a single point with the center of mass of the whole layer, the output layer will contain a center of mass for the features in each category. qgis:mergelines: > This algorithm joins all connected parts of MultiLineString geometries into single LineString geometries. @@ -312,7 +312,7 @@ qgis:mergelines: > qgis:mergevectorlayers: > This algorithm combines multiple vector layers of the same geometry type into a single one. - If attributes tables are different, the attribute table of the resulting layer will contain the attributes from both input layers + If attributes tables are different, the attribute table of the resulting layer will contain the attributes from both input layers. qgis:multiparttosingleparts: > This algorithm takes a vector layer with multipart geometries and generates a new one in which all geometries contain a single part. Features with multipart geometries are divided in as many different features as parts the geometry contain, and the same attributes are used for each of them. @@ -326,7 +326,7 @@ qgis:nearestneighbouranalysis: > qgis:numberofuniquevaluesinclasses: > This algorithm counts the different values that appear in a specified attributes for features of the same class. - Classes are defined according to a given attribute. For all layers that share the same value of this attributes, the values of a second attributes are analyzed. + Classes are defined according to a given attribute. For all layers that share the same value of this attribute, the values of a second attribute are analyzed. The resulting layer contains the same features as the input layer, but with an additional attribute containing the count of unique values for that class. @@ -342,7 +342,7 @@ qgis:offsetline: > qgis:orientedminimumboundingbox: > This algorithm takes a vector layer and generate a new one with the minimum rectangle that covers all the input features. - As an alternative, the output layer can contain not just a single rectangle, but one for each input feature, representing the minimum rectangle that covers each of them. + As an alternative, the output layer can contain not just a single rectangle, but one for each input feature, representing the minimum rectangle that covers each of them. qgis:orthogonalize: > This algorithm takes a line or polygon layer and attempts to orthogonalize all the geometries in the layer. This process shifts the nodes in the geometries to try to make every angle in the geometry either a right angle or a straight line. @@ -392,7 +392,7 @@ qgis:polygoncentroids: > qgis:polygonfromlayerextent: > - This algorithm takes a vector layer and generate a new one with the minimum bounding box (rectangle with N-S orientation) that covers all the input features. + This algorithm takes a vector layer and generates a new one with the minimum bounding box (rectangle with N-S orientation) that covers all the input features. As an alternative, the output layer can contain not just a single bounding box, but one for each input feature, representing the bounding box of each of them. @@ -411,12 +411,12 @@ qgis:postgisexecutesql: > qgis:randomextract: > This algorithm takes a vector layer and generates a new one that contains only a subset of the features in the input layer. - The subset is defined randomly, using a percentage or count value to define the total number of features in the subset. + The subset is defined randomly, using a percentage or count value to define the total number of features in the subset. qgis:randomextractwithinsubsets: > This algorithm takes a vector layer and generates a new one that contains only a subset of the features in the input layer. - The subset is defined randomly, using a percentage or count value to define the total number of features in the subset. + The subset is defined randomly, using a percentage or count value to define the total number of features in the subset. The percentage/count value is not applied to the whole layer, but instead to each category. Categories are defined according to a given attribute, which is also specified as an input parameter for the algorithm. @@ -456,13 +456,13 @@ qgis:rastercalculator: > - sin(), cos(), tan(), atan2(), ln(), log10() - The extent and cellsize can be defined by the user. If the extent is not specified, the minimum extent that covers the input layers will be used. If the cell size is not specified, the minimum cell size of all input layers will be used. + The extent and cell size can be defined by the user. If the extent is not specified, the minimum extent that covers the input layers will be used. If the cell size is not specified, the minimum cell size of all input layers will be used. The cell size is assumed to be the same in both X and Y axes. Layers are referred by their name as displayed in the layer list and the number of the band to use (based on 1), using the pattern 'layer_name@band number'. For instance, the first band from a layer named DEM will be referred as DEM@1. - When using the calculator in the batch interface or from the console, the files to use have to be specified. The corresponding layers are referred using the base name of the file (without the full path). For instance, is using a layer at path/to/my/rasterfile.tif, the first band of that layer will be referred as rasterfile.tif@1. + When using the calculator in the batch interface or from the console, the files to use have to be specified. The corresponding layers are referred using the base name of the file (without the full path). For instance, if using a layer at path/to/my/rasterfile.tif, the first band of that layer will be referred as rasterfile.tif@1. qgis:rasterlayerhistogram: > This algorithm generates a histogram with the values of a raster layer. @@ -540,7 +540,7 @@ qgis:smoothgeometry: > The offset parameter controls how "tightly" the smoothed geometries follow the original geometries. Smaller values results in a tighter fit, and larger values will create a looser fit. - The maximum angle parameter can be used to prevent smoothing of nodes with large angles. Any node where the angle of the segments to either side is larger then this will not be smoothed. For example, setting the maximum angle to 90 degrees or lower would preserve right angles in the geometry. + The maximum angle parameter can be used to prevent smoothing of nodes with large angles. Any node where the angle of the segments to either side is larger than this will not be smoothed. For example, setting the maximum angle to 90 degrees or lower would preserve right angles in the geometry. qgis:snapgeometries: > This algorithm snaps the geometries in a layer. Snapping can be done either to the geometries from another layer, or to geometries within the same layer.