@aics/vole-app 2.15.0 → 3.1.2

package/es/aics-image-viewer/shared/utils/controlPointsToLut.js

@@ -1,20 +1,30 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
 function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
 function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-import { Lut, remapControlPoints } from "@aics/vole-core";
+import { Lut } from "@aics/vole-core";
 import { LUT_MAX_PERCENTILE, LUT_MIN_PERCENTILE, TFEDITOR_DEFAULT_COLOR, TFEDITOR_MAX_BIN } from "../constants";
 import { findFirstChannelMatch } from "./viewerChannelSettings";
 
-// @param {Object[]} controlPoints - array of {x:number, opacity:number, color:string}
-// @return {Uint8Array} array of length 256*4 representing the rgba values of the gradient
-export function controlPointsToLut(controlPoints) {
+/**
+ * @param {Object[]} controlPoints - array of `{x:number, opacity:number,
+ * color:string}`, where `x` is a histogram bin index.
+ * @returns {Uint8Array} array of length 256*4 representing the rgba values of
+ * the gradient
+ */
+export function binIndexedControlPointsToLut(controlPoints) {
   var lut = new Lut().createFromControlPoints(controlPoints);
   return lut;
 }
@@ -77,19 +87,25 @@ function parseLutValue(value, histogram) {
  * ```
  */
 export function parseLutFromSettings(histogram, initSettings) {
+  var _initSettings$intensi, _initSettings$intensi2;
   // TODO: Consider minimizing the types/classes this function is interacting
   // with, since it is only using `initSettings.lut` and the returned Lut is a
   // wrapper around the control point array, e.g.
   // `parseControlPointsFromLutParam(histogram: Histogram, lutParam: [string,
   // string] | undefined): ControlPoint[] | undefined`
-  if (initSettings.lut === undefined || initSettings.lut.length !== 2) {
+
+  // There are two possible locations for the LUT settings, due to legacy
+  // reasons. `initSettings.lut` is deprecated in favor of
+  // `initSettings.intensity.lut`.
+  var settingsLut = (_initSettings$intensi = (_initSettings$intensi2 = initSettings.intensity) === null || _initSettings$intensi2 === void 0 ? void 0 : _initSettings$intensi2.lut) !== null && _initSettings$intensi !== void 0 ? _initSettings$intensi : initSettings.lut;
+  if (settingsLut === undefined || settingsLut.length !== 2) {
     return undefined;
   }
   var lutValues;
-  if (initSettings.lut[0] === "autoij" || initSettings.lut[1] === "autoij") {
+  if (settingsLut[0] === "autoij" || settingsLut[1] === "autoij") {
     lutValues = histogram.findAutoIJBins();
   } else {
-    lutValues = [parseLutValue(initSettings.lut[0], histogram), parseLutValue(initSettings.lut[1], histogram)];
+    lutValues = [parseLutValue(settingsLut[0], histogram), parseLutValue(settingsLut[1], histogram)];
   }
   if (!Number.isFinite(lutValues[0]) || !Number.isFinite(lutValues[1])) {
     return undefined;
@@ -128,7 +144,7 @@ export function parseLutFromSettings(histogram, initSettings) {
  * to the volume; otherwise, the ramp will be applied.
  */
 export function initializeLut(aimg, channelIndex, channelSettings) {
-  var _initSettings$control;
+  var _initSettings$intensi3, _initSettings$intensi4;
   var histogram = aimg.getHistogram(channelIndex);
   var defaultLut = getDefaultLut(histogram);
   var ramp = [];
@@ -137,15 +153,42 @@ export function initializeLut(aimg, channelIndex, channelSettings) {
   var name = aimg.channelNames[channelIndex];
   var initSettings = channelSettings && findFirstChannelMatch(name, channelIndex, channelSettings);
 
-  // Attempt to load a LUT from the settings, which will be used to initialize the control points and ramp
-  if (initSettings && initSettings.lut) {
+  // Attempt to load a LUT from the settings, which will be used as a fallback
+  // to initialize the control points and ramp.
+  if (initSettings) {
     var _parseLutFromSettings;
     lut = (_parseLutFromSettings = parseLutFromSettings(histogram, initSettings)) !== null && _parseLutFromSettings !== void 0 ? _parseLutFromSettings : defaultLut;
   }
-  // Initialize the control points + ramp using the LUT.
-  // Optionally, override the LUT's control points with the provided control points and/or ramp.
-  controlPoints = (_initSettings$control = initSettings === null || initSettings === void 0 ? void 0 : initSettings.controlPoints) !== null && _initSettings$control !== void 0 ? _initSettings$control : _toConsumableArray(lut.controlPoints);
-  ramp = initSettings !== null && initSettings !== void 0 && initSettings.ramp ? rampToControlPoints(initSettings.ramp) : _toConsumableArray(lut.controlPoints);
+
+  // Use raw intensity values for control points or ramp if provided in the
+  // settings. Otherwise, get default values from the LUT by remapping
+  // from histogram bin indices.
+  if (initSettings !== null && initSettings !== void 0 && (_initSettings$intensi3 = initSettings.intensity) !== null && _initSettings$intensi3 !== void 0 && _initSettings$intensi3.controlPoints) {
+    // Raw intensity values can be used directly.
+    controlPoints = initSettings.intensity.controlPoints;
+  } else {
+    var _initSettings$control;
+    // No provided value; use histogram to convert from bin index to raw
+    // intensity values.
+    var binIndexedControlPoints = (_initSettings$control = initSettings === null || initSettings === void 0 ? void 0 : initSettings.controlPoints) !== null && _initSettings$control !== void 0 ? _initSettings$control : _toConsumableArray(lut.controlPoints);
+    controlPoints = binIndexedControlPoints.map(function (cp) {
+      return _objectSpread(_objectSpread({}, cp), {}, {
+        x: histogram.getValueFromBinIndex(cp.x)
+      });
+    });
+  }
+
+  // Initialize the ramp
+  if (initSettings !== null && initSettings !== void 0 && (_initSettings$intensi4 = initSettings.intensity) !== null && _initSettings$intensi4 !== void 0 && _initSettings$intensi4.ramp) {
+    ramp = rampToControlPoints(initSettings.intensity.ramp);
+  } else {
+    var binIndexedRamp = initSettings !== null && initSettings !== void 0 && initSettings.ramp ? rampToControlPoints(initSettings.ramp) : _toConsumableArray(lut.controlPoints);
+    ramp = binIndexedRamp.map(function (cp) {
+      return _objectSpread(_objectSpread({}, cp), {}, {
+        x: histogram.getValueFromBinIndex(cp.x)
+      });
+    });
+  }
 
   // Apply whatever lut is currently visible
   var visibleLut;
@@ -198,14 +241,4 @@ export function rampToControlPoints(_ref) {
     opacity: 1,
     color: TFEDITOR_DEFAULT_COLOR
   }];
-}
-
-/** Remaps an array of control points from an old range (as a 2-tuple) to a new one (extracted from a `Channel`) */
-export function remapControlPointsForChannel(controlPoints, oldRange, _ref3) {
-  var rawMin = _ref3.rawMin,
-    rawMax = _ref3.rawMax;
-  if (oldRange === undefined) {
-    return controlPoints;
-  }
-  return remapControlPoints(controlPoints, oldRange[0], oldRange[1], rawMin, rawMax);
 }

package/es/aics-image-viewer/shared/utils/sceneStore.js

@@ -1,4 +1,12 @@
-function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function define(t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == _typeof(h) && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function value(t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator["return"] && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(_typeof(e) + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function reset(e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function stop() { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function dispatchException(e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function abrupt(t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function complete(t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function finish(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, "catch": function _catch(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw Error("illegal catch attempt"); }, delegateYield: function delegateYield(e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; }
+function _regeneratorRuntime() { "use strict"; var r = _regenerator(), e = r.m(_regeneratorRuntime), t = (Object.getPrototypeOf ? Object.getPrototypeOf(e) : e.__proto__).constructor; function n(r) { var e = "function" == typeof r && r.constructor; return !!e && (e === t || "GeneratorFunction" === (e.displayName || e.name)); } var o = { "throw": 1, "return": 2, "break": 3, "continue": 3 }; function a(r) { var e, t; return function (n) { e || (e = { stop: function stop() { return t(n.a, 2); }, "catch": function _catch() { return n.v; }, abrupt: function abrupt(r, e) { return t(n.a, o[r], e); }, delegateYield: function delegateYield(r, o, a) { return e.resultName = o, t(n.d, _regeneratorValues(r), a); }, finish: function finish(r) { return t(n.f, r); } }, t = function t(r, _t, o) { n.p = e.prev, n.n = e.next; try { return r(_t, o); } finally { e.next = n.n; } }), e.resultName && (e[e.resultName] = n.v, e.resultName = void 0), e.sent = n.v, e.next = n.n; try { return r.call(this, e); } finally { n.p = e.prev, n.n = e.next; } }; } return (_regeneratorRuntime = function _regeneratorRuntime() { return { wrap: function wrap(e, t, n, o) { return r.w(a(e), t, n, o && o.reverse()); }, isGeneratorFunction: n, mark: r.m, awrap: function awrap(r, e) { return new _OverloadYield(r, e); }, AsyncIterator: _regeneratorAsyncIterator, async: function async(r, e, t, o, u) { return (n(e) ? _regeneratorAsyncGen : _regeneratorAsync)(a(r), e, t, o, u); }, keys: _regeneratorKeys, values: _regeneratorValues }; })(); }
+function _regeneratorValues(e) { if (null != e) { var t = e["function" == typeof Symbol && Symbol.iterator || "@@iterator"], r = 0; if (t) return t.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) return { next: function next() { return e && r >= e.length && (e = void 0), { value: e && e[r++], done: !e }; } }; } throw new TypeError(_typeof(e) + " is not iterable"); }
+function _regeneratorKeys(e) { var n = Object(e), r = []; for (var t in n) r.unshift(t); return function e() { for (; r.length;) if ((t = r.pop()) in n) return e.value = t, e.done = !1, e; return e.done = !0, e; }; }
+function _regeneratorAsync(n, e, r, t, o) { var a = _regeneratorAsyncGen(n, e, r, t, o); return a.next().then(function (n) { return n.done ? n.value : a.next(); }); }
+function _regeneratorAsyncGen(r, e, t, o, n) { return new _regeneratorAsyncIterator(_regenerator().w(r, e, t, o), n || Promise); }
+function _regeneratorAsyncIterator(t, e) { function n(r, o, i, f) { try { var c = t[r](o), u = c.value; return u instanceof _OverloadYield ? e.resolve(u.v).then(function (t) { n("next", t, i, f); }, function (t) { n("throw", t, i, f); }) : e.resolve(u).then(function (t) { c.value = t, i(c); }, function (t) { return n("throw", t, i, f); }); } catch (t) { f(t); } } var r; this.next || (_regeneratorDefine2(_regeneratorAsyncIterator.prototype), _regeneratorDefine2(_regeneratorAsyncIterator.prototype, "function" == typeof Symbol && Symbol.asyncIterator || "@asyncIterator", function () { return this; })), _regeneratorDefine2(this, "_invoke", function (t, o, i) { function f() { return new e(function (e, r) { n(t, i, e, r); }); } return r = r ? r.then(f, f) : f(); }, !0); }
+function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
+function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
+function _OverloadYield(e, d) { this.v = e, this.k = d; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
 function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
@@ -68,7 +76,8 @@ var SceneStore = /*#__PURE__*/function () {
   }, {
     key: "loadScene",
     value: function () {
-      var _loadScene = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2(scene, image, loadSpec, onChannelLoaded) {
+      var _loadScene = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2(scene, image, loadSpec, options) {
+        var _options$onCreateScen;
         var loader, spec;
         return _regeneratorRuntime().wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
@@ -83,8 +92,9 @@ var SceneStore = /*#__PURE__*/function () {
               return loader.createImageInfo(spec);
             case 7:
               image.imageInfo.imageInfo = _context2.sent.imageInfo;
-              loader.loadVolumeData(image, spec, onChannelLoaded);
-            case 9:
+              options === null || options === void 0 || (_options$onCreateScen = options.onCreateScene) === null || _options$onCreateScen === void 0 || _options$onCreateScen.call(options, image, scene);
+              loader.loadVolumeData(image, spec, options === null || options === void 0 ? void 0 : options.onChannelLoaded);
+            case 10:
             case "end":
               return _context2.stop();
           }

package/es/aics-image-viewer/shared/utils/storage.js

@@ -0,0 +1,238 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
+function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { mapKeys, mapValues } from "lodash";
+var QUEUE_KEY = "GLOBAL_ENTRY_QUEUE";
+var StorageEntryType = /*#__PURE__*/function (StorageEntryType) {
+  StorageEntryType["Scenes"] = "scenes";
+  StorageEntryType["Meta"] = "meta";
+  return StorageEntryType;
+}(StorageEntryType || {});
+var MAX_ENTRIES = {
+  scenes: 25,
+  meta: 1000
+};
+var sanitizeStorageKey = function sanitizeStorageKey(key) {
+  return key.includes(",") ? encodeURIComponent(key) : key;
+};
+
+/** `window.localStorage.setItem`, but returns `false` on quota exceeded instead of erroring */
+function safeSetItem(key, value) {
+  try {
+    window.localStorage.setItem(key, value);
+    return true;
+  } catch (e) {
+    // `setItem` throws a `QuotaExceededError` when the browser won't let us put any more data in local storage
+    if (e instanceof DOMException && e.name === "QuotaExceededError") {
+      return false;
+    }
+    throw e;
+  }
+}
+
+/**
+ * Wrapper for `window.localStorage.setItem` that accepts a `queue` of evictable storage keys, and attempts to safely
+ * handle exceeding the storage quota by removing items off the back of the `queue` until space is available.
+ *
+ * Also, unlike `setItem`, this function can accept `value`s of type `string[]`. This allows `queue` to also be passed
+ * into `value`, so that it can be written to storage *after* picking up any evictions that are made during the write.
+ *
+ * Returns `false` if `value` could not fit into storage even after removing everything from `queue`, `true` otherwise.
+ */
+function setStorageItem(key, value, queue) {
+  var removedItems = [];
+  while (!safeSetItem(key, Array.isArray(value) ? value.join(",") : value)) {
+    // can't fit `value` in the store; remove something off the back of `queue` and try again
+    var evictKey = queue.shift();
+    if (evictKey === undefined) {
+      // nothing left to remove means `value` is larger than the entire store
+      // give up on inserting it and try to put everything we removed back
+      var _iterator = _createForOfIteratorHelper(removedItems),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var _step$value = _slicedToArray(_step.value, 2),
+            _key = _step$value[0],
+            _value = _step$value[1];
+          if (safeSetItem(_key, _value)) {
+            queue.unshift(_key);
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      return false;
+    }
+    var removedValue = window.localStorage.getItem(evictKey);
+    if (removedValue !== null) {
+      removedItems.push([evictKey, removedValue]);
+      window.localStorage.removeItem(evictKey);
+    }
+  }
+  return true;
+}
+var getStorageQueue = function getStorageQueue() {
+  var _window$localStorage$, _window$localStorage$2;
+  return (_window$localStorage$ = (_window$localStorage$2 = window.localStorage.getItem(QUEUE_KEY)) === null || _window$localStorage$2 === void 0 ? void 0 : _window$localStorage$2.split(",")) !== null && _window$localStorage$ !== void 0 ? _window$localStorage$ : [];
+};
+/** If this function returns `false`, something serious has gone wrong and using local storage is likely impossible. */
+var setStorageQueue = function setStorageQueue(queue) {
+  return setStorageItem(QUEUE_KEY, queue, queue);
+};
+
+/**
+ * Writes a bundle of `entries` to local storage, all with an optional `entryType` for categorizing the data.
+ *
+ * Entries written with this function are tracked like a least-recently-used cache, and evicted when either:
+ * - the size of local storage exceeds the browser's quota
+ * - the number of entries of type `entryType` exceeds the maximum for that type
+ *
+ * Returns `true` if all entries fit in storage, or `false` if some did not.
+ */
+function writeStorage(entries, entryType) {
+  var prevQueue = getStorageQueue();
+  var typePrefix = entryType ? "".concat(entryType, "@") : "";
+  var escapedEntries = mapKeys(entries, function (_, key) {
+    return sanitizeStorageKey(key);
+  });
+
+  // filter keys we're currently inserting out of the queue (to be re-inserted at the front)
+  var index = 0;
+  var thisTypeIndexes = [];
+  var queue = prevQueue.filter(function (k) {
+    if (k.startsWith(typePrefix)) {
+      if (k.slice(typePrefix.length) in escapedEntries) {
+        return false;
+      } else if (entryType !== undefined) {
+        // start saving the location of entries of this type, for enforcing the maximum entry count below
+        thisTypeIndexes.push(index);
+      }
+    }
+    index += 1;
+    return true;
+  });
+
+  // push new keys onto the end
+  for (var _i = 0, _Object$keys = Object.keys(escapedEntries); _i < _Object$keys.length; _i++) {
+    var key = _Object$keys[_i];
+    thisTypeIndexes.push(queue.length);
+    queue.push(typePrefix + key);
+  }
+
+  // enforce the maximum number of entries for this type (e.g. no more than 25 of type "scenes")
+  if (entryType !== undefined) {
+    var evictIndexes = thisTypeIndexes.slice(0, -MAX_ENTRIES[entryType]);
+    var _iterator2 = _createForOfIteratorHelper(evictIndexes.reverse()),
+      _step2;
+    try {
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        var _index = _step2.value;
+        var _queue$splice = queue.splice(_index, 1),
+          _queue$splice2 = _slicedToArray(_queue$splice, 1),
+          evictKey = _queue$splice2[0];
+        window.localStorage.removeItem(evictKey);
+        delete escapedEntries[evictKey.slice(typePrefix.length)];
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
+  }
+
+  // write the new entries
+  var entryList = Object.entries(escapedEntries);
+  var firstKey = entryList.length < 2 ? undefined : typePrefix + entryList[0][0];
+  var allEntriesFit = true;
+  for (var _i2 = 0, _Object$entries = Object.entries(escapedEntries); _i2 < _Object$entries.length; _i2++) {
+    var _Object$entries$_i = _slicedToArray(_Object$entries[_i2], 2),
+      _key2 = _Object$entries$_i[0],
+      value = _Object$entries$_i[1];
+    var entryFits = setStorageItem(typePrefix + _key2, value, queue);
+    allEntriesFit = allEntriesFit && entryFits;
+  }
+
+  // TODO if the queue somehow doesn't fit, it's a much more serious problem than an individual entry.
+  //   Should that be communicated in the return type?
+  var queueFit = setStorageQueue(queue);
+  return allEntriesFit && queueFit && (firstKey === undefined || window.localStorage.getItem(firstKey) !== null);
+}
+
+/**
+ * Writes a bundle of metadata records keyed by image URL to local storage.
+ *
+ * Returns `true` if all records fit into local storage, or `false` if at least one did not.
+ */
+export function writeMetadata(meta) {
+  var stringMeta = mapValues(meta, function (metaVal) {
+    return JSON.stringify(metaVal);
+  });
+  return writeStorage(stringMeta, StorageEntryType.Meta);
+}
+
+/**
+ * Writes a scene `url` to local storage at the given `key`.
+ *
+ * Returns `false` if the entry did not fit in local storage, or `true` if it did.
+ */
+export function writeScenes(key, url) {
+  return writeStorage(_defineProperty({}, sanitizeStorageKey(key), url), StorageEntryType.Scenes);
+}
+export function readStoredMetadata(scenes) {
+  var skipCacheUpdate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  var keySet = new Set();
+  var result = scenes.map(function (scene) {
+    if (Array.isArray(scene)) {
+      // can't handle multi-source scenes (yet)
+      return undefined;
+    }
+    var globalKey = "".concat(StorageEntryType.Meta, "@").concat(sanitizeStorageKey(scene));
+    var meta = window.localStorage.getItem(globalKey);
+    if (meta === null) {
+      return undefined;
+    }
+    keySet.add(globalKey);
+    return JSON.parse(meta);
+  });
+  if (keySet.size > 0 && !skipCacheUpdate) {
+    var prevQueue = getStorageQueue();
+    var queue = prevQueue.filter(function (key) {
+      return !keySet.has(key);
+    });
+    queue.push.apply(queue, _toConsumableArray(keySet));
+    setStorageQueue(queue);
+  }
+  return result;
+}
+export function readStoredScenes(key) {
+  var skipCacheUpdate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  var globalKey = "".concat(StorageEntryType.Scenes, "@").concat(sanitizeStorageKey(key));
+  var result = window.localStorage.getItem(globalKey);
+  if (result === null) {
+    return undefined;
+  }
+  if (!skipCacheUpdate) {
+    var queue = getStorageQueue();
+    var entryIndex = queue.indexOf(globalKey);
+    if (entryIndex !== -1) {
+      queue.splice(entryIndex, 1);
+    }
+    queue.push(globalKey);
+    setStorageQueue(queue);
+  }
+  return result;
+}