@seasketch/geoprocessing/dist/src/toolbox/overlapArea.test.js

Geoprocessing and reporting framework for SeaSketch 2.0

import { describe, test, expect } from "vitest";
import { firstMatchingMetric } from "../metrics/index.js";
import { overlapArea, overlapSubarea } from "./overlapArea.js";
import { area } from "@turf/turf";
import fix from "../testing/fixtures/squareSketches.js";
import { testWithinPerc } from "../testing/index.js";
import { ValidationError } from "../types/index.js";
describe("overlapArea", () => {
    test("function is present", () => {
        expect(typeof overlapArea).toBe("function");
    });
    test("outerArea", () => {
        expect(fix.twoByPolyArea).toBeCloseTo(49_447_340_364.086_09);
    });
    test("outerOuterArea", () => {
        expect(fix.fourByPolyArea).toBeCloseTo(197_668_873_521.434_88);
    });
    test("overlapArea - undefined sketch throws", async () => {
        expect(async () => await overlapArea("test", undefined, 500)).rejects.toThrow(ValidationError);
    });
    // sketch always assumed to be within outer boundary.  outerArea is passed as pre-calculated area avoiding need to compute it on the fly
    test("overlapArea overall - single polygon fully inside", async () => {
        const metrics = await overlapArea("test", fix.insideTwoByPolySketch, fix.twoByPolyArea);
        expect(metrics[0].value).toBeCloseTo(12_363_718_145.180_046);
        expect(metrics[1].value).toBeCloseTo(0.25); // takes up bottom left quadrant of outer
    });
    test("overlapSubarea - undefined sketch throws", async () => {
        expect(async () => await overlapSubarea("test", undefined, fix.twoByPoly)).rejects.toThrow(ValidationError);
    });
});
describe("overlapSubarea", () => {
    test("overlapSubarea - undefined subareaFeature returns zero value metrics", async () => {
        const metrics = await overlapSubarea("test", fix.insideTwoByPolySketch, undefined);
        expect(metrics.length).toBe(2);
        for (const m of metrics)
            expect(m.value).toEqual(0);
    });
    test("overlapSubarea intersect - single polygon fully inside", async () => {
        const metrics = await overlapSubarea("test", fix.insideTwoByPolySketch, fix.twoByPoly);
        expect(metrics[0].value).toBeCloseTo(12_363_718_145.180_046);
        expect(metrics[1].value).toBeCloseTo(0.25);
    });
    test("overlapSubarea difference - single polygon fully inside", async () => {
        const metrics = await overlapSubarea("test", fix.insideTwoByPolySketch, fix.twoByPoly, {
            operation: "difference",
            outerArea: fix.twoByPolyArea,
        });
        expect(metrics[0].value).toBeCloseTo(0);
        expect(metrics[1].value).toBeCloseTo(0);
    });
    test("overlapSubarea intersect - single polygon fully outside", async () => {
        const metrics = await overlapSubarea("test", fix.outsideTwoByPolyTopRightSketch, fix.twoByPoly);
        expect(metrics[0].value).toBeCloseTo(0);
        expect(metrics[1].value).toBeCloseTo(0);
    });
    test("overlapSubarea difference - single polygon fully outside outer, inside of outerOuter", async () => {
        const metrics = await overlapSubarea("test", fix.outsideTwoByPolyTopRightSketch, fix.twoByPoly, {
            operation: "difference",
            outerArea: fix.fourByPolyArea,
        });
        expect(metrics[0].value).toBeCloseTo(12_341_127_230.893_69);
        expect(metrics[1].value).toBeCloseTo(0.083_26); // should be 1 square of 16 in outerOuter
    });
    // sketch always assumed to be within outer boundary.  outerArea is passed as pre-calculated area avoiding need to compute it on the fly
    test("overlapArea - network", async () => {
        const metrics = await overlapArea("test", fix.sketchCollection, fix.fourByPolyArea);
        const collPercMetric = firstMatchingMetric(metrics, (m) => m.sketchId === "CCCC" && m.metricId === "testPerc");
        expect(collPercMetric.value).toBeCloseTo(0.25); // takes up 4 out of 16 squares of outerOuter
        const sketchPercMetrics = metrics.filter((m) => m.sketchId !== "CCCC" && m.metricId === "testPerc");
        expect(sketchPercMetrics.length).toBe(fix.sketchCollection.features.length);
    });
    test("overlapSubarea intersect - network, half inside and outside", async () => {
        const metrics = await overlapSubarea("test", fix.sketchCollection, fix.twoByPoly);
        expect(area(fix.sketchCollection)).toBe(fix.scArea);
        const collAreaMetric = firstMatchingMetric(metrics, (m) => m.sketchId === "CCCC" && m.metricId === "test");
        // Expect about half, but not exactly same as inside
        testWithinPerc(collAreaMetric.value, fix.scArea / 2, {
            withinPerc: 0.5,
        });
        const collAreaPercMetric = firstMatchingMetric(metrics, (m) => m.sketchId === "CCCC" && m.metricId === "testPerc");
        expect(collAreaPercMetric.value).toBeCloseTo(2 / 4); // 2 of 4 squares in outer
        const sketchPercMetrics = metrics.filter((m) => m.sketchId !== "CCCC");
        expect(sketchPercMetrics.length).toBe(fix.sketchCollection.features.length * 2); // 2 metrics per sketch
    });
    test("overlapSubarea difference - network, half inside and outside", async () => {
        const metrics = await overlapSubarea("test", fix.sketchCollection, fix.twoByPoly, {
            operation: "difference",
            outerArea: fix.fourByPolyArea,
        });
        const collAreaMetric = firstMatchingMetric(metrics, (m) => m.sketchId === "CCCC" && m.metricId === "test");
        // Expect about half, but not exactly same as inside
        testWithinPerc(collAreaMetric.value, fix.scArea / 2);
        const collAreaPercMetric = firstMatchingMetric(metrics, (m) => m.sketchId === "CCCC" && m.metricId === "testPerc");
        expect(collAreaPercMetric.value).toBeCloseTo(2 / 12); // 2 of 12 squares in outerOuter
        const sketchPercMetrics = metrics.filter((m) => m.sketchId !== "CCCC");
        expect(sketchPercMetrics.length).toBe(fix.sketchCollection.features.length * 2); // 2 metrics per sketch
    });
});
//# sourceMappingURL=overlapArea.test.js.map