@cornerstonejs/core 1.3.0 → 1.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "",
   "main": "dist/umd/index.js",
   "types": "dist/esm/index.d.ts",
@@ -44,5 +44,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "2d2a16d47deaee1ad6d6c5b15e84626ae6ecfdf5"
+  "gitHead": "13e9e13e8445e84ac0ef70e4214c0c74b324cce3"
 }

package/src/RenderingEngine/StackViewport.ts

@@ -1289,7 +1289,7 @@ class StackViewport extends Viewport implements IStackViewport {
    * @param imageIdScalingFactor - suvbw, suvlbm, suvbsa
    */
   private _addScalingToViewport(imageIdScalingFactor) {
-    if (this.scaling.PET) {
+    if (this.scaling.PT) {
       return;
     }
 
@@ -1297,17 +1297,17 @@ class StackViewport extends Viewport implements IStackViewport {
     // These ratios are constant across all frames, so only need one.
     const { suvbw, suvlbm, suvbsa } = imageIdScalingFactor;
 
-    const petScaling = <PTScaling>{};
+    const ptScaling = <PTScaling>{};
 
     if (suvlbm) {
-      petScaling.suvbwToSuvlbm = suvlbm / suvbw;
+      ptScaling.suvbwToSuvlbm = suvlbm / suvbw;
     }
 
     if (suvbsa) {
-      petScaling.suvbwToSuvbsa = suvbsa / suvbw;
+      ptScaling.suvbwToSuvbsa = suvbsa / suvbw;
     }
 
-    this.scaling.PET = petScaling;
+    this.scaling.PT = ptScaling;
   }
 
   /**

package/src/RenderingEngine/VolumeViewport.ts

@@ -2,7 +2,7 @@ import vtkPlane from '@kitware/vtk.js/Common/DataModel/Plane';
 import { vec3 } from 'gl-matrix';
 
 import cache from '../cache';
-import { EPSILON, MPR_CAMERA_VALUES, RENDERING_DEFAULTS } from '../constants';
+import { MPR_CAMERA_VALUES, RENDERING_DEFAULTS } from '../constants';
 import { BlendModes, OrientationAxis } from '../enums';
 import type {
   ActorEntry,

package/src/cache/classes/ImageVolume.ts

@@ -23,6 +23,9 @@ export class ImageVolume implements IImageVolume {
 
   /** Read-only unique identifier for the volume */
   readonly volumeId: string;
+
+  isPreScaled = false;
+
   /** Dimensions of the volume */
   dimensions: Point3;
   /** volume direction in world space */
@@ -32,10 +35,9 @@ export class ImageVolume implements IImageVolume {
   /** volume origin, Note this is an opinionated origin for the volume */
   origin: Point3;
   /** Whether preScaling has been performed on the volume */
-  isPrescaled = false;
   /** volume scaling parameters if it contains scaled data */
   scaling?: {
-    PET?: {
+    PT?: {
       // @TODO: Do these values exist?
       SUVlbmFactor?: number;
       SUVbsaFactor?: number;

package/src/init.ts

@@ -8,8 +8,9 @@ import { deepMerge } from './utilities';
 import { Cornerstone3DConfig } from './types';
 // TODO: move sharedArrayBuffer into config.
 // TODO: change config into a class with methods to better control get/set
-const defaultConfig = {
-  detectGPU: {},
+const defaultConfig: Cornerstone3DConfig = {
+  gpuTier: undefined,
+  detectGPUConfig: {},
   rendering: {
     useCPURendering: false,
     // GPU rendering options
@@ -21,8 +22,9 @@ const defaultConfig = {
   // ...
 };
 
-let config = {
-  detectGPU: {},
+let config: Cornerstone3DConfig = {
+  gpuTier: undefined,
+  detectGPUConfig: {},
   rendering: {
     useCPURendering: false,
     // GPU rendering options
@@ -106,19 +108,19 @@ async function init(configuration = {}): Promise<boolean> {
   // merge configs
   config = deepMerge(defaultConfig, configuration);
 
-  // detectGPU
+  // gpuTier
   const hasWebGLContext = _hasActiveWebGLContext();
   if (!hasWebGLContext) {
     console.log('CornerstoneRender: GPU not detected, using CPU rendering');
     config.rendering.useCPURendering = true;
   } else {
-    const gpuTier = await getGPUTier();
-    config.detectGPU = gpuTier;
+    config.gpuTier =
+      config.gpuTier || (await getGPUTier(config.detectGPUConfig));
     console.log(
       'CornerstoneRender: Using detect-gpu to get the GPU benchmark:',
-      gpuTier
+      config.gpuTier
     );
-    if (gpuTier.tier < 1) {
+    if (config.gpuTier.tier < 1) {
       console.log(
         'CornerstoneRender: GPU is not powerful enough, using CPU rendering'
       );

package/src/types/Cornerstone3DConfig.ts

@@ -1,5 +1,20 @@
+import type { TierResult, GetGPUTier } from 'detect-gpu';
+
 type Cornerstone3DConfig = {
-  detectGPU: any;
+  /**
+   * It is used to store the device information,
+   * we use it if provided if not a network call is performed.
+   * Its type is the `TierResult` in the `detect-gpu` library.
+   * https://github.com/pmndrs/detect-gpu/blob/master/src/index.ts#L82
+   */
+  gpuTier?: TierResult;
+  /**
+   * When the `gpuTier` is not provided, the `detectGPUConfig` is passed as
+   * an argument to the `getGPUTier` method.
+   * Its type is the `GetGPUTier` in the `detect-gpu` library.
+   * https://github.com/pmndrs/detect-gpu/blob/master/src/index.ts#L20
+   */
+  detectGPUConfig: GetGPUTier;
   rendering: {
     // vtk.js supports 8bit integer textures and 32bit float textures.
     // However, if the client has norm16 textures (it can be seen by visiting

package/src/types/IImage.ts

@@ -82,7 +82,7 @@ interface IImage {
   colormap?: CPUFallbackColormap;
   /** image scaling metadata - including PT suv values */
   scaling?: {
-    PET?: {
+    PT?: {
       // @TODO: Do these values exist?
       SUVlbmFactor?: number;
       SUVbsaFactor?: number;

package/src/types/IImageVolume.ts

@@ -23,10 +23,10 @@ interface IImageVolume {
   /** volume origin - set to the imagePositionPatient of the last image in the volume */
   origin: Point3;
   /** Whether preScaling has been performed on the volume */
-  isPrescaled: boolean;
+  isPreScaled: boolean;
   /** volume scaling metadata */
   scaling?: {
-    PET?: {
+    PT?: {
       SUVlbmFactor?: number;
       SUVbsaFactor?: number;
       suvbwToSuvlbm?: number;

package/src/types/IVolume.ts

@@ -31,7 +31,7 @@ interface IVolume {
   referencedVolumeId?: string;
   /** volume scaling metadata */
   scaling?: {
-    PET?: {
+    PT?: {
       // @TODO: Do these values exist?
       SUVlbmFactor?: number;
       SUVbsaFactor?: number;

package/src/types/ScalingParameters.ts

@@ -27,7 +27,7 @@ type PTScaling = {
 };
 
 type Scaling = {
-  PET?: PTScaling;
+  PT?: PTScaling;
 };
 
 export { PTScaling, Scaling, ScalingParameters };