@cornerstonejs/core 5.0.10 → 5.0.11

package/dist/esm/RenderingEngine/BaseVolumeViewport.d.ts

@@ -33,6 +33,7 @@ declare abstract class BaseVolumeViewport extends Viewport {
     private initializeVolumeNewImageEventDispatcher;
     private setVOILUTFunction;
     private setColormap;
+    private _applyColormapOpacity;
     private setOpacity;
     private setInvert;
     protected getVOIModifiedEventDetail(volumeId: string): VoiModifiedEventDetail;

package/dist/esm/RenderingEngine/BaseVolumeViewport.js

@@ -1,5 +1,4 @@
 import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction';
-import vtkPiecewiseFunction from '@kitware/vtk.js/Common/DataModel/PiecewiseFunction';
 import { vec2, vec3 } from 'gl-matrix';
 import cache from '../cache/cache';
 import { MPR_CAMERA_VALUES, RENDERING_DEFAULTS, VIEWPORT_PRESETS, } from '../constants';
@@ -12,7 +11,7 @@ import * as colormapUtils from '../utilities/colormap';
 import invertRgbTransferFunction from '../utilities/invertRgbTransferFunction';
 import createSigmoidRGBTransferFunction from '../utilities/createSigmoidRGBTransferFunction';
 import transformWorldToIndex from '../utilities/transformWorldToIndex';
-import { findMatchingColormap, updateOpacity as colormapUpdateOpacity, updateThreshold as colormapUpdateThreshold, getThresholdValue, getMaxOpacity, } from '../utilities/colormap';
+import { findMatchingColormap, updateOpacity as colormapUpdateOpacity, updateThreshold as colormapUpdateThreshold, updateOpacityMapping as colormapUpdateOpacityMapping, getOpacityState, } from '../utilities/colormap';
 import getAcquisitionPlaneOrientation from '../utilities/getAcquisitionPlaneOrientation';
 import { getTransferFunctionNodes, setTransferFunctionNodes, } from '../utilities/transferFunctionUtils';
 import createVolumeActor from './helpers/createVolumeActor';
@@ -163,10 +162,10 @@ class BaseVolumeViewport extends Viewport {
                 return acc;
             }, []);
             const matchedColormap = findMatchingColormap(RGBPoints, volumeActor) || {};
-            const threshold = getThresholdValue(volumeActor);
-            const opacity = getMaxOpacity(volumeActor);
-            matchedColormap.threshold = threshold;
+            const { opacity, opacityMapping, threshold } = getOpacityState(volumeActor);
             matchedColormap.opacity = opacity;
