@cornerstonejs/core 0.47.3 → 0.101.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "0.47.3",
+  "version": "0.101.0",
   "description": "",
   "main": "dist/umd/index.js",
   "types": "dist/esm/index.d.ts",
@@ -43,5 +43,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "cae60430345c18a30265eb66bd89131750d3ee40"
+  "gitHead": "186364d5ecda841550ca4928715a988ddf585c7e"
 }

package/src/RenderingEngine/StackViewport.ts

@@ -69,22 +69,14 @@ import cache from '../cache';
 import correctShift from './helpers/cpuFallback/rendering/correctShift';
 import { ImageActor } from '../types/IActor';
 import createLinearRGBTransferFunction from '../utilities/createLinearRGBTransferFunction';
+import {
+  PixelDataTypedArray,
+  ImagePixelModule,
+  ImagePlaneModule,
+} from '../types';
 
 const EPSILON = 1; // Slice Thickness
 
-interface ImagePixelModule {
-  bitsAllocated: number;
-  bitsStored: number;
-  samplesPerPixel: number;
-  highBit: number;
-  photometricInterpretation: string;
-  pixelRepresentation: string;
-  windowWidth: number | number[];
-  windowCenter: number | number[];
-  voiLUTFunction: VOILUTFunctionType;
-  modality: string;
-}
-
 interface ImageDataMetaData {
   bitsAllocated: number;
   numComps: number;
@@ -93,25 +85,9 @@ interface ImageDataMetaData {
   dimensions: Point3;
   spacing: Point3;
   numVoxels: number;
-  imagePlaneModule: unknown;
+  imagePlaneModule: ImagePlaneModule;
   imagePixelModule: ImagePixelModule;
 }
-
-interface ImagePlaneModule {
-  columnCosines?: Point3;
-  columnPixelSpacing?: number;
-  imageOrientationPatient?: Float32Array;
-  imagePositionPatient?: Point3;
-  pixelSpacing?: Point2;
-  rowCosines?: Point3;
-  rowPixelSpacing?: number;
-  sliceLocation?: number;
-  sliceThickness?: number;
-  frameOfReferenceUID: string;
-  columns: number;
-  rows: number;
-}
-
 // TODO This needs to be exposed as its published to consumers.
 type CalibrationEvent = {
   rowScale: number;
@@ -164,7 +140,7 @@ class StackViewport extends Viewport implements IStackViewport {
   // yet widely supported in all hardwares. This feature can be turned on
   // by setting useNorm16Texture or preferSizeOverAccuracy in the configuration
   private useNativeDataType = false;
-  private cpuImagePixelData: number[];
+  private cpuImagePixelData: PixelDataTypedArray;
   private cpuRenderingInvalidated: boolean;
   private csImage: IImage;
 
@@ -1750,49 +1726,7 @@ class StackViewport extends Viewport implements IStackViewport {
 
         triggerEvent(this.element, Events.STACK_NEW_IMAGE, eventDetail);
 
-        const metadata = this._getImageDataMetadata(image) as ImageDataMetaData;
-
-        const viewport = getDefaultViewport(
-          this.canvas,
-          image,
-          this.modality,
-          this._cpuFallbackEnabledElement.viewport.colormap
-        );
-
-        const { windowCenter, windowWidth } = viewport.voi;
-        this.voiRange = windowLevelUtil.toLowHighRange(
-          windowWidth,
-          windowCenter
-        );
-
-        this._cpuFallbackEnabledElement.image = image;
-        this._cpuFallbackEnabledElement.metadata = {
-          ...metadata,
-        };
-        this.cpuImagePixelData = image.getPixelData();
-
-        const viewportSettingToUse = Object.assign(
-          {},
-          viewport,
-          this._cpuFallbackEnabledElement.viewport
-        );
-
-        // Important: this.stackInvalidated is different than cpuRenderingInvalidated. The
-        // former is being used to maintain the previous state of the viewport
-        // in the same stack, the latter is used to trigger drawImageSync
-        this._cpuFallbackEnabledElement.viewport = this.stackInvalidated
-          ? viewport
-          : viewportSettingToUse;
-
-        // used the previous state of the viewport, then stackInvalidated is set to false
-        this.stackInvalidated = false;
-
-        // new viewport is set to the current viewport, then cpuRenderingInvalidated is set to true
-        this.cpuRenderingInvalidated = true;
-
-        this._cpuFallbackEnabledElement.transform = calculateTransform(
-          this._cpuFallbackEnabledElement
-        );
+        this._updateToDisplayImageCPU(image);
 
         // Todo: trigger an event to allow applications to hook into END of loading state
         // Currently we use loadHandlerManagers for this
@@ -1975,7 +1909,12 @@ class StackViewport extends Viewport implements IStackViewport {
    */
   public renderImageObject = (image) => {
     this._setCSImage(image);
-    this._updateActorToDisplayImageId(image);
+
+    const renderFn = this.useCPURendering
+      ? this._updateToDisplayImageCPU
+      : this._updateActorToDisplayImageId;
+
+    renderFn.call(this, image);
   };
 
   private _setCSImage = (image) => {
@@ -1983,6 +1922,49 @@ class StackViewport extends Viewport implements IStackViewport {
     this.csImage = image;
   };
 
+  private _updateToDisplayImageCPU(image: IImage) {
+    const metadata = this._getImageDataMetadata(image) as ImageDataMetaData;
+
+    const viewport = getDefaultViewport(
+      this.canvas,
+      image,
+      this.modality,
+      this._cpuFallbackEnabledElement.viewport.colormap
+    );
+
+    const { windowCenter, windowWidth } = viewport.voi;
+    this.voiRange = windowLevelUtil.toLowHighRange(windowWidth, windowCenter);
+
+    this._cpuFallbackEnabledElement.image = image;
+    this._cpuFallbackEnabledElement.metadata = {
+      ...metadata,
+    };
+    this.cpuImagePixelData = image.getPixelData();
+
+    const viewportSettingToUse = Object.assign(
+      {},
+      viewport,
+      this._cpuFallbackEnabledElement.viewport
+    );
+
+    // Important: this.stackInvalidated is different than cpuRenderingInvalidated. The
+    // former is being used to maintain the previous state of the viewport
+    // in the same stack, the latter is used to trigger drawImageSync
+    this._cpuFallbackEnabledElement.viewport = this.stackInvalidated
+      ? viewport
+      : viewportSettingToUse;
+
+    // used the previous state of the viewport, then stackInvalidated is set to false
+    this.stackInvalidated = false;
+
+    // new viewport is set to the current viewport, then cpuRenderingInvalidated is set to true
+    this.cpuRenderingInvalidated = true;
+
+    this._cpuFallbackEnabledElement.transform = calculateTransform(
+      this._cpuFallbackEnabledElement
+    );
+  }
+
   /**
    * It updates the volume actor with the retrieved cornerstone image.
    * It first checks if the new image has the same dimensions, spacings, and

package/src/types/CPUFallbackEnabledElement.ts

@@ -6,6 +6,8 @@ import CPUFallbackViewport from './CPUFallbackViewport';
 import CPUFallbackTransform from './CPUFallbackTransform';
 import CPUFallbackColormap from './CPUFallbackColormap';
 import CPUFallbackRenderingTools from './CPUFallbackRenderingTools';
+import { ImagePlaneModule } from './ImagePlaneModule';
+import { ImagePixelModule } from './ImagePixelModule';
 
 interface CPUFallbackEnabledElement {
   scale?: number;
@@ -31,40 +33,8 @@ interface CPUFallbackEnabledElement {
     /** Last spacing is always EPSILON for CPU */
     spacing?: Point3;
     origin?: Point3;
-    imagePlaneModule?: {
-      frameOfReferenceUID: string;
-      rows: number;
-      columns: number;
-      imageOrientationPatient: number[];
-      rowCosines: Point3;
-      columnCosines: Point3;
-      imagePositionPatient: number[];
-      sliceThickness?: number;
-      sliceLocation?: number;
-      pixelSpacing: Point2;
-      rowPixelSpacing: number;
-      columnPixelSpacing: number;
-    };
-    imagePixelModule?: {
-      samplesPerPixel: number;
-      photometricInterpretation: string;
-      rows: number;
-      columns: number;
-      bitsAllocated: number;
-      bitsStored: number;
-      highBit: number;
-      pixelRepresentation: number;
-      planarConfiguration?: number;
-      pixelAspectRatio?: number;
-      smallestPixelValue?: number;
-      largestPixelValue?: number;
-      redPaletteColorLookupTableDescriptor?: number[];
-      greenPaletteColorLookupTableDescriptor?: number[];
-      bluePaletteColorLookupTableDescriptor?: number[];
-      redPaletteColorLookupTableData: number[];
-      greenPaletteColorLookupTableData: number[];
-      bluePaletteColorLookupTableData: number[];
-    };
+    imagePlaneModule?: ImagePlaneModule;
+    imagePixelModule?: ImagePixelModule;
   };
 }
 

package/src/types/CPUIImageData.ts

@@ -1,4 +1,4 @@
-import { Point3, Scaling, Mat3 } from '../types';
+import { Point3, Scaling, Mat3, PixelDataTypedArray } from '../types';
 
 type CPUImageData = {
   worldToIndex?: (point: Point3) => Point3;
@@ -8,7 +8,7 @@ type CPUImageData = {
   /** Last spacing is always EPSILON */
   getSpacing?: () => Point3;
   getDirection?: () => Mat3;
-  getScalarData?: () => number[];
+  getScalarData?: () => PixelDataTypedArray;
   /** Last index is always 1 */
   getDimensions?: () => Point3;
 };
@@ -20,7 +20,7 @@ type CPUIImageData = {
   origin: Point3;
   imageData: CPUImageData;
   metadata: { Modality: string };
-  scalarData: number[];
+  scalarData: PixelDataTypedArray;
   scaling: Scaling;
   /** whether the image has pixel spacing and it is not undefined */
   hasPixelSpacing?: boolean;

package/src/types/IImage.ts

@@ -1,14 +1,7 @@
 import CPUFallbackLUT from './CPUFallbackLUT';
 import CPUFallbackColormap from './CPUFallbackColormap';
 import CPUFallbackEnabledElement from './CPUFallbackEnabledElement';
-
-type PixelDataTypedArray =
-  | Float32Array
-  | Int16Array
-  | Uint16Array
-  | Uint8Array
-  | Int8Array
-  | Uint8ClampedArray;
+import { PixelDataTypedArray } from './PixelDataTypedArray';
 
 /**
  * Cornerstone Image interface, it is used for both CPU and GPU rendering

package/src/types/ImagePixelModule.ts

@@ -0,0 +1,14 @@
+import { VOILUTFunctionType } from '../enums';
+
+export interface ImagePixelModule {
+  bitsAllocated: number;
+  bitsStored: number;
+  samplesPerPixel: number;
+  highBit: number;
+  photometricInterpretation: string;
+  pixelRepresentation: string;
+  windowWidth: number | number[];
+  windowCenter: number | number[];
+  voiLUTFunction: VOILUTFunctionType;
+  modality: string;
+}

package/src/types/ImagePlaneModule.ts

@@ -0,0 +1,17 @@
+import Point2 from './Point2';
+import Point3 from './Point3';
+
+export interface ImagePlaneModule {
+  columnCosines?: Point3;
+  columnPixelSpacing?: number;
+  imageOrientationPatient?: Float32Array;
+  imagePositionPatient?: Point3;
+  pixelSpacing?: Point2;
+  rowCosines?: Point3;
+  rowPixelSpacing?: number;
+  sliceLocation?: number;
+  sliceThickness?: number;
+  frameOfReferenceUID: string;
+  columns: number;
+  rows: number;
+}

package/src/types/PixelDataTypedArray.ts

@@ -0,0 +1,7 @@
+export type PixelDataTypedArray =
+  | Float32Array
+  | Int16Array
+  | Uint16Array
+  | Uint8Array
+  | Int8Array
+  | Uint8ClampedArray;

package/src/types/index.ts

@@ -77,6 +77,9 @@ import type { IContour } from './IContour';
 import type RGB from './RGB';
 import { ColormapPublic, ColormapRegistration } from './Colormap';
 import type { ViewportProperties } from './ViewportProperties';
+import type { PixelDataTypedArray } from './PixelDataTypedArray';
+import type { ImagePixelModule } from './ImagePixelModule';
+import type { ImagePlaneModule } from './ImagePlaneModule';
 
 export type {
   // config
@@ -164,4 +167,8 @@ export type {
   RGB,
   ColormapPublic,
   ColormapRegistration,
+  // PixelData
+  PixelDataTypedArray,
+  ImagePixelModule,
+  ImagePlaneModule,
 };