@cornerstonejs/core 1.40.2 → 1.41.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "1.40.2",
+  "version": "1.41.0",
   "description": "",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -47,5 +47,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "d0219949539e3f24a1b8f880c6c6aba797e061eb"
+  "gitHead": "a151cd133119685c23a9aa7b739e5b7a55312bd1"
 }

package/src/RenderingEngine/BaseVolumeViewport.ts

@@ -82,7 +82,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     VolumeViewportProperties
   >();
   // Camera properties
-  private initialViewUp: Point3;
+  protected initialViewUp: Point3;
   protected viewportProperties: VolumeViewportProperties = {};
 
   constructor(props: ViewportInput) {
@@ -100,16 +100,6 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     const renderer = this.getRenderer();
 
     const camera = vtkSlabCamera.newInstance();
-
-    this.initialViewUp = <Point3>[0, -1, 0];
-    const viewPlaneNormal = <Point3>[0, 0, -1];
-
-    camera.setDirectionOfProjection(
-      -viewPlaneNormal[0],
-      -viewPlaneNormal[1],
-      -viewPlaneNormal[2]
-    );
-    camera.setViewUp(...this.initialViewUp);
     renderer.setActiveCamera(camera);
 
     switch (this.type) {
@@ -145,6 +135,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       -viewPlaneNormal[2]
     );
     camera.setViewUpFrom(viewUp);
+    this.initialViewUp = viewUp;
 
     this.resetCamera();
   }
@@ -1029,9 +1020,12 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     // the viewPlaneNormal indicates a positive or negative rotation respectively.
     const normalDot = vec3.dot(initialToCurrentViewUpCross, viewPlaneNormal);
 
