@cornerstonejs/tools 2.0.0-beta.18 → 2.0.0-beta.19

package/dist/esm/tools/ScaleOverlayTool.d.ts

@@ -1,7 +1,7 @@
 import AnnotationDisplayTool from './base/AnnotationDisplayTool';
 import { ScaleOverlayAnnotation } from '../types/ToolSpecificAnnotationTypes';
 import type { Types } from '@cornerstonejs/core';
-import { PublicToolProps, ToolProps, SVGDrawingHelper } from '../types';
+import { EventTypes, PublicToolProps, ToolProps, SVGDrawingHelper } from '../types';
 declare class ScaleOverlayTool extends AnnotationDisplayTool {
     static toolName: any;
     touchDragCallback: any;

package/dist/esm/tools/annotation/BidirectionalTool.js

@@ -609,13 +609,13 @@ class BidirectionalTool extends AnnotationTool {
                 const index4 = transformWorldToIndex(imageData, worldPos4);
                 const handles1 = [index1, index2];
                 const handles2 = [index3, index4];
-                const { scale: scale1, units: units1 } = getCalibratedLengthUnitsAndScale(image, handles1);
-                const { scale: scale2, units: units2 } = getCalibratedLengthUnitsAndScale(image, handles2);
+                const { scale: scale1, lengthUnits: units1 } = getCalibratedLengthUnitsAndScale(image, handles1);
+                const { scale: scale2, lengthUnits: units2 } = getCalibratedLengthUnitsAndScale(image, handles2);
                 const dist1 = this._calculateLength(worldPos1, worldPos2) / scale1;
                 const dist2 = this._calculateLength(worldPos3, worldPos4) / scale2;
                 const length = dist1 > dist2 ? dist1 : dist2;
                 const width = dist1 > dist2 ? dist2 : dist1;
-                const lengthUnit = dist1 > dist2 ? units1 : units2;
+                const lengthUnits = dist1 > dist2 ? units1 : units2;
                 const widthUnit = dist1 > dist2 ? units2 : units1;
                 this._isInsideVolume(index1, index2, index3, index4, dimensions)
                     ? (this.isHandleOutsideImage = false)
@@ -623,8 +623,7 @@ class BidirectionalTool extends AnnotationTool {
                 cachedStats[targetId] = {
                     length,
                     width,
-                    unit: units1,
-                    lengthUnit,
+                    lengthUnits,
                     widthUnit,
                 };
             }
@@ -714,7 +713,7 @@ class BidirectionalTool extends AnnotationTool {
 }
 function defaultGetTextLines(data, targetId) {
     const { cachedStats, label } = data;
-    const { length, width, unit, lengthUnit, widthUnit } = cachedStats[targetId];
+    const { length, width, unit, lengthUnits, widthUnit } = cachedStats[targetId];
     const textLines = [];
     if (label) {
         textLines.push(label);
@@ -722,7 +721,7 @@ function defaultGetTextLines(data, targetId) {
     if (length === undefined) {
         return textLines;
     }
-    textLines.push(`L: ${roundNumber(length)} ${lengthUnit || unit}`, `W: ${roundNumber(width)} ${widthUnit || unit}`);
+    textLines.push(`L: ${roundNumber(length)} ${lengthUnits || unit}`, `W: ${roundNumber(width)} ${widthUnit || unit}`);
     return textLines;
 }
 BidirectionalTool.toolName = 'Bidirectional';

package/dist/esm/tools/annotation/CircleROITool.js

@@ -16,7 +16,7 @@ import getWorldWidthAndHeightFromTwoPoints from '../../utilities/planar/getWorld
 import { resetElementCursor, hideElementCursor, } from '../../cursors/elementCursor';
 import triggerAnnotationRenderForViewportIds from '../../utilities/triggerAnnotationRenderForViewportIds';
 import { pointInShapeCallback } from '../../utilities';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import { getPixelValueUnits } from '../../utilities/getPixelValueUnits';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
 import { getCanvasCircleCorners, getCanvasCircleRadius, } from '../../utilities/math/circle';
 import { pointInEllipse } from '../../utilities/math/ellipse';
@@ -347,14 +347,14 @@ class CircleROITool extends AnnotationTool {
                 const canvasCorners = getCanvasCircleCorners(canvasCoordinates);
                 const { centerPointRadius } = this.configuration;
                 if (!data.cachedStats[targetId] ||
-                    data.cachedStats[targetId].areaUnit == null) {
+                    data.cachedStats[targetId].areaUnits == null) {
                     data.cachedStats[targetId] = {
                         Modality: null,
                         area: null,
                         max: null,
                         mean: null,
                         stdDev: null,
-                        areaUnit: null,
+                        areaUnits: null,
                         radius: null,
                         radiusUnit: null,
                         perimeter: null,
@@ -508,16 +508,16 @@ class CircleROITool extends AnnotationTool {
                     const { worldWidth, worldHeight } = getWorldWidthAndHeightFromTwoPoints(viewPlaneNormal, viewUp, worldPos1, worldPos2);
                     const isEmptyArea = worldWidth === 0 && worldHeight === 0;
                     const handles = [pos1Index, pos2Index];
-                    const { scale, units, areaUnits } = getCalibratedLengthUnitsAndScale(image, handles);
+                    const { scale, lengthUnits, areaUnits } = getCalibratedLengthUnitsAndScale(image, handles);
                     const aspect = getCalibratedAspect(image);
                     const area = Math.abs(Math.PI *
                         (worldWidth / scale / 2) *
                         (worldHeight / aspect / scale / 2));
-                    const modalityUnitOptions = {
+                    const pixelUnitsOptions = {
                         isPreScaled: isViewportPreScaled(viewport, targetId),
                         isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
                     };
-                    const modalityUnit = getModalityUnit(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
+                    const pixelValueUnits = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, pixelUnitsOptions);
                     const pointsInShape = pointInShapeCallback(imageData, (pointLPS) => pointInEllipse(ellipseObj, pointLPS, {
                         fast: true,
                     }), this.configuration.statsCalculator.statsCallback, boundsIJK);
@@ -531,11 +531,11 @@ class CircleROITool extends AnnotationTool {
                         statsArray: stats.array,
                         pointsInShape: pointsInShape,
                         isEmptyArea,
-                        areaUnit: areaUnits,
+                        areaUnits,
                         radius: worldWidth / 2 / scale,
-                        radiusUnit: units,
+                        radiusUnit: lengthUnits,
                         perimeter: (2 * Math.PI * (worldWidth / 2)) / scale,
-                        modalityUnit,
+                        pixelValueUnits,
                     };
                 }
                 else {
@@ -558,7 +558,7 @@ class CircleROITool extends AnnotationTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { radius, radiusUnit, area, mean, stdDev, max, isEmptyArea, areaUnit, modalityUnit, } = cachedVolumeStats;
+    const { radius, radiusUnit, area, mean, stdDev, max, isEmptyArea, areaUnits, pixelValueUnits, } = cachedVolumeStats;
     const textLines = [];
     if (radius) {
         const radiusLine = isEmptyArea
@@ -569,17 +569,17 @@ function defaultGetTextLines(data, targetId) {
     if (area) {
         const areaLine = isEmptyArea
             ? `Area: Oblique not supported`
-            : `Area: ${roundNumber(area)} ${areaUnit}`;
+            : `Area: ${roundNumber(area)} ${areaUnits}`;
         textLines.push(areaLine);
     }
     if (mean) {
-        textLines.push(`Mean: ${roundNumber(mean)} ${modalityUnit}`);
+        textLines.push(`Mean: ${roundNumber(mean)} ${pixelValueUnits}`);
     }
     if (max) {
-        textLines.push(`Max: ${roundNumber(max)} ${modalityUnit}`);
+        textLines.push(`Max: ${roundNumber(max)} ${pixelValueUnits}`);
     }
     if (stdDev) {
-        textLines.push(`Std Dev: ${roundNumber(stdDev)} ${modalityUnit}`);
+        textLines.push(`Std Dev: ${roundNumber(stdDev)} ${pixelValueUnits}`);
     }
     return textLines;
 }

package/dist/esm/tools/annotation/DragProbeTool.js

@@ -84,7 +84,7 @@ class DragProbeTool extends ProbeTool {
                 annotation,
                 styleSpecifier,
             });
-            const modalityUnitOptions = {
+            const pixelUnitsOptions = {
                 isPreScaled: isViewportPreScaled(viewport, targetId),
                 isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
             };
@@ -122,13 +122,13 @@ class DragProbeTool extends ProbeTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { index, value, modalityUnit } = cachedVolumeStats;
+    const { index, value, pixelValueUnits } = cachedVolumeStats;
     if (value === undefined) {
         return;
     }
     const textLines = [];
     textLines.push(`(${index[0]}, ${index[1]}, ${index[2]})`);
-    textLines.push(`${value.toFixed(2)} ${modalityUnit}`);
+    textLines.push(`${value.toFixed(2)} ${pixelValueUnits}`);
     return textLines;
 }
 DragProbeTool.toolName = 'DragProbe';

package/dist/esm/tools/annotation/EllipticalROITool.js

@@ -17,7 +17,7 @@ import { pointInEllipse, getCanvasEllipseCorners, } from '../../utilities/math/e
 import { resetElementCursor, hideElementCursor, } from '../../cursors/elementCursor';
 import triggerAnnotationRenderForViewportIds from '../../utilities/triggerAnnotationRenderForViewportIds';
 import { pointInShapeCallback } from '../../utilities/';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import { getPixelValueUnits } from '../../utilities/getPixelValueUnits';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
 import { BasicStatsCalculator } from '../../utilities/math/basic';
 const { transformWorldToIndex } = csUtils;
@@ -428,14 +428,14 @@ class EllipticalROITool extends AnnotationTool {
                 const canvasCorners = (getCanvasEllipseCorners(canvasCoordinates));
                 const { centerPointRadius } = this.configuration;
                 if (!data.cachedStats[targetId] ||
-                    data.cachedStats[targetId].areaUnit == null) {
+                    data.cachedStats[targetId].areaUnits == null) {
                     data.cachedStats[targetId] = {
                         Modality: null,
                         area: null,
                         max: null,
                         mean: null,
                         stdDev: null,
-                        areaUnit: null,
+                        areaUnits: null,
                     };
                     this._calculateCachedStats(annotation, viewport, renderingEngine);
                 }
@@ -592,11 +592,11 @@ class EllipticalROITool extends AnnotationTool {
                 const area = Math.abs(Math.PI * (worldWidth / 2) * (worldHeight / 2)) /
                     scale /
                     scale;
-                const modalityUnitOptions = {
+                const pixelUnitsOptions = {
                     isPreScaled: isViewportPreScaled(viewport, targetId),
                     isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
                 };
-                const modalityUnit = getModalityUnit(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
+                const pixelValueUnits = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, pixelUnitsOptions);
                 const pointsInShape = pointInShapeCallback(imageData, (pointLPS) => pointInEllipse(ellipseObj, pointLPS, { fast: true }), this.configuration.statsCalculator.statsCallback, boundsIJK);
                 const stats = this.configuration.statsCalculator.getStatistics();
                 cachedStats[targetId] = {
@@ -608,8 +608,8 @@ class EllipticalROITool extends AnnotationTool {
                     statsArray: stats.array,
                     pointsInShape,
                     isEmptyArea,
-                    areaUnit: areaUnits,
-                    modalityUnit,
+                    areaUnits,
+                    pixelValueUnits,
                 };
             }
             annotation.invalidated = false;
@@ -647,22 +647,22 @@ class EllipticalROITool extends AnnotationTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { area, mean, stdDev, max, isEmptyArea, areaUnit, modalityUnit } = cachedVolumeStats;
+    const { area, mean, stdDev, max, isEmptyArea, areaUnits, pixelValueUnits } = cachedVolumeStats;
     const textLines = [];
     if (area) {
         const areaLine = isEmptyArea
             ? `Area: Oblique not supported`
-            : `Area: ${roundNumber(area)} ${areaUnit}`;
+            : `Area: ${roundNumber(area)} ${areaUnits}`;
         textLines.push(areaLine);
     }
     if (mean) {
-        textLines.push(`Mean: ${roundNumber(mean)} ${modalityUnit}`);
+        textLines.push(`Mean: ${roundNumber(mean)} ${pixelValueUnits}`);
     }
     if (max) {
-        textLines.push(`Max: ${roundNumber(max)} ${modalityUnit}`);
+        textLines.push(`Max: ${roundNumber(max)} ${pixelValueUnits}`);
     }
     if (stdDev) {
-        textLines.push(`Std Dev: ${roundNumber(stdDev)} ${modalityUnit}`);
+        textLines.push(`Std Dev: ${roundNumber(stdDev)} ${pixelValueUnits}`);
     }
     return textLines;
 }

package/dist/esm/tools/annotation/LengthTool.js

@@ -393,14 +393,14 @@ class LengthTool extends AnnotationTool {
             const index1 = transformWorldToIndex(imageData, worldPos1);
             const index2 = transformWorldToIndex(imageData, worldPos2);
             const handles = [index1, index2];
-            const { scale, units } = getCalibratedLengthUnitsAndScale(image, handles);
+            const { scale, lengthUnits } = getCalibratedLengthUnitsAndScale(image, handles);
             const length = this._calculateLength(worldPos1, worldPos2) / scale;
             this._isInsideVolume(index1, index2, dimensions)
                 ? (this.isHandleOutsideImage = false)
                 : (this.isHandleOutsideImage = true);
             cachedStats[targetId] = {
                 length,
-                unit: units,
+                lengthUnits,
             };
         }
         annotation.invalidated = false;

package/dist/esm/tools/annotation/PlanarFreehandROITool.js

@@ -19,7 +19,7 @@ import { getTextBoxCoordsCanvas } from '../../utilities/drawing';
 import { getLineSegmentIntersectionsCoordinates } from '../../utilities/math/polyline';
 import pointInShapeCallback from '../../utilities/pointInShapeCallback';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import { getPixelValueUnits } from '../../utilities/getPixelValueUnits';
 import { BasicStatsCalculator } from '../../utilities/math/basic';
 import calculatePerimeter from '../../utilities/contours/calculatePerimeter';
 import ContourSegmentationBaseTool from '../base/ContourSegmentationBaseTool';
@@ -249,11 +249,11 @@ class PlanarFreehandROITool extends ContourSegmentationBaseTool {
                     }
                     return result;
                 }, this.configuration.statsCalculator.statsCallback, boundsIJK);
-                const modalityUnitOptions = {
+                const pixelUnitsOptions = {
                     isPreScaled: isViewportPreScaled(viewport, targetId),
                     isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
                 };
-                const modalityUnit = getModalityUnit(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
+                const pixelValueUnits = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, pixelUnitsOptions);
                 const stats = this.configuration.statsCalculator.getStatistics();
                 cachedStats[targetId] = {
                     Modality: metadata.Modality,
@@ -264,8 +264,8 @@ class PlanarFreehandROITool extends ContourSegmentationBaseTool {
                     stdDev: stats.stdDev?.value,
                     statsArray: stats.array,
                     pointsInShape: pointsInShape,
-                    areaUnit: areaUnits,
-                    modalityUnit,
+                    areaUnits,
+                    pixelValueUnits,
                 };
             }
             triggerAnnotationModified(annotation, enabledElement.viewport.element, ChangeTypes.StatsUpdated);
@@ -443,14 +443,14 @@ class PlanarFreehandROITool extends ContourSegmentationBaseTool {
         if (!this.commonData?.movingTextBox) {
             const { data } = annotation;
             if (!data.cachedStats[targetId] ||
-                data.cachedStats[targetId].areaUnit == null) {
+                data.cachedStats[targetId].areaUnits == null) {
                 data.cachedStats[targetId] = {
                     Modality: null,
                     area: null,
                     max: null,
                     mean: null,
                     stdDev: null,
-                    areaUnit: null,
+                    areaUnits: null,
                 };
                 this._calculateCachedStats(annotation, viewport, renderingEngine, enabledElement);
             }
@@ -462,25 +462,25 @@ class PlanarFreehandROITool extends ContourSegmentationBaseTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { area, mean, stdDev, perimeter, max, isEmptyArea, areaUnit, modalityUnit, } = cachedVolumeStats || {};
+    const { area, mean, stdDev, perimeter, max, isEmptyArea, areaUnits, pixelValueUnits, } = cachedVolumeStats || {};
     const textLines = [];
     if (area) {
         const areaLine = isEmptyArea
             ? `Area: Oblique not supported`
-            : `Area: ${roundNumber(area)} ${areaUnit}`;
+            : `Area: ${roundNumber(area)} ${areaUnits}`;
         textLines.push(areaLine);
     }
     if (mean) {
-        textLines.push(`Mean: ${roundNumber(mean)} ${modalityUnit}`);
+        textLines.push(`Mean: ${roundNumber(mean)} ${pixelValueUnits}`);
     }
     if (max) {
-        textLines.push(`Max: ${roundNumber(max)} ${modalityUnit}`);
+        textLines.push(`Max: ${roundNumber(max)} ${pixelValueUnits}`);
     }
     if (stdDev) {
-        textLines.push(`Std Dev: ${roundNumber(stdDev)} ${modalityUnit}`);
+        textLines.push(`Std Dev: ${roundNumber(stdDev)} ${pixelValueUnits}`);
     }
     if (perimeter) {
-        textLines.push(`Perimeter: ${roundNumber(perimeter)} ${modalityUnit}`);
+        textLines.push(`Perimeter: ${roundNumber(perimeter)} ${pixelValueUnits}`);
     }
     return textLines;
 }

package/dist/esm/tools/annotation/ProbeTool.js

@@ -11,7 +11,7 @@ import { getViewportIdsWithToolToRender } from '../../utilities/viewportFilters'
 import { roundNumber } from '../../utilities';
 import { resetElementCursor, hideElementCursor, } from '../../cursors/elementCursor';
 import triggerAnnotationRenderForViewportIds from '../../utilities/triggerAnnotationRenderForViewportIds';
-import { getModalityUnit, } from '../../utilities/getModalityUnit';
+import { getPixelValueUnits, } from '../../utilities/getPixelValueUnits';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
 const { transformWorldToIndex } = csUtils;
 class ProbeTool extends AnnotationTool {
@@ -257,7 +257,7 @@ class ProbeTool extends AnnotationTool {
         const targetIds = Object.keys(cachedStats);
         for (let i = 0; i < targetIds.length; i++) {
             const targetId = targetIds[i];
-            const modalityUnitOptions = {
+            const pixelUnitsOptions = {
                 isPreScaled: isViewportPreScaled(viewport, targetId),
                 isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
             };
@@ -294,25 +294,25 @@ class ProbeTool extends AnnotationTool {
                     const viewport = viewports[0];
                     index[2] = viewport.getCurrentImageIdIndex();
                 }
-                let modalityUnit;
+                let pixelValueUnits;
                 if (modality === 'US') {
                     const calibratedResults = getCalibratedProbeUnitsAndValue(image, [
                         index,
                     ]);
                     const hasEnhancedRegionValues = calibratedResults.values.every((value) => value !== null);
                     value = hasEnhancedRegionValues ? calibratedResults.values : value;
-                    modalityUnit = hasEnhancedRegionValues
+                    pixelValueUnits = hasEnhancedRegionValues
                         ? calibratedResults.units
                         : 'raw';
                 }
                 else {
-                    modalityUnit = getModalityUnit(modality, annotation.metadata.referencedImageId, modalityUnitOptions);
+                    pixelValueUnits = getPixelValueUnits(modality, annotation.metadata.referencedImageId, pixelUnitsOptions);
                 }
                 cachedStats[targetId] = {
                     index,
                     value,
                     Modality: modality,
-                    modalityUnit,
+                    pixelValueUnits,
                 };
             }
             else {
@@ -330,19 +330,19 @@ class ProbeTool extends AnnotationTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { index, value, modalityUnit } = cachedVolumeStats;
+    const { index, value, pixelValueUnits } = cachedVolumeStats;
     if (value === undefined) {
         return;
     }
     const textLines = [];
     textLines.push(`(${index[0]}, ${index[1]}, ${index[2]})`);
-    if (value instanceof Array && modalityUnit instanceof Array) {
+    if (value instanceof Array && pixelValueUnits instanceof Array) {
         for (let i = 0; i < value.length; i++) {
-            textLines.push(`${roundNumber(value[i])} ${modalityUnit[i]}`);
+            textLines.push(`${roundNumber(value[i])} ${pixelValueUnits[i]}`);
         }
     }
     else {
-        textLines.push(`${roundNumber(value)} ${modalityUnit}`);
+        textLines.push(`${roundNumber(value)} ${pixelValueUnits}`);
     }
     return textLines;
 }

package/dist/esm/tools/annotation/RectangleROITool.js

@@ -16,7 +16,7 @@ import { getTextBoxCoordsCanvas } from '../../utilities/drawing';
 import getWorldWidthAndHeightFromCorners from '../../utilities/planar/getWorldWidthAndHeightFromCorners';
 import { resetElementCursor, hideElementCursor, } from '../../cursors/elementCursor';
 import triggerAnnotationRenderForViewportIds from '../../utilities/triggerAnnotationRenderForViewportIds';
-import { getModalityUnit } from '../../utilities/getModalityUnit';
+import { getPixelValueUnits } from '../../utilities/getPixelValueUnits';
 import { isViewportPreScaled } from '../../utilities/viewport/isViewportPreScaled';
 import { pointInShapeCallback } from '../../utilities/';
 import { BasicStatsCalculator } from '../../utilities/math/basic';
@@ -347,14 +347,14 @@ class RectangleROITool extends AnnotationTool {
                 });
                 const { viewPlaneNormal, viewUp } = viewport.getCamera();
                 if (!data.cachedStats[targetId] ||
-                    data.cachedStats[targetId].areaUnit == null) {
+                    data.cachedStats[targetId].areaUnits == null) {
                     data.cachedStats[targetId] = {
                         Modality: null,
                         area: null,
                         max: null,
                         mean: null,
                         stdDev: null,
-                        areaUnit: null,
+                        areaUnits: null,
                     };
                     this._calculateCachedStats(annotation, viewPlaneNormal, viewUp, renderingEngine, enabledElement);
                 }
@@ -490,11 +490,11 @@ class RectangleROITool extends AnnotationTool {
                     const handles = [pos1Index, pos2Index];
                     const { scale, areaUnits } = getCalibratedLengthUnitsAndScale(image, handles);
                     const area = Math.abs(worldWidth * worldHeight) / (scale * scale);
-                    const modalityUnitOptions = {
+                    const pixelUnitsOptions = {
                         isPreScaled: isViewportPreScaled(viewport, targetId),
                         isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
                     };
-                    const modalityUnit = getModalityUnit(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
+                    const pixelValueUnits = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, pixelUnitsOptions);
                     const pointsInShape = pointInShapeCallback(imageData, () => true, this.configuration.statsCalculator.statsCallback, boundsIJK);
                     const stats = this.configuration.statsCalculator.getStatistics();
                     cachedStats[targetId] = {
@@ -505,8 +505,8 @@ class RectangleROITool extends AnnotationTool {
                         max: stats.max?.value,
                         statsArray: stats.array,
                         pointsInShape: pointsInShape,
-                        areaUnit: areaUnits,
-                        modalityUnit,
+                        areaUnits,
+                        pixelValueUnits,
                     };
                 }
                 else {
@@ -529,15 +529,15 @@ class RectangleROITool extends AnnotationTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { area, mean, max, stdDev, areaUnit, modalityUnit } = cachedVolumeStats;
+    const { area, mean, max, stdDev, areaUnits, pixelValueUnits } = cachedVolumeStats;
     if (mean === undefined) {
         return;
     }
     const textLines = [];
-    textLines.push(`Area: ${roundNumber(area)} ${areaUnit}`);
-    textLines.push(`Mean: ${roundNumber(mean)} ${modalityUnit}`);
-    textLines.push(`Max: ${roundNumber(max)} ${modalityUnit}`);
-    textLines.push(`Std Dev: ${roundNumber(stdDev)} ${modalityUnit}`);
+    textLines.push(`Area: ${roundNumber(area)} ${areaUnits}`);
+    textLines.push(`Mean: ${roundNumber(mean)} ${pixelValueUnits}`);
+    textLines.push(`Max: ${roundNumber(max)} ${pixelValueUnits}`);
+    textLines.push(`Std Dev: ${roundNumber(stdDev)} ${pixelValueUnits}`);
     return textLines;
 }
 RectangleROITool.toolName = 'RectangleROI';

package/dist/esm/tools/annotation/SplineROITool.js

@@ -468,7 +468,7 @@ class SplineROITool extends ContourSegmentationBaseTool {
                 cachedStats[targetId] = {
                     Modality: metadata.Modality,
                     area,
-                    areaUnit: areaUnits,
+                    areaUnits,
                 };
             }
             this.triggerAnnotationModified(annotation, enabledElement, ChangeTypes.StatsUpdated);
@@ -557,11 +557,11 @@ class SplineROITool extends ContourSegmentationBaseTool {
         });
         super.renderAnnotationInstance(renderContext);
         if (!data.cachedStats[targetId] ||
-            data.cachedStats[targetId].areaUnit == null) {
+            data.cachedStats[targetId].areaUnits == null) {
             data.cachedStats[targetId] = {
                 Modality: null,
                 area: null,
-                areaUnit: null,
+                areaUnits: null,
             };
             this._calculateCachedStats(annotation, element);
         }
@@ -712,12 +712,12 @@ class SplineROITool extends ContourSegmentationBaseTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { area, isEmptyArea, areaUnit } = cachedVolumeStats;
+    const { area, isEmptyArea, areaUnits } = cachedVolumeStats;
     const textLines = [];
     if (area) {
         const areaLine = isEmptyArea
             ? `Area: Oblique not supported`
-            : `Area: ${roundNumber(area)} ${areaUnit}`;
+            : `Area: ${roundNumber(area)} ${areaUnits}`;
         textLines.push(areaLine);
     }
     return textLines;

package/dist/esm/types/ToolSpecificAnnotationTypes.d.ts

@@ -7,7 +7,7 @@ interface ROICachedStats {
     [targetId: string]: {
         Modality: string;
         area: number;
-        areaUnit: string;
+        areaUnits: string;
         max: number;
         mean: number;
         stdDev: number;
@@ -130,7 +130,7 @@ export type SplineROIAnnotation = ContourAnnotation & {
             [targetId: string]: {
                 Modality: string;
                 area: number;
-                areaUnit: string;
+                areaUnits: string;
             };
         };
     };

package/dist/esm/utilities/getCalibratedUnits.d.ts

@@ -1,7 +1,13 @@
 declare const getCalibratedLengthUnitsAndScale: (image: any, handles: any) => {
+    lengthUnits: string;
+    areaUnits: string;
+    scale: number;
+    units?: undefined;
+} | {
     units: string;
     areaUnits: string;
     scale: number;
+    lengthUnits?: undefined;
 };
 declare const getCalibratedProbeUnitsAndValue: (image: any, handles: any) => {
     units: string[];

package/dist/esm/utilities/getCalibratedUnits.js

@@ -18,13 +18,13 @@ const EPS = 1e-3;
 const SQUARE = '\xb2';
 const getCalibratedLengthUnitsAndScale = (image, handles) => {
     const { calibration, hasPixelSpacing } = image;
-    let units = hasPixelSpacing ? 'mm' : PIXEL_UNITS;
-    let areaUnits = units + SQUARE;
+    let lengthUnits = hasPixelSpacing ? 'mm' : PIXEL_UNITS;
+    let areaUnits = lengthUnits + SQUARE;
     let scale = 1;
     let calibrationType = '';
     if (!calibration ||
         (!calibration.type && !calibration.sequenceOfUltrasoundRegions)) {
-        return { units, areaUnits, scale };
+        return { lengthUnits, areaUnits, scale };
     }
     if (calibration.type === CalibrationTypes.UNCALIBRATED) {
         return { units: PIXEL_UNITS, areaUnits: PIXEL_UNITS + SQUARE, scale };
@@ -48,12 +48,16 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
             imageIndex2[1] >= region.regionLocationMinY0 &&
             imageIndex2[1] <= region.regionLocationMaxY1);
         if (!regions?.length) {
-            return { units, areaUnits, scale };
+            return { lengthUnits, areaUnits, scale };
         }
         regions = regions.filter((region) => SUPPORTED_REGION_DATA_TYPES.includes(region.regionDataType) &&
             SUPPORTED_LENGTH_VARIANT.includes(`${region.physicalUnitsXDirection},${region.physicalUnitsYDirection}`));
         if (!regions.length) {
-            return { units: PIXEL_UNITS, areaUnits: PIXEL_UNITS + SQUARE, scale };
+            return {
+                lengthUnits: PIXEL_UNITS,
+                areaUnits: PIXEL_UNITS + SQUARE,
+                scale,
+            };
         }
         const region = regions[0];
         const physicalDeltaX = Math.abs(region.physicalDeltaX);
@@ -62,11 +66,15 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
         if (isSamePhysicalDelta) {
             scale = 1 / (physicalDeltaX * 10);
             calibrationType = 'US Region';
-            units = 'mm';
+            lengthUnits = 'mm';
             areaUnits = 'mm' + SQUARE;
         }
         else {
-            return { units: PIXEL_UNITS, areaUnits: PIXEL_UNITS + SQUARE, scale };
+            return {
+                lengthUnits: PIXEL_UNITS,
+                areaUnits: PIXEL_UNITS + SQUARE,
+                scale,
+            };
         }
     }
     else if (calibration.scale) {
@@ -82,7 +90,7 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
         calibrationType = calibration.type;
     }
     return {
-        units: units + (calibrationType ? ` ${calibrationType}` : ''),
+        lengthUnits: lengthUnits + (calibrationType ? ` ${calibrationType}` : ''),
         areaUnits: areaUnits + (calibrationType ? ` ${calibrationType}` : ''),
         scale,
     };

package/dist/esm/utilities/getPixelValueUnits.d.ts

@@ -0,0 +1,6 @@
+type pixelUnitsOptions = {
+    isPreScaled: boolean;
+    isSuvScaled: boolean;
+};
+declare function getPixelValueUnits(modality: string, imageId: string, options: pixelUnitsOptions): string;
+export { getPixelValueUnits, pixelUnitsOptions };

package/dist/esm/utilities/{getModalityUnit.js → getPixelValueUnits.js}

@@ -1,5 +1,5 @@
 import { metaData } from '@cornerstonejs/core';
-function getModalityUnit(modality, imageId, options) {
+function getPixelValueUnits(modality, imageId, options) {
     if (modality === 'CT') {
         return 'HU';
     }
@@ -23,4 +23,4 @@ function _handlePTModality(imageId, options) {
         return petSeriesModule?.units || 'unitless';
     }
 }
-export { getModalityUnit };
+export { getPixelValueUnits };