updated docs

GeoTIFF · Aug 5, 2024 · 24e18ea · 24e18ea
1 parent baee284
commit 24e18ea
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/sum/index.js b/src/sum/index.js
@@ -27,6 +27,11 @@ import stat from "../stat";
  * const results = await geoblaze.sum(elevation_url, geometry, value => value >= 0);
  * // results is sum of all interesecting pixels at or above sea level
  * [2131]
+ *
+ * const population_url = "https://example.org/population.tif";
+ * const results = await geoblaze.sum(population_url, geometry, undefined, { vrm: [100, 100], rescale: true });
+ * // results is the estimated number of people living within a geometry after resampling pixels (dividing 100 times horizontally then vertically)
+ * [3154.25425]
  */
 export default function sum(georaster, geometry, test, { rescale, vrm } = {}) {
   return stat(georaster, geometry, "sum", test, { rescale, vrm });