Improve sinuosity help

Added explanation what this new expression actually calculates, based on help coded in /src/core/geometry/qgscurve.h
Also streamlined noted requirement that needs to be applied to a curve.
This commit is contained in:
Martin Pergler 2021-07-29 06:40:18 -04:00 committed by Nyall Dawson
parent 473ac474a3
commit 1d845c8a6c

View File

@ -2,9 +2,9 @@
"name": "sinuosity", "name": "sinuosity",
"type": "function", "type": "function",
"groups": ["GeometryGroup"], "groups": ["GeometryGroup"],
"description": "Returns the sinuosity of a geometry. The geometry must be a curve (circularstring, linestring).", "description": "Returns the sinuosity of a curve, which is the ratio of the curve length to the straight (2D) distance between its endpoints.",
"arguments": [ "arguments": [
{"arg":"geometry", "description": "The geometry."} {"arg":"geometry", "description": "Curve (circularstring, linestring) whose sinuosity to evaluate"}
], ],
"examples": [ "examples": [
{ "expression":"round(sinuosity(geom_from_wkt('LINESTRING(2 0, 2 2, 3 2, 3 3)')), 3)", "returns":"1.265"}, { "expression":"round(sinuosity(geom_from_wkt('LINESTRING(2 0, 2 2, 3 2, 3 3)')), 3)", "returns":"1.265"},