@aics/vole-app 2.13.2 → 2.13.4

package/es/aics-image-viewer/components/App/index.js

@@ -178,6 +178,33 @@ var App = function App(props) {
 
   // we need to keep track of channel ranges for remapping control points
   var channelRangesRef = useRef([]);
+  var onCreateImage = useCallback(function (newImage) {
+    if (newImage === null) {
+      return;
+    }
+    channelRangesRef.current = new Array(newImage.channelNames.length).fill(undefined);
+    var channelSettings = viewerState.current.channelSettings;
+    view3d.addVolume(newImage, {
+      // Immediately passing down channel parameters isn't strictly necessary, but keeps things looking consistent on load
+      channels: newImage.channelNames.map(function (name) {
+        // TODO do we really need to be searching by name here?
+        var ch = channelSettings.find(function (channel) {
+          return channel.name === name;
+        });
+        if (!ch) {
+          return {};
+        }
+        return {
+          enabled: ch.volumeEnabled,
+          isosurfaceEnabled: ch.isosurfaceEnabled,
+          isovalue: ch.isovalue,
+          isosurfaceOpacity: ch.opacity,
+          color: ch.color
+        };
+      })
+    });
+    view3d.updateActiveChannels(newImage);
+  }, [view3d, viewerState]);
   var onChannelLoaded = useCallback(function (image, channelIndex, isInitialLoad) {
     // TODO this was once a search by name - is that still necessary or will the index always be correct?
     var thisChannelSettings = channelSettings[channelIndex];
@@ -185,18 +212,17 @@ var App = function App(props) {
       getChannelsAwaitingResetOnLoad = _viewerState$current2.getChannelsAwaitingResetOnLoad,
       getCurrentViewerChannelSettings = _viewerState$current2.getCurrentViewerChannelSettings,
       changeChannelSetting = _viewerState$current2.changeChannelSetting;
-    var ramp = thisChannelSettings.ramp,
-      controlPoints = thisChannelSettings.controlPoints;
     var thisChannel = image.getChannel(channelIndex);
-    if (isInitialLoad || !controlPoints || !ramp || getChannelsAwaitingResetOnLoad().has(channelIndex)) {
+    var noLut = !thisChannelSettings || !thisChannelSettings.controlPoints || !thisChannelSettings.ramp;
+    if (isInitialLoad || noLut || getChannelsAwaitingResetOnLoad().has(channelIndex)) {
       // This channel needs its LUT initialized
       var _initializeLut = initializeLut(image, channelIndex, getCurrentViewerChannelSettings()),
-        _ramp = _initializeLut.ramp,
-        _controlPoints = _initializeLut.controlPoints;
+        ramp = _initializeLut.ramp,
+        controlPoints = _initializeLut.controlPoints;
       var dtype = thisChannel.dtype;
       changeChannelSetting(channelIndex, {
-        controlPoints: _controlPoints,
-        ramp: controlPointsToRamp(_ramp),
+        controlPoints: controlPoints,
+        ramp: controlPointsToRamp(ramp),
         // set the default range of the transfer function editor to cover the full range of the data type
         plotMin: DTYPE_RANGE[dtype].min,
         plotMax: DTYPE_RANGE[dtype].max
@@ -215,13 +241,13 @@ var App = function App(props) {
         });
       } else {
         // ramp was just automatically remapped - update in state
-        var _ramp2 = controlPointsToRamp(thisChannel.lut.controlPoints);
+        var _ramp = controlPointsToRamp(thisChannel.lut.controlPoints);
         // now manually remap control points using the channel's old range
-        var _controlPoints2 = thisChannelSettings.controlPoints;
-        var remappedControlPoints = remapControlPointsForChannel(_controlPoints2, oldRange, thisChannel);
+        var _controlPoints = thisChannelSettings.controlPoints;
+        var remappedControlPoints = remapControlPointsForChannel(_controlPoints, oldRange, thisChannel);
         changeChannelSetting(channelIndex, {
           controlPoints: remappedControlPoints,
-          ramp: _ramp2
+          ramp: _ramp
         });
       }
     }
@@ -230,7 +256,6 @@ var App = function App(props) {
     channelRangesRef.current[channelIndex] = [thisChannel.rawMin, thisChannel.rawMax];
     view3d.updateLuts(image);
     view3d.onVolumeData(image, [channelIndex]);
-    view3d.setVolumeChannelEnabled(image, channelIndex, thisChannelSettings.volumeEnabled);
     if (image.channelNames[channelIndex] === maskChannelName) {
       view3d.setVolumeChannelAsMask(image, channelIndex);
     }
@@ -239,6 +264,7 @@ var App = function App(props) {
     }
   }, [view3d, channelSettings, maskChannelName, viewerState]);
   var volume = useVolume(scenes, {
+    onCreateImage: onCreateImage,
     onChannelLoaded: onChannelLoaded,
     onError: showError,
     maskChannelName: maskChannelName
@@ -246,36 +272,6 @@ var App = function App(props) {
   var image = volume.image,
     setTime = volume.setTime,
     setScene = volume.setScene;
-
-  // add the image to the viewer on load
-  useEffect(function () {
-    if (image === null) {
-      return;
-    }
-    channelRangesRef.current = new Array(image.channelNames.length).fill(undefined);
-    var channelSettings = viewerState.current.channelSettings;
-    view3d.addVolume(image, {
-      // Immediately passing down channel parameters isn't strictly necessary, but keeps things looking consistent on load
-      channels: image.channelNames.map(function (name) {
-        // TODO do we really need to be searching by name here?
-        var ch = channelSettings.find(function (channel) {
-          return channel.name === name;
-        });
-        if (!ch) {
-          return {};
-        }
-        return {
-          enabled: ch.volumeEnabled,
-          isosurfaceEnabled: ch.isosurfaceEnabled,
-          isovalue: ch.isovalue,
-          isosurfaceOpacity: ch.opacity,
-          color: ch.color
-        };
-      })
-    });
-    view3d.updateActiveChannels(image);
-    return view3d.removeAllVolumes.bind(view3d);
-  }, [image, view3d, viewerState]);
   var hasRawImage = !!(props.rawData && props.rawDims);
   var numScenes = hasRawImage ? 1 : (_scenes$length = (_scenes2 = props.imageUrl.scenes) === null || _scenes2 === void 0 ? void 0 : _scenes2.length) !== null && _scenes$length !== void 0 ? _scenes$length : 1;
   var numSlices = (_image$imageInfo$volu = image === null || image === void 0 ? void 0 : image.imageInfo.volumeSize) !== null && _image$imageInfo$volu !== void 0 ? _image$imageInfo$volu : {

package/es/aics-image-viewer/components/useVolume.js

@@ -66,6 +66,7 @@ var useVolume = function useVolume(scenePaths, options) {
   var viewerStateRef = useContext(ViewerStateContext).ref;
   var onErrorRef = useEffectEventRef(options === null || options === void 0 ? void 0 : options.onError);
   var onChannelLoadedRef = useEffectEventRef(options === null || options === void 0 ? void 0 : options.onChannelLoaded);
+  var onCreateImageRef = useEffectEventRef(options === null || options === void 0 ? void 0 : options.onCreateImage);
   var maskChannelName = options === null || options === void 0 ? void 0 : options.maskChannelName;
 
   // set up our big objects: the image, its loading infrastructure, and controls for playback
@@ -223,7 +224,7 @@ var useVolume = function useVolume(scenePaths, options) {
     };
     var openImage = /*#__PURE__*/function () {
       var _ref3 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
-        var _getCurrentViewerChan;
+        var _onCreateImageRef$cur, _getCurrentViewerChan;
         var _viewerStateRef$curre2, scene, time, loadSpec, aimg, channelNames, newChannelSettings, requiredLoadSpec, requiredChannelsToLoad, maskChannelName, maskChannelIndex, slice;
         return _regeneratorRuntime().wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
@@ -239,6 +240,7 @@ var useVolume = function useVolume(scenePaths, options) {
               newChannelSettings = setChannelStateForNewImage(channelNames);
               setChannelVersions(new Array(channelNames.length).fill(CHANNEL_INITIAL_LOAD));
               setImage(aimg);
+              (_onCreateImageRef$cur = onCreateImageRef.current) === null || _onCreateImageRef$cur === void 0 || _onCreateImageRef$cur.call(onCreateImageRef, aimg);
               playControls.stepAxis = function (axis) {
                 var _viewerStateRef$curre3 = viewerStateRef.current,
                   time = _viewerStateRef$curre3.time,
@@ -285,7 +287,7 @@ var useVolume = function useVolume(scenePaths, options) {
               // initiate loading only after setting up new channel settings,
               // in case the loader callback fires before the state is set
               sceneLoader.loadScene(scene, aimg, requiredLoadSpec)["catch"](onError);
-            case 20:
+            case 21:
             case "end":
               return _context.stop();
           }
@@ -296,7 +298,7 @@ var useVolume = function useVolume(scenePaths, options) {
       };
     }();
     openImage();
-  }, [sceneLoader, onError, onChannelLoadedRef, viewerStateRef, channelVersionsRef, setChannelVersions, playControls, setIsLoading, onChannelDataLoaded]);
+  }, [sceneLoader, onError, onCreateImageRef, onChannelLoadedRef, viewerStateRef, channelVersionsRef, setChannelVersions, playControls, setIsLoading, onChannelDataLoaded]);
   // of the above dependencies, we expect only `sceneLoader` to change.
 
   var setTime = useCallback(function (view3d, time) {

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

@@ -8,6 +8,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, 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); }
+import { VolumeFileFormat } from "@aics/vole-core";
 var SceneStore = /*#__PURE__*/function () {
   function SceneStore(context, paths) {
     _classCallCheck(this, SceneStore);
@@ -38,6 +39,7 @@ var SceneStore = /*#__PURE__*/function () {
               options = {};
               if (_typeof(path) === "object" && !Array.isArray(path)) {
                 options.rawArrayOptions = path;
+                options.fileType = VolumeFileFormat.DATA;
                 path = "";
               }
               _context.next = 8;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aics/vole-app",
-  "version": "2.13.2",
+  "version": "2.13.4",
   "description": "web view of cell volume images",
   "repository": "github:allen-cell-animated/vole-app",
   "main": "es/index.js",
@@ -41,7 +41,7 @@
   "author": "Megan Riel-Mehan",
   "license": "ISC",
   "dependencies": {
-    "@aics/vole-core": "^3.15.7",
+    "@aics/vole-core": "^4.1.0",
     "@ant-design/icons": "^5.2.5",
     "@fortawesome/fontawesome-svg-core": "^6.5.2",
     "@fortawesome/free-solid-svg-icons": "^6.5.2",

package/type-declarations/aics-image-viewer/components/useVolume.d.ts

@@ -3,6 +3,8 @@ import { AxisName } from "../shared/types";
 import PlayControls from "../shared/utils/playControls";
 import { ChannelGrouping } from "../shared/utils/viewerChannelSettings";
 export type UseVolumeOptions = {
+    /** Callback for when the volume is created. */
+    onCreateImage?: (image: Volume) => void;
     /** Callback for when a single channel of the volume has loaded. */
     onChannelLoaded?: (image: Volume, channelIndex: number, isInitialLoad: boolean) => void;
     /** Callback for when image loading encounters an error. */