+            matchedColormap.opacityMapping = opacityMapping;
+            matchedColormap.threshold = threshold;
             return matchedColormap;
         };
         this.getRotation = () => {
@@ -447,6 +446,7 @@ class BaseVolumeViewport extends Viewport {
         cfun.setMappingRange(range[0], range[1]);
         volumeActor.getProperty().setRGBTransferFunction(0, cfun);
         this.viewportProperties.colormap = colormap;
+        this._applyColormapOpacity(colormap, volumeActor);
         if (!suppressEvents) {
             const completeColormap = this.getColormap(volumeId);
             const eventDetail = {
@@ -458,26 +458,33 @@ class BaseVolumeViewport extends Viewport {
             triggerEvent(this.element, Events.COLORMAP_MODIFIED, eventDetail);
         }
     }
+    _applyColormapOpacity(colormap, volumeActor) {
+        const mapping = Array.isArray(colormap.opacityMapping)
+            ? colormap.opacityMapping
+            : Array.isArray(colormap.opacity)
+                ? colormap.opacity
+                : undefined;
+        const overall = typeof colormap.opacity === 'number' ? colormap.opacity : undefined;
+        if (mapping !== undefined) {
+            colormapUpdateOpacityMapping(volumeActor, mapping, overall);
+        }
+        else if (overall !== undefined) {
+            colormapUpdateOpacity(volumeActor, overall);
+        }
+    }
     setOpacity(colormap, volumeId) {
         const applicableVolumeActorInfo = this._getApplicableVolumeActor(volumeId);
         if (!applicableVolumeActorInfo) {
             return;
         }
         const { volumeActor } = applicableVolumeActorInfo;
-        const ofun = vtkPiecewiseFunction.newInstance();
-        if (typeof colormap.opacity === 'number') {
-            colormapUpdateOpacity(volumeActor, colormap.opacity);
-        }
-        else {
-            colormap.opacity.forEach(({ opacity, value }) => {
-                ofun.addPoint(value, opacity);
-            });
-            volumeActor.getProperty().setScalarOpacity(0, ofun);
-        }
+        this._applyColormapOpacity(colormap, volumeActor);
         if (!this.viewportProperties.colormap) {
             this.viewportProperties.colormap = {};
         }
-        this.viewportProperties.colormap.opacity = colormap.opacity;
+        const { opacity, opacityMapping } = getOpacityState(volumeActor);
+        this.viewportProperties.colormap.opacity = opacity;
+        this.viewportProperties.colormap.opacityMapping = opacityMapping;
         const matchedColormap = this.getColormap(volumeId);
         const eventDetail = {
             viewportId: this.id,
@@ -801,7 +808,7 @@ class BaseVolumeViewport extends Viewport {
         if (colormap?.name) {
             this.setColormap(colormap, volumeId, suppressEvents);
         }
-        if (colormap?.opacity != null) {
+        if (colormap?.opacity != null || colormap?.opacityMapping != null) {
             this.setOpacity(colormap, volumeId);
         }
         if (colormap?.threshold != null) {

package/dist/esm/types/Colormap.d.ts

@@ -12,6 +12,7 @@ interface OpacityMapping {
 interface ColormapPublic {
     name?: string;
     opacity?: OpacityMapping[] | number;
-    threshold?: number;
+    opacityMapping?: OpacityMapping[];
+    threshold?: number | null;
 }
 export type { ColormapRegistration, ColormapPublic, OpacityMapping };

package/dist/esm/utilities/colormap.d.ts

@@ -1,4 +1,5 @@
 import type { ColormapPublic, ColormapRegistration } from '../types';
+import type { OpacityMapping } from '../types/Colormap';
 declare function registerColormap(colormap: ColormapRegistration): void;
 declare function getColormap(name: any): any;
 declare function getColormapNames(): any[];
@@ -7,6 +8,12 @@ declare function findMatchingColormap(rgbPoints: any, actor: any): ColormapPubli
 export declare function setColorMapTransferFunctionForVolumeActor(volumeInfo: any): void;
 export declare function updateOpacity(volumeActor: any, newOpacity: any): void;
 export declare function updateThreshold(volumeActor: any, newThreshold: any): void;
+export declare function updateOpacityMapping(volumeActor: any, mapping: OpacityMapping[], overall?: number): void;
+export declare function getOpacityState(volumeActor: any): {
+    opacity: number;
+    opacityMapping?: OpacityMapping[];
+    threshold: number | null;
+};
 declare function getThresholdValue(volumeActor: any): any;
 declare function getMaxOpacity(volumeActor: any): number;
 export { getColormap, getColormapNames, resolveColormap, registerColormap, findMatchingColormap, getThresholdValue, getMaxOpacity, };

package/dist/esm/utilities/colormap.js

@@ -3,6 +3,17 @@ import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransf
 import vtkPiecewiseFunction from '@kitware/vtk.js/Common/DataModel/PiecewiseFunction';
 import isEqual from './isEqual';
 import { actorIsA } from './actorCheck';
+const opacitySpecByActor = new WeakMap();
+function getOpacitySpec(volumeActor) {
+    const stored = opacitySpecByActor.get(volumeActor);
+    if (stored) {
+        return stored;
+    }
+    return {
+        overall: getMaxOpacity(volumeActor),
+        threshold: getThresholdValue(volumeActor),
+    };
+}
 const _colormaps = new Map();
 function normalizeColormapName(name) {
     return name?.trim().toLowerCase();
@@ -109,12 +120,64 @@ export function setColorMapTransferFunctionForVolumeActor(volumeInfo) {
     updateOpacityWithThreshold(volumeActor, opacity, threshold);
 }
 export function updateOpacity(volumeActor, newOpacity) {
-    const currentThreshold = getThresholdValue(volumeActor);
-    updateOpacityWithThreshold(volumeActor, newOpacity, currentThreshold);
+    const spec = getOpacitySpec(volumeActor);
+    applyOpacitySpec(volumeActor, { ...spec, overall: newOpacity });
 }
 export function updateThreshold(volumeActor, newThreshold) {
-    const currentOpacity = getMaxOpacity(volumeActor);
-    updateOpacityWithThreshold(volumeActor, currentOpacity, newThreshold);
+    const spec = getOpacitySpec(volumeActor);
+    applyOpacitySpec(volumeActor, { ...spec, threshold: newThreshold });
+}
+export function updateOpacityMapping(volumeActor, mapping, overall) {
+    const spec = getOpacitySpec(volumeActor);
+    applyOpacitySpec(volumeActor, {
+        ...spec,
+        mapping,
+        ...(overall !== undefined && { overall }),
+    });
+}
+export function getOpacityState(volumeActor) {
+    const spec = opacitySpecByActor.get(volumeActor);
+    if (spec) {
+        return {
+            opacity: spec.overall,
+            opacityMapping: spec.mapping,
+            threshold: spec.threshold ?? null,
+        };
+    }
+    return {
+        opacity: getMaxOpacity(volumeActor),
+        opacityMapping: undefined,
+        threshold: getThresholdValue(volumeActor),
+    };
+}
+function applyOpacitySpec(volumeActor, spec) {
+    const overall = spec.overall ?? 1;
+    const threshold = spec.threshold ?? null;
+    const mapping = spec.mapping;
+    opacitySpecByActor.set(volumeActor, { overall, mapping, threshold });
+    if (mapping?.length) {
+        const ofun = vtkPiecewiseFunction.newInstance();
+        const sorted = [...mapping].sort((a, b) => a.value - b.value);
+        if (threshold !== null) {
+            const span = Math.abs(sorted[sorted.length - 1].value - sorted[0].value) || 1;
+            const delta = span * 0.001;
+            ofun.addPoint(sorted[0].value, 0);
+            ofun.addPoint(threshold - delta, 0);
+            sorted.forEach(({ value, opacity }) => {
+                if (value >= threshold) {
+                    ofun.addPoint(value, opacity * overall);
+                }
+            });
+        }
+        else {
+            sorted.forEach(({ value, opacity }) => {
+                ofun.addPoint(value, opacity * overall);
+            });
+        }
+        volumeActor.getProperty().setScalarOpacity(0, ofun);
+        return;
+    }
+    updateOpacityWithThreshold(volumeActor, overall, threshold);
 }
 function updateOpacityWithThreshold(volumeActor, opacity, threshold) {
     const meta = volumeActor.getMapper().getInputData().get('voxelManager');

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.0.10";
+export declare const version = "5.0.11";

package/dist/esm/version.js

@@ -1 +1 @@
-export const version = '5.0.10';
+export const version = '5.0.11';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "5.0.10",
+  "version": "5.0.11",
   "description": "Cornerstone3D Core",
   "module": "./dist/esm/index.js",
   "types": "./dist/esm/index.d.ts",
@@ -84,18 +84,18 @@
     "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
-    "@cornerstonejs/utils": "5.0.10",
+    "@cornerstonejs/utils": "5.0.11",
     "@kitware/vtk.js": "35.5.3",
     "comlink": "4.4.2",
     "gl-matrix": "3.4.3",
     "loglevel": "1.9.2"
   },
   "devDependencies": {
-    "@cornerstonejs/metadata": "5.0.10"
+    "@cornerstonejs/metadata": "5.0.11"
   },
   "peerDependencies": {
-    "@cornerstonejs/metadata": "5.0.10",
-    "@cornerstonejs/utils": "5.0.10"
+    "@cornerstonejs/metadata": "5.0.11",
+    "@cornerstonejs/utils": "5.0.11"
   },
   "contributors": [
     {
@@ -108,5 +108,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "7a0e2fd2fb15e2893e93f469d5d83ebb7e6d4f5b"
+  "gitHead": "40e7a86b4bc2cdee68df76f9abed9cd762c70dc6"
 }