Skip to main content
Returns a struct of statistic values, where each statistic is computed over a region defined by the zone geometry. The struct has the following schema: The allTouched parameter (Since v1.7.1) determines how pixels are selected:
  • When true, any pixel touched by the geometry will be included.
  • When false (default), only pixels whose centroid intersects with the geometry will be included.
RS_ZonalStatsAll_allTouched
  • count: Count of the pixels.
  • sum: Sum of the pixel values.
  • mean: Arithmetic mean.
  • median: Median.
  • mode: Mode.
  • stddev: Standard deviation.
  • variance: Variance.
  • min: Minimum value of the zone.
  • max: Maximum value of the zone.
If the coordinate reference system (CRS) of the input zone geometry differs from that of the raster, then zone will be transformed to match the CRS of the raster before computation.The following conditions will throw an IllegalArgumentException if they are not met:
  • The provided raster and zone geometry should intersect when lenient parameter is set to false.
  • The option provided to statType should be valid.
lenient parameter is set to true by default. The function will return null if the raster and zone geometry do not intersect.
RS_ZonalStatsAll

​
Signatures

RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Boolean, excludeNodata: Boolean, lenient: Boolean)

RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Boolean, excludeNodata: Boolean)

RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Boolean)

RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer)

RS_ZonalStatsAll(raster: Raster, zone: Geometry)

​
Parameters

​
raster
Raster
required
The input raster.
​
zone
Geometry
required
The zone value.
​
band
Integer
The band index.
​
allTouched
Boolean
The all touched value.
​
excludeNodata
Boolean
The exclude nodata value.
​
lenient
Boolean
The lenient value.

​
Return type

A struct containing the result fields.

​
Examples

RS_ZonalStatsAll(rast1, geom1, 1, true, false)

{184792.0, 1.0690406E7, 57.851021689230684, 0.0, 0.0, 92.13277429243035, 8488.448098819916, 0.0, 255.0}

RS_ZonalStatsAll(rast2, geom2, 1, false, true)

{14184.0, 3213526.0, 226.55992667794473, 255.0, 255.0, 74.87605357255357, 5606.423398599913, 1.0, 255.0}