@cornerstonejs/tools 1.41.0 → 1.42.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.41.0",
+  "version": "1.42.0",
   "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.41.0",
+    "@cornerstonejs/core": "^1.42.0",
     "comlink": "^4.4.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "^4.4.2"
@@ -53,5 +53,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "a151cd133119685c23a9aa7b739e5b7a55312bd1"
+  "gitHead": "75102c80b6bc3714f00590b92ccd8d4d52bf1ca2"
 }

package/src/eventDispatchers/keyboardEventHandlers/keyDown.ts

@@ -34,7 +34,13 @@ export default function keyDown(evt: KeyDownEventType): void {
   if (activeToolsWithEventBinding?.size) {
     const { element } = evt.detail;
     for (const [key, value] of [...activeToolsWithEventBinding.entries()]) {
-      key[value.method](element);
+      // Calls the method that implements the action, which can be a string
+      // in which case it belongs to the tool instance, or a function
+      // Call it on the tool instance, with the element and configuration value
+      // so that the method can depend on the specific configuration in use.
+      const method =
+        typeof value.method === 'function' ? value.method : key[value.method];
+      method.call(key, element, value);
     }
   }
 }

package/src/stateManagement/annotation/annotationState.ts

@@ -126,6 +126,9 @@ function getNumberOfAnnotations(
  * @param annotationUID - The unique identifier for the annotation.
  */
 function removeAnnotation(annotationUID: string): void {
+  if (!annotationUID) {
+    return;
+  }
   const manager = getAnnotationManager();
   const annotation = manager.getAnnotation(annotationUID);
 

package/src/tools/annotation/BidirectionalTool.ts

@@ -1348,19 +1348,23 @@ class BidirectionalTool extends AnnotationTool {
 }
 
 function defaultGetTextLines(data, targetId): string[] {
-  const { cachedStats } = data;
+  const { cachedStats, label } = data;
   const { length, width, unit } = cachedStats[targetId];
 
+  const textLines = [];
+  if (label) {
+    textLines.push(label);
+  }
   if (length === undefined) {
-    return;
+    return textLines;
   }
 
   // spaceBetweenSlices & pixelSpacing &
   // magnitude in each direction? Otherwise, this is "px"?
-  const textLines = [
+  textLines.push(
     `L: ${roundNumber(length)} ${unit}`,
-    `W: ${roundNumber(width)} ${unit}`,
-  ];
+    `W: ${roundNumber(width)} ${unit}`
+  );
 
   return textLines;
 }

package/src/types/index.ts

@@ -73,11 +73,13 @@ import type { ISpline } from './ISpline';
 import type { SplineCurveSegment } from './SplineCurveSegment';
 import type { SplineLineSegment } from './SplineLineSegment';
 import type { SplineProps } from './SplineProps';
+import type { BidirectionalData } from '../utilities/segmentation/createBidirectionalToolData';
 
 export type {
   // AnnotationState
   Annotation,
   Annotations,
+  BidirectionalData,
   CanvasCoordinates,
   IAnnotationManager,
   GroupSpecificAnnotations,

package/src/utilities/contours/AnnotationToPointData.ts

@@ -0,0 +1,61 @@
+import RectangleROIStartEndThreshold from './RectangleROIStartEndThreshold';
+
+function validateAnnotation(annotation) {
+  if (!annotation?.data) {
+    throw new Error('Tool data is empty');
+  }
+
+  if (!annotation.metadata || annotation.metadata.referenceImageId) {
+    throw new Error('Tool data is not associated with any imageId');
+  }
+}
+
+class AnnotationToPointData {
+  static TOOL_NAMES: Record<string, any> = {};
+
+  constructor() {
+    // empty
+  }
+
+  static convert(annotation, index, metadataProvider) {
+    validateAnnotation(annotation);
+
+    const { toolName } = annotation.metadata;
+    const toolClass = AnnotationToPointData.TOOL_NAMES[toolName];
+
+    if (!toolClass) {
+      throw new Error(
+        `Unknown tool type: ${toolName}, cannot convert to RTSSReport`
+      );
+    }
+
+    // Each toolData should become a list of contours, ContourSequence
+    // contains a list of contours with their pointData, their geometry
+    // type and their length.
+    const ContourSequence = toolClass.getContourSequence(
+      annotation,
+      metadataProvider
+    );
+
+    // Todo: random rgb color for now, options should be passed in
+    const color = [
+      Math.floor(Math.random() * 255),
+      Math.floor(Math.random() * 255),
+      Math.floor(Math.random() * 255),
+    ];
+
+    return {
+      ReferencedROINumber: index + 1,
+      ROIDisplayColor: color,
+      ContourSequence,
+    };
+  }
+
+  static register(toolClass) {
+    AnnotationToPointData.TOOL_NAMES[toolClass.toolName] = toolClass;
+  }
+}
+
+AnnotationToPointData.register(RectangleROIStartEndThreshold);
+
+export default AnnotationToPointData;

package/src/utilities/contours/RectangleROIStartEndThreshold.ts

@@ -0,0 +1,60 @@
+// comment
+class RectangleROIStartEndThreshold {
+  static toolName: string;
+
+  constructor() {
+    // empty
+  }
+
+  static getContourSequence(toolData, metadataProvider) {
+    const { data } = toolData;
+    const { projectionPoints, projectionPointsImageIds } = data.cachedStats;
+
+    return projectionPoints.map((point, index) => {
+      const ContourData = getPointData(point);
+      const ContourImageSequence = getContourImageSequence(
+        projectionPointsImageIds[index],
+        metadataProvider
+      );
+
+      return {
+        NumberOfContourPoints: ContourData.length / 3,
+        ContourImageSequence,
+        ContourGeometricType: 'CLOSED_PLANAR',
+        ContourData,
+      };
+    });
+  }
+}
+
+RectangleROIStartEndThreshold.toolName = 'RectangleROIStartEndThreshold';
+
+function getPointData(points) {
+  // Since this is a closed contour, the order of the points is important.
+  // re-order the points to be in the correct order clockwise
+  // Spread to make sure Float32Arrays are converted to arrays
+  const orderedPoints = [
+    ...points[0],
+    ...points[1],
+    ...points[3],
+    ...points[2],
+  ];
+  const pointsArray = orderedPoints.flat();
+
+  // reduce the precision of the points to 2 decimal places
+  const pointsArrayWithPrecision = pointsArray.map((point) => {
+    return point.toFixed(2);
+  });
+
+  return pointsArrayWithPrecision;
+}
+
+function getContourImageSequence(imageId, metadataProvider) {
+  const sopCommon = metadataProvider.get('sopCommonModule', imageId);
+
+  return {
+    ReferencedSOPClassUID: sopCommon.sopClassUID,
+    ReferencedSOPInstanceUID: sopCommon.sopInstanceUID,
+  };
+}
+export default RectangleROIStartEndThreshold;

package/src/utilities/contours/contourFinder.ts

@@ -0,0 +1,78 @@
+function findNextLink(line, lines, contourPoints) {
+  let index = -1;
+  lines.forEach((cell, i) => {
+    if (index >= 0) {
+      return;
+    }
+
+    if (cell.a == line.b) {
+      index = i;
+    }
+  });
+
+  if (index >= 0) {
+    const nextLine = lines[index];
+    lines.splice(index, 1);
+
+    contourPoints.push(nextLine.b);
+
+    if (contourPoints[0] == nextLine.b) {
+      return {
+        remainingLines: lines,
+        contourPoints,
+        type: 'CLOSED_PLANAR',
+        //type: 'CLOSEDPLANAR_XOR',
+      };
+    }
+
+    return findNextLink(nextLine, lines, contourPoints);
+  }
+
+  return {
+    remainingLines: lines,
+    contourPoints,
+    type: 'OPEN_PLANAR',
+  };
+}
+
+/**
+ *
+ * @param {*} lines
+ */
+export function findContours(lines) {
+  if (lines.length == 0) {
+    return [];
+  }
+
+  const contourPoints = [];
+
+  const firstCell = lines.shift();
+  contourPoints.push(firstCell.a);
+  contourPoints.push(firstCell.b);
+  const result = findNextLink(firstCell, lines, contourPoints);
+
+  if (result.remainingLines.length == 0) {
+    return [
+      {
+        type: result.type,
+        contourPoints: result.contourPoints,
+      },
+    ];
+  } else {
+    const extraContours = findContours(result.remainingLines);
+    extraContours.push({
+      type: result.type,
+      contourPoints: result.contourPoints,
+    });
+    return extraContours;
+  }
+}
+
+export function findContoursFromReducedSet(lines) {
+  return findContours(lines);
+}
+
+export default {
+  findContours,
+  findContoursFromReducedSet,
+};

package/src/utilities/contours/detectContourHoles.ts

@@ -0,0 +1,147 @@
+/**
+ * Functions for detecting and dealing with holes within contours.
+ * Expected Contour format:
+ * {
+ *   type,
+ *   contourPoints
+ * }
+ */
+
+/**
+ * Checks if point is inside polygon defined by vertices array
+ * Code from
+ * https://stackoverflow.com/questions/22521982/check-if-point-is-inside-a-polygon
+ * most original version based on:
+ * https://wrf.ecse.rpi.edu/Research/Short_Notes/pnpoly.html/pnpoly.html
+ * @param {*} point
+ * @param {*} vertices
+ * @returns
+ */
+const getIsPointInsidePolygon = (point, vertices) => {
+  const x = point[0];
+  const y = point[1];
+
+  let inside = false;
+  for (let i = 0, j = vertices.length - 1; i < vertices.length; j = i++) {
+    const xi = vertices[i][0],
+      yi = vertices[i][1];
+    const xj = vertices[j][0],
+      yj = vertices[j][1];
+
+    const intersect =
+      yi > y != yj > y && x < ((xj - xi) * (y - yi)) / (yj - yi) + xi;
+    if (intersect) {
+      inside = !inside;
+    }
+  }
+
+  return inside;
+};
+
+/**
+ * Check if inner contour is completely surrounded by outer contour.
+ * @param {*} outerContour
+ * @param {*} innerContour
+ * @returns
+ */
+function checkEnclosed(outerContour, innerContour, points) {
+  const vertices = [];
+  outerContour.contourPoints.forEach((point) => {
+    vertices.push([points[point][0], points[point][1]]);
+  });
+
+  let pointsNotEnclosed = 0;
+  innerContour.contourPoints.forEach((point) => {
+    const result = getIsPointInsidePolygon(
+      [points[point][0], points[point][1]],
+      vertices
+    );
+    //console.log(result);
+
+    if (!result) {
+      pointsNotEnclosed++;
+    }
+  });
+
+  return pointsNotEnclosed === 0;
+}
+
+/**
+ * Check if contours have holes, if so update contour accordingly
+ * @param {*} polyData
+ * @param {*} bypass
+ */
+export function processContourHoles(contours, points, useXOR = true) {
+  //console.log(points);
+
+  // Add non-closed planars to contour list
+  const retContours = contours.filter(
+    (contour) => contour.type !== 'CLOSED_PLANAR'
+  );
+
+  // Find closed planar contours
+  const closedContours = contours.filter(
+    (contour) => contour.type === 'CLOSED_PLANAR'
+  );
+
+  // Iterate through each contour in list check for contours that have holes
+  const contourWithHoles = [];
+  let contourWithoutHoles = [];
+  closedContours.forEach((contour, index) => {
+    const holes = [];
+
+    // Check if any other contour is a hole surrounded by current contour
+    closedContours.forEach((hContour, hIndex) => {
+      if (index != hIndex) {
+        // Check if inner loop contour is a hole of outer loop contour
+        if (checkEnclosed(contour, hContour, points)) {
+          holes.push(hIndex);
+        }
+      }
+    });
+
+    // Check if holes were found
+    if (holes.length > 0) {
+      // Note current contour and reference of its holes
+      contourWithHoles.push({
+        contour,
+        holes,
+      });
+    } else {
+      // Note contour index without holes
+      contourWithoutHoles.push(index);
+    }
+  });
+
+  if (useXOR) {
+    // XOR method
+    contourWithHoles.forEach((contourHoleSet) => {
+      // Modify contour with hole to type CLOSEDPLANAR_XOR
+      contourHoleSet.contour.type = 'CLOSEDPLANAR_XOR';
+      retContours.push(contourHoleSet.contour);
+
+      contourHoleSet.holes.forEach((holeIndex) => {
+        // Modify hole type to CLOSEDPLANAR_XOR
+        // and add to contour list to be returned
+        closedContours[holeIndex].type = 'CLOSEDPLANAR_XOR';
+        retContours.push(closedContours[holeIndex]);
+
+        // Remove hole from list of contours without holes
+        contourWithoutHoles = contourWithoutHoles.filter((contourIndex) => {
+          return contourIndex !== holeIndex;
+        });
+      });
+    });
+
+    // Add remaining contours to list (neither hole nor have holes)
+    contourWithoutHoles.forEach((contourIndex) => {
+      retContours.push(closedContours[contourIndex]);
+    });
+  } else {
+    // Keyhole method, not implemented
+  }
+
+  return retContours;
+}
+
+export default { processContourHoles };

package/src/utilities/contours/generateContourSetsFromLabelmap.ts

@@ -0,0 +1,160 @@
+import { cache as cornerstoneCache } from '@cornerstonejs/core';
+import vtkImageMarchingSquares from '@kitware/vtk.js/Filters/General/ImageMarchingSquares';
+import vtkDataArray from '@kitware/vtk.js/Common/Core/DataArray';
+import vtkImageData from '@kitware/vtk.js/Common/DataModel/ImageData';
+
+import { removeDuplicatePoints } from './mergePoints';
+import { findContoursFromReducedSet } from './contourFinder';
+import SegmentationRepresentations from '../../enums/SegmentationRepresentations';
+
+const { Labelmap } = SegmentationRepresentations;
+
+function generateContourSetsFromLabelmap({ segmentations }) {
+  const { representationData, segments = [0, 1] } = segmentations;
+  const { volumeId: segVolumeId } = representationData[Labelmap];
+
+  // Get segmentation volume
+  const vol = cornerstoneCache.getVolume(segVolumeId);
+  if (!vol) {
+    console.warn(`No volume found for ${segVolumeId}`);
+    return;
+  }
+
+  const numSlices = vol.dimensions[2];
+
+  // Get image volume segmentation references
+  const imageVol = cornerstoneCache.getVolume(vol.referencedVolumeId);
+  if (!imageVol) {
+    console.warn(`No volume found for ${vol.referencedVolumeId}`);
+    return;
+  }
+
+  // NOTE: Workaround for marching squares not finding closed contours at
+  // boundary of image volume, clear pixels along x-y border of volume
+  const segData = vol.imageData.getPointData().getScalars().getData();
+  const pixelsPerSlice = vol.dimensions[0] * vol.dimensions[1];
+
+  for (let z = 0; z < numSlices; z++) {
+    for (let y = 0; y < vol.dimensions[1]; y++) {
+      const index = y * vol.dimensions[0] + z * pixelsPerSlice;
+      segData[index] = 0;
+      segData[index + vol.dimensions[0] - 1] = 0;
+    }
+  }
+
+  // end workaround
+  //
+  //
+  const ContourSets = [];
+
+  const { FrameOfReferenceUID } = imageVol.metadata;
+  // Iterate through all segments in current segmentation set
+  const numSegments = segments.length;
+  for (let segIndex = 0; segIndex < numSegments; segIndex++) {
+    const segment = segments[segIndex];
+
+    // Skip empty segments
+    if (!segment) {
+      continue;
+    }
+
+    const sliceContours = [];
+    const scalars = vtkDataArray.newInstance({
+      name: 'Scalars',
+      numberOfComponents: 1,
+      size: pixelsPerSlice * numSlices,
+      dataType: 'Uint8Array',
+    });
+    const { containedSegmentIndices } = segment;
+    for (let sliceIndex = 0; sliceIndex < numSlices; sliceIndex++) {
+      // Check if the slice is empty before running marching cube
+      if (
+        isSliceEmptyForSegment(sliceIndex, segData, pixelsPerSlice, segIndex)
+      ) {
+        continue;
+      }
+      const frameStart = sliceIndex * pixelsPerSlice;
+
+      try {
+        // Modify segData for this specific segment directly
+        for (let i = 0; i < pixelsPerSlice; i++) {
+          const value = segData[i + frameStart];
+          if (value === segIndex || containedSegmentIndices?.has(value)) {
+            (scalars as any).setValue(i + frameStart, 1);
+          } else {
+            (scalars as any).setValue(i, 0);
+          }
+        }
+
+        const mSquares = vtkImageMarchingSquares.newInstance({
+          slice: sliceIndex,
+        });
+
+        // filter out the scalar data so that only it has background and
+        // the current segment index
+        const imageDataCopy = vtkImageData.newInstance();
+
+        imageDataCopy.shallowCopy(vol.imageData);
+        imageDataCopy.getPointData().setScalars(scalars);
+
+        // Connect pipeline
+        mSquares.setInputData(imageDataCopy);
+        const cValues = [1];
+        mSquares.setContourValues(cValues);
+        mSquares.setMergePoints(false);
+
+        // Perform marching squares
+        const msOutput = mSquares.getOutputData();
+
+        // Clean up output from marching squares
+        const reducedSet = removeDuplicatePoints(msOutput);
+        if (reducedSet.points?.length) {
+          const contours = findContoursFromReducedSet(reducedSet.lines);
+
+          sliceContours.push({
+            referencedImageId: imageVol.imageIds[sliceIndex],
+            contours,
+            polyData: reducedSet,
+            FrameNumber: sliceIndex + 1,
+            sliceIndex,
+            FrameOfReferenceUID,
+          });
+        }
+      } catch (e) {
+        console.warn(sliceIndex);
+        console.warn(e);
+      }
+    }
+
+    const metadata = {
+      referencedImageId: imageVol.imageIds[0], // just use 0 for overall
+      FrameOfReferenceUID,
+    };
+
+    const ContourSet = {
+      label: segment.label,
+      color: segment.color,
+      metadata,
+      sliceContours,
+    };
+
+    ContourSets.push(ContourSet);
+  }
+
+  return ContourSets;
+}
+
+function isSliceEmptyForSegment(sliceIndex, segData, pixelsPerSlice, segIndex) {
+  const startIdx = sliceIndex * pixelsPerSlice;
+  const endIdx = startIdx + pixelsPerSlice;
+
+  for (let i = startIdx; i < endIdx; i++) {
+    if (segData[i] === segIndex) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+export { generateContourSetsFromLabelmap };

package/src/utilities/contours/index.ts

@@ -0,0 +1,14 @@
+import contourFinder from './contourFinder';
+import mergePoints from './mergePoints';
+import detectContourHoles from './detectContourHoles';
+import { generateContourSetsFromLabelmap } from './generateContourSetsFromLabelmap';
+
+import AnnotationToPointData from './AnnotationToPointData';
+
+export {
+  contourFinder,
+  mergePoints,
+  detectContourHoles,
+  generateContourSetsFromLabelmap,
+  AnnotationToPointData,
+};