@cornerstonejs/tools 1.65.3 → 1.65.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.65.3",
+  "version": "1.65.5",
   "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.65.3",
+    "@cornerstonejs/core": "^1.65.5",
     "@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": "7059912b7d083525acdc48af7d0d38eec27efa64"
+  "gitHead": "bc54ae70cb2180d5ce42cc7eaa17633f0bb5f34a"
 }

package/src/stateManagement/annotation/annotationSelection.ts

@@ -94,7 +94,7 @@ function getAnnotationsSelected(): Array<string> {
 function getAnnotationsSelectedByToolName(toolName: string): Array<string> {
   return getAnnotationsSelected().filter((annotationUID) => {
     const annotation = getAnnotation(annotationUID);
-    return annotation.metadata.toolName === toolName;
+    return annotation?.metadata?.toolName === toolName;
   });
 }
 

package/src/tools/MIPJumpToClickTool.ts

@@ -5,6 +5,7 @@ import { getPointInLineOfSightWithCriteria } from '../utilities/planar';
 import jumpToWorld from '../utilities/viewport/jumpToWorld';
 import { PublicToolProps, ToolProps } from '../types';
 import { getToolGroupForViewport } from '../store/ToolGroupManager';
+import { getVolumeId } from '../utilities/getVolumeId';
 
 /**
  * On a Maximum Intensity Projection (MIP) viewport, MIPJumpToClickTool allows the
@@ -54,7 +55,7 @@ class MIPJumpToClickTool extends BaseTool {
       );
     }
 
-    const volumeId = targetId.split(/volumeId:|\?/)[1];
+    const volumeId = getVolumeId(targetId);
 
     // 3. Criteria function to search for the point (maximum intensity)
     let maxIntensity = -Infinity;

package/src/tools/StackScrollToolMouseWheelTool.ts

@@ -2,6 +2,7 @@ import { getEnabledElement } from '@cornerstonejs/core';
 import { BaseTool } from './base';
 import { MouseWheelEventType } from '../types/EventTypes';
 import scroll from '../utilities/scroll';
+import { getVolumeId } from '../utilities/getVolumeId';
 
 /**
  * The StackScrollMouseWheelTool is a tool that allows the user to scroll through a
@@ -35,7 +36,7 @@ class StackScrollMouseWheelTool extends BaseTool {
     const delta = direction * (invert ? -1 : 1);
 
     const targetId = this.getTargetId(viewport);
-    const volumeId = targetId.split(/volumeId:|\?/)[1];
+    const volumeId = getVolumeId(targetId);
 
     scroll(viewport, {
       delta,

package/src/tools/annotation/CircleROITool.ts

@@ -980,10 +980,10 @@ class CircleROITool extends AnnotationTool {
         cachedStats[targetId] = {
           Modality: metadata.Modality,
           area,
-          mean: stats[1]?.value,
-          max: stats[0]?.value,
-          stdDev: stats[2]?.value,
-          statsArray: stats,
+          mean: stats.mean?.value,
+          max: stats.max?.value,
+          stdDev: stats.stdDev?.value,
+          statsArray: stats.array,
           pointsInShape: pointsInShape,
           isEmptyArea,
           areaUnit: getCalibratedAreaUnits(null, image),

package/src/tools/annotation/EllipticalROITool.ts

@@ -1099,11 +1099,11 @@ class EllipticalROITool extends AnnotationTool {
         cachedStats[targetId] = {
           Modality: metadata.Modality,
           area,
-          mean: stats[1]?.value,
-          max: stats[0]?.value,
-          stdDev: stats[2]?.value,
-          statsArray: stats,
-          pointsInShape: pointsInShape,
+          mean: stats.mean?.value,
+          max: stats.max?.value,
+          stdDev: stats.stdDev?.value,
+          statsArray: stats.array,
+          pointsInShape,
           isEmptyArea,
           areaUnit: getCalibratedAreaUnits(null, image),
           modalityUnit,

package/src/tools/annotation/PlanarFreehandROITool.ts

@@ -835,10 +835,10 @@ class PlanarFreehandROITool extends ContourSegmentationBaseTool {
       cachedStats[targetId] = {
         Modality: metadata.Modality,
         area,
-        mean: stats[1]?.value,
-        max: stats[0]?.value,
-        stdDev: stats[3]?.value,
-        statsArray: stats,
+        mean: stats.mean?.value,
+        max: stats.max?.value,
+        stdDev: stats.stdDev?.value,
+        statsArray: stats.array,
         pointsInShape: pointsInShape,
         areaUnit: getCalibratedAreaUnits(null, image),
         modalityUnit,

package/src/tools/annotation/RectangleROITool.ts

@@ -954,10 +954,10 @@ class RectangleROITool extends AnnotationTool {
         cachedStats[targetId] = {
           Modality: metadata.Modality,
           area,
-          mean: stats[1]?.value,
-          stdDev: stats[2]?.value,
-          max: stats[0]?.value,
-          statsArray: stats,
+          mean: stats.mean?.value,
+          stdDev: stats.stdDev?.value,
+          max: stats.max?.value,
+          statsArray: stats.array,
           pointsInShape: pointsInShape,
           areaUnit: getCalibratedAreaUnits(null, image),
           modalityUnit,

package/src/tools/base/AnnotationDisplayTool.ts

@@ -15,6 +15,7 @@ import filterAnnotationsForDisplay from '../../utilities/planar/filterAnnotation
 import { getStyleProperty } from '../../stateManagement/annotation/config/helpers';
 import { getState } from '../../stateManagement/annotation/config';
 import { StyleSpecifier } from '../../types/AnnotationStyle';
+import { getVolumeId } from '../../utilities/getVolumeId';
 
 /**
  * Abstract class for tools which create and display annotations on the
@@ -137,7 +138,7 @@ abstract class AnnotationDisplayTool extends BaseTool {
     } else if (viewport instanceof VideoViewport) {
       referencedImageId = targetId.split('videoId:')[1];
     } else {
-      const volumeId = targetId.split(/volumeId:|\?/)[1];
+      const volumeId = getVolumeId(targetId);
       const imageVolume = cache.getVolume(volumeId);
 
       referencedImageId = utilities.getClosestImageId(

package/src/tools/base/AnnotationTool.ts

@@ -24,6 +24,7 @@ import {
 import { addAnnotation } from '../../stateManagement/annotation/annotationState';
 import { StyleSpecifier } from '../../types/AnnotationStyle';
 import { triggerAnnotationModified } from '../../stateManagement/annotation/helpers/state';
+import { getVolumeId } from '../../utilities/getVolumeId';
 
 /**
  * Abstract class for tools which create and display annotations on the
@@ -368,7 +369,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
     imageId?: string
   ): boolean {
     if (viewport instanceof BaseVolumeViewport) {
-      const volumeId = targetId.split(/volumeId:|\?/)[1];
+      const volumeId = getVolumeId(targetId);
       const volume = cache.getVolume(volumeId);
       return volume.scaling?.PT !== undefined;
     }

package/src/tools/base/BaseTool.ts

@@ -3,6 +3,7 @@ import { Types } from '@cornerstonejs/core';
 import ToolModes from '../../enums/ToolModes';
 import StrategyCallbacks from '../../enums/StrategyCallbacks';
 import { InteractionTypes, ToolProps, PublicToolProps } from '../../types';
+import { getVolumeId } from '../../utilities/getVolumeId';
 
 export interface IBaseTool {
   /** ToolGroup ID the tool instance belongs to */
@@ -208,7 +209,7 @@ abstract class BaseTool implements IBaseTool {
 
       return viewports[0].getImageData();
     } else if (targetId.startsWith('volumeId:')) {
-      const volumeId = targetId.split(/volumeId:|\?/)[1];
+      const volumeId = getVolumeId(targetId);
       const viewports = utilities.getViewportsWithVolumeId(
         volumeId,
         renderingEngine.id

package/src/types/CalculatorTypes.ts

@@ -1,7 +1,20 @@
 type Statistics = {
   name: string;
+  label?: string;
   value: number | number[];
   unit: null | string;
 };
 
-export type { Statistics };
+type NamedStatistics = {
+  mean: Statistics & { name: 'mean' };
+  max: Statistics & { name: 'max' };
+  stdDev: Statistics & { name: 'stdDev' };
+  stdDevWithSumSquare: Statistics & { name: 'stdDevWithSumSquare' };
+  count: Statistics & { name: 'count' };
+  area?: Statistics & { name: 'area' };
+  volume?: Statistics & { name: 'volume' };
+  circumferance?: Statistics & { name: 'circumferance' };
+  array: Statistics[];
+};
+
+export type { Statistics, NamedStatistics };

package/src/types/index.ts

@@ -64,7 +64,7 @@ import type { ContourSegmentationData } from './ContourTypes';
 import type IAnnotationManager from './IAnnotationManager';
 import type AnnotationGroupSelector from './AnnotationGroupSelector';
 import type AnnotationRenderContext from './AnnotationRenderContext';
-import type { Statistics } from './CalculatorTypes';
+import type { Statistics, NamedStatistics } from './CalculatorTypes';
 import type { CanvasCoordinates } from '../utilities/math/ellipse/getCanvasEllipseCorners';
 import {
   LabelmapToolOperationData,
@@ -162,6 +162,9 @@ export type {
   ContourSegmentationData,
   //Statistics
   Statistics,
+  NamedStatistics,
+
+  // Labelmap data
   LabelmapToolOperationData,
   LabelmapToolOperationDataStack,
   LabelmapToolOperationDataVolume,

package/src/utilities/getVolumeId.ts

@@ -0,0 +1,13 @@
+export const getVolumeId = (targetId: string) => {
+  const prefix = 'volumeId:';
+  const str = targetId.includes(prefix)
+    ? targetId.substring(prefix.length)
+    : targetId;
+
+  if (str.startsWith('nifti:')) {
+    return str;
+  }
+
+  const index = str.indexOf('?');
+  return index === -1 ? str : str.substring(0, index);
+};

package/src/utilities/math/basic/BasicStatsCalculator.ts

@@ -1,4 +1,4 @@
-import { Statistics } from '../../../types';
+import { NamedStatistics, Statistics } from '../../../types';
 import Calculator from './Calculator';
 
 export default class BasicStatsCalculator extends Calculator {
@@ -46,15 +46,15 @@ export default class BasicStatsCalculator extends Calculator {
 
   /**
    * Basic function that calculates statictics for a given array of points.
-   * @param points
    * @returns An object that contains :
    * max : The maximum value of the array
    * mean : mean of the array
    * stdDev : standard deviation of the array
    * stdDevWithSumSquare : standard deviation of the array using sum²
+   * array : An array of hte above values, in order.
    */
 
-  static getStatistics = (): Statistics[] => {
+  static getStatistics = (): NamedStatistics => {
     const mean = this.sum.map((sum) => sum / this.count);
     const stdDev = this.squaredDiffSum.map((squaredDiffSum) =>
       Math.sqrt(squaredDiffSum / this.count)
@@ -62,7 +62,46 @@ export default class BasicStatsCalculator extends Calculator {
     const stdDevWithSumSquare = this.sumSquares.map((it, idx) =>
       Math.sqrt(this.sumSquares[idx] / this.count - mean[idx] ** 2)
     );
-    const currentMax = this.max;
+
+    const named: NamedStatistics = {
+      max: {
+        name: 'max',
+        label: 'Max Pixel',
+        value: singleArrayAsNumber(this.max),
+        unit: null,
+      },
+      mean: {
+        name: 'mean',
+        label: 'Mean Pixel',
+        value: singleArrayAsNumber(mean),
+        unit: null,
+      },
+      stdDev: {
+        name: 'stdDev',
+        label: 'Standard Deviation',
+        value: singleArrayAsNumber(stdDev),
+        unit: null,
+      },
+      stdDevWithSumSquare: {
+        name: 'stdDevWithSumSquare',
+        value: singleArrayAsNumber(stdDevWithSumSquare),
+        unit: null,
+      },
+      count: {
+        name: 'count',
+        label: 'Pixel Count',
+        value: this.count,
+        unit: null,
+      },
+      array: [],
+    };
+    named.array.push(
+      named.max,
+      named.mean,
+      named.stdDev,
+      named.stdDevWithSumSquare,
+      named.count
+    );
 
     this.max = [-Infinity];
     this.sum = [0];
@@ -70,16 +109,7 @@ export default class BasicStatsCalculator extends Calculator {
     this.squaredDiffSum = [0];
     this.count = 0;
 
-    return [
-      { name: 'max', value: singleArrayAsNumber(currentMax), unit: null },
-      { name: 'mean', value: singleArrayAsNumber(mean), unit: null },
-      { name: 'stdDev', value: singleArrayAsNumber(stdDev), unit: null },
-      {
-        name: 'stdDevWithSumSquare',
-        value: singleArrayAsNumber(stdDevWithSumSquare),
-        unit: null,
-      },
-    ];
+    return named;
   };
 }
 

package/src/utilities/math/basic/Calculator.ts

@@ -1,8 +1,11 @@
-import { Statistics } from '../../../types';
+import { NamedStatistics } from '../../../types';
 
 abstract class Calculator {
   static run: ({ value }) => void;
-  static getStatistics: () => Statistics[];
+  /**
+   * Gets the statistics as both an array of values, as well as the named values.
+   */
+  static getStatistics: () => NamedStatistics;
 }
 
 export default Calculator;