QGIS/resources/function_help/json/raster_statistic

25 lines
1.0 KiB
Plaintext

{
"name": "raster_statistic",
"type": "function",
"groups": ["Rasters"],
"description": "Returns statistics from a raster layer.",
"arguments": [{
"arg": "layer",
"description": "a string, representing either a raster layer name or layer ID"
}, {
"arg": "band",
"description": "integer representing the band number from the raster layer, starting at 1"
}, {
"arg": "property",
"description": "a string corresponding to the property to return. Valid options are:<br /><ul><li>min: minimum value</li><li>max: maximum value</li><li>avg: average (mean) value</li><li>stdev: standard deviation of values</li><li>range: range of values (max - min)</li><li>sum: sum of all values from raster</li></ul>"
}],
"examples": [{
"expression": "raster_statistic('lc',1,'avg')",
"returns": "Average value from band 1 from 'lc' raster layer"
}, {
"expression": "raster_statistic('ac2010',3,'min')",
"returns": "Minimum value from band 3 from 'ac2010' raster layer"
}],
"tags": ["raster", "statistics"]
}