Adds categoryMetricProperty

seasketch · Mar 13, 2024 · a9cd9d6 · a9cd9d6
1 parent 6c03c7e
commit a9cd9d6
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 23 deletions.
diff --git a/packages/geoprocessing/src/toolbox/geoblaze/rasterStats.ts b/packages/geoprocessing/src/toolbox/geoblaze/rasterStats.ts
@@ -3,12 +3,12 @@ import {
   GEOBLAZE_RASTER_STATS,
   Sketch,
   SketchCollection,
+  MetricDimension,
 } from "../../types";
 import { Feature, MultiPolygon, FeatureCollection } from "@turf/helpers";
 import geoblaze, { Georaster } from "geoblaze";
 import { StatsObject, CalcStatsOptions } from "../../types/geoblaze";
 import { toRasterProjection, defaultStatValues } from "./geoblaze";
-import { forEach } from "lodash";
 
 /**
  * options accepted by rasterStats
@@ -25,9 +25,12 @@ export interface RasterStatsOptions extends CalcStatsOptions {
   filterFn?: (cellValue: number) => boolean;
   /** Optional number of bands in the raster, defaults to 1, used to initialize zero values */
   numBands?: number;
-  /** For categorical rasters, category is equal to the classId in metricGroup */
+  /** If categorical raster, set to true */
   categorical?: boolean;
-  categoryClassValues?: string[];
+  /** If categorical raster, metric property name that categories are organized. Defaults to classId */
+  categoryMetricProperty?: MetricDimension;
+  /** If categorical raster, array of values to create metrics for */
+  categoryMetricValues?: string[];
 }
 
 /**
@@ -46,7 +49,8 @@ export const rasterStats = async (
     feature,
     filterFn,
     categorical = false,
-    categoryClassValues,
+    categoryMetricProperty = "classId",
+    categoryMetricValues,
     ...restCalcOptions
   } = options;
 
@@ -84,10 +88,10 @@ export const rasterStats = async (
           })
         ).map((h: any) => {
           let hist = {};
-          if (!categoryClassValues || categoryClassValues.length === 0) {
+          if (!categoryMetricValues || categoryMetricValues.length === 0) {
             return { histogram: h };
           } else {
-            categoryClassValues.forEach((c) => (hist[c] = h[c] ?? 0));
+            categoryMetricValues.forEach((c) => (hist[c] = h[c] ?? 0));
             return { histogram: hist };
           }
         })

diff --git a/packages/geoprocessing/src/toolbox/geoblaze/rasterStatsToMetrics.ts b/packages/geoprocessing/src/toolbox/geoblaze/rasterStatsToMetrics.ts
@@ -59,7 +59,7 @@ export const rasterStatsToMetrics = (
           ? categoryClassValues.forEach((category) => {
               metrics.push(
                 createMetric({
-                  metricId: "valid" ?? `${metricIdPrefix}valid`,
+                  metricId: metricIdPrefix ? `${metricIdPrefix}valid` : "valid",
                   value: truncate
                     ? roundDecimal(value[category], 6, {
                         keepSmallValues: true,
@@ -74,7 +74,7 @@ export const rasterStatsToMetrics = (
           : Object.keys(value).forEach((category) => {
               metrics.push(
                 createMetric({
-                  metricId: "valid" ?? `${metricIdPrefix}valid`,
+                  metricId: metricIdPrefix ? `${metricIdPrefix}valid` : "valid",
                   value: truncate
                     ? roundDecimal(value[category], 6, {
                         keepSmallValues: true,

diff --git a/packages/geoprocessing/src/toolbox/rasterMetrics.test.ts b/packages/geoprocessing/src/toolbox/rasterMetrics.test.ts
@@ -80,9 +80,10 @@ describe("rasterMetrics tests", () => {
     );
     const metrics = await rasterMetrics(raster, {
       categorical: true,
-      categoryClassValues: ["1"],
+      categoryMetricValues: ["1"],
     });
     expect(metrics.length).toBe(1);
+    expect(metrics[0].classId).toBe("1");
     expect(metrics[0].value).toBe(2);
     expect(metrics[0].metricId).toEqual("valid");
   });
@@ -107,7 +108,7 @@ describe("rasterMetrics tests", () => {
     const metrics = await rasterMetrics(raster, {
       feature: fix.topRightPoly,
       categorical: true,
-      categoryClassValues: ["1"],
+      categoryMetricValues: ["1"],
     });
     expect(metrics.length).toBe(1);
     expect(metrics[0].value).toBe(0);

diff --git a/packages/geoprocessing/src/toolbox/rasterMetrics.ts b/packages/geoprocessing/src/toolbox/rasterMetrics.ts
@@ -6,7 +6,6 @@ import { rasterStatsToMetrics } from "./geoblaze/rasterStatsToMetrics";
 
 // @ts-ignore
 import { Georaster } from "geoblaze";
-import { createMetric } from "../metrics";
 
 interface OverlapRasterOptions extends RasterStatsOptions {
   /** Optional metricId to be assigned.  Don't use if you are calculating more than one stat because you won't be able to tell them apart */
