From fdd0083584674a737e99772d60c103a2d8e4367d Mon Sep 17 00:00:00 2001
From: David Manthey <david.manthey@kitware.com>
Date: Wed, 7 Sep 2022 16:59:04 -0400
Subject: [PATCH] Improve scaled overlays.

Overlay annotations at scales other than the base image could show
eccentric tile layers.
---
 .../views/imageViewerWidget/geojs.js          | 50 +++++++++++++++----
 1 file changed, 39 insertions(+), 11 deletions(-)

diff --git a/girder_annotation/girder_large_image_annotation/web_client/views/imageViewerWidget/geojs.js b/girder_annotation/girder_large_image_annotation/web_client/views/imageViewerWidget/geojs.js
index a45ea0b05..042f16077 100644
--- a/girder_annotation/girder_large_image_annotation/web_client/views/imageViewerWidget/geojs.js
+++ b/girder_annotation/girder_large_image_annotation/web_client/views/imageViewerWidget/geojs.js
@@ -88,12 +88,22 @@ var GeojsImageViewerWidgetExtension = function (viewer) {
         _getOverlayTransformProjString: function (overlay) {
             const transformInfo = overlay.transform || {};
             let xOffset = transformInfo.xoffset || 0;
-            const yOffset = transformInfo.yoffset || 0;
+            let yOffset = transformInfo.yoffset || 0;
             const matrix = transformInfo.matrix || [[1, 0], [0, 1]];
-            const s11 = matrix[0][0];
-            const s12 = matrix[0][1];
-            const s21 = matrix[1][0];
-            const s22 = matrix[1][1];
+            let s11 = matrix[0][0];
+            let s12 = matrix[0][1];
+            let s21 = matrix[1][0];
+            let s22 = matrix[1][1];
+
+            const scale = 2 ** this._getOverlayRelativeScale(overlay);
+            if (scale && scale !== 1) {
+                s11 /= scale;
+                s12 /= scale;
+                s21 /= scale;
+                s22 /= scale;
+                xOffset *= scale;
+                yOffset *= scale;
+            }
 
             let projString = '+proj=longlat +axis=enu';
             if (xOffset !== 0) {
@@ -112,6 +122,25 @@ var GeojsImageViewerWidgetExtension = function (viewer) {
             return projString;
         },
 
+        /**
+         * Given an overlay with a transform matrix, compute an approximate
+         * scale compaared to the base.
+         *
+         * @param {object} overlay The overlay annotation record.
+         * @returns {number} The approximate scale as an integer power of two.
+         */
+        _getOverlayRelativeScale: function (overlay) {
+            const transformInfo = overlay.transform || {};
+            const matrix = transformInfo.matrix || [[1, 0], [0, 1]];
+            const s11 = matrix[0][0];
+            const s12 = matrix[0][1];
+            const s21 = matrix[1][0];
+            const s22 = matrix[1][1];
+
+            let scale = Math.sqrt(Math.abs(s11 * s22 - s12 * s21)) || 1;
+            return Math.floor(Math.log2(scale));
+        },
+
         /**
          * @returns The number of currently drawn overlay elements across
          * all annotations.
@@ -136,11 +165,7 @@ var GeojsImageViewerWidgetExtension = function (viewer) {
         _addPixelmapLayerParams(layerParams, pixelmapElement, levelDifference) {
             // For pixelmap overlays, there are additional parameters to set
             layerParams.keepLower = false;
-            if (levelDifference !== 0) {
-                layerParams.url = (x, y, z) => 'api/v1/item/' + pixelmapElement.girderId + `/tiles/zxy/${z - levelDifference}/${x}/${y}?encoding=PNG`;
-            } else {
-                layerParams.url = layerParams.url + '?encoding=PNG';
-            }
+            layerParams.url = (x, y, z) => 'api/v1/item/' + pixelmapElement.girderId + `/tiles/zxy/${z - levelDifference}/${x}/${y}?encoding=PNG`;
             let pixelmapData = pixelmapElement.values;
             if (pixelmapElement.boundaries) {
                 let valuesWithBoundaries = new Array(pixelmapData.length * 2);
@@ -193,7 +218,10 @@ var GeojsImageViewerWidgetExtension = function (viewer) {
             params.layer.opacity = overlay.opacity || 1;
             params.layer.opacity *= this._globalAnnotationOpacity;
 
-            const levelDifference = this.levels - overlayImageMetadata.levels;
+            let levelDifference = this.levels - overlayImageMetadata.levels;
+
+            levelDifference -= this._getOverlayRelativeScale(overlay);
+
             if (this.levels !== overlayImageMetadata.levels) {
                 params.layer.url = (x, y, z) => 'api/v1/item/' + overlayImageId + `/tiles/zxy/${z - levelDifference}/${x}/${y}`;
                 params.layer.minLevel = levelDifference;