@aics/vole-app 2.11.0

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

@@ -0,0 +1,97 @@
+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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), 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); }
+var PLAY_STEP_INTERVAL_MS = 125;
+var PlayControls = /*#__PURE__*/function () {
+  function PlayControls() {
+    _classCallCheck(this, PlayControls);
+    _defineProperty(this, "playingAxis", null);
+    _defineProperty(this, "playWaitingForLoad", false);
+    _defineProperty(this, "playHolding", false);
+    _defineProperty(this, "playTimeoutId", 0);
+  }
+  return _createClass(PlayControls, [{
+    key: "setPlayingAxis",
+    value: function setPlayingAxis(axis) {
+      var _this$onPlayingAxisCh;
+      this.playingAxis = axis;
+      (_this$onPlayingAxisCh = this.onPlayingAxisChanged) === null || _this$onPlayingAxisCh === void 0 || _this$onPlayingAxisCh.call(this, axis);
+    }
+  }, {
+    key: "playStep",
+    value: function playStep() {
+      var _this$getVolumeIsLoad;
+      if (!this.playingAxis || this.playHolding || !this.stepAxis) {
+        return;
+      }
+      // If the volume is not loaded, wait for it to load before continuing
+      if (!((_this$getVolumeIsLoad = this.getVolumeIsLoaded) !== null && _this$getVolumeIsLoad !== void 0 && _this$getVolumeIsLoad.call(this))) {
+        this.playWaitingForLoad = true;
+        return;
+      }
+      this.stepAxis(this.playingAxis);
+      this.playTimeoutId = window.setTimeout(this.playStep.bind(this), PLAY_STEP_INTERVAL_MS);
+    }
+
+    /** Call whenever new data is loaded to resume playback if it was paused for data loading. */
+  }, {
+    key: "onImageLoaded",
+    value: function onImageLoaded() {
+      if (this.playWaitingForLoad) {
+        this.playWaitingForLoad = false;
+        this.playStep();
+      }
+    }
+
+    /**
+     * Pause playback on the currently playing axis.
+     * `willResume` marks this as a temporary suspension, e.g. while the user is scrubbing along the playing axis.
+     */
+  }, {
+    key: "pause",
+    value: function pause() {
+      var willResume = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+      window.clearTimeout(this.playTimeoutId);
+      this.playTimeoutId = 0;
+      this.playWaitingForLoad = false;
+      if (this.playingAxis !== null && !willResume) {
+        this.playHolding = false;
+        this.setPlayingAxis(null);
+      }
+    }
+
+    /** Begin playback on `axis`. */
+  }, {
+    key: "play",
+    value: function play(axis) {
+      if (this.playingAxis !== null) {
+        this.pause(true);
+      }
+      this.setPlayingAxis(axis);
+      this.playStep();
+    }
+
+    /** If `axis` is currently playing, begin a temporary hold on playback while other input is pending. */
+  }, {
+    key: "startHold",
+    value: function startHold(axis) {
+      this.playHolding = true;
+      this.pause(axis === this.playingAxis);
+    }
+
+    /** If a playback hold is active, end it. */
+  }, {
+    key: "endHold",
+    value: function endHold() {
+      if (this.playHolding) {
+        this.playHolding = false;
+        this.playStep();
+      }
+    }
+  }]);
+}();
+export { PlayControls as default };

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

