@cornerstonejs/tools 2.0.0-beta.22 → 2.0.0-beta.23

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

@@ -452,7 +452,7 @@ class SplineROITool extends ContourSegmentationBaseTool {
                 const deltaInX = vec3.distance(originalWorldPoint, deltaXPoint);
                 const deltaInY = vec3.distance(originalWorldPoint, deltaYPoint);
                 const { imageData } = image;
-                const { scale, areaUnits } = getCalibratedLengthUnitsAndScale(image, () => {
+                const { scale, areaUnit } = getCalibratedLengthUnitsAndScale(image, () => {
                     const { maxX: canvasMaxX, maxY: canvasMaxY, minX: canvasMinX, minY: canvasMinY, } = math.polyline.getAABB(canvasCoordinates);
                     const topLeftBBWorld = viewport.canvasToWorld([
                         canvasMinX,
@@ -471,7 +471,7 @@ class SplineROITool extends ContourSegmentationBaseTool {
                 cachedStats[targetId] = {
                     Modality: metadata.Modality,
                     area,
-                    areaUnits,
+                    areaUnit,
                 };
             }
             this.triggerAnnotationModified(annotation, enabledElement, ChangeTypes.StatsUpdated);
@@ -560,11 +560,11 @@ class SplineROITool extends ContourSegmentationBaseTool {
         });
         super.renderAnnotationInstance(renderContext);
         if (!data.cachedStats[targetId] ||
-            data.cachedStats[targetId].areaUnits == null) {
+            data.cachedStats[targetId].areaUnit == null) {
             data.cachedStats[targetId] = {
                 Modality: null,
                 area: null,
-                areaUnits: null,
+                areaUnit: null,
             };
             this._calculateCachedStats(annotation, element);
         }
@@ -715,12 +715,12 @@ class SplineROITool extends ContourSegmentationBaseTool {
 }
 function defaultGetTextLines(data, targetId) {
     const cachedVolumeStats = data.cachedStats[targetId];
-    const { area, isEmptyArea, areaUnits } = cachedVolumeStats;
+    const { area, isEmptyArea, areaUnit } = cachedVolumeStats;
     const textLines = [];
     if (area) {
         const areaLine = isEmptyArea
             ? `Area: Oblique not supported`
-            : `Area: ${utilities.roundNumber(area)} ${areaUnits}`;
+            : `Area: ${utilities.roundNumber(area)} ${areaUnit}`;
         textLines.push(areaLine);
     }
     return textLines;

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

@@ -5,7 +5,6 @@ import WindowLevelTool from './WindowLevelTool';
 import WindowLevelRegionTool from './WindowLevelRegionTool';
 import StackScrollTool from './StackScrollTool';
 import PlanarRotateTool from './PlanarRotateTool';
-import StackScrollMouseWheelTool from './StackScrollToolMouseWheelTool';
 import ZoomTool from './ZoomTool';
 import VolumeRotateMouseWheelTool from './VolumeRotateMouseWheelTool';
 import MIPJumpToClickTool from './MIPJumpToClickTool';
@@ -16,7 +15,6 @@ import ReferenceLinesTool from './ReferenceLinesTool';
 import OverlayGridTool from './OverlayGridTool';
 import SegmentationIntersectionTool from './SegmentationIntersectionTool';
 import ReferenceCursors from './ReferenceCursors';
-import ReferenceLines from './ReferenceLinesTool';
 import ScaleOverlayTool from './ScaleOverlayTool';
 import SculptorTool from './SculptorTool';
 import BidirectionalTool from './annotation/BidirectionalTool';
@@ -49,4 +47,4 @@ import BrushTool from './segmentation/BrushTool';
 import PaintFillTool from './segmentation/PaintFillTool';
 import OrientationMarkerTool from './OrientationMarkerTool';
 import SegmentSelectTool from './segmentation/SegmentSelectTool';
-export { BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, StackScrollTool, PlanarRotateTool, StackScrollMouseWheelTool, ZoomTool, VolumeRotateMouseWheelTool, MIPJumpToClickTool, ReferenceCursors, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, BidirectionalTool, LengthTool, HeightTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, SplineROITool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, AnnotationEraserTool as EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, SplineContourSegmentationTool, BrushTool, MagnifyTool, AdvancedMagnifyTool, ReferenceLines, PaintFillTool, ScaleOverlayTool, OrientationMarkerTool, SculptorTool, SegmentSelectTool, };
+export { BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, StackScrollTool, PlanarRotateTool, ZoomTool, VolumeRotateMouseWheelTool, MIPJumpToClickTool, ReferenceCursors, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, BidirectionalTool, LengthTool, HeightTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, SplineROITool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, AnnotationEraserTool as EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, SplineContourSegmentationTool, BrushTool, MagnifyTool, AdvancedMagnifyTool, PaintFillTool, ScaleOverlayTool, OrientationMarkerTool, SculptorTool, SegmentSelectTool, };

package/dist/esm/tools/index.js

@@ -5,7 +5,6 @@ import WindowLevelTool from './WindowLevelTool';
 import WindowLevelRegionTool from './WindowLevelRegionTool';
 import StackScrollTool from './StackScrollTool';
 import PlanarRotateTool from './PlanarRotateTool';
-import StackScrollMouseWheelTool from './StackScrollToolMouseWheelTool';
 import ZoomTool from './ZoomTool';
 import VolumeRotateMouseWheelTool from './VolumeRotateMouseWheelTool';
 import MIPJumpToClickTool from './MIPJumpToClickTool';
@@ -16,7 +15,6 @@ import ReferenceLinesTool from './ReferenceLinesTool';
 import OverlayGridTool from './OverlayGridTool';
 import SegmentationIntersectionTool from './SegmentationIntersectionTool';
 import ReferenceCursors from './ReferenceCursors';
-import ReferenceLines from './ReferenceLinesTool';
 import ScaleOverlayTool from './ScaleOverlayTool';
 import SculptorTool from './SculptorTool';
 import BidirectionalTool from './annotation/BidirectionalTool';
@@ -49,4 +47,4 @@ import BrushTool from './segmentation/BrushTool';
 import PaintFillTool from './segmentation/PaintFillTool';
 import OrientationMarkerTool from './OrientationMarkerTool';
 import SegmentSelectTool from './segmentation/SegmentSelectTool';
-export { BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, StackScrollTool, PlanarRotateTool, StackScrollMouseWheelTool, ZoomTool, VolumeRotateMouseWheelTool, MIPJumpToClickTool, ReferenceCursors, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, BidirectionalTool, LengthTool, HeightTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, SplineROITool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, AnnotationEraserTool as EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, SplineContourSegmentationTool, BrushTool, MagnifyTool, AdvancedMagnifyTool, ReferenceLines, PaintFillTool, ScaleOverlayTool, OrientationMarkerTool, SculptorTool, SegmentSelectTool, };
+export { BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, StackScrollTool, PlanarRotateTool, ZoomTool, VolumeRotateMouseWheelTool, MIPJumpToClickTool, ReferenceCursors, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, BidirectionalTool, LengthTool, HeightTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, SplineROITool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, AnnotationEraserTool as EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, SplineContourSegmentationTool, BrushTool, MagnifyTool, AdvancedMagnifyTool, PaintFillTool, ScaleOverlayTool, OrientationMarkerTool, SculptorTool, SegmentSelectTool, };

package/dist/esm/tools/segmentation/CircleROIStartEndThresholdTool.js

@@ -345,7 +345,7 @@ class CircleROIStartEndThresholdTool extends CircleROITool {
             isPreScaled: isViewportPreScaled(viewport, targetId),
             isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
         };
-        const pixelValueUnits = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
+        const modalityUnit = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
         for (let i = 0; i < projectionPoints.length; i++) {
             if (!imageVolume) {
                 continue;
@@ -409,8 +409,8 @@ class CircleROIStartEndThresholdTool extends CircleROITool {
             stdDev: stats.stdDev?.value,
             max: stats.max?.value,
             statsArray: stats.array,
-            areaUnits: measureInfo.areaUnits,
-            pixelValueUnits,
+            areaUnit: measureInfo.areaUnit,
+            modalityUnit,
         };
     }
     _calculateCachedStatsTool(annotation, enabledElement) {
@@ -456,15 +456,15 @@ class CircleROIStartEndThresholdTool extends CircleROITool {
 }
 function defaultGetTextLines(data) {
     const cachedVolumeStats = data.cachedStats.statistics;
-    const { area, mean, max, stdDev, areaUnits, pixelValueUnits } = cachedVolumeStats;
+    const { area, mean, max, stdDev, areaUnit, modalityUnit } = cachedVolumeStats;
     if (mean === undefined) {
         return;
     }
     const textLines = [];
-    textLines.push(`Area: ${csUtils.roundNumber(area)} ${areaUnits}`);
-    textLines.push(`Mean: ${csUtils.roundNumber(mean)} ${pixelValueUnits}`);
-    textLines.push(`Max: ${csUtils.roundNumber(max)} ${pixelValueUnits}`);
-    textLines.push(`Std Dev: ${csUtils.roundNumber(stdDev)} ${pixelValueUnits}`);
+    textLines.push(`Area: ${csUtils.roundNumber(area)} ${areaUnit}`);
+    textLines.push(`Mean: ${csUtils.roundNumber(mean)} ${modalityUnit}`);
+    textLines.push(`Max: ${csUtils.roundNumber(max)} ${modalityUnit}`);
+    textLines.push(`Std Dev: ${csUtils.roundNumber(stdDev)} ${modalityUnit}`);
     return textLines;
 }
 CircleROIStartEndThresholdTool.toolName = 'CircleROIStartEndThreshold';

package/dist/esm/tools/segmentation/RectangleROIStartEndThresholdTool.js

@@ -316,7 +316,7 @@ class RectangleROIStartEndThresholdTool extends RectangleROITool {
             isPreScaled: isViewportPreScaled(viewport, targetId),
             isSuvScaled: this.isSuvScaled(viewport, targetId, annotation.metadata.referencedImageId),
         };
-        const pixelValueUnits = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
+        const modalityUnit = getPixelValueUnits(metadata.Modality, annotation.metadata.referencedImageId, modalityUnitOptions);
         for (let i = 0; i < projectionPoints.length; i++) {
             if (!imageVolume) {
                 continue;
@@ -367,8 +367,8 @@ class RectangleROIStartEndThresholdTool extends RectangleROITool {
             stdDev: stats.stdDev?.value,
             max: stats.max?.value,
             statsArray: stats.array,
-            areaUnits: measureInfo.areaUnits,
-            pixelValueUnits,
+            areaUnit: measureInfo.areaUnit,
+            modalityUnit,
         };
     }
     _calculateCachedStatsTool(annotation, enabledElement) {
@@ -410,15 +410,15 @@ class RectangleROIStartEndThresholdTool extends RectangleROITool {
 }
 function defaultGetTextLines(data) {
     const cachedVolumeStats = data.cachedStats.statistics;
-    const { area, mean, max, stdDev, areaUnits, pixelValueUnits } = cachedVolumeStats;
+    const { area, mean, max, stdDev, areaUnit, modalityUnit } = cachedVolumeStats;
     if (mean === undefined) {
         return;
     }
     const textLines = [];
-    textLines.push(`Area: ${csUtils.roundNumber(area)} ${areaUnits}`);
-    textLines.push(`Mean: ${csUtils.roundNumber(mean)} ${pixelValueUnits}`);
-    textLines.push(`Max: ${csUtils.roundNumber(max)} ${pixelValueUnits}`);
-    textLines.push(`Std Dev: ${csUtils.roundNumber(stdDev)} ${pixelValueUnits}`);
+    textLines.push(`Area: ${csUtils.roundNumber(area)} ${areaUnit}`);
+    textLines.push(`Mean: ${csUtils.roundNumber(mean)} ${modalityUnit}`);
+    textLines.push(`Max: ${csUtils.roundNumber(max)} ${modalityUnit}`);
+    textLines.push(`Std Dev: ${csUtils.roundNumber(stdDev)} ${modalityUnit}`);
     return textLines;
 }
 RectangleROIStartEndThresholdTool.toolName = 'RectangleROIStartEndThreshold';

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

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

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

@@ -1,6 +1,6 @@
 declare const getCalibratedLengthUnitsAndScale: (image: any, handles: any) => {
-    lengthUnits: string;
-    areaUnits: string;
+    unit: string;
+    areaUnit: string;
     scale: number;
 };
 declare const getCalibratedProbeUnitsAndValue: (image: any, handles: any) => {

package/dist/esm/utilities/getCalibratedUnits.js

@@ -27,16 +27,16 @@ const EPS = 1e-3;
 const SQUARE = '\xb2';
 const getCalibratedLengthUnitsAndScale = (image, handles) => {
     const { calibration, hasPixelSpacing } = image;
-    let lengthUnits = hasPixelSpacing ? 'mm' : PIXEL_UNITS;
-    let areaUnits = lengthUnits + SQUARE;
+    let unit = hasPixelSpacing ? 'mm' : PIXEL_UNITS;
+    let areaUnit = unit + SQUARE;
     let scale = 1;
     let calibrationType = '';
     if (!calibration ||
         (!calibration.type && !calibration.sequenceOfUltrasoundRegions)) {
-        return { lengthUnits, areaUnits, scale };
+        return { unit, areaUnit, scale };
     }
     if (calibration.type === CalibrationTypes.UNCALIBRATED) {
-        return { lengthUnits: PIXEL_UNITS, areaUnits: PIXEL_UNITS + SQUARE, scale };
+        return { unit: PIXEL_UNITS, areaUnit: PIXEL_UNITS + SQUARE, scale };
     }
     if (calibration.sequenceOfUltrasoundRegions) {
         let imageIndex1, imageIndex2;
@@ -57,14 +57,14 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
             imageIndex2[1] >= region.regionLocationMinY0 &&
             imageIndex2[1] <= region.regionLocationMaxY1);
         if (!regions?.length) {
-            return { lengthUnits, areaUnits, scale };
+            return { unit, areaUnit, scale };
         }
         regions = regions.filter((region) => SUPPORTED_REGION_DATA_TYPES.includes(region.regionDataType) &&
             SUPPORTED_LENGTH_VARIANT.includes(`${region.physicalUnitsXDirection},${region.physicalUnitsYDirection}`));
         if (!regions.length) {
             return {
-                lengthUnits: PIXEL_UNITS,
-                areaUnits: PIXEL_UNITS + SQUARE,
+                unit: PIXEL_UNITS,
+                areaUnit: PIXEL_UNITS + SQUARE,
                 scale,
             };
         }
@@ -75,13 +75,13 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
         if (isSamePhysicalDelta) {
             scale = 1 / physicalDeltaX;
             calibrationType = 'US Region';
-            lengthUnits = UNIT_MAPPING[region.physicalUnitsXDirection] || 'unknown';
-            areaUnits = lengthUnits + SQUARE;
+            unit = UNIT_MAPPING[region.physicalUnitsXDirection] || 'unknown';
+            areaUnit = unit + SQUARE;
         }
         else {
             return {
-                lengthUnits: PIXEL_UNITS,
-                areaUnits: PIXEL_UNITS + SQUARE,
+                unit: PIXEL_UNITS,
+                areaUnit: PIXEL_UNITS + SQUARE,
                 scale,
             };
         }
@@ -99,8 +99,8 @@ const getCalibratedLengthUnitsAndScale = (image, handles) => {
         calibrationType = calibration.type;
     }
     return {
-        lengthUnits: lengthUnits + (calibrationType ? ` ${calibrationType}` : ''),
-        areaUnits: areaUnits + (calibrationType ? ` ${calibrationType}` : ''),
+        unit: unit + (calibrationType ? ` ${calibrationType}` : ''),
+        areaUnit: areaUnit + (calibrationType ? ` ${calibrationType}` : ''),
         scale,
     };
 };