Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wherobots.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns summary stats struct consisting of count, sum, mean, stddev, min, max for a given band in raster. If band is not specified then it defaults to 1.
If excludeNoDataValue is set true then it will only count pixels with value not equal to the nodata value of the raster. Set excludeNoDataValue to false to get count of all pixels in raster.
If the mentioned band index doesn’t exist, this will throw an IllegalArgumentException.

​
Signatures

RS_SummaryStatsAll(raster: Raster, band: Integer = 1, excludeNoDataValue: Boolean = true)

RS_SummaryStatsAll(raster: Raster, band: Integer = 1)

RS_SummaryStatsAll(raster: Raster)

​
Parameters

​
raster
Raster
required
The input raster.
​
band
Integer
default:"1"
The band index.
​
excludeNoDataValue
Boolean
default:"true"
Whether to exclude NoData pixels from the calculation.

​
Return type

A struct containing the result fields.

​
Examples

SELECT RS_SummaryStatsAll(RS_MakeEmptyRaster(2, 5, 5, 0, 0, 1, -1, 0, 0, 0), 1, false)

{25.0, 204.0, 8.16, 9.4678403028357, 0.0, 25.0}

SELECT RS_SummaryStatsAll(RS_MakeEmptyRaster(2, 5, 5, 0, 0, 1, -1, 0, 0, 0), 1)

{14.0, 204.0, 14.571428571428571, 11.509091348732502, 1.0, 25.0}