@cornerstonejs/tools 1.4.3 → 1.4.5

package/package.json

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

package/src/tools/annotation/CircleROITool.ts

@@ -51,7 +51,10 @@ import {
 import triggerAnnotationRenderForViewportIds from '../../utilities/triggerAnnotationRenderForViewportIds';
 import { pointInShapeCallback } from '../../utilities';
 import { StyleSpecifier } from '../../types/AnnotationStyle';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import {
+  ModalityUnitOptions,
+  getModalityUnit,
+} from '../../utilities/getModalityUnit';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
 import {
   getCanvasCircleCorners,
@@ -661,6 +664,16 @@ class CircleROITool extends AnnotationTool {
 
       const { centerPointRadius } = this.configuration;
 
+      const modalityUnitOptions = {
+        isPreScaled: isViewportPreScaled(viewport, targetId),
+
+        isSuvScaled: this.isSuvScaled(
+          viewport,
+          targetId,
+          annotation.metadata.referencedImageId
+        ),
+      };
+
       // If cachedStats does not exist, or the unit is missing (as part of import/hydration etc.),
       // force to recalculate the stats from the points
       if (
@@ -683,14 +696,16 @@ class CircleROITool extends AnnotationTool {
           annotation,
           viewport,
           renderingEngine,
-          enabledElement
+          enabledElement,
+          modalityUnitOptions
         );
       } else if (annotation.invalidated) {
         this._throttledCalculateCachedStats(
           annotation,
           viewport,
           renderingEngine,
-          enabledElement
+          enabledElement,
+          modalityUnitOptions
         );
         // If the invalidated data is as a result of volumeViewport manipulation
         // of the tools, we need to invalidate the related viewports data, so that
@@ -797,20 +812,7 @@ class CircleROITool extends AnnotationTool {
 
       renderStatus = true;
 
-      const isPreScaled = isViewportPreScaled(viewport, targetId);
-
-      const isSuvScaled = this.isSuvScaled(
-        viewport,
-        targetId,
-        annotation.metadata.referencedImageId
-      );
-
-      const textLines = this._getTextLines(
-        data,
-        targetId,
-        isPreScaled,
-        isSuvScaled
-      );
+      const textLines = this._getTextLines(data, targetId);
       if (!textLines || textLines.length === 0) {
         continue;
       }
@@ -854,12 +856,7 @@ class CircleROITool extends AnnotationTool {
     return renderStatus;
   };
 
-  _getTextLines = (
-    data,
-    targetId: string,
-    isPreScaled: boolean,
-    isSuvScaled: boolean
-  ): string[] => {
+  _getTextLines = (data, targetId: string): string[] => {
     const cachedVolumeStats = data.cachedStats[targetId];
     const {
       radius,
@@ -871,10 +868,10 @@ class CircleROITool extends AnnotationTool {
       isEmptyArea,
       Modality,
       areaUnit,
+      modalityUnit,
     } = cachedVolumeStats;
 
     const textLines: string[] = [];
-    const unit = getModalityUnit(Modality, isPreScaled, isSuvScaled);
 
     if (radius) {
       const radiusLine = isEmptyArea
@@ -891,15 +888,15 @@ class CircleROITool extends AnnotationTool {
     }
 
     if (mean) {
-      textLines.push(`Mean: ${mean.toFixed(2)} ${unit}`);
+      textLines.push(`Mean: ${mean.toFixed(2)} ${modalityUnit}`);
     }
 
     if (max) {
-      textLines.push(`Max: ${max.toFixed(2)} ${unit}`);
+      textLines.push(`Max: ${max.toFixed(2)} ${modalityUnit}`);
     }
 
     if (stdDev) {
-      textLines.push(`Std Dev: ${stdDev.toFixed(2)} ${unit}`);
+      textLines.push(`Std Dev: ${stdDev.toFixed(2)} ${modalityUnit}`);
     }
 
     return textLines;
@@ -909,7 +906,8 @@ class CircleROITool extends AnnotationTool {
     annotation,
     viewport,
     renderingEngine,
-    enabledElement
+    enabledElement,
+    modalityUnitOptions: ModalityUnitOptions
   ) => {
     const data = annotation.data;
     const { viewportId, renderingEngineId } = enabledElement;
@@ -1037,6 +1035,12 @@ class CircleROITool extends AnnotationTool {
         stdDev /= count;
         stdDev = Math.sqrt(stdDev);
 
+        const modalityUnit = getModalityUnit(
+          metadata.Modality,
+          annotation.metadata.referencedImageId,
+          modalityUnitOptions
+        );
+
         cachedStats[targetId] = {
           Modality: metadata.Modality,
           area,
@@ -1048,6 +1052,7 @@ class CircleROITool extends AnnotationTool {
           radius: worldWidth / 2,
           radiusUnit: hasPixelSpacing ? 'mm' : 'px',
           perimeter: 2 * Math.PI * (worldWidth / 2),
+          modalityUnit,
         };
       } else {
         this.isHandleOutsideImage = true;

package/src/tools/annotation/DragProbeTool.ts

@@ -155,6 +155,16 @@ class DragProbeTool extends ProbeTool {
 
     const color = this.getStyle('color', styleSpecifier, annotation);
 
+    const modalityUnitOptions = {
+      isPreScaled: isViewportPreScaled(viewport, targetId),
+
+      isSuvScaled: this.isSuvScaled(
+        viewport,
+        targetId,
+        annotation.metadata.referencedImageId
+      ),
+    };
+
     if (!data.cachedStats[targetId]) {
       data.cachedStats[targetId] = {
         Modality: null,
@@ -162,9 +172,19 @@ class DragProbeTool extends ProbeTool {
         value: null,
       };
 
-      this._calculateCachedStats(annotation, renderingEngine, enabledElement);
+      this._calculateCachedStats(
+        annotation,
+        renderingEngine,
+        enabledElement,
+        modalityUnitOptions
+      );
     } else if (annotation.invalidated) {
-      this._calculateCachedStats(annotation, renderingEngine, enabledElement);
+      this._calculateCachedStats(
+        annotation,
+        renderingEngine,
+        enabledElement,
+        modalityUnitOptions
+      );
     }
 
     // If rendering engine has been destroyed while rendering
@@ -185,20 +205,7 @@ class DragProbeTool extends ProbeTool {
 
     renderStatus = true;
 
-    const isPreScaled = isViewportPreScaled(viewport, targetId);
-
-    const isSuvScaled = this.isSuvScaled(
-      viewport,
-      targetId,
-      annotation.metadata.referencedImageId
-    );
-
-    const textLines = this._getTextLines(
-      data,
-      targetId,
-      isPreScaled,
-      isSuvScaled
-    );
+    const textLines = this._getTextLines(data, targetId);
     if (textLines) {
       const textCanvasCoordinates = [
         canvasCoordinates[0] + 6,

package/src/tools/annotation/EllipticalROITool.ts

@@ -56,7 +56,10 @@ import {
 import triggerAnnotationRenderForViewportIds from '../../utilities/triggerAnnotationRenderForViewportIds';
 import { pointInShapeCallback } from '../../utilities/';
 import { StyleSpecifier } from '../../types/AnnotationStyle';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import {
+  ModalityUnitOptions,
+  getModalityUnit,
+} from '../../utilities/getModalityUnit';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
 
 const { transformWorldToIndex } = csUtils;
@@ -787,6 +790,16 @@ class EllipticalROITool extends AnnotationTool {
 
       const { centerPointRadius } = this.configuration;
 
+      const modalityUnitOptions = {
+        isPreScaled: isViewportPreScaled(viewport, targetId),
+
+        isSuvScaled: this.isSuvScaled(
+          viewport,
+          targetId,
+          annotation.metadata.referencedImageId
+        ),
+      };
+
       // If cachedStats does not exist, or the unit is missing (as part of import/hydration etc.),
       // force to recalculate the stats from the points
       if (
@@ -806,14 +819,16 @@ class EllipticalROITool extends AnnotationTool {
           annotation,
           viewport,
           renderingEngine,
-          enabledElement
+          enabledElement,
+          modalityUnitOptions
         );
       } else if (annotation.invalidated) {
         this._throttledCalculateCachedStats(
           annotation,
           viewport,
           renderingEngine,
-          enabledElement
+          enabledElement,
+          modalityUnitOptions
         );
         // If the invalidated data is as a result of volumeViewport manipulation
         // of the tools, we need to invalidate the related viewports data, so that
@@ -925,20 +940,7 @@ class EllipticalROITool extends AnnotationTool {
 
       renderStatus = true;
 
-      const isPreScaled = isViewportPreScaled(viewport, targetId);
-
-      const isSuvScaled = this.isSuvScaled(
-        viewport,
-        targetId,
-        annotation.metadata.referencedImageId
-      );
-
-      const textLines = this._getTextLines(
-        data,
-        targetId,
-        isPreScaled,
-        isSuvScaled
-      );
+      const textLines = this._getTextLines(data, targetId);
       if (!textLines || textLines.length === 0) {
         continue;
       }
@@ -982,18 +984,12 @@ class EllipticalROITool extends AnnotationTool {
     return renderStatus;
   };
 
-  _getTextLines = (
-    data,
-    targetId: string,
-    isPreScaled: boolean,
-    isSuvScaled: boolean
-  ): string[] => {
+  _getTextLines = (data, targetId: string): string[] => {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { area, mean, stdDev, max, isEmptyArea, Modality, areaUnit } =
+    const { area, mean, stdDev, max, isEmptyArea, areaUnit, modalityUnit } =
       cachedVolumeStats;
 
     const textLines: string[] = [];
-    const unit = getModalityUnit(Modality, isPreScaled, isSuvScaled);
 
     if (area) {
       const areaLine = isEmptyArea
@@ -1003,15 +999,15 @@ class EllipticalROITool extends AnnotationTool {
     }
 
     if (mean) {
-      textLines.push(`Mean: ${mean.toFixed(2)} ${unit}`);
+      textLines.push(`Mean: ${mean.toFixed(2)} ${modalityUnit}`);
     }
 
     if (max) {
-      textLines.push(`Max: ${max.toFixed(2)} ${unit}`);
+      textLines.push(`Max: ${max.toFixed(2)} ${modalityUnit}`);
     }
 
     if (stdDev) {
-      textLines.push(`Std Dev: ${stdDev.toFixed(2)} ${unit}`);
+      textLines.push(`Std Dev: ${stdDev.toFixed(2)} ${modalityUnit}`);
     }
 
     return textLines;
@@ -1021,7 +1017,8 @@ class EllipticalROITool extends AnnotationTool {
     annotation,
     viewport,
     renderingEngine,
-    enabledElement
+    enabledElement,
+    modalityUnitOptions: ModalityUnitOptions
   ) => {
     const data = annotation.data;
     const { viewportId, renderingEngineId } = enabledElement;
@@ -1149,6 +1146,12 @@ class EllipticalROITool extends AnnotationTool {
         stdDev /= count;
         stdDev = Math.sqrt(stdDev);
 
+        const modalityUnit = getModalityUnit(
+          metadata.Modality,
+          annotation.metadata.referencedImageId,
+          modalityUnitOptions
+        );
+
         cachedStats[targetId] = {
           Modality: metadata.Modality,
           area,
@@ -1157,6 +1160,7 @@ class EllipticalROITool extends AnnotationTool {
           stdDev,
           isEmptyArea,
           areaUnit: hasPixelSpacing ? 'mm' : 'px',
+          modalityUnit,
         };
       } else {
         this.isHandleOutsideImage = true;

package/src/tools/annotation/PlanarFreehandROITool.ts

@@ -49,7 +49,10 @@ import pointInPolyline from '../../utilities/math/polyline/pointInPolyline';
 import { getIntersectionCoordinatesWithPolyline } from '../../utilities/math/polyline/getIntersectionWithPolyline';
 import pointInShapeCallback from '../../utilities/pointInShapeCallback';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import {
+  ModalityUnitOptions,
+  getModalityUnit,
+} from '../../utilities/getModalityUnit';
 
 const { pointCanProjectOnLine } = polyline;
 const { EPSILON } = CONSTANTS;
@@ -663,6 +666,15 @@ class PlanarFreehandROITool extends AnnotationTool {
       )
         return;
 
+      const modalityUnitOptions = {
+        isPreScaled: isViewportPreScaled(viewport, targetId),
+        isSuvScaled: this.isSuvScaled(
+          viewport,
+          targetId,
+          annotation.metadata.referencedImageId
+        ),
+      };
+
       if (!this.commonData?.movingTextBox) {
         const { data } = annotation;
         if (
@@ -682,14 +694,16 @@ class PlanarFreehandROITool extends AnnotationTool {
             annotation,
             viewport,
             renderingEngine,
-            enabledElement
+            enabledElement,
+            modalityUnitOptions
           );
         } else if (annotation.invalidated) {
           this._throttledCalculateCachedStats(
             annotation,
             viewport,
             renderingEngine,
-            enabledElement
+            enabledElement,
+            modalityUnitOptions
           );
         }
       }
@@ -704,7 +718,8 @@ class PlanarFreehandROITool extends AnnotationTool {
     annotation,
     viewport,
     renderingEngine,
-    enabledElement
+    enabledElement,
+    modalityUnitOptions: ModalityUnitOptions
   ) => {
     const data = annotation.data;
     const { cachedStats, polyline: points } = data;
@@ -841,6 +856,12 @@ class PlanarFreehandROITool extends AnnotationTool {
       let stdDev = sumSquares / count - mean ** 2;
       stdDev = Math.sqrt(stdDev);
 
+      const modalityUnit = getModalityUnit(
+        metadata.Modality,
+        annotation.metadata.referencedImageId,
+        modalityUnitOptions
+      );
+
       cachedStats[targetId] = {
         Modality: metadata.Modality,
         area,
@@ -848,6 +869,7 @@ class PlanarFreehandROITool extends AnnotationTool {
         max,
         stdDev,
         areaUnit: hasPixelSpacing ? 'mm' : 'px',
+        modalityUnit,
       };
     }
 
@@ -861,19 +883,8 @@ class PlanarFreehandROITool extends AnnotationTool {
   _renderStats = (annotation, viewport, enabledElement, svgDrawingHelper) => {
     const data = annotation.data;
     const targetId = this.getTargetId(viewport);
-    const isPreScaled = isViewportPreScaled(viewport, targetId);
-    const isSuvScaled = this.isSuvScaled(
-      viewport,
-      targetId,
-      annotation.metadata.referencedImageId
-    );
 
-    const textLines = this._getTextLines(
-      data,
-      targetId,
-      isPreScaled,
-      isSuvScaled
-    );
+    const textLines = this._getTextLines(data, targetId);
     if (!textLines || textLines.length === 0) return;
 
     const canvasCoordinates = data.polyline.map((p) =>
@@ -918,18 +929,12 @@ class PlanarFreehandROITool extends AnnotationTool {
     };
   };
 
-  _getTextLines = (
-    data,
-    targetId: string,
-    isPreScaled: boolean,
-    isSuvScaled: boolean
-  ): string[] => {
+  _getTextLines = (data, targetId: string): string[] => {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { area, mean, stdDev, max, isEmptyArea, Modality, areaUnit } =
+    const { area, mean, stdDev, max, isEmptyArea, areaUnit, modalityUnit } =
       cachedVolumeStats;
 
     const textLines: string[] = [];
-    const unit = getModalityUnit(Modality, isPreScaled, isSuvScaled);
 
     if (area) {
       const areaLine = isEmptyArea
@@ -939,15 +944,15 @@ class PlanarFreehandROITool extends AnnotationTool {
     }
 
     if (mean) {
-      textLines.push(`Mean: ${mean.toFixed(2)} ${unit}`);
+      textLines.push(`Mean: ${mean.toFixed(2)} ${modalityUnit}`);
     }
 
     if (max) {
-      textLines.push(`Max: ${max.toFixed(2)} ${unit}`);
+      textLines.push(`Max: ${max.toFixed(2)} ${modalityUnit}`);
     }
 
     if (stdDev) {
-      textLines.push(`Std Dev: ${stdDev.toFixed(2)} ${unit}`);
+      textLines.push(`Std Dev: ${stdDev.toFixed(2)} ${modalityUnit}`);
     }
 
     return textLines;

package/src/tools/annotation/ProbeTool.ts

@@ -44,7 +44,10 @@ import {
 } from '../../types';
 import { ProbeAnnotation } from '../../types/ToolSpecificAnnotationTypes';
 import { StyleSpecifier } from '../../types/AnnotationStyle';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import {
+  ModalityUnitOptions,
+  getModalityUnit,
+} from '../../utilities/getModalityUnit';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
 
 const { transformWorldToIndex } = csUtils;
@@ -437,6 +440,16 @@ class ProbeTool extends AnnotationTool {
 
       const color = this.getStyle('color', styleSpecifier, annotation);
 
+      const modalityUnitOptions = {
+        isPreScaled: isViewportPreScaled(viewport, targetId),
+
+        isSuvScaled: this.isSuvScaled(
+          viewport,
+          targetId,
+          annotation.metadata.referencedImageId
+        ),
+      };
+
       if (!data.cachedStats[targetId]) {
         data.cachedStats[targetId] = {
           Modality: null,
@@ -444,9 +457,19 @@ class ProbeTool extends AnnotationTool {
           value: null,
         };
 
-        this._calculateCachedStats(annotation, renderingEngine, enabledElement);
+        this._calculateCachedStats(
+          annotation,
+          renderingEngine,
+          enabledElement,
+          modalityUnitOptions
+        );
       } else if (annotation.invalidated) {
-        this._calculateCachedStats(annotation, renderingEngine, enabledElement);
+        this._calculateCachedStats(
+          annotation,
+          renderingEngine,
+          enabledElement,
+          modalityUnitOptions
+        );
 
         // If the invalidated data is as a result of volumeViewport manipulation
         // of the tools, we need to invalidate the related stackViewports data if
@@ -502,20 +525,7 @@ class ProbeTool extends AnnotationTool {
 
       renderStatus = true;
 
-      const isPreScaled = isViewportPreScaled(viewport, targetId);
-
-      const isSuvScaled = this.isSuvScaled(
-        viewport,
-        targetId,
-        annotation.metadata.referencedImageId
-      );
-
-      const textLines = this._getTextLines(
-        data,
-        targetId,
-        isPreScaled,
-        isSuvScaled
-      );
+      const textLines = this._getTextLines(data, targetId);
       if (textLines) {
         const textCanvasCoordinates = [
           canvasCoordinates[0] + 6,
@@ -537,71 +547,29 @@ class ProbeTool extends AnnotationTool {
     return renderStatus;
   };
 
-  _getTextLines(
-    data,
-    targetId: string,
-    isPreScaled: boolean,
-    isSuvScaled: boolean
-  ): string[] | undefined {
+  _getTextLines(data, targetId: string): string[] | undefined {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { index, Modality, value, SUVBw, SUVLbm, SUVBsa } = cachedVolumeStats;
+    const { index, value, modalityUnit } = cachedVolumeStats;
 
-    if (value === undefined && SUVBw === undefined) {
+    if (value === undefined) {
       return;
     }
 
     const textLines = [];
-    const unit = getModalityUnit(Modality, isPreScaled, isSuvScaled);
 
     textLines.push(`(${index[0]}, ${index[1]}, ${index[2]})`);
 
-    // Check if we have scaling for the other 2 SUV types for the PET.
-    if (Modality === 'PT' && isPreScaled === true && SUVBw !== undefined) {
-      textLines.push(`${SUVBw.toFixed(2)} SUV bw`);
-      if (SUVLbm) {
-        textLines.push(`${SUVLbm.toFixed(2)} SUV lbm`);
-      }
-      if (SUVBsa) {
-        textLines.push(`${SUVBsa.toFixed(2)} SUV bsa`);
-      }
-    } else {
-      textLines.push(`${value.toFixed(2)} ${unit}`);
-    }
+    textLines.push(`${value.toFixed(2)} ${modalityUnit}`);
 
     return textLines;
   }
 
-  _getValueForModality(value, imageVolume, modality) {
-    const values = {};
-
-    values['value'] = value;
-
-    // Check if we have scaling for the other 2 SUV types for the PET.
-    if (
-      modality === 'PT' &&
-      imageVolume.scaling?.PT &&
-      (imageVolume.scaling.PT.suvbwToSuvbsa ||
-        imageVolume.scaling.PT.suvbwToSuvlbm)
-    ) {
-      const { suvbwToSuvlbm, suvbwToSuvbsa } = imageVolume.scaling.PT;
-
-      values['SUVBw'] = value;
-
-      if (suvbwToSuvlbm) {
-        const SUVLbm = value * suvbwToSuvlbm;
-        values['SUVLbm'] = SUVLbm;
-      }
-
-      if (suvbwToSuvbsa) {
-        const SUVBsa = value * suvbwToSuvbsa;
-        values['SUVBsa'] = SUVBsa;
-      }
-    }
-
-    return values;
-  }
-
-  _calculateCachedStats(annotation, renderingEngine, enabledElement) {
+  _calculateCachedStats(
+    annotation,
+    renderingEngine,
+    enabledElement,
+    modalityUnitOptions: ModalityUnitOptions
+  ) {
     const data = annotation.data;
     const { viewportId, renderingEngineId } = enabledElement;
 
@@ -656,12 +624,17 @@ class ProbeTool extends AnnotationTool {
           index[2] = viewport.getCurrentImageIdIndex();
         }
 
-        const values = this._getValueForModality(value, image, modality);
+        const modalityUnit = getModalityUnit(
+          modality,
+          annotation.metadata.referencedImageId,
+          modalityUnitOptions
+        );
 
         cachedStats[targetId] = {
           index,
-          ...values,
+          value,
           Modality: modality,
+          modalityUnit,
         };
       } else {
         this.isHandleOutsideImage = true;