@cornerstonejs/tools 1.56.2 → 1.57.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.56.2",
+  "version": "1.57.1",
   "description": "Cornerstone3D Tools",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -29,7 +29,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^1.56.2",
+    "@cornerstonejs/core": "^1.57.1",
     "@icr/polyseg-wasm": "0.4.0",
     "@types/offscreencanvas": "2019.7.3",
     "comlink": "^4.4.1",
@@ -59,5 +59,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "f0e02324b49825859090ffd7b92523680a6616ce"
+  "gitHead": "f0b7bf4653169cad680753b9d79556b5998b5758"
 }

package/src/eventListeners/annotations/contourSegmentation/contourSegmentationCompleted.ts

@@ -43,8 +43,10 @@ export default async function contourSegmentationCompletedListener(
   }
 
   const viewport = getViewport(sourceAnnotation);
-  const contourSegmentationAnnotations =
-    getValidContourSegmentationAnnotations(sourceAnnotation);
+  const contourSegmentationAnnotations = getValidContourSegmentationAnnotations(
+    viewport,
+    sourceAnnotation
+  );
 
   if (!contourSegmentationAnnotations.length) {
     return;
@@ -143,6 +145,7 @@ function convertContourPolylineToCanvasSpace(
 }
 
 function getValidContourSegmentationAnnotations(
+  viewport: Types.IViewport,
   sourceAnnotation: ContourSegmentationAnnotation
 ): ContourSegmentationAnnotation[] {
   const { annotationUID: sourceAnnotationUID } = sourceAnnotation;
@@ -155,10 +158,14 @@ function getValidContourSegmentationAnnotations(
       targetAnnotation.annotationUID !== sourceAnnotationUID &&
       contourSegUtils.isContourSegmentationAnnotation(targetAnnotation) &&
       contourSegUtils.areSameSegment(targetAnnotation, sourceAnnotation) &&
-      contourUtils.areCoplanarContours(targetAnnotation, sourceAnnotation)
+      viewport.isReferenceViewable(targetAnnotation.metadata)
   ) as ContourSegmentationAnnotation[];
 }
 
+/**
+ * Finds other contours on the same slice which intersect the source polyline,
+ * represented as canvas points.
+ */
 function findIntersectingContour(
   viewport: Types.IViewport,
   sourcePolyline: Types.Point2[],

package/src/tools/annotation/CobbAngleTool.ts

@@ -796,7 +796,7 @@ class CobbAngleTool extends AnnotationTool {
         data.cachedStats[targetId].points.canvas;
       const { arc1Angle, arc2Angle } = data.cachedStats[targetId];
 
-      if (this.configuration.showArcLines){
+      if (this.configuration.showArcLines) {
         lineUID = 'arc1';
 
         drawLineSvg(
@@ -826,7 +826,6 @@ class CobbAngleTool extends AnnotationTool {
         );
       }
 
-
       if (!data.cachedStats[targetId]?.angle) {
         continue;
       }
@@ -880,7 +879,7 @@ class CobbAngleTool extends AnnotationTool {
         bottomRight: viewport.canvasToWorld([left + width, top + height]),
       };
 
-      if (this.configuration.showArcLines){
+      if (this.configuration.showArcLines) {
         const arc1TextBoxUID = 'arcAngle1';
 
         const arc1TextLine = [

package/src/tools/annotation/LengthTool.ts

@@ -138,9 +138,11 @@ class LengthTool extends AnnotationTool {
     hideElementCursor(element);
     this.isDrawing = true;
 
-    const camera = viewport.getCamera();
-    const { viewPlaneNormal, viewUp } = camera;
-
+    const {
+      viewPlaneNormal,
+      viewUp,
+      position: cameraPosition,
+    } = viewport.getCamera();
     const referencedImageId = this.getReferencedImageId(
       viewport,
       worldPos,
@@ -148,17 +150,15 @@ class LengthTool extends AnnotationTool {
       viewUp
     );
 
-    const FrameOfReferenceUID = viewport.getFrameOfReferenceUID();
-
     const annotation = {
       highlighted: true,
       invalidated: true,
       metadata: {
+        ...viewport.getViewReference({ points: [worldPos] }),
         toolName: this.getToolName(),
-        viewPlaneNormal: <Types.Point3>[...viewPlaneNormal],
-        viewUp: <Types.Point3>[...viewUp],
-        FrameOfReferenceUID,
         referencedImageId,
+        viewUp,
+        cameraPosition,
       },
       data: {
         handles: {

package/src/tools/annotation/PlanarFreehandROITool.ts

@@ -531,6 +531,11 @@ class PlanarFreehandROITool extends ContourSegmentationBaseTool {
     const worldPos = evt.detail.currentPoints.world;
     const contourAnnotation = super.createAnnotation(evt);
 
+    const onInterpolationComplete = (annotation) => {
+      // Clear out the handles because they aren't used for straight freeform
+      annotation.data.handles.points.length = 0;
+    };
+
     return <PlanarFreehandROIAnnotation>csUtils.deepMerge(contourAnnotation, {
       data: {
         contour: {
@@ -539,6 +544,7 @@ class PlanarFreehandROITool extends ContourSegmentationBaseTool {
         label: '',
         cachedStats: {},
       },
+      onInterpolationComplete,
     });
   }
 

package/src/tools/base/BaseTool.ts

@@ -243,7 +243,7 @@ abstract class BaseTool implements IBaseTool {
    * @returns targetId
    */
   protected getTargetId(viewport: Types.IViewport): string | undefined {
-    const targetId = viewport.getTargetId?.();
+    const targetId = viewport.getReferenceId?.();
     if (targetId) {
       return targetId;
     }

package/src/tools/base/ContourBaseTool.ts

@@ -110,7 +110,7 @@ abstract class ContourBaseTool extends AnnotationTool {
     const { viewport } = enabledElement;
 
     const camera = viewport.getCamera();
-    const { viewPlaneNormal, viewUp } = camera;
+    const { viewPlaneNormal, viewUp, position: cameraPosition } = camera;
 
     const referencedImageId = this.getReferencedImageId(
       viewport,
@@ -119,19 +119,17 @@ abstract class ContourBaseTool extends AnnotationTool {
       viewUp
     );
 
-    const referencedSliceIndex = viewport.getCurrentImageIdIndex();
-    const FrameOfReferenceUID = viewport.getFrameOfReferenceUID();
+    const viewReference = viewport.getViewReference({ points: [worldPos] });
 
     return <ContourAnnotation>{
       highlighted: true,
       invalidated: true,
       metadata: {
         toolName: this.getToolName(),
-        viewPlaneNormal: <Types.Point3>[...viewPlaneNormal],
-        viewUp: <Types.Point3>[...viewUp],
-        FrameOfReferenceUID,
+        ...viewReference,
         referencedImageId,
-        referencedSliceIndex,
+        viewUp,
+        cameraPosition,
       },
       data: {
         handles: {

package/src/types/AnnotationTypes.ts

@@ -28,41 +28,19 @@ type Annotation = {
   /** If the annotation is auto generated from other annotations*/
   autoGenerated?: boolean;
   /** Metadata for annotation */
-  metadata: {
-    /**
-     * The position of the camera in world space
-     */
-    cameraPosition?: Types.Point3;
-    /**
-     * The focal point of the camera in world space
-     */
-    cameraFocalPoint?: Types.Point3;
-    /**
-     * The normal on which the tool was drawn
-     */
-    viewPlaneNormal?: Types.Point3;
-    /**
-     * The viewUp on which the tool was drawn.
-     */
-    viewUp?: Types.Point3;
-    /**
-     * The FrameOfReferenceUID
-     */
-    FrameOfReferenceUID: string;
+  metadata: Types.ViewReference & {
     /**
      * The registered name of the tool
      */
     toolName: string;
     /**
-     * An optional property used when annotating on a slice in a StackViewport,
-     * or when annotating in a VolumeViewport on a viewPlane that corresponds to
-     * original slice-based image data.
+     * The position of the camera in world space.
      */
-    referencedImageId?: string;
+    cameraPosition?: Types.Point3;
     /**
-     * VolumeId of the volume that the tool was configured to work on.
+     * The viewUp for the view position
      */
-    volumeId?: string;
+    viewUp?: Types.Point3;
   };
   /**
    * Data for annotation, Derivatives need to define their own data types.

package/src/types/ToolSpecificAnnotationTypes.ts

@@ -262,15 +262,7 @@ export type PlanarFreehandContourSegmentationAnnotation =
 
 export type InterpolationROIAnnotation = ContourAnnotation & {
   metadata: {
-    cameraPosition?: Types.Point3;
-    cameraFocalPoint?: Types.Point3;
-    viewPlaneNormal?: Types.Point3;
-    viewUp?: Types.Point3;
     annotationUID?: string;
-    FrameOfReferenceUID: string;
-    referencedImageId?: string;
-    toolName: string;
-    referencedSliceIndex?: number;
   };
   interpolationUID?: string;
   /**

package/src/utilities/contours/interpolation/findAnnotationForInterpolation.ts

@@ -30,6 +30,10 @@ function findAnnotationsForInterpolation(
     },
   ]);
   const rangeToInterpolate = getRangeToInterpolate(interpolationData);
+  if (!rangeToInterpolate) {
+    console.warn('No annotations found to interpolate', interpolationData);
+    return;
+  }
   const sliceEdited = _getSlicePositionOfToolData(
     interpolationData,
     toolData.annotationUID

package/src/utilities/contours/interpolation/getInterpolationData.ts

@@ -43,10 +43,13 @@ export default function getInterpolationData(
     viewport.element
   );
 
+  if (!annotations) {
+    return interpolationDatas;
+  }
+
   for (let i = 0; i < sliceData.numberOfSlices; i++) {
     const imageAnnotations = annotations.filter(
-      (x) =>
-        (x as InterpolationROIAnnotation).metadata.referencedSliceIndex === i
+      (x) => x.metadata.sliceIndex === i
     );
 
     if (!imageAnnotations?.length) {

package/src/utilities/contours/interpolation/interpolate.ts

@@ -76,7 +76,11 @@ function interpolate(viewportData: InterpolationViewportData) {
 function startInterpolation(viewportData: InterpolationViewportData) {
   const toolData = viewportData.annotation;
   const { interpolationData, interpolationList } =
-    findAnnotationsForInterpolation(toolData, viewportData);
+    findAnnotationsForInterpolation(toolData, viewportData) || {};
+
+  if (!interpolationData || !interpolationList) {
+    return;
+  }
 
   const eventData = {
     toolName: toolData.metadata.toolName,
@@ -247,9 +251,9 @@ function _addInterpolatedContour(
     referencedToolData
   );
 
-  const targetId = viewport.getTargetId({ sliceIndex });
+  const targetId = viewport.getReferenceId({ sliceIndex });
   interpolatedAnnotation.metadata.referencedImageId = targetId;
-  interpolatedAnnotation.metadata.referencedSliceIndex = sliceIndex;
+  interpolatedAnnotation.metadata.sliceIndex = sliceIndex;
   annotationState.state.addAnnotation(interpolatedAnnotation, viewport.element);
   referencedToolData.onInterpolationComplete?.(
     interpolatedAnnotation,
@@ -289,7 +293,7 @@ function _editInterpolatedContour(
     const annotation = annotations[i] as InterpolationROIAnnotation;
     if (
       annotation.interpolationUID === referencedToolData.interpolationUID &&
-      annotation.metadata.referencedSliceIndex === sliceIndex
+      annotation.metadata.sliceIndex === sliceIndex
     ) {
       toolDataIndex = i;
       break;

package/src/utilities/planar/filterAnnotationsForDisplay.ts

@@ -1,16 +1,12 @@
 import {
   StackViewport,
   VolumeViewport,
-  VideoViewport,
   Types,
   utilities as csUtils,
 } from '@cornerstonejs/core';
 
 import filterAnnotationsWithinSlice from './filterAnnotationsWithinSlice';
 import type { Annotations } from '../../types';
-import annotationFrameRange from '../annotationFrameRange';
-
-const baseUrlExtractor = /(videoId:|imageId:|volumeId:)([a-zA-Z]*:)/;
 
 /**
  * Given the viewport and the annotations, it filters the annotations array and only
@@ -20,71 +16,10 @@ const baseUrlExtractor = /(videoId:|imageId:|volumeId:)([a-zA-Z]*:)/;
  */
 export default function filterAnnotationsForDisplay(
   viewport: Types.IViewport,
-  annotations: Annotations
+  annotations: Annotations,
+  filterOptions: Types.ReferenceCompatibleOptions = {}
 ): Annotations {
-  if (viewport instanceof StackViewport) {
-    // 1. Get the currently displayed imageId from the StackViewport
-    const imageId = viewport.getCurrentImageId();
-
-    // 2. remove the dataLoader scheme since it might be an annotation that was
-    // created on the volumeViewport initially and has the volumeLoader scheme
-    // but shares the same imageId
-    const colonIndex = imageId.indexOf(':');
-    const imageURI = imageId.substring(colonIndex + 1);
-
-    // 3. Filter annotation in the frame of reference by the referenced image ID property
-    // Note: With the current implementation drawing on the stack (PT stack) will not
-    // show the annotation on a volume that does not share the same imageURIs (CT Volume),
-    // and we don't have a proper way to check distance either since a stack can be
-    // composed of multiple unrelated images
-    return annotations.filter((annotation) => {
-      if (!annotation.isVisible) {
-        return false;
-      }
-
-      // The referenced image id can be a targetId, so handle removing the
-      // imageId portion to make the base comparison work.
-      const imageId = annotation.metadata.referencedImageId?.replace(
-        'imageId:',
-        ''
-      );
-
-      if (imageId === undefined) {
-        // This annotation was not drawn on a non-coplanar reformat, and such does
-        // not have a referenced imageId.
-        return false;
-      }
-
-      const colonIndex = imageId.indexOf(':');
-      const referenceImageURI = imageId.substring(colonIndex + 1);
-      return referenceImageURI === imageURI;
-    });
-  } else if (viewport instanceof VideoViewport) {
-    const frameOfReferenceUID: string = viewport.getFrameOfReferenceUID();
-
-    return annotations.filter((annotation) => {
-      if (!annotation.isVisible) {
-        return false;
-      }
-      if (annotation.metadata.FrameOfReferenceUID !== frameOfReferenceUID) {
-        return false;
-      }
-      const testURI = annotation.metadata.referencedImageId.replace(
-        baseUrlExtractor,
-        ''
-      );
-
-      if (!viewport.hasImageURI(testURI)) {
-        return false;
-      }
-      const range = annotationFrameRange.getFrameRange(annotation);
-      const frameNumber = viewport.getFrameNumber();
-      if (Array.isArray(range)) {
-        return frameNumber >= range[0] && frameNumber <= range[1];
-      }
-      return Math.abs(frameNumber - range) < 1;
-    });
-  } else if (viewport instanceof VolumeViewport) {
+  if (viewport instanceof VolumeViewport) {
     const camera = viewport.getCamera();
 
     const { spacingInNormalDirection } =
@@ -96,7 +31,22 @@ export default function filterAnnotationsForDisplay(
       camera,
       spacingInNormalDirection
     );
-  } else {
-    throw new Error(`Viewport Type ${viewport.type} not supported`);
   }
+  if (viewport instanceof StackViewport) {
+    // 1. Get the currently displayed imageId from the StackViewport
+    const imageId = viewport.getCurrentImageId();
+
+    // 2. remove the dataLoader scheme since it might be an annotation that was
+    // created on the volumeViewport initially and has the volumeLoader scheme
+    // but shares the same imageId
+    const colonIndex = imageId.indexOf(':');
+
+    filterOptions.imageURI = imageId.substring(colonIndex + 1);
+  }
+  return annotations.filter((annotation) => {
+    if (!annotation.isVisible) {
+      return false;
+    }
+    return viewport.isReferenceViewable(annotation.metadata, filterOptions);
+  });
 }

package/src/utilities/planar/filterAnnotationsWithinSlice.ts

@@ -2,7 +2,6 @@ import { vec3 } from 'gl-matrix';
 import { CONSTANTS, metaData } from '@cornerstonejs/core';
 import type { Types } from '@cornerstonejs/core';
 import { Annotations, Annotation } from '../../types';
-import { debug } from 'console';
 
 const { EPSILON } = CONSTANTS;
 

package/src/utilities/segmentation/InterpolationManager/InterpolationManager.ts

@@ -84,7 +84,7 @@ export default class InterpolationManager {
         if (
           sliceIndex !== undefined &&
           metadata &&
-          sliceIndex !== (metadata as any).referencedSliceIndex
+          sliceIndex !== metadata.sliceIndex
         ) {
           continue;
         }

package/src/utilities/segmentation/InterpolationManager/deleteRelatedAnnotations.ts

@@ -21,7 +21,7 @@ export default function deleteRelatedAnnotations(
     { key: 'interpolationUID', value: viewportData.interpolationUID },
   ]);
 
-  const referencedSliceIndex = annotation.metadata.referencedSliceIndex;
+  const referencedSliceIndex = annotation.metadata.sliceIndex as number;
   let minInterpolation = -1;
   let maxInterpolation = viewportData.sliceData.numberOfSlices;
   for (const [sliceIndex, annotations] of interpolationAnnotations.entries()) {
@@ -87,7 +87,7 @@ export default function deleteRelatedAnnotations(
       viewport: viewportData.viewport,
       sliceData: {
         numberOfSlices: viewportData.sliceData.numberOfSlices,
-        imageIndex: nextAnnotation.metadata.referencedSliceIndex,
+        imageIndex: nextAnnotation.metadata.sliceIndex as number,
       },
       annotation: nextAnnotation,
       interpolationUID: nextAnnotation.interpolationUID,