Merge pull request #31 from concord-consortium/NASAEARTH-26-robust-pin-lat-long

NASAEARTH-26 handle more cases of pin lat long values

Author: scytacki

playwright.config.ts

@@ -1,5 +1,6 @@
-import { PlaywrightCoverageOptions } from "@bgotink/playwright-coverage";
-import { defineConfig, devices, ReporterDescription } from "@playwright/test";
+import type { PlaywrightCoverageOptions } from "@bgotink/playwright-coverage";
+import type { ReporterDescription } from "@playwright/test";
+import { defineConfig, devices } from "@playwright/test";
 import path, { dirname } from "path";
 import { fileURLToPath } from "url";
 

src/models/geo-image.test.ts

@@ -0,0 +1,35 @@
+import { latLongToPixel } from "./geo-image";
+
+describe("latLongToPixel", () => {
+  it("should convert latitude and longitude to pixel coordinates", () => {
+    expect(latLongToPixel(800, 600, 0, 0))
+      .toEqual({ x: 400, y: 300 });
+    expect(latLongToPixel(800, 600, 45, 90))
+      .toEqual({ x: 600, y: 150 });
+    expect(latLongToPixel(800, 600, -45, -90))
+      .toEqual({ x: 200, y: 450 });
+  });
+
+  it("should handle coordinates on the edge of the normal range", () => {
+    expect(latLongToPixel(800, 600, 90, 180))
+      .toEqual({ x: 0, y: 0 });
+    expect(latLongToPixel(800, 600, -90, -180))
+      .toEqual({ x: 0, y: 599 });
+  });
+
+  it("should clamp latitude values outside the range", () => {
+    expect(latLongToPixel(800, 600, 100, 0))
+      .toEqual({ x: 400, y: 0 });
+    expect(latLongToPixel(800, 600, -100, 0))
+      .toEqual({ x: 400, y: 599 });
+  });
+
+  it("should normalize longitude values outside the range", () => {
+    expect(latLongToPixel(800, 600, 0, -160))
+      .toEqual({ x: 44, y: 300 });
+    expect(latLongToPixel(800, 600, 0, 200))
+      .toEqual({ x: 44, y: 300 });
+    expect(latLongToPixel(800, 600, 0, -520))
+      .toEqual({ x: 44, y: 300 });
+  });
+});

src/models/geo-image.ts

@@ -19,6 +19,45 @@ interface PixelCoordinate {
   y: number;
 }
 
+/**
+ * Converts latitude and longitude to pixel coordinates.
+ * @param imageWidth - The width of the image in pixels.
+ * @param imageHeight - The height of the image in pixels.
+ * @param lat - The latitude to convert (-90 to 90), values outside this range will be clamped.
+ * @param long - The longitude to convert, this will be normalized between -180 to 180.
+ * @returns The pixel coordinates corresponding to the latitude and longitude.
+ */
+export function latLongToPixel(
+  imageWidth: number, imageHeight: number, lat: number, long: number
+): PixelCoordinate {
+  // Validate image dimensions
+  if (imageWidth <= 0 || imageHeight <= 0) {
+    throw new Error("Invalid image dimensions");
+  }
+
+  // Shift longitude so -180 is 0 and 180 is 360.
+  const shiftedLong = long - kLongitudeMin;
+  // Normalize longitude so it is always in the range [0, 360)
+  const normalizedLong = ((shiftedLong % kLongitudeRange) + kLongitudeRange) % kLongitudeRange;
+
+  // Shift latitude so -90 is 0 and 90 is 180
+  const shiftedLat = lat - kLatitudeMin;
+
+  // Convert to percentages
+  const xPercent = normalizedLong / kLongitudeRange;
+  const yPercent = shiftedLat / kLatitudeRange;
+
+  // Convert to pixel coordinates
+  // Note: y is inverted because image coordinates go top-down
+  // The y value is clamped so it always a valid pixel value
+  // The x value is normalized above so it will always be a valid pixel value
+  return {
+    x: Math.floor(xPercent * imageWidth),
+    y: Math.min(Math.max(Math.floor((1 - yPercent) * imageHeight), 0), imageHeight - 1),
+  };
+}
+
+
 /**
  * GeoImage represents a single geographic image and provides methods to process it.
  * Each instance is tied to a specific image and should be disposed after use.
@@ -81,28 +120,12 @@ export class GeoImage {
       throw new Error("Image not loaded");
     }
 
-    const imageWidth = this.img.naturalWidth;
-    const imageHeight = this.img.naturalHeight;
-
-    // Validate image dimensions
-    if (imageWidth <= 0 || imageHeight <= 0) {
-      throw new Error("Invalid image dimensions");
-    }
-
-    // Normalize longitude from -180...180 to 0...360
-    const normalizedLong = long - kLongitudeMin;
-    // Normalize latitude from -90...90 to 0...180
-    const normalizedLat = lat - kLatitudeMin;
-    // Convert to percentages
-    const xPercent = normalizedLong / kLongitudeRange;
-    const yPercent = normalizedLat / kLatitudeRange;
-
-    // Convert to pixel coordinates
-    // Note: y is inverted because image coordinates go top-down
-    return {
-      x: Math.floor(xPercent * imageWidth),
-      y: Math.floor((1 - yPercent) * imageHeight)
-    };
+    return latLongToPixel(
+      this.img.naturalWidth,
+      this.img.naturalHeight,
+      lat,
+      long
+    );
   }
 
   /**

src/models/plugin-state.ts

@@ -28,6 +28,22 @@ export function pinLabel(pin: IMapPin) {
   return `${pin.lat.toFixed(2)}, ${pin.long.toFixed(2)}`;
 }
 
+/**
+ * Return NaN for invalid values, otherwise return the numeric value.
+ *
+ * @param value
+ * @returns
+ */
+export function numericValue(value: string | number | null | undefined): number {
+  if (typeof value === "number") {
+    return value;
+  }
+  if (typeof value === "string") {
+    return parseFloat(value);
+  }
+  return NaN;
+}
+
 class PluginState {
   neoDataset: NeoDataset | undefined;
   neoDatasetName = "";
@@ -72,15 +88,18 @@ class PluginState {
     const pinResult = yield(getAllItems(kPinDataContextName));
     if (pinResult.success) {
       const pinData = pinResult.values as any;
-      this.pins = pinData.map((pin: any) => {
-        const values = pin.values;
-        return {
-          color: values[kPinColorAttributeName],
-          id: pin.id,
-          lat: values[kPinLatAttributeName],
-          long: values[kPinLongAttributeName]
-        };
-      });
+      this.pins = pinData
+        .map((pin: any) => {
+          const values = pin.values;
+          return {
+            color: values[kPinColorAttributeName],
+            id: pin.id,
+            // Handle missing or invalid
+            lat: numericValue(values[kPinLatAttributeName]),
+            long: numericValue(values[kPinLongAttributeName])
+          };
+        })
+        .filter((pin: IMapPin) => !isNaN(pin.lat) && !isNaN(pin.long));
     }
   }
 
@@ -165,8 +184,8 @@ export async function initializeNeoPlugin() {
             const pinCase = (pinValues as any).case;
             return {
               id: pinCase.id,
-              lat: pinCase.values.pinLat,
-              long: pinCase.values.pinLong,
+              lat: numericValue(pinCase.values.pinLat),
+              long: numericValue(pinCase.values.pinLong),
               color: pinCase.values.pinColor,
             };
           }