-    return normalDot >= 0
-      ? initialToCurrentViewUpAngle
-      : (360 - initialToCurrentViewUpAngle) % 360;
+    const value =
+      normalDot >= 0
+        ? initialToCurrentViewUpAngle
+        : (360 - initialToCurrentViewUpAngle) % 360;
+
+    return value;
   };
 
   /**

package/src/RenderingEngine/StackViewport.ts

@@ -1,95 +1,96 @@
 import vtkDataArray from '@kitware/vtk.js/Common/Core/DataArray';
-import vtkImageData from '@kitware/vtk.js/Common/DataModel/ImageData';
 import type { vtkImageData as vtkImageDataType } from '@kitware/vtk.js/Common/DataModel/ImageData';
-import vtkColorMaps from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction/ColorMaps';
-import _cloneDeep from 'lodash.clonedeep';
+import vtkImageData from '@kitware/vtk.js/Common/DataModel/ImageData';
 import vtkCamera from '@kitware/vtk.js/Rendering/Core/Camera';
-import { vec2, vec3, mat4 } from 'gl-matrix';
+import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction';
+import vtkColorMaps from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction/ColorMaps';
 import vtkImageMapper from '@kitware/vtk.js/Rendering/Core/ImageMapper';
 import vtkImageSlice from '@kitware/vtk.js/Rendering/Core/ImageSlice';
-import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction';
-import * as metaData from '../metaData';
-import Viewport from './Viewport';
+import { mat4, vec2, vec3 } from 'gl-matrix';
+import _cloneDeep from 'lodash.clonedeep';
 import eventTarget from '../eventTarget';
-import {
-  triggerEvent,
-  isEqual,
-  invertRgbTransferFunction,
-  createSigmoidRGBTransferFunction,
-  windowLevel as windowLevelUtil,
-  imageIdToURI,
-  isImageActor,
-  actorIsA,
-  colormap as colormapUtils,
-  updateVTKImageDataWithCornerstoneImage,
-  imageRetrieveMetadataProvider,
-} from '../utilities';
+import * as metaData from '../metaData';
 import type {
-  Point2,
-  Point3,
-  VOIRange,
+  ActorEntry,
+  CPUFallbackColormapData,
+  CPUFallbackEnabledElement,
+  CPUIImageData,
+  ColormapPublic,
+  EventTypes,
+  FlipDirection,
   ICamera,
   IImage,
+  IImageCalibration,
   IImageData,
-  CPUIImageData,
+  IImagesLoader,
+  IStackInput,
+  IStackViewport,
+  ImageLoadListener,
+  Mat3,
   PTScaling,
+  Point2,
+  Point3,
   Scaling,
   StackViewportProperties,
-  FlipDirection,
-  ActorEntry,
-  CPUFallbackEnabledElement,
-  CPUFallbackColormapData,
-  EventTypes,
-  IStackViewport,
+  VOIRange,
   VolumeActor,
-  Mat3,
-  ColormapPublic,
-  IImageCalibration,
-  IStackInput,
-  IImagesLoader,
-  ImageLoadListener,
 } from '../types';
 import { ViewportInput } from '../types/IViewport';
-import drawImageSync from './helpers/cpuFallback/drawImageSync';
+import {
+  actorIsA,
+  colormap as colormapUtils,
+  createSigmoidRGBTransferFunction,
+  imageIdToURI,
+  imageRetrieveMetadataProvider,
+  invertRgbTransferFunction,
+  isEqual,
+  isImageActor,
+  triggerEvent,
+  updateVTKImageDataWithCornerstoneImage,
+  windowLevel as windowLevelUtil,
+} from '../utilities';
+import Viewport from './Viewport';
 import { getColormap } from './helpers/cpuFallback/colors/index';
+import drawImageSync from './helpers/cpuFallback/drawImageSync';
 
-import { loadAndCacheImage, ImageLoaderOptions } from '../loaders/imageLoader';
-import imageLoadPoolManager from '../requestPool/imageLoadPoolManager';
 import {
+  Events,
   InterpolationType,
+  MetadataModules,
   RequestType,
-  Events,
   VOILUTFunctionType,
   ViewportStatus,
 } from '../enums';
+import { ImageLoaderOptions, loadAndCacheImage } from '../loaders/imageLoader';
+import imageLoadPoolManager from '../requestPool/imageLoadPoolManager';
+import calculateTransform from './helpers/cpuFallback/rendering/calculateTransform';
 import canvasToPixel from './helpers/cpuFallback/rendering/canvasToPixel';
-import pixelToCanvas from './helpers/cpuFallback/rendering/pixelToCanvas';
 import getDefaultViewport from './helpers/cpuFallback/rendering/getDefaultViewport';
-import calculateTransform from './helpers/cpuFallback/rendering/calculateTransform';
+import pixelToCanvas from './helpers/cpuFallback/rendering/pixelToCanvas';
 import resize from './helpers/cpuFallback/rendering/resize';
 
-import resetCamera from './helpers/cpuFallback/rendering/resetCamera';
-import { Transform } from './helpers/cpuFallback/rendering/transform';
+import cache from '../cache';
 import { getConfiguration, getShouldUseCPURendering } from '../init';
+import { createProgressive } from '../loaders/ProgressiveRetrieveImages';
+import {
+  ImagePixelModule,
+  ImagePlaneModule,
+  PixelDataTypedArray,
+} from '../types';
 import {
   StackViewportNewStackEventDetail,
   StackViewportScrollEventDetail,
   VoiModifiedEventDetail,
 } from '../types/EventTypes';
-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';
-import { createProgressive } from '../loaders/ProgressiveRetrieveImages';
 import {
   getTransferFunctionNodes,
   setTransferFunctionNodes,
 } from '../utilities/transferFunctionUtils';
+import correctShift from './helpers/cpuFallback/rendering/correctShift';
+import resetCamera from './helpers/cpuFallback/rendering/resetCamera';
+import { Transform } from './helpers/cpuFallback/rendering/transform';
 
 const EPSILON = 1; // Slice Thickness
 
@@ -442,7 +443,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       metadata: { Modality: this.modality },
       scaling: this.scaling,
       hasPixelSpacing: this.hasPixelSpacing,
-      calibration: this.calibration,
+      calibration: { ...this.csImage.calibration, ...this.calibration },
       preScale: {
         ...this.csImage.preScale,
       },
@@ -484,7 +485,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       },
       scalarData: this.cpuImagePixelData,
       hasPixelSpacing: this.hasPixelSpacing,
-      calibration: this.calibration,
+      calibration: { ...this.csImage.calibration, ...this.calibration },
       preScale: {
         ...this.csImage.preScale,
       },
@@ -587,6 +588,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
 
     const { modality } = metaData.get('generalSeriesModule', imageId);
     const imageIdScalingFactor = metaData.get('scalingModule', imageId);
+    const calibration = metaData.get(MetadataModules.CALIBRATION, imageId);
 
     if (modality === 'PT' && imageIdScalingFactor) {
       this._addScalingToViewport(imageIdScalingFactor);
@@ -596,7 +598,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
     const voiLUTFunctionEnum = this._getValidVOILUTFunction(voiLUTFunction);
     this.VOILUTFunction = voiLUTFunctionEnum;
 
-    this.calibration = null;
+    this.calibration = calibration;
     let imagePlaneModule = this._getImagePlaneModule(imageId);
 
     if (!this.useCPURendering) {
@@ -2963,15 +2965,9 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
 
   // create default values for imagePlaneModule if values are undefined
   private _getImagePlaneModule(imageId: string): ImagePlaneModule {
-    const imagePlaneModule = metaData.get('imagePlaneModule', imageId);
-
-    const calibratedPixelSpacing = metaData.get(
-      'calibratedPixelSpacing',
-      imageId
-    );
+    const imagePlaneModule = metaData.get(MetadataModules.IMAGE_PLANE, imageId);
 
     this.calibration ||= imagePlaneModule.calibration;
-
     const newImagePlaneModule: ImagePlaneModule = {
       ...imagePlaneModule,
     };

package/src/RenderingEngine/VolumeViewport.ts

@@ -196,6 +196,7 @@ class VolumeViewport extends BaseVolumeViewport {
       viewUp,
     });
 
+    this.initialViewUp = viewUp;
     this.resetCamera();
   }
 

package/src/enums/MetadataModules.ts

@@ -9,12 +9,17 @@
 enum MetadataModules {
   CINE = 'cineModule',
   IMAGE_URL = 'imageUrlModule',
+  SOP_COMMON = 'sopCommonModule',
+  VOI_LUT = 'voiLutModule',
+  MODALITY_LUT = 'modalityLutModule',
   GENERAL_SERIES = 'generalSeriesModule',
   PATIENT_STUDY = 'patientStudyModule',
   NM_MULTIFRAME_GEOMETRY = 'nmMultiframeGeometryModule',
   IMAGE_PLANE = 'imagePlaneModule',
   IMAGE_PIXEL = 'imagePixelModule',
   MULTIFRAME = 'multiframeModule',
+  ULTRASOUND_ENHANCED_REGION = 'ultrasoundEnhancedRegionModule',
+  CALIBRATION = 'calibrationModule',
 }
 
 export default MetadataModules;

package/src/types/IImage.ts

@@ -3,6 +3,7 @@ import type CPUFallbackColormap from './CPUFallbackColormap';
 import type CPUFallbackEnabledElement from './CPUFallbackEnabledElement';
 import type { PixelDataTypedArray } from './PixelDataTypedArray';
 import { ImageQualityStatus } from '../enums';
+import IImageCalibration from './IImageCalibration';
 
 /**
  * Cornerstone Image interface, it is used for both CPU and GPU rendering
@@ -118,6 +119,7 @@ interface IImage {
   };
 
   imageQualityStatus?: ImageQualityStatus;
+  calibration?: IImageCalibration;
 }
 
 export default IImage;