@cornerstonejs/core 0.46.1 → 0.47.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "0.46.1",
+  "version": "0.47.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": "a853107a5b908984ec3649ec3c0d9a61e7c3397f"
+  "gitHead": "2c2efd8536d4af3ede72a47bdab199efe67bb1d3"
 }

package/src/RenderingEngine/RenderingEngine.ts

@@ -148,9 +148,8 @@ class RenderingEngine implements IRenderingEngine {
 
     // 1.a) If there is a found viewport, we remove the viewport and create a new viewport
     if (viewport) {
+      console.log('Viewport already exists, disabling it first');
       this.disableElement(viewportId);
-      // todo: if only removing the viewport, make sure resize also happens
-      // this._removeViewport(viewportId)
     }
 
     // 2.a) See if viewport uses a custom rendering pipeline.

package/src/RenderingEngine/StackViewport.ts

@@ -6,6 +6,7 @@ import vtkCamera from '@kitware/vtk.js/Rendering/Core/Camera';
 import { vec2, vec3, mat4 } from 'gl-matrix';
 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 eventTarget from '../eventTarget';
@@ -39,6 +40,7 @@ import {
   IStackViewport,
   VolumeActor,
   Mat3,
+  ColormapRegistration,
 } from '../types';
 import { ViewportInput } from '../types/IViewport';
 import drawImageSync from './helpers/cpuFallback/drawImageSync';
@@ -267,7 +269,9 @@ class StackViewport extends Viewport implements IStackViewport {
    * Sets the colormap for the current viewport.
    * @param colormap - The colormap data to use.
    */
-  public setColormap: (colormap: CPUFallbackColormapData) => void;
+  public setColormap: (
+    colormap: CPUFallbackColormapData | ColormapRegistration
+  ) => void;
 
   /**
    * If the user has selected CPU rendering, return the CPU camera, otherwise
@@ -1494,6 +1498,8 @@ class StackViewport extends Viewport implements IStackViewport {
     imageIds: Array<string>,
     currentImageIdIndex = 0
   ): Promise<string> {
+    this._throwIfDestroyed();
+
     this.imageIds = imageIds;
     this.currentImageIdIndex = currentImageIdIndex;
     this.targetImageIdIndex = currentImageIdIndex;
@@ -1527,6 +1533,19 @@ class StackViewport extends Viewport implements IStackViewport {
     return imageId;
   }
 
+  /**
+   * Throws an error if you are using a destroyed instance of the stack viewport
+   */
+  private _throwIfDestroyed() {
+    if (this.isDisabled) {
+      throw new Error(
+        'The stack viewport has been destroyed and is no longer usable. Renderings will not be performed. If you ' +
+          'are using the same viewportId and have re-enabled the viewport, you need to grab the new viewport instance ' +
+          'using renderingEngine.getViewport(viewportId), instead of using your lexical scoped reference to the viewport instance.'
+      );
+    }
+  }
+
   /**
    * It checks if the new image object matches the dimensions, spacing,
    * and direction of the previously displayed image in the viewport or not.
@@ -2278,6 +2297,8 @@ class StackViewport extends Viewport implements IStackViewport {
    * provided imageIds in setStack
    */
   public async setImageIdIndex(imageIdIndex: number): Promise<string> {
+    this._throwIfDestroyed();
+
     // If we are already on this imageId index, stop here
     if (this.currentImageIdIndex === imageIdIndex) {
       return this.getCurrentImageId();
@@ -2653,10 +2674,24 @@ class StackViewport extends Viewport implements IStackViewport {
     this.render();
   }
 
-  private setColormapGPU(colormap: CPUFallbackColormapData) {
-    // TODO -> vtk has full colormaps which are piecewise and frankly better?
-    // Do we really want a pre defined 256 color map just for the sake of harmonization?
-    throw new Error('setColorMapGPU not implemented.');
+  private setColormapGPU(colormap: ColormapRegistration) {
+    const ActorEntry = this.getDefaultActor();
+    const actor = ActorEntry.actor as ImageActor;
+    const actorProp = actor.getProperty();
+    const rgbTransferFunction = actorProp.getRGBTransferFunction();
+
+    if (!rgbTransferFunction) {
+      const cfun = vtkColorTransferFunction.newInstance();
+      const voiRange = this._getVOIRangeForCurrentImage();
+      cfun.applyColorMap(colormap);
+      cfun.setMappingRange(voiRange.lower, voiRange.upper);
+      actorProp.setRGBTransferFunction(0, cfun);
+    } else {
+      rgbTransferFunction.applyColorMap(colormap);
+      actorProp.setRGBTransferFunction(0, rgbTransferFunction);
+    }
+
+    this.render();
   }
 
   private unsetColormapGPU() {

package/src/types/IStackViewport.ts

@@ -7,6 +7,7 @@ import Point2 from './Point2';
 import Point3 from './Point3';
 import { Scaling } from './ScalingParameters';
 import StackViewportProperties from './StackViewportProperties';
+import { ColormapRegistration } from './Colormap';
 
 /**
  * Interface for Stack Viewport
@@ -130,7 +131,7 @@ export default interface IStackViewport extends IViewport {
    * Sets the colormap for the current viewport.
    * @param colormap - The colormap data to use.
    */
-  setColormap(colormap: CPUFallbackColormapData): void;
+  setColormap(colormap: CPUFallbackColormapData | ColormapRegistration): void;
   /**
    * It sets the colormap to the default colormap.
    */

package/src/utilities/renderToCanvasGPU.ts

@@ -44,6 +44,17 @@ export default function renderToCanvasGPU(
   element.style.visibility = 'hidden';
   element.style.position = 'absolute';
 
+  // Up-sampling the provided canvas to match the device pixel ratio
+  // since we use device pixel ratio to determine the size of the canvas
+  // inside the rendering engine.
+  const devicePixelRatio = window.devicePixelRatio || 1;
+  const originalWidth = canvas.width;
+  const originalHeight = canvas.height;
+  canvas.width = originalWidth * devicePixelRatio;
+  canvas.height = originalHeight * devicePixelRatio;
+  canvas.style.width = `${originalWidth}px`;
+  canvas.style.height = `${originalHeight}px`;
+
   document.body.appendChild(element);
 
   // add id to the element so we can find it later, and fix the : which is not allowed in css
@@ -85,7 +96,18 @@ export default function renderToCanvasGPU(
 
       // Copy the temporary canvas to the given canvas
       const context = canvas.getContext('2d');
-      context.drawImage(temporaryCanvas, 0, 0);
+      context.drawImage(
+        temporaryCanvas,
+        0,
+        0,
+        temporaryCanvas.width,
+        temporaryCanvas.height, // source dimensions
+        0,
+        0,
+        canvas.width,
+        canvas.height // destination dimensions
+      );
+
       elementRendered = true;
 
       // remove based on id