@cornerstonejs/tools 1.68.3 → 1.70.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.68.3",
+  "version": "1.70.0",
   "description": "Cornerstone3D Tools",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -29,7 +29,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^1.68.3",
+    "@cornerstonejs/core": "^1.70.0",
     "@icr/polyseg-wasm": "0.4.0",
     "@types/offscreencanvas": "2019.7.3",
     "comlink": "^4.4.1",
@@ -41,7 +41,7 @@
   },
   "peerDependencies": {
     "@icr/polyseg-wasm": "0.4.0",
-    "@kitware/vtk.js": "29.7.0",
+    "@kitware/vtk.js": "30.3.1",
     "@types/d3-array": "^3.0.4",
     "@types/d3-interpolate": "^3.0.1",
     "d3-array": "^3.2.3",
@@ -59,5 +59,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "648e1625502b28ab85282c9edd50b9a51ebd34e0"
+  "gitHead": "00e347188b0b57854ddbefdfae220db42c4bf02f"
 }

package/src/eventListeners/keyboard/keyDownListener.ts

@@ -1,5 +1,5 @@
-import _cloneDeep from 'lodash.clonedeep';
 import { getEnabledElement, triggerEvent } from '@cornerstonejs/core';
+import cloneDeep from 'lodash.clonedeep';
 import Events from '../../enums/Events';
 import { KeyDownEventDetail, KeyUpEventDetail } from '../../types/EventTypes';
 
@@ -97,7 +97,7 @@ function _onKeyUp(evt: KeyboardEvent): void {
   state.element.addEventListener('keydown', keyListener);
 
   // Restore `state` to `defaultState`
-  state = _cloneDeep(defaultState);
+  state = cloneDeep(defaultState);
   triggerEvent(eventDetail.element, Events.KEY_UP, eventDetail);
 }
 

package/src/stateManagement/segmentation/SegmentationStateManager.ts

@@ -450,7 +450,7 @@ export default class SegmentationStateManager {
       console.warn('Color LUT table already exists, overwriting');
     }
 
-    this.state.colorLUT[lutIndex] = structuredClone(colorLUT);
+    this.state.colorLUT[lutIndex] = cloneDeep(colorLUT);
   }
 
   /**

package/src/stateManagement/segmentation/addSegmentations.ts

@@ -1,4 +1,4 @@
-import _cloneDeep from 'lodash.clonedeep';
+import cloneDeep from 'lodash.clonedeep';
 import { SegmentationPublicInput } from '../../types/SegmentationStateTypes';
 import { validateSegmentationInput } from './helpers';
 import { addSegmentation as addSegmentationToState } from './segmentationState';
@@ -18,7 +18,7 @@ function addSegmentations(
   validateSegmentationInput(segmentationInputArray);
 
   segmentationInputArray.map((segInput) => {
-    const segmentationInput = _cloneDeep(segInput);
+    const segmentationInput = cloneDeep(segInput);
 
     addSegmentationToState(segmentationInput);
   });

package/src/store/ToolGroupManager/ToolGroup.ts

@@ -1,6 +1,6 @@
 import { MouseBindings, ToolModes } from '../../enums';
-import cloneDeep from 'lodash.clonedeep';
 import get from 'lodash.get';
+import cloneDeep from 'lodash.clonedeep';
 import {
   triggerEvent,
   eventTarget,

package/src/store/state.ts

@@ -1,8 +1,7 @@
-import _cloneDeep from 'lodash.clonedeep';
-
 import { IToolGroup, IToolClassReference } from '../types';
 import Synchronizer from './SynchronizerManager/Synchronizer';
 import svgNodeCache, { resetSvgNodeCache } from './svgNodeCache';
+import cloneDeep from 'lodash.clonedeep';
 
 interface ICornerstoneTools3dState {
   isInteractingWithTool: boolean;
@@ -46,7 +45,15 @@ let state: ICornerstoneTools3dState = {
 
 function resetCornerstoneToolsState(): void {
   resetSvgNodeCache();
-  state = _cloneDeep(defaultState);
+  state = {
+    ...cloneDeep({
+      ...defaultState,
+      svgNodeCache: {},
+    }),
+    svgNodeCache: {
+      ...defaultState.svgNodeCache,
+    },
+  };
 }
 
 export {

package/src/synchronizers/callbacks/presentationViewSyncCallback.ts

@@ -0,0 +1,36 @@
+import { getRenderingEngine, Types } from '@cornerstonejs/core';
+
+/**
+ * Synchronizer callback to synchronize the camera. Synchronization
+ *
+ * targetViewport.options.syncZoom set to false to not sync the zoom
+ * targetViewport.options.syncPan set to false to not sync the pan
+
+ * @param synchronizerInstance - The Instance of the Synchronizer
+ * @param sourceViewport - The list of IDs defining the source viewport.
+ * @param targetViewport - The list of IDs defining the target viewport, different
+ *   from sourceViewport
+ */
+export default function presentationViewSyncCallback(
+  _synchronizerInstance,
+  sourceViewport: Types.IViewportId,
+  targetViewport: Types.IViewportId,
+  _sourceEvent,
+  options?: Types.ViewPresentationSelector
+): void {
+  const renderingEngine = getRenderingEngine(targetViewport.renderingEngineId);
+  if (!renderingEngine) {
+    throw new Error(
+      `No RenderingEngine for Id: ${targetViewport.renderingEngineId}`
+    );
+  }
+
+  const tViewport = renderingEngine.getViewport(targetViewport.viewportId);
+  const sViewport = renderingEngine.getViewport(sourceViewport.viewportId);
+
+  const presentationView = sViewport.getViewPresentation(options);
+
+  tViewport.setView(null, presentationView);
+
+  tViewport.render();
+}