@@ -20,10 +19,12 @@ interface OverlapRasterOptions extends RasterStatsOptions {
   /** If multi-band raster, object mapping band number (starting with 0 index) to unique ID value eg. { 0: 'mangroves', 1: 'coral' }.  Defaults to 'band 1', 'band 2'  */
   bandMetricValues?: string[];
   includeChildMetrics?: boolean;
-  /** If categorical raster, get categoryClassValues (in metric group as classIds) from raster histogram */
+  /** If categorical raster, set to true */
   categorical?: boolean;
+  /** If categorical raster, metric property name that categories are organized. Defaults to classId */
   categoryMetricProperty?: MetricDimension;
-  categoryClassValues?: string[];
+  /** If categorical raster, array of values to create metrics for */
+  categoryMetricValues?: string[];
 }
 
 /**
@@ -43,8 +44,8 @@ export async function rasterMetrics(
     bandMetricValues,
     includeChildMetrics = true,
     categorical = false,
-    categoryMetricProperty,
-    categoryClassValues,
+    categoryMetricProperty = "classId",
+    categoryMetricValues,
     ...statOptions
   } = options;
   let metrics: Metric[] = [];
@@ -64,7 +65,8 @@ export async function rasterMetrics(
             feature: curSketch,
             numBands,
             categorical,
-            categoryClassValues,
+            categoryMetricProperty,
+            categoryMetricValues,
             ...(statOptions ?? {}),
           })
         );
@@ -95,7 +97,7 @@ export async function rasterMetrics(
           bandMetricValues,
           categorical,
           categoryMetricProperty,
-          categoryMetricValues: categoryClassValues,
+          categoryMetricValues,
         });
         metrics = metrics.concat(curMetrics);
       });
@@ -107,7 +109,8 @@ export async function rasterMetrics(
         feature: options?.feature,
         numBands,
         categorical,
-        categoryClassValues,
+        categoryMetricProperty,
+        categoryMetricValues,
         ...(statOptions ?? {}),
       });
 
@@ -133,7 +136,7 @@ export async function rasterMetrics(
         bandMetricValues,
         categorical,
         categoryMetricProperty,
-        categoryMetricValues: categoryClassValues,
+        categoryMetricValues,
       });
       metrics = metrics.concat(collMetrics);
     }
@@ -142,10 +145,10 @@ export async function rasterMetrics(
     const wholeStats = await rasterStats(raster, {
       numBands,
       categorical,
-      categoryClassValues,
+      categoryMetricProperty,
+      categoryMetricValues,
       ...(statOptions ?? {}),
     });
-    console.log(wholeStats);
 
     const wholeMetrics = rasterStatsToMetrics(wholeStats, {
       metricId,
@@ -154,7 +157,7 @@ export async function rasterMetrics(
       bandMetricValues,
       categorical,
       categoryMetricProperty,
-      categoryMetricValues: categoryClassValues,
+      categoryMetricValues,
     });
     metrics = metrics.concat(wholeMetrics);
   }

diff --git a/packages/geoprocessing/src/types/geoblaze.ts b/packages/geoprocessing/src/types/geoblaze.ts
@@ -27,7 +27,7 @@ export const GEOBLAZE_RASTER_STATS: ReadonlyArray<string> = [
 export type GEOBLAZE_RASTER_STAT = typeof GEOBLAZE_RASTER_STATS[number];
 
 /** Additional raster stats calculated by geoprocessing library */
-export const EXTRA_RASTER_STATS: ReadonlyArray<string> = ["area"];
+export const EXTRA_RASTER_STATS: ReadonlyArray<string> = ["area", "histogram"];
 export type EXTRA_RASTER_STAT = typeof EXTRA_RASTER_STATS[number];
 
 /** Combined raster stats supported by geoprocessing library */