@cornerstonejs/tools 2.15.5 → 2.16.1

package/dist/esm/enums/ChangeTypes.d.ts

@@ -5,6 +5,7 @@ declare enum ChangeTypes {
     InitialSetup = "InitialSetup",
     Completed = "Completed",
     InterpolationUpdated = "InterpolationUpdated",
-    History = "History"
+    History = "History",
+    MetadataReferenceModified = "MetadataReferenceModified"
 }
 export default ChangeTypes;

package/dist/esm/enums/ChangeTypes.js

@@ -7,5 +7,6 @@ var ChangeTypes;
     ChangeTypes["Completed"] = "Completed";
     ChangeTypes["InterpolationUpdated"] = "InterpolationUpdated";
     ChangeTypes["History"] = "History";
+    ChangeTypes["MetadataReferenceModified"] = "MetadataReferenceModified";
 })(ChangeTypes || (ChangeTypes = {}));
 export default ChangeTypes;

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

@@ -21,16 +21,10 @@ class KeyImageTool extends AnnotationTool {
         super(toolProps, defaultToolProps);
         this.addNewAnnotation = (evt) => {
             const eventDetail = evt.detail;
-            const { currentPoints, element } = eventDetail;
-            const worldPos = currentPoints.world;
+            const { element } = eventDetail;
             const enabledElement = getEnabledElement(element);
             const { viewport } = enabledElement;
-            const camera = viewport.getCamera();
-            const { viewPlaneNormal, viewUp } = camera;
-            const referencedImageId = this.getReferencedImageId(viewport, worldPos, viewPlaneNormal, viewUp);
-            const annotation = KeyImageTool.createAnnotation({
-                metadata: { ...viewport.getViewReference(), referencedImageId },
-            });
+            const annotation = KeyImageTool.createAnnotationForViewport(viewport);
             addAnnotation(annotation, element);
             const viewportIdsToRender = getViewportIdsWithToolToRender(element, this.getToolName());
             evt.preventDefault();

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

@@ -32,26 +32,11 @@ class ProbeTool extends AnnotationTool {
             const enabledElement = getEnabledElement(element);
             const { viewport } = enabledElement;
             this.isDrawing = true;
-            const camera = viewport.getCamera();
-            const { viewPlaneNormal, viewUp } = camera;
-            const referencedImageId = this.getReferencedImageId(viewport, worldPos, viewPlaneNormal);
-            const FrameOfReferenceUID = viewport.getFrameOfReferenceUID();
-            const annotation = {
-                invalidated: true,
-                highlighted: true,
-                metadata: {
-                    toolName: this.getToolName(),
-                    viewPlaneNormal: [...viewPlaneNormal],
-                    viewUp: [...viewUp],
-                    FrameOfReferenceUID,
-                    referencedImageId,
-                },
+            const annotation = ProbeTool.createAnnotationForViewport(viewport, {
                 data: {
-                    label: '',
                     handles: { points: [[...worldPos]] },
-                    cachedStats: {},
                 },
-            };
+            });
             addAnnotation(annotation, element);
             const viewportIdsToRender = getViewportIdsWithToolToRender(element, this.getToolName());
             this.editData = {

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

@@ -36,25 +36,10 @@ class RectangleROITool extends AnnotationTool {
             const { currentPoints, element } = eventDetail;
             const worldPos = currentPoints.world;
             const enabledElement = getEnabledElement(element);
-            const { viewport, renderingEngine } = enabledElement;
+            const { viewport } = enabledElement;
             this.isDrawing = true;
-            const camera = viewport.getCamera();
-            const { viewPlaneNormal, viewUp } = camera;
-            const referencedImageId = this.getReferencedImageId(viewport, worldPos, viewPlaneNormal, viewUp);
-            const FrameOfReferenceUID = viewport.getFrameOfReferenceUID();
-            const annotation = {
-                invalidated: true,
-                highlighted: true,
-                metadata: {
-                    toolName: this.getToolName(),
-                    viewPlaneNormal: [...viewPlaneNormal],
-                    viewUp: [...viewUp],
-                    FrameOfReferenceUID,
-                    referencedImageId,
-                    ...viewport.getViewReference({ points: [worldPos] }),
-                },
+            const annotation = RectangleROITool.createAnnotationForViewport(viewport, {
                 data: {
-                    label: '',
                     handles: {
                         points: [
                             [...worldPos],
@@ -72,11 +57,9 @@ class RectangleROITool extends AnnotationTool {
                                 bottomRight: [0, 0, 0],
                             },
                         },
-                        activeHandleIndex: null,
                     },
-                    cachedStats: {},
                 },
-            };
+            });
             addAnnotation(annotation, element);
             const viewportIdsToRender = getViewportIdsWithToolToRender(element, this.getToolName());
             this.editData = {

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

@@ -22,21 +22,10 @@ class VideoRedactionTool extends AnnotationTool {
             const { currentPoints, element } = eventData;
             const worldPos = currentPoints.world;
             const enabledElement = getEnabledElement(element);
-            const { viewport, renderingEngine } = enabledElement;
+            const { viewport } = enabledElement;
             this.isDrawing = true;
-            const camera = viewport.getCamera();
-            const { viewPlaneNormal, viewUp } = camera;
-            const referencedImageId = this.getReferencedImageId(viewport, worldPos, viewPlaneNormal, viewUp);
-            const annotation = {
-                metadata: {
-                    viewPlaneNormal: [0, 0, 1],
-                    viewUp: [0, 1, 0],
-                    FrameOfReferenceUID: viewport.getFrameOfReferenceUID(),
-                    referencedImageId,
-                    toolName: this.getToolName(),
-                },
+            const annotation = VideoRedactionTool.createAnnotationForViewport(viewport, {
                 data: {
-                    invalidated: true,
                     handles: {
                         points: [
                             [...worldPos],
@@ -44,12 +33,9 @@ class VideoRedactionTool extends AnnotationTool {
                             [...worldPos],
                             [...worldPos],
                         ],
-                        activeHandleIndex: null,
                     },
-                    cachedStats: {},
-                    active: true,
                 },
-            };
+            });
             addAnnotation(annotation, element);
             const viewportUIDsToRender = getViewportIdsWithToolToRender(element, this.getToolName(), false);
             this.editData = {

package/dist/esm/tools/base/AnnotationTool.d.ts

@@ -4,7 +4,7 @@ import type { Annotation, Annotations, EventTypes, ToolHandle, InteractionTypes,
 import type { AnnotationStyle, StyleSpecifier } from '../../types/AnnotationStyle';
 declare abstract class AnnotationTool extends AnnotationDisplayTool {
     static createAnnotation(...annotationBaseData: any[]): Annotation;
-    static createAnnotationForViewport(viewport: any, ...annotationBaseData: any[]): Annotation;
+    static createAnnotationForViewport<T extends Annotation>(viewport: any, ...annotationBaseData: any[]): T;
     static createAndAddAnnotation(viewport: any, ...annotationBaseData: any[]): void;
     static toolName: any;
     constructor(toolProps: PublicToolProps, defaultToolProps: ToolProps);

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

@@ -0,0 +1,11 @@
+import type { Annotation } from '../types';
+export type FramesRange = [number, number] | number;
+export default class AnnotationMultiSlice {
+    static setStartRange(viewport: any, annotation: any, startRange?: any): void;
+    static setEndRange(viewport: any, annotation: any, endRange?: any): void;
+    static setRange(viewport: any, annotation: any, startRange?: number, endRange?: number): void;
+    static setSingle(viewport: any, annotation: any, current?: any): void;
+    static getFrameRange(annotation: Annotation): number | [number, number];
+    static getFrameRangeStr(annotation: Annotation): string;
+    static setViewportFrameRange(viewport: any, specifier: any): void;
+}

package/dist/esm/utilities/AnnotationMultiSlice.js

@@ -0,0 +1,68 @@
+import { triggerEvent, eventTarget } from '@cornerstonejs/core';
+import Events from '../enums/Events';
+import { ChangeTypes } from '../enums';
+export default class AnnotationMultiSlice {
+    static setStartRange(viewport, annotation, startRange = viewport.getCurrentImageIdIndex()) {
+        this.setRange(viewport, annotation, startRange);
+    }
+    static setEndRange(viewport, annotation, endRange = viewport.getCurrentImageIdIndex()) {
+        this.setRange(viewport, annotation, undefined, endRange);
+    }
+    static setRange(viewport, annotation, startRange, endRange) {
+        const { metadata } = annotation;
+        if (startRange === undefined) {
+            startRange = metadata.sliceIndex < endRange ? metadata.sliceIndex : 0;
+            if (endRange === undefined) {
+                endRange = viewport.getNumberOfSlices() - 1;
+            }
+        }
+        const rangeEndSliceIndex = viewport.getSliceIndexForImage(metadata.multiSliceReference);
+        if (endRange === undefined) {
+            endRange =
+                rangeEndSliceIndex >= startRange
+                    ? rangeEndSliceIndex
+                    : viewport.getNumberOfSlices() - 1;
+        }
+        endRange = Math.max(startRange, endRange);
+        metadata.sliceIndex = Math.min(startRange, endRange);
+        metadata.referencedImageId = viewport.getCurrentImageId(metadata.sliceIndex);
+        metadata.referencedImageURI = undefined;
+        if (endRange === metadata.sliceIndex) {
+            metadata.multiSliceReference = undefined;
+        }
+        else if (endRange !== metadata.multiSliceReference?.sliceIndex) {
+            metadata.multiSliceReference = {
+                referencedImageId: viewport.getCurrentImageId(endRange),
+                sliceIndex: endRange,
+            };
+        }
+        const eventDetail = {
+            viewportId: viewport.id,
+            renderingEngineId: viewport.renderingEngineId,
+            changeType: ChangeTypes.MetadataReferenceModified,
+            annotation,
+        };
+        triggerEvent(eventTarget, Events.ANNOTATION_MODIFIED, eventDetail);
+        this.setViewportFrameRange(viewport, metadata);
+    }
+    static setSingle(viewport, annotation, current = viewport.getCurrentImageIdIndex()) {
+        this.setRange(viewport, annotation, current, current);
+    }
+    static getFrameRange(annotation) {
+        const { metadata } = annotation;
+        const { sliceIndex, multiSliceReference } = metadata;
+        const rangeEndSliceIndex = multiSliceReference?.sliceIndex;
+        return rangeEndSliceIndex
+            ? [sliceIndex + 1, rangeEndSliceIndex + 1]
+            : sliceIndex + 1;
+    }
+    static getFrameRangeStr(annotation) {
+        const range = this.getFrameRange(annotation);
+        return Array.isArray(range) ? `${range[0]}-${range[1]}` : String(range);
+    }
+    static setViewportFrameRange(viewport, specifier) {
+        if (viewport.setFrameRange && specifier.multiSliceReference?.sliceIndex) {
+            viewport.setFrameRange(specifier.sliceIndex + 1, specifier.multiSliceReference.sliceIndex + 1);
+        }
+    }
+}

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

@@ -10,7 +10,7 @@ import triggerAnnotationRenderForToolGroupIds from './triggerAnnotationRenderFor
 import triggerAnnotationRender from './triggerAnnotationRender';
 import { getSphereBoundsInfo } from './getSphereBoundsInfo';
 import { pointToString } from './pointToString';
-import annotationFrameRange from './annotationFrameRange';
+import AnnotationMultiSlice from './AnnotationMultiSlice';
 import getViewportForAnnotation from './getViewportForAnnotation';
 import { annotationHydration, getClosestImageIdForStackViewport } from './annotationHydration';
 import * as contours from './contours';
@@ -36,4 +36,4 @@ declare const roundNumber: typeof utilities.roundNumber;
 import normalizeViewportPlane from './normalizeViewportPlane';
 import IslandRemoval from './segmentation/islandRemoval';
 import { getPixelValueUnits } from './getPixelValueUnits';
-export { math, planar, viewportFilters, drawing, debounce, dynamicVolume, throttle, orientation, isObject, touch, triggerEvent, calibrateImageSpacing, getCalibratedLengthUnitsAndScale, getCalibratedProbeUnitsAndValue, getCalibratedAspect, getPixelValueUnits, segmentation, contours, triggerAnnotationRenderForViewportIds, triggerAnnotationRenderForToolGroupIds, triggerAnnotationRender, getSphereBoundsInfo, getAnnotationNearPoint, getViewportForAnnotation, getAnnotationNearPointOnEnabledElement, viewport, cine, boundingBox, rectangleROITool, planarFreehandROITool, stackPrefetch, stackContextPrefetch, roundNumber, pointToString, polyDataUtils, voi, annotationFrameRange, contourSegmentation, annotationHydration, getClosestImageIdForStackViewport, pointInSurroundingSphereCallback, normalizeViewportPlane, IslandRemoval, };
+export { math, planar, viewportFilters, drawing, debounce, dynamicVolume, throttle, orientation, isObject, touch, triggerEvent, calibrateImageSpacing, getCalibratedLengthUnitsAndScale, getCalibratedProbeUnitsAndValue, getCalibratedAspect, getPixelValueUnits, segmentation, contours, triggerAnnotationRenderForViewportIds, triggerAnnotationRenderForToolGroupIds, triggerAnnotationRender, getSphereBoundsInfo, getAnnotationNearPoint, getViewportForAnnotation, getAnnotationNearPointOnEnabledElement, viewport, cine, boundingBox, rectangleROITool, planarFreehandROITool, stackPrefetch, stackContextPrefetch, roundNumber, pointToString, polyDataUtils, voi, AnnotationMultiSlice, contourSegmentation, annotationHydration, getClosestImageIdForStackViewport, pointInSurroundingSphereCallback, normalizeViewportPlane, IslandRemoval, };

package/dist/esm/utilities/index.js

@@ -10,7 +10,7 @@ import triggerAnnotationRenderForToolGroupIds from './triggerAnnotationRenderFor
 import triggerAnnotationRender from './triggerAnnotationRender';
 import { getSphereBoundsInfo } from './getSphereBoundsInfo';
 import { pointToString } from './pointToString';
-import annotationFrameRange from './annotationFrameRange';
+import AnnotationMultiSlice from './AnnotationMultiSlice';
 import getViewportForAnnotation from './getViewportForAnnotation';
 import { annotationHydration, getClosestImageIdForStackViewport, } from './annotationHydration';
 import * as contours from './contours';
@@ -36,4 +36,4 @@ const roundNumber = utilities.roundNumber;
 import normalizeViewportPlane from './normalizeViewportPlane';
 import IslandRemoval from './segmentation/islandRemoval';
 import { getPixelValueUnits } from './getPixelValueUnits';
-export { math, planar, viewportFilters, drawing, debounce, dynamicVolume, throttle, orientation, isObject, touch, triggerEvent, calibrateImageSpacing, getCalibratedLengthUnitsAndScale, getCalibratedProbeUnitsAndValue, getCalibratedAspect, getPixelValueUnits, segmentation, contours, triggerAnnotationRenderForViewportIds, triggerAnnotationRenderForToolGroupIds, triggerAnnotationRender, getSphereBoundsInfo, getAnnotationNearPoint, getViewportForAnnotation, getAnnotationNearPointOnEnabledElement, viewport, cine, boundingBox, rectangleROITool, planarFreehandROITool, stackPrefetch, stackContextPrefetch, roundNumber, pointToString, polyDataUtils, voi, annotationFrameRange, contourSegmentation, annotationHydration, getClosestImageIdForStackViewport, pointInSurroundingSphereCallback, normalizeViewportPlane, IslandRemoval, };
+export { math, planar, viewportFilters, drawing, debounce, dynamicVolume, throttle, orientation, isObject, touch, triggerEvent, calibrateImageSpacing, getCalibratedLengthUnitsAndScale, getCalibratedProbeUnitsAndValue, getCalibratedAspect, getPixelValueUnits, segmentation, contours, triggerAnnotationRenderForViewportIds, triggerAnnotationRenderForToolGroupIds, triggerAnnotationRender, getSphereBoundsInfo, getAnnotationNearPoint, getViewportForAnnotation, getAnnotationNearPointOnEnabledElement, viewport, cine, boundingBox, rectangleROITool, planarFreehandROITool, stackPrefetch, stackContextPrefetch, roundNumber, pointToString, polyDataUtils, voi, AnnotationMultiSlice, contourSegmentation, annotationHydration, getClosestImageIdForStackViewport, pointInSurroundingSphereCallback, normalizeViewportPlane, IslandRemoval, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "2.15.5",
+  "version": "2.16.1",
   "description": "Cornerstone3D Tools",
   "types": "./dist/esm/index.d.ts",
   "module": "./dist/esm/index.js",
@@ -104,7 +104,7 @@
     "canvas": "^2.11.2"
   },
   "peerDependencies": {
-    "@cornerstonejs/core": "^2.15.5",
+    "@cornerstonejs/core": "^2.16.1",
     "@kitware/vtk.js": "32.9.0",
     "@types/d3-array": "^3.0.4",
     "@types/d3-interpolate": "^3.0.1",
@@ -123,5 +123,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "382df4deb7311b011fed61935d1cccf28a27c4b8"
+  "gitHead": "bbe715cbc6c3e791783196b5016a1bdec47f46be"
 }

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

@@ -1,13 +0,0 @@
-import type { Annotation } from '../types';
-export type FramesRange = [number, number] | number;
-export default class AnnotationFrameRange {
-    protected static frameRangeExtractor: RegExp;
-    protected static imageIdToFrames(imageId: string): FramesRange;
-    static framesToString(range: any): string;
-    protected static framesToImageId(imageId: string, range: FramesRange | string): string;
-    static setFrameRange(annotation: Annotation, range: FramesRange | string, eventBase?: {
-        viewportId: any;
-        renderingEngineId: any;
-    }): void;
-    static getFrameRange(annotation: Annotation): number | [number, number];
-}

package/dist/esm/utilities/annotationFrameRange.js

@@ -1,42 +0,0 @@
-import { triggerEvent, eventTarget } from '@cornerstonejs/core';
-import Events from '../enums/Events';
-export default class AnnotationFrameRange {
-    static { this.frameRangeExtractor = /(\/frames\/|[&?]frameNumber=)([^/&?]*)/i; }
-    static imageIdToFrames(imageId) {
-        const match = imageId.match(this.frameRangeExtractor);
-        if (!match || !match[2]) {
-            return null;
-        }
-        const range = match[2].split('-').map((it) => Number(it));
-        if (range.length === 1) {
-            return range[0];
-        }
-        return range;
-    }
-    static framesToString(range) {
-        if (Array.isArray(range)) {
-            return `${range[0]}-${range[1]}`;
-        }
-        return String(range);
-    }
-    static framesToImageId(imageId, range) {
-        const match = imageId.match(this.frameRangeExtractor);
-        if (!match || !match[2]) {
-            return null;
-        }
-        const newRangeString = this.framesToString(range);
-        return imageId.replace(this.frameRangeExtractor, `${match[1]}${newRangeString}`);
-    }
-    static setFrameRange(annotation, range, eventBase) {
-        const { referencedImageId } = annotation.metadata;
-        annotation.metadata.referencedImageId = this.framesToImageId(referencedImageId, range);
-        const eventDetail = {
-            ...eventBase,
-            annotation,
-        };
-        triggerEvent(eventTarget, Events.ANNOTATION_MODIFIED, eventDetail);
-    }
-    static getFrameRange(annotation) {
-        return this.imageIdToFrames(annotation.metadata.referencedImageId);
-    }
-}