@cornerstonejs/tools 1.43.7 → 1.44.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.43.7",
+  "version": "1.44.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.43.7",
+    "@cornerstonejs/core": "^1.44.1",
     "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": "2d0c559929aa0524bf303922230ded50ac0ef1df"
+  "gitHead": "0cc7cbccd489e63dbea1a855fbb72d87792b6f89"
 }

package/src/index.ts

@@ -40,9 +40,12 @@ import {
   EllipticalROITool,
   CircleROITool,
   SplineROITool,
+  SplineContourSegmentationTool,
   BidirectionalTool,
   PlanarFreehandROITool,
+  PlanarFreehandContourSegmentationTool,
   LivewireContourTool,
+  LivewireContourSegmentationTool,
   ArrowAnnotateTool,
   KeyImageTool,
   CrosshairsTool,
@@ -107,9 +110,12 @@ export {
   EllipticalROITool,
   CircleROITool,
   SplineROITool,
+  SplineContourSegmentationTool,
   BidirectionalTool,
   PlanarFreehandROITool,
+  PlanarFreehandContourSegmentationTool,
   LivewireContourTool,
+  LivewireContourSegmentationTool,
   ArrowAnnotateTool,
   AngleTool,
   CobbAngleTool,

package/src/stateManagement/segmentation/SegmentationStateManager.ts

@@ -382,7 +382,10 @@ export default class SegmentationStateManager {
   setSegmentSpecificConfig(
     toolGroupId: string,
     segmentationRepresentationUID: string,
-    config: SegmentSpecificRepresentationConfig
+    config: SegmentSpecificRepresentationConfig,
+    options?: {
+      clear: false;
+    }
   ): void {
     const segmentationRepresentation = this.getSegmentationRepresentationByUID(
       toolGroupId,
@@ -393,7 +396,13 @@ export default class SegmentationStateManager {
       return;
     }
 
-    segmentationRepresentation.segmentSpecificConfig = config;
+    if (!segmentationRepresentation.segmentSpecificConfig || options?.clear) {
+      segmentationRepresentation.segmentSpecificConfig = {};
+    }
+
+    Object.keys(config).forEach((key) => {
+      segmentationRepresentation.segmentSpecificConfig[key] = config[key];
+    });
   }
 
   /**

package/src/stateManagement/segmentation/config/segmentationVisibility.ts

@@ -5,7 +5,7 @@ import { ToolGroupSpecificRepresentation } from '../../../types/SegmentationStat
 import { triggerSegmentationRepresentationModified } from '../triggerSegmentationEvents';
 import SegmentationRepresentations from '../../../enums/SegmentationRepresentations';
 
-function getSegmentationIndices(segmentationId) {
+function getUniqueSegmentIndices(segmentationId) {
   const segmentation = SegmentationState.getSegmentation(segmentationId);
 
   if (segmentation.type === SegmentationRepresentations.Labelmap) {
@@ -21,6 +21,10 @@ function getSegmentationIndices(segmentationId) {
     }
     return Object.keys(keySet).map((it) => parseInt(it, 10));
   } else if (segmentation.type === SegmentationRepresentations.Contour) {
+    const annotationUIDsMap =
+      segmentation.representationData.CONTOUR?.annotationUIDsMap;
+
+    const indices = new Set(annotationUIDsMap.keys());
     const geometryIds = segmentation.representationData.CONTOUR?.geometryIds;
 
     if (!geometryIds) {
@@ -29,10 +33,12 @@ function getSegmentationIndices(segmentationId) {
       );
     }
 
-    return geometryIds.map((geometryId) => {
+    geometryIds.forEach((geometryId) => {
       const geometry = cache.getGeometry(geometryId) as Types.IGeometry;
-      return (geometry.data as Types.IContourSet).getSegmentIndex();
+      indices.add((geometry.data as Types.IContourSet).getSegmentIndex());
     });
+
+    return Array.from(indices.values()).sort();
   }
 }
 
@@ -70,7 +76,7 @@ function setSegmentationVisibility(
 
   const { segmentsHidden, segmentationId } = representation;
 
-  const indices = getSegmentationIndices(segmentationId);
+  const indices = getUniqueSegmentIndices(segmentationId);
 
   // if visibility is set to be true, we need to remove all the segments
   // from the segmentsHidden set, otherwise we need to add all the segments
@@ -115,9 +121,17 @@ function getSegmentationVisibility(
     return;
   }
 
-  const { segmentsHidden } = representation;
+  const { segmentsHidden, segmentationId } = representation;
+  const indices = getUniqueSegmentIndices(segmentationId);
+
+  // Create a set that contains all segments indices
+  const indicesSet = new Set(indices);
+
+  // Remove a indices that are hidden
+  segmentsHidden.forEach((segmentIndex) => indicesSet.delete(segmentIndex));
 
-  return segmentsHidden.size === 0;
+  // Check if there is at least one segment visible
+  return !!indicesSet.size;
 }
 
 /**
@@ -160,6 +174,13 @@ function setSegmentsVisibility(
   );
 }
 
+/**
+ * @param toolGroupId - The Id of the tool group that contains the segmentation
+ * @param segmentationRepresentationUID - The id of the segmentation representation that contains the segment
+ * @param segmentIndex - Index of the segment that will be updated
+ * @param visibility - True to show the segment or false to hide it
+ * @returns True if the segment is visible or false otherwise
+ */
 function setSegmentVisibility(
   toolGroupId: string,
   segmentationRepresentationUID: string,
@@ -186,9 +207,34 @@ function setSegmentVisibility(
   );
 }
 
+/**
+ * @param toolGroupId - The Id of the tool group that contains the segmentation.
+ * @param segmentationRepresentationUID - The id of the segmentation representation to modify its visibility.
+ * @param segmentIndex - Index of the segment
+ * @returns True if the segment is visible or false otherwise
+ */
+function getSegmentVisibility(
+  toolGroupId: string,
+  segmentationRepresentationUID: string,
+  segmentIndex: number
+): boolean {
+  const segRepresentation =
+    SegmentationState.getSegmentationRepresentationByUID(
+      toolGroupId,
+      segmentationRepresentationUID
+    );
+
+  if (!segRepresentation) {
+    return false;
+  }
+
+  return !segRepresentation.segmentsHidden.has(segmentIndex);
+}
+
 export {
   setSegmentationVisibility,
   getSegmentationVisibility,
   setSegmentVisibility,
   setSegmentsVisibility,
+  getSegmentVisibility,
 };

package/src/stateManagement/segmentation/helpers/normalizeSegmentationInput.ts

@@ -1,7 +1,9 @@
+import { SegmentationRepresentations } from '../../../enums';
 import {
   SegmentationPublicInput,
   Segmentation,
 } from '../../../types/SegmentationStateTypes';
+import type { ContourSegmentationData } from '../../../types/ContourTypes';
 
 /**
  * It takes in a segmentation input and returns a segmentation with default values
@@ -13,6 +15,30 @@ function normalizeSegmentationInput(
   segmentationInput: SegmentationPublicInput
 ): Segmentation {
   const { segmentationId, representation } = segmentationInput;
+  const isContourRepresentation =
+    representation.type === SegmentationRepresentations.Contour;
+  let data = representation.data ? { ...representation.data } : null;
+
+  // Contour representation data is defined internally
+  data = !data && isContourRepresentation ? {} : data;
+
+  // Data cannot be undefined for labelmap and surface
+  if (!data) {
+    throw new Error('Segmentation representation data may not be undefined');
+  }
+
+  if (isContourRepresentation) {
+    const contourData = <ContourSegmentationData>data;
+
+    // geometryIds will be removed in a near future. It still exist in the
+    // code for compatibility only but it is optional from now on.
+    contourData.geometryIds = contourData.geometryIds ?? [];
+
+    // Make sure annotationUIDsMap is defined because an empty contour is
+    // created before adding contour annotations to the map. Also it prevents
+    // breaking legacy code after moving from geometryIds to annotationUIDsMap.
+    contourData.annotationUIDsMap = contourData.annotationUIDsMap ?? new Map();
+  }
 
   // Todo: we should be able to let the user pass in non-default values for
   // cachedStats, label, activeSegmentIndex, etc.
@@ -26,7 +52,7 @@ function normalizeSegmentationInput(
     activeSegmentIndex: 1,
     representationData: {
       [representation.type]: {
-        ...representation.data,
+        ...data,
       },
     },
   };

package/src/tools/annotation/AngleTool.ts

@@ -649,9 +649,10 @@ class AngleTool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
-      const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
-      const color = this.getStyle('color', styleSpecifier, annotation);
+      const { color, lineWidth, lineDash } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       const canvasCoordinates = points.map((p) => viewport.worldToCanvas(p));
 

package/src/tools/annotation/ArrowAnnotateTool.ts

@@ -703,9 +703,10 @@ class ArrowAnnotateTool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
-      const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
-      const color = this.getStyle('color', styleSpecifier, annotation);
+      const { color, lineWidth, lineDash } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       const canvasCoordinates = points.map((p) => viewport.worldToCanvas(p));
 

package/src/tools/annotation/BidirectionalTool.ts

@@ -1064,10 +1064,10 @@ class BidirectionalTool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
-      const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
-      const color = this.getStyle('color', styleSpecifier, annotation);
-      const shadow = this.getStyle('shadow', styleSpecifier, annotation);
+      const { color, lineWidth, lineDash, shadow } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       // If cachedStats does not exist, or the unit is missing (as part of import/hydration etc.),
       // force to recalculate the stats from the points

package/src/tools/annotation/CircleROITool.ts

@@ -659,9 +659,10 @@ class CircleROITool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
-      const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
-      const color = this.getStyle('color', styleSpecifier, annotation);
+      const { color, lineWidth, lineDash } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       const canvasCoordinates = points.map((p) =>
         viewport.worldToCanvas(p)

package/src/tools/annotation/CobbAngleTool.ts

@@ -673,9 +673,10 @@ class CobbAngleTool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
-      const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
-      const color = this.getStyle('color', styleSpecifier, annotation);
+      const { color, lineWidth, lineDash } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       const canvasCoordinates = points.map((p) => viewport.worldToCanvas(p));
 

package/src/tools/annotation/DragProbeTool.ts

@@ -154,7 +154,10 @@ class DragProbeTool extends ProbeTool {
 
     styleSpecifier.annotationUID = annotationUID;
 
-    const color = this.getStyle('color', styleSpecifier, annotation);
+    const { color } = this.getAnnotationStyle({
+      annotation,
+      styleSpecifier,
+    });
 
     const modalityUnitOptions = {
       isPreScaled: isViewportPreScaled(viewport, targetId),

package/src/tools/annotation/EllipticalROITool.ts

@@ -774,9 +774,10 @@ class EllipticalROITool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
-      const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
-      const color = this.getStyle('color', styleSpecifier, annotation);
+      const { color, lineWidth, lineDash } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       const canvasCoordinates = points.map((p) =>
         viewport.worldToCanvas(p)

package/src/tools/annotation/KeyImageTool.ts

@@ -384,7 +384,10 @@ class KeyImageTool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      const color = this.getStyle('color', styleSpecifier, annotation);
+      const { color } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       const { canvasPosition, canvasSize } = this.configuration;
       if (canvasPosition?.length) {

package/src/tools/annotation/LengthTool.ts

@@ -645,11 +645,10 @@ class LengthTool extends AnnotationTool {
 
       styleSpecifier.annotationUID = annotationUID;
 
-      // Todo: move these into annotationTool class
-      const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
-      const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
-      const color = this.getStyle('color', styleSpecifier, annotation);
-      const shadow = this.getStyle('shadow', styleSpecifier, annotation);
+      const { color, lineWidth, lineDash, shadow } = this.getAnnotationStyle({
+        annotation,
+        styleSpecifier,
+      });
 
       const canvasCoordinates = points.map((p) => viewport.worldToCanvas(p));
 

package/src/tools/annotation/LivewireContourSegmentationTool.ts

@@ -0,0 +1,13 @@
+import LivewireContourTool from './LivewireContourTool';
+
+class LivewireContourSegmentationTool extends LivewireContourTool {
+  static toolName;
+
+  protected isContourSegmentationTool(): boolean {
+    // Re-enable contour segmentation behavior disabled by LivewireContourTool
+    return true;
+  }
+}
+
+LivewireContourSegmentationTool.toolName = 'LivewireContourSegmentationTool';
+export default LivewireContourSegmentationTool;