package/src/synchronizers/callbacks/voiSyncCallback.ts

@@ -60,4 +60,4 @@ export default function voiSyncCallback(
   }
 
   tViewport.render();
-}
+}

package/src/synchronizers/index.ts

@@ -1,4 +1,5 @@
 import createCameraPositionSynchronizer from './synchronizers/createCameraPositionSynchronizer';
+import createPresentationViewSynchronizer from './synchronizers/createPresentationViewSynchronizer';
 import createVOISynchronizer from './synchronizers/createVOISynchronizer';
 import createZoomPanSynchronizer from './synchronizers/createZoomPanSynchronizer';
 import createImageSliceSynchronizer from './synchronizers/createImageSliceSynchronizer';
@@ -9,6 +10,7 @@ const createStackImageSynchronizer = createImageSliceSynchronizer;
 
 export {
   createCameraPositionSynchronizer,
+  createPresentationViewSynchronizer,
   createVOISynchronizer,
   createZoomPanSynchronizer,
   createImageSliceSynchronizer,

package/src/synchronizers/synchronizers/createPresentationViewSynchronizer.ts

@@ -0,0 +1,29 @@
+import { Enums } from '@cornerstonejs/core';
+import type { Types } from '@cornerstonejs/core';
+import { createSynchronizer } from '../../store/SynchronizerManager';
+import presentationViewSyncCallback from '../callbacks/presentationViewSyncCallback';
+import Synchronizer from '../../store/SynchronizerManager/Synchronizer';
+
+const { CAMERA_MODIFIED } = Enums.Events;
+
+/**
+ * A helper that creates a new `Synchronizer` which listens to the `CAMERA_MODIFIED`
+ * rendering event and calls the `cameraSyncCallback` based on presentation view
+ * values and not based on absolute camera positions.
+ *
+ * @param synchronizerName - The name of the synchronizer.
+ * @returns A new `Synchronizer` instance.
+ */
+export default function createPresentationViewSynchronizer(
+  synchronizerName: string,
+  options?: Types.ViewPresentation
+): Synchronizer {
+  const presentationView = createSynchronizer(
+    synchronizerName,
+    CAMERA_MODIFIED,
+    presentationViewSyncCallback,
+    options
+  );
+
+  return presentationView;
+}

package/src/synchronizers/synchronizers/index.ts

@@ -1,4 +1,5 @@
 import createCameraPositionSynchronizer from './createCameraPositionSynchronizer';
+import createPresentationViewSynchronizer from './createPresentationViewSynchronizer';
 import createVOISynchronizer from './createVOISynchronizer';
 import createZoomPanSynchronizer from './createZoomPanSynchronizer';
 import createImageSliceSynchronizer from './createImageSliceSynchronizer';
@@ -7,6 +8,7 @@ import createImageSliceSynchronizer from './createImageSliceSynchronizer';
 const createStackImageSynchronizer = createImageSliceSynchronizer;
 export {
   createCameraPositionSynchronizer,
+  createPresentationViewSynchronizer,
   createVOISynchronizer,
   createZoomPanSynchronizer,
   createImageSliceSynchronizer,

package/src/tools/displayTools/Surface/addOrUpdateSurfaceToElement.ts

@@ -96,7 +96,8 @@ function addOrUpdateSurfaceToElement(
   actor.getProperty().setLineWidth(2);
 
   viewport.addActor({
-    actor,
+    // @ts-ignore
+    actor: actor as vtkActor,
     uid: actorUID,
     clippingFilter,
   });

package/src/tools/segmentation/BrushTool.ts

@@ -1,4 +1,8 @@
-import { utilities as csUtils, getEnabledElement } from '@cornerstonejs/core';
+import {
+  utilities as csUtils,
+  cache,
+  getEnabledElement,
+} from '@cornerstonejs/core';
 import { vec3, vec2 } from 'gl-matrix';
 
 import type { Types } from '@cornerstonejs/core';
@@ -113,6 +117,7 @@ class BrushTool extends BaseTool {
         },
         defaultStrategy: 'FILL_INSIDE_CIRCLE',
         activeStrategy: 'FILL_INSIDE_CIRCLE',
+        thresholdVolumeId: null,
         brushSize: 25,
         preview: {
           // Have to enable the preview to use this
@@ -203,14 +208,23 @@ class BrushTool extends BaseTool {
       ] as LabelmapSegmentationDataVolume;
       const actors = viewport.getActors();
 
-      // Note: For tools that need the source data. Assumed to use
-      // First volume actor for now.
-      const firstVolumeActorUID = actors[0].uid;
+      // we used to take the first actor here but we should take the one that is
+      // probably the same size as the segmentation volume
+      const volumes = actors.map((actorEntry) =>
+        cache.getVolume(actorEntry.referenceId)
+      );
+
+      const segmentationVolume = cache.getVolume(volumeId);
+
+      const referencedVolumeIdToThreshold =
+        volumes.find((volume) =>
+          csUtils.isEqual(volume.dimensions, segmentationVolume.dimensions)
+        )?.volumeId || volumes[0]?.volumeId;
 
       return {
         volumeId,
         referencedVolumeId:
-          labelmapData.referencedVolumeId ?? firstVolumeActorUID,
+          this.configuration.thresholdVolumeId ?? referencedVolumeIdToThreshold,
         segmentsLocked,
         segmentationRepresentationUID,
       };

package/src/utilities/segmentation/createLabelmapVolumeForViewport.ts

@@ -1,4 +1,4 @@
-import { _cloneDeep } from 'lodash.clonedeep';
+import cloneDeep from 'lodash.clonedeep';
 import {
   getEnabledElementByIds,
   volumeLoader,
@@ -23,16 +23,16 @@ export default async function createLabelmapVolumeForViewport(input: {
   renderingEngineId: string;
   segmentationId?: string;
   options?: {
-    volumeId?: string;
-    scalarData?: Float32Array | Uint8Array | Uint16Array | Int16Array;
-    targetBuffer?: {
+    volumeId: string;
+    scalarData: Float32Array | Uint8Array | Uint16Array | Int16Array;
+    targetBuffer: {
       type: 'Float32Array' | 'Uint8Array' | 'Uint16Array' | 'Int8Array';
     };
-    metadata?: any;
-    dimensions?: Types.Point3;
-    spacing?: Types.Point3;
-    origin?: Types.Point3;
-    direction?: Float32Array;
+    metadata: Types.Metadata;
+    dimensions: Types.Point3;
+    spacing: Types.Point3;
+    origin: Types.Point3;
+    direction: Types.Mat3;
   };
 }): Promise<string> {
   const { viewportId, renderingEngineId, options } = input;
@@ -60,7 +60,7 @@ export default async function createLabelmapVolumeForViewport(input: {
   if (options) {
     // create a new labelmap with its own properties
     // This allows creation of a higher resolution labelmap vs reference volume
-    const properties = _cloneDeep(options);
+    const properties = cloneDeep(options);
     await volumeLoader.createLocalVolume(properties, segmentationId);
   } else {
     // create a labelmap from a reference volume

package/src/utilities/triggerAnnotationRender.ts

@@ -159,7 +159,9 @@ class AnnotationRenderingEngine {
     const enabledElement = getEnabledElement(element);
 
     if (!enabledElement) {
-      console.warn('Element has been disabled');
+      // Happens during testing, and isn't an issue as it just means there
+      // is overlap between shutdown and re-render
+      // console.warn('Element has been disabled');
       return;
     }