@seasketch/geoprocessing/dist/src/toolbox/overlapRasterClass.d.ts

Geoprocessing and reporting framework for SeaSketch 2.0

import { Polygon, Sketch, SketchCollection, Georaster, Metric, MetricDimension, MultiPolygon } from "../types/index.js";
/**
 * Calculates sum of overlap between sketches and a categorical raster with numeric values representing feature classes
 * If sketch collection, then calculate overlap for all child sketches also
 * @deprecated use rasterMetrics instead
 */
export declare function overlapRasterClass(
/** metricId value to assign to each measurement */
metricId: string, 
/** Cloud-optimized geotiff, loaded via loadCog or geoblaze.parse(), representing categorical data (multiple classes) */
raster: Georaster, 
/**
 * single sketch or collection.  If undefined will return sum by feature class for the whole raster.
 * Supports polygon or multipolygon.  Will remove overlap between sketches, but will not remove overlap within Multipolygon sketch
 */
sketch: Sketch<Polygon | MultiPolygon> | SketchCollection<Polygon | MultiPolygon> | undefined, 
/** Object mapping numeric category IDs (as strings e.g. "1") in the raster to their string names for display e.g. "Coral Reef" */
mapping: Record<string, string>, 
/** Dimension to assign category name when creating metrics, defaults to classId */
metricCategoryDimension?: MetricDimension): Promise<Metric[]>;