@@ -0,0 +1,140 @@
+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 _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); }); }; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), 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); }
+var SceneStore = /*#__PURE__*/function () {
+  function SceneStore(context, paths) {
+    _classCallCheck(this, SceneStore);
+    _defineProperty(this, "currentScene", 0);
+    _defineProperty(this, "syncChannels", false);
+    _defineProperty(this, "prefetchPriority", []);
+    this.paths = paths;
+    this.context = context;
+    this.loaders = new Array(paths.length).fill(undefined);
+  }
+
+  /** Get the loader associated with the given scene index, or create it if it doesn't exist */
+  return _createClass(SceneStore, [{
+    key: "getLoader",
+    value: (function () {
+      var _getLoader = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(scene) {
+        var loader, path, options;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              this.currentScene = scene;
+              loader = this.loaders[scene];
+              if (loader) {
+                _context.next = 12;
+                break;
+              }
+              path = this.paths[scene];
+              options = {};
+              if (_typeof(path) === "object" && !Array.isArray(path)) {
+                options.rawArrayOptions = path;
+                path = "";
+              }
+              _context.next = 8;
+              return this.context.onOpen();
+            case 8:
+              _context.next = 10;
+              return this.context.createLoader(path, options);
+            case 10:
+              loader = _context.sent;
+              this.loaders[scene] = loader;
+            case 12:
+              loader.syncMultichannelLoading(this.syncChannels);
+              loader.setPrefetchPriority(this.prefetchPriority);
+              return _context.abrupt("return", loader);
+            case 15:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function getLoader(_x) {
+        return _getLoader.apply(this, arguments);
+      }
+      return getLoader;
+    }())
+  }, {
+    key: "loadScene",
+    value: function () {
+      var _loadScene = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2(scene, image, loadSpec, onChannelLoaded) {
+        var loader, spec;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.next = 2;
+              return this.getLoader(scene);
+            case 2:
+              loader = _context2.sent;
+              spec = loadSpec !== null && loadSpec !== void 0 ? loadSpec : image.loadSpecRequired;
+              image.loader = loader;
+              _context2.next = 7;
+              return loader.createImageInfo(spec);
+            case 7:
+              image.imageInfo.imageInfo = _context2.sent.imageInfo;
+              loader.loadVolumeData(image, spec, onChannelLoaded);
+            case 9:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this);
+      }));
+      function loadScene(_x2, _x3, _x4, _x5) {
+        return _loadScene.apply(this, arguments);
+      }
+      return loadScene;
+    }()
+  }, {
+    key: "createVolume",
+    value: function () {
+      var _createVolume = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee3(scene, loadSpec, onChannelLoaded) {
+        var loader;
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.next = 2;
+              return this.getLoader(scene);
+            case 2:
+              loader = _context3.sent;
+              return _context3.abrupt("return", loader.createVolume(loadSpec, onChannelLoaded));
+            case 4:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this);
+      }));
+      function createVolume(_x6, _x7, _x8) {
+        return _createVolume.apply(this, arguments);
+      }
+      return createVolume;
+    }()
+  }, {
+    key: "syncMultichannelLoading",
+    value: function syncMultichannelLoading(sync) {
+      this.syncChannels = sync;
+      var currentLoader = this.loaders[this.currentScene];
+      if (currentLoader) {
+        currentLoader.syncMultichannelLoading(sync);
+      }
+    }
+  }, {
+    key: "setPrefetchPriority",
+    value: function setPrefetchPriority(priority) {
+      this.prefetchPriority = priority;
+      var currentLoader = this.loaders[this.currentScene];
+      if (currentLoader) {
+        currentLoader.setPrefetchPriority(priority);
+      }
+    }
+  }]);
+}();
+export { SceneStore as default };

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

@@ -0,0 +1,36 @@
+export var gammaSliderToImageValues = function gammaSliderToImageValues(sliderValues) {
+  var min = Number(sliderValues[0]);
+  var mid = Number(sliderValues[1]);
+  var max = Number(sliderValues[2]);
+  if (mid > max || mid < min) {
+    mid = 0.5 * (min + max);
+  }
+  var div = 255;
+  min /= div;
+  max /= div;
+  mid /= div;
+  var diff = max - min;
+  var x = (mid - min) / diff;
+  var scale = 4 * x * x;
+  if ((mid - 0.5) * (mid - 0.5) < 0.0005) {
+    scale = 1.0;
+  }
+  return {
+    min: min,
+    max: max,
+    scale: scale
+  };
+};
+
+// Density and brightness are overloaded for the two supported rendering modes in the volume viewer.
+// These formulae are somewhat ad-hoc based on what will subjectively look reasonable in the viewer, and should be considered tweakable.
+// vole-core expects to see numbers from 0..1 for density, brightness, and alpha.
+export var densitySliderToImageValue = function densitySliderToImageValue(sliderValues, _isPT) {
+  return +sliderValues / 100.0;
+};
+export var brightnessSliderToImageValue = function brightnessSliderToImageValue(sliderValues, _isPT) {
+  return +sliderValues / 100.0;
+};
+export var alphaSliderToImageValue = function alphaSliderToImageValue(sliderValues) {
+  return 1 - sliderValues / 100.0;
+};

package/es/aics-image-viewer/shared/utils/test/viewerChannelSettings.test.js

