@cornerstonejs/tools 1.68.1 → 1.68.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.68.1",
+  "version": "1.68.2",
   "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.1",
+    "@cornerstonejs/core": "^1.68.2",
     "@icr/polyseg-wasm": "0.4.0",
     "@types/offscreencanvas": "2019.7.3",
     "comlink": "^4.4.1",
@@ -59,5 +59,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "bc07d0e3bfd08cffba904f3deb5ce18b3079255d"
+  "gitHead": "7d2a43e464e709b9da393ef58fd105395112a2d9"
 }

package/src/eventListeners/segmentation/imageChangeEventListener.ts

@@ -45,6 +45,8 @@ const disable = function (element: HTMLDivElement): void {
   );
 };
 
+const perToolGroupManualTriggers = new Map();
+
 /**
  *  When the image is rendered, check what tools can be rendered for this element.
  *
@@ -123,7 +125,11 @@ function _imageChangeEventListener(evt) {
     // where we are in the process of updating the volume conversion to a stack while
     // the data is still coming in. In such situations, we should trigger the render
     // to ensure that the segmentation actors are created, even if the data arrives late.
-    triggerSegmentationRender(toolGroup.id);
+
+    if (!perToolGroupManualTriggers.has(toolGroup.id)) {
+      perToolGroupManualTriggers.set(toolGroup.id, true);
+      triggerSegmentationRender(toolGroup.id);
+    }
 
     // we should return here, since there is no segmentation actor to update
     // we will hit this function later on after the actor is created

package/src/stateManagement/segmentation/segmentationState.ts

@@ -306,6 +306,29 @@ function setSegmentSpecificRepresentationConfig(
   }
 }
 
+function getToolGroupIdFromSegmentationRepresentationUID(
+  segmentationRepresentationUID: string
+): string {
+  const allToolGroupRepresentations = getAllSegmentationRepresentations() || [];
+
+  const toolGroupIds = Object.keys(allToolGroupRepresentations);
+
+  for (const toolGroupId of toolGroupIds) {
+    const toolGroupRepresentations =
+      getAllSegmentationRepresentations()[toolGroupId];
+
+    const foundRepresentation = toolGroupRepresentations.find(
+      (representation) =>
+        representation.segmentationRepresentationUID ===
+        segmentationRepresentationUID
+    );
+
+    if (foundRepresentation) {
+      return toolGroupId;
+    }
+  }
+}
+
 /**
  * Add the given segmentation representation data to the given tool group state. It fires
  * SEGMENTATION_REPRESENTATION_MODIFIED event if not suppressed.
@@ -512,4 +535,5 @@ export {
   removeColorLUT,
   //
   findSegmentationRepresentationByUID,
+  getToolGroupIdFromSegmentationRepresentationUID,
 };

package/src/store/ToolGroupManager/ToolGroup.ts

@@ -48,6 +48,8 @@ export default class ToolGroup implements IToolGroup {
   id: string;
   viewportsInfo = [];
   toolOptions = {};
+  currentActivePrimaryToolName: string | null = null;
+  prevActivePrimaryToolName: string | null = null;
   /**
    * Options used for restoring a tool
    */
@@ -407,6 +409,18 @@ export default class ToolGroup implements IToolGroup {
       }
     }
 
+    // if it is a primary tool binding, we should store it as the previous primary tool
+    // so that we can restore it when the tool is disabled if desired
+    if (this._hasMousePrimaryButtonBinding(toolBindingsOptions)) {
+      if (this.prevActivePrimaryToolName === null) {
+        this.prevActivePrimaryToolName = toolName;
+      } else {
+        this.prevActivePrimaryToolName = this.currentActivePrimaryToolName;
+      }
+
+      this.currentActivePrimaryToolName = toolName;
+    }
+
     if (typeof toolInstance.onSetToolActive === 'function') {
       toolInstance.onSetToolActive();
     }
@@ -736,6 +750,14 @@ export default class ToolGroup implements IToolGroup {
     return cloneDeep(_configuration);
   }
 
