@cornerstonejs/tools 1.14.3 → 1.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.14.3",
+  "version": "1.15.0",
   "description": "Cornerstone3D Tools",
   "main": "dist/umd/index.js",
   "types": "dist/esm/index.d.ts",
@@ -29,7 +29,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^1.14.3",
+    "@cornerstonejs/core": "^1.15.0",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "^4.4.2"
   },
@@ -52,5 +52,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "a41ad226c52019627d584142eefc7b412022a3e8"
+  "gitHead": "d4478aa1242c48e10c95ef6dd511f2497e19b5e8"
 }

package/src/stateManagement/annotation/config/ToolStyle.ts

@@ -35,6 +35,7 @@ class ToolStyle {
       lineWidth: '1',
       lineDash: '',
       shadow: true,
+      textBoxVisibility: true,
       textBoxFontFamily: 'Helvetica Neue, Helvetica, Arial, sans-serif',
       textBoxFontSize: '14px',
       textBoxColor: 'rgb(255, 255, 0)',

package/src/store/SynchronizerManager/Synchronizer.ts

@@ -205,6 +205,7 @@ class Synchronizer {
     }
 
     this._ignoreFiredEvents = true;
+    const promises = [];
     try {
       for (let i = 0; i < this._targetViewports.length; i++) {
         const targetViewport = this._targetViewports[i];
@@ -214,19 +215,26 @@ class Synchronizer {
         if (targetIsSource) {
           continue;
         }
-
-        this._eventHandler(
-          this,
-          sourceViewport,
-          targetViewport,
-          sourceEvent,
-          this._options
+        promises.push(
+          this._eventHandler(
+            this,
+            sourceViewport,
+            targetViewport,
+            sourceEvent,
+            this._options
+          )
         );
       }
     } catch (ex) {
       console.warn(`Synchronizer, for: ${this._eventName}`, ex);
     } finally {
-      this._ignoreFiredEvents = false;
+      if (promises.length) {
+        Promise.allSettled(promises).then(() => {
+          this._ignoreFiredEvents = false;
+        });
+      } else {
+        this._ignoreFiredEvents = false;
+      }
     }
   }
 

package/src/synchronizers/callbacks/stackImageSyncCallback.ts

@@ -1,4 +1,4 @@
-import { vec3 } from 'gl-matrix';
+import { vec3, mat4 } from 'gl-matrix';
 import {
   getRenderingEngine,
   Types,
@@ -8,28 +8,27 @@ import {
 import { Synchronizer } from '../../store';
 import { jumpToSlice } from '../../utilities';
 import areViewportsCoplanar from './areViewportsCoplanar ';
+
+const getSpatialRegistration = (targetId, sourceId) =>
+  utilities.spatialRegistrationMetadataProvider.get(
+    'spatialRegistrationModule',
+    [targetId, sourceId]
+  );
+
 /**
  * Synchronizer callback to synchronize the source viewport image to the
- * target viewports closest image in its stack. There are two scenarios
+ * target viewports closest image in its stack.
  *
- * 1) viewports are in the same frameOfReferenceUID then we can use the
- * absolute imagePositionPatient for the source viewport's current image
- * and set the target viewport's image to the closest image in its stack
- * (which might have different slice thickness so cannot use slice number)
+ * This synchronizer does a setup (which can already be predefined as required)
+ * to register the target and soruce viewports.  The registration will default
+ * to the identity registration if the same FOR is present in both viewports,
+ * unless the option `useInitialPosition` is set in the target viewport.
  *
- * 2) viewports have different frameOfReferenceUIDs then we look inside the
- * registrationMetadataProvider to check if there is a corresponding matrix
- * for mapping between the source and target viewport if so it is used to
- * and is applied to the imagePositionPatient of the source viewport's to
- * get the imagePositionPatient of the target viewport's closest image in
- * its stack.
- * Note for 2) The consuming apps using Cornerstone3D (OHIF, etc) are responsible
- * to provide such data in the registrationMetadataProvider. This can be done
+ * The consuming apps using Cornerstone3D (OHIF, etc) MAY provide such data in
+ * the registrationMetadataProvider to override the data here. This can be done
  * by various methods 1) Using spatialRegistrationModule inside dicom 2) assuming
  * the user has actually manually scrolled the target viewport to the correct
  * slice before initiating the synchronization 3) using some other method
- * But overall, the consuming app is responsible for providing the data.
- *
  *
  * @param synchronizerInstance - The Instance of the Synchronizer
  * @param sourceViewport - The list of IDs defining the source viewport.
@@ -53,13 +52,16 @@ export default async function stackImageSyncCallback(
     sourceViewport.viewportId
   ) as Types.IStackViewport;
 
+  const options = synchronizerInstance.getOptions(targetViewport.viewportId);
+
+  if (options?.disabled) {
+    return;
+  }
+
   const tViewport = renderingEngine.getViewport(
     targetViewport.viewportId
   ) as Types.IStackViewport;
 
-  const frameOfReferenceUID1 = sViewport.getFrameOfReferenceUID();
-  const frameOfReferenceUID2 = tViewport.getFrameOfReferenceUID();
-
   const imageId1 = sViewport.getCurrentImageId();
   const imagePlaneModule1 = metaData.get('imagePlaneModule', imageId1);
   const sourceImagePositionPatient = imagePlaneModule1.imagePositionPatient;
@@ -70,69 +72,62 @@ export default async function stackImageSyncCallback(
     return;
   }
 
-  if (frameOfReferenceUID1 === frameOfReferenceUID2) {
-    // if frames of references are the same we can use the absolute
-    // imagePositionPatient to find the closest image in the target viewport's stack
-    const closestImageIdIndex = _getClosestImageIdIndex(
-      sourceImagePositionPatient,
-      targetImageIds
-    );
+  // if the frame of reference is different we need to use the registrationMetadataProvider
+  // and add that to the imagePositionPatient of the source viewport to get the
+  // imagePositionPatient of the target viewport's closest image in its stack
+  let registrationMatrixMat4 = getSpatialRegistration(
+    targetViewport.viewportId,
+    sourceViewport.viewportId
+  );
 
+  if (!registrationMatrixMat4) {
+    const frameOfReferenceUID1 = sViewport.getFrameOfReferenceUID();
+    const frameOfReferenceUID2 = tViewport.getFrameOfReferenceUID();
     if (
-      closestImageIdIndex.index !== -1 &&
-      tViewport.getCurrentImageIdIndex() !== closestImageIdIndex.index
+      frameOfReferenceUID1 === frameOfReferenceUID2 &&
+      options.useInitialPosition !== false
     ) {
-      // await tViewport.setImageIdIndex(closestImageIdIndex.index);
-      await jumpToSlice(tViewport.element, {
-        imageIndex: closestImageIdIndex.index,
-      });
-
-      return;
-    }
-  } else {
-    // if the frame of reference is different we need to use the registrationMetadataProvider
-    // and add that to the imagePositionPatient of the source viewport to get the
-    // imagePositionPatient of the target viewport's closest image in its stack
-    const registrationMatrixMat4 =
-      utilities.spatialRegistrationMetadataProvider.get(
-        'spatialRegistrationModule',
-        [targetViewport.viewportId, sourceViewport.viewportId]
+      registrationMatrixMat4 = mat4.identity(mat4.create());
+    } else {
+      utilities.calculateViewportsSpatialRegistration(sViewport, tViewport);
+      registrationMatrixMat4 = getSpatialRegistration(
+        targetViewport.viewportId,
+        sourceViewport.viewportId
       );
-
+    }
     if (!registrationMatrixMat4) {
-      throw new Error(
-        `No registration matrix found for sourceViewport: ${sourceViewport.viewportId} and targetViewport: ${targetViewport.viewportId}, viewports with different frameOfReferenceUIDs must have a registration matrix in the registrationMetadataProvider. Use calculateViewportsRegistrationMatrix to calculate the matrix.`
-      );
+      return;
     }
+  }
 
-    // apply the registration matrix to the source viewport's imagePositionPatient
-    // to get the target viewport's imagePositionPatient
-    const targetImagePositionPatientWithRegistrationMatrix = vec3.transformMat4(
-      vec3.create(),
-      sourceImagePositionPatient,
-      registrationMatrixMat4
-    );
+  // apply the registration matrix to the source viewport's imagePositionPatient
+  // to get the target viewport's imagePositionPatient
+  const targetImagePositionPatientWithRegistrationMatrix = vec3.transformMat4(
+    vec3.create(),
+    sourceImagePositionPatient,
+    registrationMatrixMat4
+  );
 
-    // find the closest image in the target viewport's stack to the
-    // targetImagePositionPatientWithRegistrationMatrix
-    const closestImageIdIndex2 = _getClosestImageIdIndex(
-      targetImagePositionPatientWithRegistrationMatrix,
-      targetImageIds
-    );
+  // find the closest image in the target viewport's stack to the
+  // targetImagePositionPatientWithRegistrationMatrix
+  const closestImageIdIndex2 = _getClosestImageIdIndex(
+    targetImagePositionPatientWithRegistrationMatrix,
+    targetImageIds
+  );
 
-    if (
-      closestImageIdIndex2.index !== -1 &&
-      tViewport.getCurrentImageIdIndex() !== closestImageIdIndex2.index
-    ) {
-      await jumpToSlice(tViewport.element, {
-        imageIndex: closestImageIdIndex2.index,
-      });
-    }
+  if (
+    closestImageIdIndex2.index !== -1 &&
+    tViewport.getCurrentImageIdIndex() !== closestImageIdIndex2.index
+  ) {
+    await jumpToSlice(tViewport.element, {
+      imageIndex: closestImageIdIndex2.index,
+    });
   }
 }
 
 function _getClosestImageIdIndex(targetPoint, imageIds) {
   // todo: this does not assume orientation yet, but that can be added later
+  // todo: handle multiframe images
   return imageIds.reduce(
     (closestImageIdIndex, imageId, index) => {
       const { imagePositionPatient } = metaData.get(

package/src/synchronizers/callbacks/voiSyncCallback.ts

@@ -39,7 +39,7 @@ export default function voiSyncCallback(
     voiRange: range,
   };
 
-  if (options.syncInvertState && invertStateChanged) {
+  if (options?.syncInvertState && invertStateChanged) {
     tProperties.invert = invert;
   }
 

package/src/tools/annotation/AngleTool.ts

@@ -745,6 +745,21 @@ class AngleTool extends AnnotationTool {
         continue;
       }
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
+
       const textLines = this.configuration.getTextLines(data, targetId);
 
       if (!data.handles.textBox.hasMoved) {
@@ -768,7 +783,7 @@ class AngleTool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/ArrowAnnotateTool.ts

@@ -776,6 +776,21 @@ class ArrowAnnotateTool extends AnnotationTool {
         continue;
       }
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
+
       // Need to update to sync w/ annotation while unlinked/not moved
       if (!data.handles.textBox.hasMoved) {
         // linked to the point that doesn't have the arrowhead by default
@@ -798,7 +813,7 @@ class ArrowAnnotateTool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/BidirectionalTool.ts

@@ -1162,11 +1162,26 @@ class BidirectionalTool extends AnnotationTool {
 
       renderStatus = true;
 
-      const textLines = this.configuration.getTextLines(data, targetId);
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
 
+      const textLines = this.configuration.getTextLines(data, targetId);
       if (!textLines || textLines.length === 0) {
         continue;
       }
+
       let canvasTextBoxCoords;
 
       if (!data.handles.textBox.hasMoved) {
@@ -1189,7 +1204,7 @@ class BidirectionalTool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/CircleROITool.ts

@@ -826,6 +826,21 @@ class CircleROITool extends AnnotationTool {
 
       renderStatus = true;
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
+
       const textLines = this.configuration.getTextLines(data, targetId);
       if (!textLines || textLines.length === 0) {
         continue;
@@ -854,7 +869,7 @@ class CircleROITool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/CobbAngleTool.ts

@@ -770,6 +770,21 @@ class CobbAngleTool extends AnnotationTool {
         continue;
       }
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
+
       const textLines = this.configuration.getTextLines(data, targetId);
 
       if (!data.handles.textBox.hasMoved) {
@@ -792,7 +807,7 @@ class CobbAngleTool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/EllipticalROITool.ts

@@ -950,6 +950,21 @@ class EllipticalROITool extends AnnotationTool {
 
       renderStatus = true;
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
+
       const textLines = this.configuration.getTextLines(data, targetId);
       if (!textLines || textLines.length === 0) {
         continue;
@@ -978,7 +993,7 @@ class EllipticalROITool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/LengthTool.ts

@@ -732,6 +732,21 @@ class LengthTool extends AnnotationTool {
         return renderStatus;
       }
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
+
       const textLines = this.configuration.getTextLines(data, targetId);
 
       // Need to update to sync with annotation while unlinked/not moved
@@ -755,7 +770,7 @@ class LengthTool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/PlanarFreehandROITool.ts

@@ -882,6 +882,17 @@ class PlanarFreehandROITool extends AnnotationTool {
     const data = annotation.data;
     const targetId = this.getTargetId(viewport);
 
+    const styleSpecifier: AnnotationStyle.StyleSpecifier = {
+      toolGroupId: this.toolGroupId,
+      toolName: this.getToolName(),
+      viewportId: enabledElement.viewport.id,
+    };
+
+    const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+    if (!options.visibility) {
+      return;
+    }
+
     const textLines = this.configuration.getTextLines(data, targetId);
     if (!textLines || textLines.length === 0) {
       return;
@@ -901,12 +912,6 @@ class PlanarFreehandROITool extends AnnotationTool {
       data.handles.textBox.worldPosition
     );
 
-    const styleSpecifier: AnnotationStyle.StyleSpecifier = {
-      toolGroupId: this.toolGroupId,
-      toolName: this.getToolName(),
-      viewportId: enabledElement.viewport.id,
-    };
-
     const textBoxUID = '1';
     const boundingBox = drawLinkedTextBox(
       svgDrawingHelper,
@@ -916,7 +921,7 @@ class PlanarFreehandROITool extends AnnotationTool {
       textBoxPosition,
       canvasCoordinates,
       {},
-      this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+      options
     );
 
     const { x: left, y: top, width, height } = boundingBox;

package/src/tools/annotation/ProbeTool.ts

@@ -527,6 +527,11 @@ class ProbeTool extends AnnotationTool {
 
       renderStatus = true;
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        continue;
+      }
+
       const textLines = this.configuration.getTextLines(data, targetId);
       if (textLines) {
         const textCanvasCoordinates = [
@@ -541,7 +546,7 @@ class ProbeTool extends AnnotationTool {
           textUID,
           textLines,
           [textCanvasCoordinates[0], textCanvasCoordinates[1]],
-          this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+          options
         );
       }
     }

package/src/tools/annotation/RectangleROITool.ts

@@ -791,6 +791,21 @@ class RectangleROITool extends AnnotationTool {
 
       renderStatus = true;
 
+      const options = this.getLinkedTextBoxStyle(styleSpecifier, annotation);
+      if (!options.visibility) {
+        data.handles.textBox = {
+          hasMoved: false,
+          worldPosition: <Types.Point3>[0, 0, 0],
+          worldBoundingBox: {
+            topLeft: <Types.Point3>[0, 0, 0],
+            topRight: <Types.Point3>[0, 0, 0],
+            bottomLeft: <Types.Point3>[0, 0, 0],
+            bottomRight: <Types.Point3>[0, 0, 0],
+          },
+        };
+        continue;
+      }
+
       const textLines = this.configuration.getTextLines(data, targetId);
       if (!textLines || textLines.length === 0) {
         continue;
@@ -816,7 +831,7 @@ class RectangleROITool extends AnnotationTool {
         textBoxPosition,
         canvasCoordinates,
         {},
-        this.getLinkedTextBoxStyle(styleSpecifier, annotation)
+        options
       );
 
       const { x: left, y: top, width, height } = boundingBox;

package/src/tools/base/AnnotationTool.ts

@@ -257,6 +257,11 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
     // for the textBox.
 
     return {
+      visibility: this.getStyle(
+        'textBoxVisibility',
+        specifications,
+        annotation
+      ),
       fontFamily: this.getStyle(
         'textBoxFontFamily',
         specifications,