@cornerstonejs/core 0.46.2 → 0.47.1

package/package.json

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

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/RenderingEngine/VolumeViewport.ts

@@ -12,7 +12,7 @@ import type {
   Point3,
 } from '../types';
 import type { ViewportInput } from '../types/IViewport';
-import { actorIsA } from '../utilities';
+import { actorIsA, getClosestImageId } from '../utilities';
 import transformWorldToIndex from '../utilities/transformWorldToIndex';
 import BaseVolumeViewport from './BaseVolumeViewport';
 
@@ -336,15 +336,29 @@ class VolumeViewport extends BaseVolumeViewport {
   }
 
   /**
-   * Uses viewport camera and volume actor to decide if the viewport
-   * is looking at the volume in the direction of acquisition (imageIds).
-   * If so, it uses the origin and focalPoint to calculate the slice index.
+   * Uses the origin and focalPoint to calculate the slice index.
    * Todo: This only works if the imageIds are properly sorted
    *
    * @returns The slice index
    */
   public getCurrentImageIdIndex = (): number | undefined => {
-    return this._getImageIdIndex();
+    const { viewPlaneNormal, focalPoint } = this.getCamera();
+
+    // Todo: handle scenario of fusion of multiple volumes
+    // we cannot only check number of actors, because we might have
+    // segmentations ...
+    const { origin, spacing } = this.getImageData();
+
+    // how many steps are from the origin to the focal point in the
+    // normal direction
+    const spacingInNormal = spacing[2];
+    const sub = vec3.create();
+    vec3.sub(sub, focalPoint, origin);
+    const distance = vec3.dot(sub, viewPlaneNormal);
+
+    // divide by the spacing in the normal direction to get the
+    // number of steps, and subtract 1 to get the index
+    return Math.round(Math.abs(distance) / spacingInNormal);
   };
 
   /**
@@ -356,10 +370,12 @@ class VolumeViewport extends BaseVolumeViewport {
    * @returns ImageId
    */
   public getCurrentImageId = (): string | undefined => {
-    const index = this._getImageIdIndex();
-
-    if (isNaN(index)) {
-      return;
+    if (this.getActors().length > 1) {
+      console.warn(
+        `Using the first/default actor of ${
+          this.getActors().length
+        } actors for getCurrentImageId.`
+      );
     }
 
     const actorEntry = this.getDefaultActor();
@@ -374,44 +390,9 @@ class VolumeViewport extends BaseVolumeViewport {
       return;
     }
 
-    const imageIds = volume.imageIds;
-
-    return imageIds[index];
-  };
-
-  private _getImageIdIndex = () => {
     const { viewPlaneNormal, focalPoint } = this.getCamera();
 
-    // Todo: handle scenario of fusion of multiple volumes
-    // we cannot only check number of actors, because we might have
-    // segmentations ...
-    const { direction, origin, spacing } = this.getImageData();
-
-    // get the last 3 components of the direction - axis normal
-    const dir = direction.slice(direction.length - 3);
-
-    const dot = Math.abs(
-      dir[0] * viewPlaneNormal[0] +
-        dir[1] * viewPlaneNormal[1] +
-        dir[2] * viewPlaneNormal[2]
-    );
-
-    // if dot is not 1 or -1 return null since it means
-    // viewport is not looking at the image acquisition plane
-    if (dot - 1 > EPSILON) {
-      return;
-    }
-
-    // how many steps are from the origin to the focal point in the
-    // normal direction
-    const spacingInNormal = spacing[2];
-    const sub = vec3.create();
-    vec3.sub(sub, focalPoint, origin);
-    const distance = vec3.dot(sub, viewPlaneNormal);
-
-    // divide by the spacing in the normal direction to get the
-    // number of steps, and subtract 1 to get the index
-    return Math.round(Math.abs(distance) / spacingInNormal);
+    return getClosestImageId(volume, focalPoint, viewPlaneNormal);
   };
 
   getRotation = (): number => 0;

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/getClosestImageId.ts

@@ -3,6 +3,7 @@ import * as metaData from '../metaData';
 import type { IImageVolume, Point3 } from '../types';
 
 import getSpacingInNormalDirection from './getSpacingInNormalDirection';
+import { EPSILON } from '../constants';
 
 /**
  * Given an image, a point in space and the viewPlaneNormal it returns the
@@ -11,15 +12,13 @@ import getSpacingInNormalDirection from './getSpacingInNormalDirection';
  * @param imageVolume - The image volume
  * @param worldPos - The position in the world coordinate system (from mouse click)
  * @param viewPlaneNormal - The normal vector of the viewport
- * @param viewUp - The viewUp vector of the camera.
  *
  * @returns The imageId for the tool.
  */
 export default function getClosestImageId(
   imageVolume: IImageVolume,
   worldPos: Point3,
-  viewPlaneNormal: Point3,
-  viewUp: Point3
+  viewPlaneNormal: Point3
 ): string {
   if (!imageVolume) {
     return;
@@ -39,7 +38,7 @@ export default function getClosestImageId(
 
   // 2.a if imagePlane is not parallel to the camera: tool is not drawn on an
   // imaging plane, return
-  if (Math.abs(dotProducts) < 0.99) {
+  if (Math.abs(dotProducts) < 1 - EPSILON) {
     return;
   }