+  /**
+   * Gets the name of the previously active tool.
+   * @returns The name of the previously active tool.
+   */
+  public getPrevActivePrimaryToolName(): string {
+    return this.prevActivePrimaryToolName;
+  }
+
   /**
    *
    * @param newToolGroupId - Id of the new (clone) tool group

package/src/synchronizers/synchronizers/createVOISynchronizer.ts

@@ -20,8 +20,11 @@ type VOISynchronizerOptions = {
  */
 export default function createVOISynchronizer(
   synchronizerName: string,
-  options = { syncInvertState: true } as VOISynchronizerOptions
+  options: VOISynchronizerOptions
 ): Synchronizer {
+  //  = { syncInvertState: true } if options is not provided or undefined or {}
+  options = Object.assign({ syncInvertState: true }, options);
+
   const VOISynchronizer = createSynchronizer(
     synchronizerName,
     Enums.Events.VOI_MODIFIED,

package/src/tools/AdvancedMagnifyTool.ts

@@ -5,7 +5,9 @@ import type { Types } from '@cornerstonejs/core';
 
 import {
   addAnnotation,
+  getAllAnnotations,
   getAnnotations,
+  removeAnnotation,
 } from '../stateManagement/annotation/annotationState';
 import { isAnnotationLocked } from '../stateManagement/annotation/annotationLocking';
 import { isAnnotationVisible } from '../stateManagement/annotation/annotationVisibility';
@@ -186,6 +188,18 @@ class AdvancedMagnifyTool extends AnnotationTool {
     return annotation;
   };
 
+  onSetToolDisabled = () => {
+    // reset
+    this.magnifyViewportManager.dispose();
+    // remove the annotations from the state for that toolGroup
+    const annotations = getAllAnnotations();
+    annotations.forEach((annotation) => {
+      if (annotation.metadata.toolName === this.getToolName()) {
+        removeAnnotation(annotation.annotationUID);
+      }
+    });
+  };
+
   /**
    * It returns if the canvas point is near the provided annotation in the provided
    * element or not. A proximity is passed to the function to determine the
@@ -588,8 +602,7 @@ class AdvancedMagnifyTool extends AnnotationTool {
         radius,
         {
           color,
-          lineDash,
-          lineWidth,
+          lineWidth: 5,
         },
         dataId
       );

package/src/tools/AdvancedMagnifyViewportManager.ts

@@ -15,7 +15,7 @@ import {
 import { AdvancedMagnifyAnnotation } from '../types/ToolSpecificAnnotationTypes';
 
 // Defined the tool name internally instead of importing
-// AdvangedMagnifyTool due to cyclic dependency
+// AdvancedMagnifyTool due to cyclic dependency
 const ADVANCED_MAGNIFY_TOOL_NAME = 'AdvancedMagnify';
 
 const PARALLEL_THRESHOLD = 1 - CONSTANTS.EPSILON;

package/src/tools/CrosshairsTool.ts

@@ -344,9 +344,10 @@ class CrosshairsTool extends AnnotationTool {
    */
   computeToolCenter = (viewportsInfo): void => {
     if (!viewportsInfo.length || viewportsInfo.length === 1) {
-      throw new Error(
+      console.warn(
         'For crosshairs to operate, at least two viewports must be given.'
       );
+      return;
     }
 
     // Todo: handle two same view viewport, or more than 3 viewports

package/src/tools/TrackballRotateTool.ts

@@ -46,7 +46,7 @@ class TrackballRotateTool extends BaseTool {
 
     if (this.cleanUp !== null) {
       // Clean up previous event listener
-      element.removeEventListener('mouseup', this.cleanUp);
+      document.removeEventListener('mouseup', this.cleanUp);
     }
 
     this.cleanUp = () => {
@@ -54,7 +54,7 @@ class TrackballRotateTool extends BaseTool {
       viewport.render();
     };
 
-    element.addEventListener('mouseup', this.cleanUp, { once: true });
+    document.addEventListener('mouseup', this.cleanUp, { once: true });
     return true;
   };
 

package/src/tools/segmentation/BrushTool.ts

@@ -209,7 +209,8 @@ class BrushTool extends BaseTool {
 
       return {
         volumeId,
-        referencedVolumeId: firstVolumeActorUID,
+        referencedVolumeId:
+          labelmapData.referencedVolumeId ?? firstVolumeActorUID,
         segmentsLocked,
         segmentationRepresentationUID,
       };

package/src/tools/segmentation/strategies/BrushStrategy.ts

@@ -215,26 +215,6 @@ export default class BrushStrategy {
       return operationData.preview;
     }
 
-    if (isVolumeSegmentation(operationData, viewport)) {
-      const { referencedVolumeId, volumeId } =
-        operationData as LabelmapToolOperationDataVolume;
-
-      const segmentation = cache.getVolume(volumeId);
-
-      if (referencedVolumeId) {
-        const imageVolume = cache.getVolume(referencedVolumeId);
-
-        if (
-          !csUtils.isEqual(segmentation.dimensions, imageVolume.dimensions) ||
-          !csUtils.isEqual(segmentation.direction, imageVolume.direction)
-        ) {
-          throw new Error(
-            'Only source data the same dimensions/size/orientation as the segmentation currently supported.'
-          );
-        }
-      }
-    }
-
     const {
       imageVoxelManager,
       segmentationVoxelManager,

package/src/utilities/cine/playClip.ts

@@ -47,6 +47,10 @@ function playClip(
     );
   }
 
+  if (!playClipOptions) {
+    playClipOptions = {};
+  }
+
   // 4D Cine is enabled by default
   playClipOptions.dynamicCineEnabled =
     playClipOptions.dynamicCineEnabled ?? true;

package/src/utilities/getCalibratedUnits.ts

@@ -140,7 +140,7 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
       (region) =>
         SUPPORTED_REGION_DATA_TYPES.includes(region.regionDataType) &&
         SUPPORTED_LENGTH_VARIANT.includes(
-          `${region.physicalUnitXDirection},${region.physicalUnitYDirection}`
+          `${region.physicalUnitsXDirection},${region.physicalUnitsYDirection}`
         )
     );
 
@@ -176,10 +176,15 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
   }
 
   // everything except REGION/Uncalibratted
-  const types = [CalibrationTypes.ERMF, CalibrationTypes.USER, CalibrationTypes.ERROR, CalibrationTypes.PROJECTION];
+  const types = [
+    CalibrationTypes.ERMF,
+    CalibrationTypes.USER,
+    CalibrationTypes.ERROR,
+    CalibrationTypes.PROJECTION,
+  ];
 
   if (types.includes(calibration?.type)) {
-      calibrationType = calibration.type;
+    calibrationType = calibration.type;
   }
 
   return {
@@ -211,7 +216,7 @@ const getCalibratedProbeUnitsAndValue = (image, handles) => {
         (region) =>
           SUPPORTED_REGION_DATA_TYPES.includes(region.regionDataType) &&
           SUPPORTED_PROBE_VARIANT.includes(
-            `${region.physicalUnitXDirection},${region.physicalUnitYDirection}`
+            `${region.physicalUnitsXDirection},${region.physicalUnitsYDirection}`
           )
       );
 
@@ -247,8 +252,8 @@ const getCalibratedProbeUnitsAndValue = (image, handles) => {
     calibrationType = 'US Region';
     values = [xValue, yValue];
     units = [
-      UNIT_MAPPING[region.physicalUnitXDirection],
-      UNIT_MAPPING[region.physicalUnitYDirection],
+      UNIT_MAPPING[region.physicalUnitsXDirection],
+      UNIT_MAPPING[region.physicalUnitsYDirection],
     ];
   }
 

package/src/utilities/segmentation/rectangleROIThresholdVolumeByRange.ts

@@ -13,6 +13,7 @@ export type ThresholdOptions = {
   numSlicesToProject?: number; // number of slices to project before and after current slice
   overwrite: boolean;
   overlapType?: number; // type of the voxel overlap
+  segmentIndex?: number; // segment index to threshold
 };
 
 export type AnnotationForThresholding = {
@@ -69,6 +70,8 @@ function rectangleROIThresholdVolumeByRange(
     { ...options, boundsIJK }
   );
 
+  outputSegmentationVolume.modified();
+
   return outputSegmentationVolume;
 }
 

package/src/utilities/segmentation/thresholdVolumeByRange.ts

@@ -12,6 +12,7 @@ export type ThresholdRangeOptions = {
   overwrite: boolean;
   boundsIJK: BoundsIJK;
   overlapType?: number;
+  segmentIndex?: number;
 };
 
 /**
@@ -136,9 +137,8 @@ function thresholdVolumeByRange(
       }
     }
 
-    // Todo: make the segmentIndex a parameter
     if (insert) {
-      scalarData[index] = 1;
+      scalarData[index] = options.segmentIndex || 1;
     }
   };
 

package/src/workers/polySegConverters.js

@@ -13,7 +13,6 @@ import { pointInShapeCallback } from '../utilities';
 import {
   containsPoint,
   getAABB,
-  isPointInsidePolyline3D,
   projectTo2D,
 } from '../utilities/math/polyline';
 import { isPlaneIntersectingAABB } from '../utilities/planar';