Skip to content
Permalink
Browse files
[processing] added help files for algs in qgis group
Most help files missing content
  • Loading branch information
volaya committed Jun 8, 2014
1 parent d8dfdd2 commit 15e923820fc5f390928e472fe496b7df97a03c53
Showing with 1,980 additions and 0 deletions.
  1. +27 −0 python/plugins/processing/algs/qgis/help/addautoincrementalfield.rst
  2. +36 −0 python/plugins/processing/algs/qgis/help/addfieldtoattributestable.rst
  3. +30 −0 python/plugins/processing/algs/qgis/help/advancedpythonfieldcalculator.rst
  4. +38 −0 python/plugins/processing/algs/qgis/help/basicstatisticsfornumericfields.rst
  5. +35 −0 python/plugins/processing/algs/qgis/help/basicstatisticsfortextfields.rst
  6. +28 −0 python/plugins/processing/algs/qgis/help/clip.rst
  7. +39 −0 python/plugins/processing/algs/qgis/help/convertgeometrytype.rst
  8. +35 −0 python/plugins/processing/algs/qgis/help/convexhull.rst
  9. +30 −0 python/plugins/processing/algs/qgis/help/countpointsinpolygon.rst
  10. +33 −0 python/plugins/processing/algs/qgis/help/countpointsinpolygonweighted.rst
  11. +32 −0 python/plugins/processing/algs/qgis/help/countuniquepointsinpolygon.rst
  12. +28 −0 python/plugins/processing/algs/qgis/help/createconstantrasterlayer.rst
  13. +28 −0 python/plugins/processing/algs/qgis/help/createequivalentnumericalfield.rst
  14. +48 −0 python/plugins/processing/algs/qgis/help/creategrid.rst
  15. +27 −0 python/plugins/processing/algs/qgis/help/delaunaytriangulation.rst
  16. +28 −0 python/plugins/processing/algs/qgis/help/deletecolumn.rst
  17. +27 −0 python/plugins/processing/algs/qgis/help/deleteduplicategeometries.rst
  18. +28 −0 python/plugins/processing/algs/qgis/help/densifygeometries.rst
  19. +28 −0 python/plugins/processing/algs/qgis/help/densifygeometriesgivenaninterval.rst
  20. +28 −0 python/plugins/processing/algs/qgis/help/difference.rst
  21. +29 −0 python/plugins/processing/algs/qgis/help/dissolve.rst
  22. +39 −0 python/plugins/processing/algs/qgis/help/distancematrix.rst
  23. +44 −0 python/plugins/processing/algs/qgis/help/distancetonearesthub.rst
  24. +27 −0 python/plugins/processing/algs/qgis/help/explodelines.rst
  25. +35 −0 python/plugins/processing/algs/qgis/help/exportaddgeometrycolumns.rst
  26. +27 −0 python/plugins/processing/algs/qgis/help/extractnodes.rst
  27. +46 −0 python/plugins/processing/algs/qgis/help/fieldcalculator.rst
  28. +30 −0 python/plugins/processing/algs/qgis/help/fixeddistancebuffer.rst
  29. +32 −0 python/plugins/processing/algs/qgis/help/hublines.rst
  30. +28 −0 python/plugins/processing/algs/qgis/help/intersection.rst
  31. +30 −0 python/plugins/processing/algs/qgis/help/joinattributestable.rst
  32. +30 −0 python/plugins/processing/algs/qgis/help/lineintersections.rst
  33. +27 −0 python/plugins/processing/algs/qgis/help/linestopolygons.rst
  34. +31 −0 python/plugins/processing/algs/qgis/help/listuniquevalues.rst
  35. +33 −0 python/plugins/processing/algs/qgis/help/meancoordinates.rst
  36. +28 −0 python/plugins/processing/algs/qgis/help/mergevectorlayers.rst
  37. +27 −0 python/plugins/processing/algs/qgis/help/multiparttosingleparts.rst
  38. +32 −0 python/plugins/processing/algs/qgis/help/nearestneighbouranalysis.rst
  39. +39 −0 python/plugins/processing/algs/qgis/help/pointsdisplacement.rst
  40. +32 −0 python/plugins/processing/algs/qgis/help/pointsfromlines.rst
  41. +31 −0 python/plugins/processing/algs/qgis/help/pointsfrompolygons.rst
  42. +37 −0 python/plugins/processing/algs/qgis/help/pointslayerfromtable.rst
  43. +27 −0 python/plugins/processing/algs/qgis/help/polygoncentroids.rst
  44. +28 −0 python/plugins/processing/algs/qgis/help/polygonfromlayerextent.rst
  45. +27 −0 python/plugins/processing/algs/qgis/help/polygonstolines.rst
  46. +35 −0 python/plugins/processing/algs/qgis/help/randomselection.rst
  47. +36 −0 python/plugins/processing/algs/qgis/help/randomselectionwithinsubsets.rst
  48. +35 −0 python/plugins/processing/algs/qgis/help/rasterlayerstatistics.rst
  49. +28 −0 python/plugins/processing/algs/qgis/help/reprojectlayer.rst
  50. +27 −0 python/plugins/processing/algs/qgis/help/saveselectedfeatures.rst
  51. +46 −0 python/plugins/processing/algs/qgis/help/selectbyattribute.rst
  52. +36 −0 python/plugins/processing/algs/qgis/help/selectbylocation.rst
  53. +28 −0 python/plugins/processing/algs/qgis/help/simplifygeometries.rst
  54. +28 −0 python/plugins/processing/algs/qgis/help/singlepartstomultipart.rst
  55. +29 −0 python/plugins/processing/algs/qgis/help/snappointstogrid.rst
  56. +29 −0 python/plugins/processing/algs/qgis/help/statisticsbycategories.rst
  57. +30 −0 python/plugins/processing/algs/qgis/help/sumlinelengths.rst
  58. +28 −0 python/plugins/processing/algs/qgis/help/texttofloat.rst
  59. +28 −0 python/plugins/processing/algs/qgis/help/union.rst
  60. +30 −0 python/plugins/processing/algs/qgis/help/variabledistancebuffer.rst
  61. +27 −0 python/plugins/processing/algs/qgis/help/voronoipolygons.rst
  62. +51 −0 python/plugins/processing/algs/qgis/help/zonalstatistics.rst
