@cornerstonejs/core 0.47.0 → 0.47.2

package/package.json

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

package/src/RenderingEngine/StackViewport.ts

@@ -508,6 +508,13 @@ class StackViewport extends Viewport implements IStackViewport {
     return imagePlaneModule.frameOfReferenceUID;
   };
 
+  /**
+   * Returns the raw/loaded image being shown inside the stack viewport.
+   */
+  public getCornerstoneImage = (): IImage => {
+    return this.csImage;
+  };
+
   /**
    * Creates imageMapper based on the provided vtkImageData and also creates
    * the imageSliceActor and connects it to the imageMapper.

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

@@ -8,6 +8,7 @@ import Point3 from './Point3';
 import { Scaling } from './ScalingParameters';
 import StackViewportProperties from './StackViewportProperties';
 import { ColormapRegistration } from './Colormap';
+import IImage from './IImage';
 
 /**
  * Interface for Stack Viewport
@@ -84,6 +85,10 @@ export default interface IStackViewport extends IViewport {
    * image scalar data, vtkImageData object, metadata, and scaling (e.g., PET suvbw)
    */
   getImageData(): IImageData | CPUIImageData;
+  /**
+   * Returns the raw/loaded image being shown inside the stack viewport.
+   */
+  getCornerstoneImage: () => IImage;
   /**
    * Reset the viewport properties to the default values
    */

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;
   }
 

package/src/utilities/getImageLegacy.ts

@@ -0,0 +1,29 @@
+import { StackViewport, Types } from '..';
+import getEnabledElement from '../getEnabledElement';
+
+/**
+ * Gets the IImage rendered by the given element. This is provided as a
+ * convenience for the legacy cornerstone getImage function. However it is
+ * encouraged for IStackViewport.getImage to be used instead.
+ * @param element - the element rendering/containing the image
+ * @returns the image
+ */
+function getImageLegacy(element: HTMLDivElement): Types.IImage | undefined {
+  const enabledElement = getEnabledElement(element);
+
+  if (!enabledElement) {
+    return;
+  }
+
+  const { viewport } = enabledElement;
+
+  if (!(viewport instanceof StackViewport)) {
+    throw new Error(
+      `An image can only be fetched for a stack viewport and not for a viewport of type: ${viewport.type}`
+    );
+  }
+
+  return viewport.getCornerstoneImage();
+}
+
+export default getImageLegacy;

package/src/utilities/index.ts

@@ -45,6 +45,7 @@ import deepMerge from './deepMerge';
 import getScalingParameters from './getScalingParameters';
 import getScalarDataType from './getScalarDataType';
 import isPTPrescaledWithSUV from './isPTPrescaledWithSUV';
+import getImageLegacy from './getImageLegacy';
 
 // name spaces
 import * as planar from './planar';
@@ -103,4 +104,5 @@ export {
   getScalingParameters,
   getScalarDataType,
   colormap,
+  getImageLegacy,
 };