@seasketch/geoprocessing
Version:
Geoprocessing and reporting framework for SeaSketch 2.0
19 lines (18 loc) • 853 B
TypeScript
import { Sketch, SketchCollection, Polygon, Metric, MultiPolygon } from "../types/index.js";
import { Georaster } from "geoblaze";
interface OverlapRasterOptions {
/** Truncates results to 6 digits, defaults to true */
truncate?: boolean;
}
/**
* Returns sum of cells overlapping sketch with raster as a metric object
* If sketch collection, then calculate overlap for all child sketches also
*/
export declare function overlapRasterSum(
/** metricId value to assign to each measurement */
metricId: string,
/** Cloud-optimized geotiff to calculate overlap with, loaded via loadCog or geoblaze.parse() */
raster: Georaster,
/** single sketch or collection to calculate metrics for. */
sketch: Sketch<Polygon | MultiPolygon> | SketchCollection<Polygon | MultiPolygon>, options?: Partial<OverlapRasterOptions>): Promise<Metric[]>;
export {};