@@ -0,0 +1,27 @@
ADD AUTOINCREMENTAL FIELD
=========================

Description
-----------

Parameters
----------

- ``Input layer[Vector]``:

Outputs
-------

- ``Output layer[Vector]``:

See also
---------


Console usage
-------------


::

processing.runalg('qgis:addautoincrementalfield', input, output)
@@ -0,0 +1,36 @@
ADD FIELD TO ATTRIBUTES TABLE
=============================

Description
-----------

Parameters
----------

- ``Input layer[Vector]``:
- ``Field name[String]``:
- ``Field type[Selection]``:

Outputs
-------

- ``Output layer[Vector]``:

See also
---------


Console usage
-------------


::

processing.runalg('qgis:addfieldtoattributestable', input_layer, field_name, field_type, output_layer)

Available options for selection parameters:

field_type(Field type)
0 - Integer
1 - Float
2 - String
@@ -0,0 +1,30 @@
ADVANCED PYTHON FIELD CALCULATOR
================================

Description
-----------

Parameters
----------

- ``Input layer[Vector]``:
- ``Result field name[String]``:
- ``Global expression[String]``:
- ``Formula[String]``:

Outputs
-------

- ``Output layer[Vector]``:

See also
---------


Console usage
-------------


::

processing.runalg('qgis:advancedpythonfieldcalculator', input_layer, field_name, global, formula, output_layer)
@@ -0,0 +1,38 @@
BASIC STATISTICS FOR NUMERIC FIELDS
===================================

Description
-----------

Parameters
----------

- ``Input vector layer[Vector]``:
- ``Field to calculate statistics on[TableField]``:

Outputs
-------

- ``Statistics for numeric field[HTML]``:
- ``Coefficient of Variation[Number]``:
- ``Minimum value[Number]``:
- ``Maximum value[Number]``:
- ``Sum[Number]``:
- ``Mean value[Number]``:
- ``Count[Number]``:
- ``Range[Number]``:
- ``Median[Number]``:
- ``Number of unique values[Number]``:
- ``Standard deviation[Number]``:

See also
---------


Console usage
-------------


::

processing.runalg('qgis:basicstatisticsfornumericfields', input_layer, field_name, output_html_file)
@@ -0,0 +1,35 @@
BASIC STATISTICS FOR TEXT FIELDS
================================

Description
-----------

Parameters
----------