@@ -0,0 +1,132 @@
+import { describe, expect, it } from "@jest/globals";
+import { matchChannel, makeChannelIndexGrouping } from "../viewerChannelSettings";
+describe("viewer settings", function () {
+  describe("matching names", function () {
+    it.each([["test1", [true, false, false]], ["test", [true, true, true]], ["^test$", [false, false, false]], ["1|2", [true, true, false]], [1, [false, true, false]]])("matches against %p", function (re, expected) {
+      var channelNames = ["test1", "test2", "test3"];
+      var setting = {
+        match: re
+      };
+      var result = channelNames.map(function (ch, i) {
+        return matchChannel(ch, i, setting);
+      });
+      expect(result).toEqual(expected);
+    });
+  });
+  describe("grouping channels", function () {
+    it("groups channels into their named groups when all match", function () {
+      var channelNames = ["test1", "test2", "test3"];
+      var settings = {
+        groups: [{
+          name: "1",
+          channels: [{
+            match: "2"
+          }]
+        }, {
+          name: "2",
+          channels: [{
+            match: "3"
+          }]
+        }, {
+          name: "3",
+          channels: [{
+            match: "1"
+          }]
+        }],
+        maskChannelName: ""
+      };
+      var expected = {
+        "1": [1],
+        "2": [2],
+        "3": [0]
+      };
+      var result = makeChannelIndexGrouping(channelNames, settings);
+      expect(Object.keys(result).length).toBe(3);
+      for (var i in result) {
+        expect(result[i].length).toBe(1);
+        expect(result[i]).toEqual(expected[i]);
+      }
+    });
+    it('groups channels into group "Other" when none match', function () {
+      var channelNames = ["test1", "test2", "test3"];
+      var settings = {
+        groups: [{
+          name: "1",
+          channels: [{
+            match: "z"
+          }]
+        }, {
+          name: "2",
+          channels: [{
+            match: "y"
+          }]
+        }, {
+          name: "3",
+          channels: [{
+            match: "x"
+          }]
+        }],
+        maskChannelName: ""
+      };
+      var expected = {
+        "1": [],
+        "2": [],
+        "3": [],
+        Other: [0, 1, 2]
+      };
+      var result = makeChannelIndexGrouping(channelNames, settings);
+      expect(Object.keys(result).length).toBe(4);
+      for (var i in result) {
+        expect(result[i]).toEqual(expected[i]);
+      }
+    });
+    it('groups channels into named groups and "Other" when only some match', function () {
+      var channelNames = ["test1", "test2", "test3"];
+      var settings = {
+        groups: [{
+          name: "1",
+          channels: [{
+            match: "1"
+          }]
+        }, {
+          name: "2",
+          channels: [{
+            match: "2"
+          }]
+        }, {
+          name: "3",
+          channels: [{
+            match: "x"
+          }]
+        }],
+        maskChannelName: ""
+      };
+      var expected = {
+        "1": [0],
+        "2": [1],
+        "3": [],
+        Other: [2]
+      };
+      var result = makeChannelIndexGrouping(channelNames, settings);
+      expect(Object.keys(result).length).toBe(4);
+      for (var i in result) {
+        expect(result[i]).toEqual(expected[i]);
+      }
+    });
+    it('groups all channels into group "Channels" when no groups are given', function () {
+      var channelNames = ["test1", "test2", "test3"];
+      var settings = {
+        groups: [],
+        maskChannelName: ""
+      };
+      var expected = {
+        Channels: [0, 1, 2]
+      };
+      var result = makeChannelIndexGrouping(channelNames, settings);
+      expect(Object.keys(result).length).toBe(1);
+      for (var i in result) {
+        expect(result[i]).toEqual(expected[i]);
+      }
+    });
+  });
+});

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

@@ -0,0 +1,54 @@
+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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), 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); }
+var UtilsService = /*#__PURE__*/function () {
+  function UtilsService() {
+    _classCallCheck(this, UtilsService);
+  }
+  return _createClass(UtilsService, null, [{
+    key: "getParameterByName",
+    value:
+    /**
+     *
+     * @param name (string) Name of query parameter to search for
+     * @param url (string) url string to search (if not provided, defaults to window url)
+     * @returns {*} value of query parameter (URI decoded).
+     * If query parameter not found, returns null.
+     * If no value provided, returns empty string
+     */
+    function getParameterByName(name, url) {
+      if (!url) url = window.location.href;
+      name = name.replace(/[[\]]/g, "\\$&");
+      var regex = new RegExp("[?&]" + name + "(=([^&#]*)|&|#|$)"),
+        results = regex.exec(url);
+      if (!results) return null;
+      if (!results[2]) return "";
+      return decodeURIComponent(results[2].replace(/\+/g, " "));
+    }
+  }, {
+    key: "intersects",
+    value: function intersects(arr1, arr2) {
+      if (!arr1 || !arr2) {
+        return false;
+      }
+      var smallerArr, largerArr;
+      if (arr1.length > arr2.length) {
+        smallerArr = arr2;
+        largerArr = arr1;
+      } else {
+        smallerArr = arr1;
+        largerArr = arr2;
+      }
+      for (var i = 0; i < smallerArr.length; i++) {
+        if (largerArr.indexOf(smallerArr[i]) > -1) {
+          return false;
+        }
+      }
+      return true;
+    }
+  }]);
+}();
+export { UtilsService as default };

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

