@cornerstonejs/core 0.47.1 → 0.47.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "0.47.1",
+  "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": "fe634bf0a19f588638aaa21d4bcbbc8df33897b3"
+  "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/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/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,
 };