- ``Input vector layer[Vector]``:
- ``Field to calculate statistics on[TableField]``:

Outputs
-------

- ``Statistics for text field[HTML]``:
- ``Minimum length[Number]``:
- ``Maximum length[Number]``:
- ``Mean length[Number]``:
- ``Count[Number]``:
- ``Number of empty values[Number]``:
- ``Number of non-empty values[Number]``:
- ``Number of unique values[Number]``:

See also
---------


Console usage
-------------


::

processing.runalg('qgis:basicstatisticsfortextfields', input_layer, field_name, output_html_file)
@@ -0,0 +1,28 @@
CLIP
====

Description
-----------

Parameters
----------

- ``Input layer[Vector]``:
- ``Clip layer[Vector]``:

Outputs
-------

- ``Clipped[Vector]``:

See also
---------


Console usage
-------------


::

processing.runalg('qgis:clip', input, input2, output)
@@ -0,0 +1,39 @@
CONVERT GEOMETRY TYPE
=====================

Description
-----------
With this algorithm you can convert a geometry type to another one. For example you can convert a polygons layer into its centroid
(points layer).

Parameters
----------

- ``Input layer[Vector]``: layer in input (it can be a points, a lines or a polygons layer)
- ``New Geometry Type[Selection]``: type of conversion to perform

Outputs
-------

- ``Output[Vector]``: the resulting layer

See also
---------


Console usage
-------------


::

processing.runalg('qgis:convertgeometrytype', layername, newtype, savename)

Available options for selection parameters:

newtype(New Geometry Type)
0 - Centroids
1 - Nodes
2 - Linestrings
3 - Multilinestrings
4 - Polygons
@@ -0,0 +1,35 @@
CONVEX HULL
===========

Description
-----------

Parameters
----------

- ``Input layer[Vector]``:
- ``Field[TableField]``:
- ``Method[Selection]``:

Outputs
-------

- ``Convex hull[Vector]``:

See also
---------


Console usage
-------------


::

processing.runalg('qgis:convexhull', input, field, method, output)

Available options for selection parameters:

method(Method)
0 - Create single minimum convex hull
1 - Create convex hulls based on field
@@ -0,0 +1,30 @@
COUNT POINTS IN POLYGON
=======================

Description
-----------
This algorithm counts the number of points present in each feature of a polygons layer.

Parameters
----------

- ``Polygons[Vector]``:polygons layer
- ``Points[Vector]``:points layer
- ``Count field name[String]``:the name of the attribute table column containing the points number

Outputs
-------

- ``Result[Vector]``: resulting layer with the attribute table containing the new column of the points count.

See also
---------


Console usage
-------------


::

processing.runalg('qgis:countpointsinpolygon', polygons, points, field, output)
@@ -0,0 +1,33 @@
COUNT POINTS IN POLYGON(WEIGHTED)
=================================

Description
-----------
This algorithm counts the number of points in each feature of a polygons layer and calculates the mean of the selected field for
each feature of the polygons layer.
These values will be added to the attribute table of the resulting polygons layer.

Parameters
----------

- ``Polygons[Vector]``: polygons layer in input
- ``Points[Vector]``: points layer in input
- ``Weight field[TableField]``: weight field of the points attribute table
- ``Count field name[String]``: name of the column for the new weighted field

Outputs
-------

- ``Result[Vector]``: the resulting polygons layer

See also
---------
Count points in polygon algorithm

Console usage
-------------


::

processing.runalg('qgis:countpointsinpolygonweighted', polygons, points, weight, field, output)
@@ -0,0 +1,32 @@
COUNT UNIQUE POINTS IN POLYGON
==============================

Description
-----------
This algorithm counts the number of unique values of a points layer in a polygons one. The algorithm creates a new polygons
layer with an extra column in the attribute table containing the count of unique values for each feature.

Parameters
----------

- ``Polygons[Vector]``: polygons layer in input
- ``Points[Vector]``: points layer in input
- ``Class field[TableField]``: points layer column name of the unique value chosen
- ``Count field name[String]``: column name containging the count of unique values in the resulting polygons layer

Outputs
-------

- ``Result[Vector]``: the resulting polygons layer

See also
---------


Console usage
-------------


::

processing.runalg('qgis:countuniquepointsinpolygon', polygons, points, classfield, field, output)

0 comments on commit 15e9238

Please sign in to comment.