@@ -0,0 +1,152 @@
+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 _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 _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 { OTHER_CHANNEL_KEY, SINGLE_GROUP_CHANNEL_KEY } from "../constants";
+
+/** Settings for a single channel, as passed in via props by App users */
+
+export function matchChannel(channelName, channelIndex, c) {
+  // c could be a number, an array of (strings or numbers), or a single regex
+  if (typeof c.match === "number") {
+    if (c.match === channelIndex) {
+      return true;
+    }
+  } else if (Array.isArray(c.match)) {
+    var _iterator = _createForOfIteratorHelper(c.match),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var r = _step.value;
+        if (typeof r === "number") {
+          if (r === channelIndex) {
+            return true;
+          }
+        } else {
+          var re = new RegExp(r);
+          if (re.test(channelName)) {
+            return true;
+          }
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  } else if (typeof c.match === "string") {
+    var _re = new RegExp(c.match);
+    if (_re.test(channelName)) {
+      return true;
+    }
+  } else {
+    throw new Error("match is required for channel settings groups, and must be a string, number, or array of strings or numbers");
+  }
+  return false;
+}
+function findFirstChannelMatchOfGroup(channel, channelIndex, g) {
+  var _iterator2 = _createForOfIteratorHelper(g.channels),
+    _step2;
+  try {
+    for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+      var c = _step2.value;
+      if (matchChannel(channel, channelIndex, c)) {
+        return c;
+      }
+    }
+  } catch (err) {
+    _iterator2.e(err);
+  } finally {
+    _iterator2.f();
+  }
+  return undefined;
+}
+export function findFirstChannelMatch(channel, channelIndex, settings) {
+  if (!settings.groups) {
+    return undefined;
+  }
+  var _iterator3 = _createForOfIteratorHelper(settings.groups),
+    _step3;
+  try {
+    for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+      var g = _step3.value;
+      var c = findFirstChannelMatchOfGroup(channel, channelIndex, g);
+      if (c !== undefined) {
+        return c;
+      }
+    }
+  } catch (err) {
+    _iterator3.e(err);
+  } finally {
+    _iterator3.f();
+  }
+  return undefined;
+}
+export function getDisplayName(name, index, settings) {
+  if (settings) {
+    var c = findFirstChannelMatch(name, index, settings);
+    if (c) {
+      return c.name || name;
+    }
+  }
+  return name;
+}
+export function makeChannelIndexGrouping(channels, settings) {
+  if (!channels) {
+    return {};
+  }
+  if (!settings) {
+    // return all channels
+    return _defineProperty({}, SINGLE_GROUP_CHANNEL_KEY, channels.map(function (_val, index) {
+      return index;
+    }));
+  }
+  var groups = settings.groups;
+  var grouping = {};
+  var channelsMatched = [];
+  // this is kinda inefficient but we want to ensure the order as specified in viewerChannelSettings
+  if (groups !== undefined) {
+    var _iterator4 = _createForOfIteratorHelper(groups),
+      _step4;
+    try {
+      var _loop = function _loop() {
+        var g = _step4.value;
+        grouping[g.name] = [];
+        g.channels.forEach(function (groupMatch) {
+          // check all channels against the match
+          channels.forEach(function (channel, index) {
+            // make sure channel was not already matched someplace.
+            if (!channelsMatched.includes(index)) {
+              if (matchChannel(channel, index, groupMatch)) {
+                grouping[g.name].push(index);
+                channelsMatched.push(index);
+              }
+            }
+          });
+        });
+      };
+      for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+        _loop();
+      }
+    } catch (err) {
+      _iterator4.e(err);
+    } finally {
+      _iterator4.f();
+    }
+  }
+  // now any channels not still matched go in the catchall group.
+  if (channelsMatched.length < channels.length) {
+    var remainderGroupName = groups.length === 0 ? SINGLE_GROUP_CHANNEL_KEY : OTHER_CHANNEL_KEY;
+    grouping[remainderGroupName] = [];
+    channels.forEach(function (channel, index) {
+      // make sure channel was not already matched someplace.
+      if (!channelsMatched.includes(index)) {
+        grouping[remainderGroupName].push(index);
+      }
+    });
+  }
+  return grouping;
+}