@cornerstonejs/core 5.0.16 → 5.1.1

package/dist/esm/utilities/index.js

@@ -57,7 +57,7 @@ import { updateVTKImageDataWithCornerstoneImage } from './updateVTKImageDataWith
 import ProgressiveIterator from './ProgressiveIterator';
 import decimate from './decimate';
 import imageRetrieveMetadataProvider from './imageRetrieveMetadataProvider';
-import genericViewportDataSetMetadataProvider from './genericViewportDataSetMetadataProvider';
+import genericViewportDisplaySetMetadataProvider from './genericViewportDisplaySetMetadataProvider';
 import isVideoTransferSyntax from './isVideoTransferSyntax';
 import { getBufferConfiguration } from './getBufferConfiguration';
 import { generateVolumePropsFromImageIds } from './generateVolumePropsFromImageIds';
@@ -87,6 +87,8 @@ import fnv1aHash from './fnv1aHash';
 import { getImageDataMetadata } from './getImageDataMetadata';
 import { buildMetadata } from './buildMetadata';
 import { _getViewportModality } from './getViewportModality';
+import { _getScalingDescriptor } from './getScalingDescriptor';
+import { resolveGenericViewportVolumeId } from './resolveGenericViewportVolumeId';
 import cache from '../cache/cache';
 import getDynamicVolumeInfo from './getDynamicVolumeInfo';
 import autoLoad from './autoLoad';
@@ -107,9 +109,10 @@ export * from './getPixelSpacingInformation';
 export * from './getPlaneCubeIntersectionDimensions';
 export * from './rotateToViewCoordinates';
 import { asArray } from './asArray';
-import { viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, } from './viewportCapabilities';
+import { viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, isGenericViewport, viewportSupportsDisplaySetPresentation, getViewportContentMode, viewportIsInVolumeMode, viewportIsInStackMode, } from './viewportCapabilities';
 import { getNormalizedAspectRatio } from './getNormalizedAspectRatio';
 export { updatePlaneRestriction } from './updatePlaneRestriction';
 const getViewportModality = (viewport, volumeId) => _getViewportModality(viewport, volumeId, cache.getVolume);
+const getScalingDescriptor = (viewport, targetId) => _getScalingDescriptor(viewport, targetId, cache.getVolume);
 export * from './isEqual';
-export { FrameRange, eventListener, csUtils as invertRgbTransferFunction, createSigmoidRGBTransferFunction, getVoiFromSigmoidRGBTransferFunction, createLinearRGBTransferFunction, scaleRgbTransferFunction, triggerEvent, imageIdToURI, fnv1aHash, calibratedPixelSpacingMetadataProvider, clamp, uuidv4, getMinMax, clonePoint3, hasOwn, getRuntimeId, getVOIRangeFromWindowLevel, isOpposite, getViewportModality, windowLevel, convertToGrayscale, convertColorArrayToRgbString, getClosestImageId, getSpacingInNormalDirection, getTargetVolumeAndSpacingInNormalDir, getVolumeActorCorners, indexWithinDimensions, getVolumeViewportsContainingSameVolumes, getViewportsWithVolumeId, transformWorldToIndex, transformIndexToWorld, loadImageToCanvas, renderToCanvasCPU, renderToCanvasGPU, worldToImageCoords, imageToWorldCoords, getVolumeSliceRangeInfo, getVolumeViewportScrollInfo, getSliceRange, snapFocalPointToSlice, getImageSliceDataForVolumeViewport, isImageActor, isPTPrescaledWithSUV, actorIsA, getViewportsWithImageURI, getClosestStackImageIndexForPoint, getCurrentVolumeViewportSlice, calculateViewportsSpatialRegistration, spatialRegistrationMetadataProvider, getViewportImageCornersInWorld, hasNaNValues, applyPreset, deepMerge, PointsManager, getScalingParameters, colormap, getImageLegacy, ProgressiveIterator, decimate, imageRetrieveMetadataProvider, genericViewportDataSetMetadataProvider, transferFunctionUtils, updateVTKImageDataWithCornerstoneImage, sortImageIdsAndGetSpacing, makeVolumeMetadata, isValidVolume, genericMetadataProvider, isVideoTransferSyntax, HistoryMemo, generateVolumePropsFromImageIds, getBufferConfiguration, VoxelManager, RLEVoxelMap, convertStackToVolumeViewport, convertVolumeToStackViewport, roundNumber, roundToPrecision, getViewportImageIds, getRandomSampleFromArray, getVolumeId, color, hasFloatScalingParameters, getDynamicVolumeInfo, autoLoad, scaleArray, deepClone, splitImageIdsBy4DTags, handleMultiframe4D, generateFrameImageId, pointInShapeCallback, ECGUtilities, VideoUtilities, WSIUtilities, deepEqual, jumpToSlice, scroll, clip, transformWorldToIndexContinuous, createSubVolume, getAcquisitionPlaneOrientation, getVolumeDirectionVectors, getVolumeViewReferenceId, calculateSpacingBetweenImageIds, getImageDataMetadata, buildMetadata, calculateNeighborhoodStats, asArray, viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, getNormalizedAspectRatio, };
+export { FrameRange, eventListener, csUtils as invertRgbTransferFunction, createSigmoidRGBTransferFunction, getVoiFromSigmoidRGBTransferFunction, createLinearRGBTransferFunction, scaleRgbTransferFunction, triggerEvent, imageIdToURI, fnv1aHash, calibratedPixelSpacingMetadataProvider, clamp, uuidv4, getMinMax, clonePoint3, hasOwn, getRuntimeId, getVOIRangeFromWindowLevel, isOpposite, getViewportModality, getScalingDescriptor, resolveGenericViewportVolumeId, windowLevel, convertToGrayscale, convertColorArrayToRgbString, getClosestImageId, getSpacingInNormalDirection, getTargetVolumeAndSpacingInNormalDir, getVolumeActorCorners, indexWithinDimensions, getVolumeViewportsContainingSameVolumes, getViewportsWithVolumeId, transformWorldToIndex, transformIndexToWorld, loadImageToCanvas, renderToCanvasCPU, renderToCanvasGPU, worldToImageCoords, imageToWorldCoords, getVolumeSliceRangeInfo, getVolumeViewportScrollInfo, getSliceRange, snapFocalPointToSlice, getImageSliceDataForVolumeViewport, isImageActor, isPTPrescaledWithSUV, actorIsA, getViewportsWithImageURI, getClosestStackImageIndexForPoint, getCurrentVolumeViewportSlice, calculateViewportsSpatialRegistration, spatialRegistrationMetadataProvider, getViewportImageCornersInWorld, hasNaNValues, applyPreset, deepMerge, PointsManager, getScalingParameters, colormap, getImageLegacy, ProgressiveIterator, decimate, imageRetrieveMetadataProvider, genericViewportDisplaySetMetadataProvider, transferFunctionUtils, updateVTKImageDataWithCornerstoneImage, sortImageIdsAndGetSpacing, makeVolumeMetadata, isValidVolume, genericMetadataProvider, isVideoTransferSyntax, HistoryMemo, generateVolumePropsFromImageIds, getBufferConfiguration, VoxelManager, RLEVoxelMap, convertStackToVolumeViewport, convertVolumeToStackViewport, roundNumber, roundToPrecision, getViewportImageIds, getRandomSampleFromArray, getVolumeId, color, hasFloatScalingParameters, getDynamicVolumeInfo, autoLoad, scaleArray, deepClone, splitImageIdsBy4DTags, handleMultiframe4D, generateFrameImageId, pointInShapeCallback, ECGUtilities, VideoUtilities, WSIUtilities, deepEqual, jumpToSlice, scroll, clip, transformWorldToIndexContinuous, createSubVolume, getAcquisitionPlaneOrientation, getVolumeDirectionVectors, getVolumeViewReferenceId, calculateSpacingBetweenImageIds, getImageDataMetadata, buildMetadata, calculateNeighborhoodStats, asArray, viewportSupportsImageSlices, viewportSupportsStackCalibration, viewportSupportsStackCompatibility, viewportSupportsVolumeActors, viewportSupportsVolumeCompatibility, viewportSupportsVolumeId, viewportSupportsVolumeURI, isGenericViewport, viewportSupportsDisplaySetPresentation, getViewportContentMode, viewportIsInVolumeMode, viewportIsInStackMode, getNormalizedAspectRatio, };

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

@@ -1,3 +1,3 @@
 import type { IImage } from '../types';
-declare const isPTPrescaledWithSUV: (image: IImage) => number;
+declare const isPTPrescaledWithSUV: (image: IImage) => boolean;
 export default isPTPrescaledWithSUV;

package/dist/esm/utilities/isPTPrescaledWithSUV.js

@@ -1,4 +1,4 @@
 const isPTPrescaledWithSUV = (image) => {
-    return image.preScale.scaled && image.preScale.scalingParameters.suvbw;
+    return Boolean(image.preScale?.scaled && image.preScale?.scalingParameters?.suvbw);
 };
 export default isPTPrescaledWithSUV;

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

@@ -0,0 +1,2 @@
+import type { IViewport } from '../types/IViewport';
+export declare function resolveGenericViewportVolumeId(viewport: IViewport, targetId?: string): string | undefined;

package/dist/esm/utilities/resolveGenericViewportVolumeId.js

@@ -0,0 +1,12 @@
+import { getVolumeId } from './getVolumeId';
+export function resolveGenericViewportVolumeId(viewport, targetId) {
+    const genericViewport = viewport;
+    const actors = genericViewport.getActors?.() ?? [];
+    const matchedActor = targetId
+        ? (actors.find((actor) => actor.referencedId === targetId) ??
+            actors.find((actor) => actor.referencedId?.endsWith(`:${targetId}`)))
+        : undefined;
+    return (matchedActor?.referencedId ??
+        (targetId ? getVolumeId(targetId) : undefined) ??
+        genericViewport.getDefaultActor?.()?.referencedId);
+}

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

@@ -1,4 +1,4 @@
-import type { ActorEntry, IStackViewport, IViewport, IVolumeViewport } from '../types';
+import type { ActorEntry, IGenericViewport, IStackViewport, IViewport, IVolumeViewport, ViewportContentMode, VOIRange } from '../types';
 export type ImageSliceViewport = IViewport & Pick<IStackViewport, 'getCurrentImageId' | 'getCurrentImageIdIndex' | 'getImageIds' | 'hasImageURI'>;
 export type StackCompatibilityViewport = ImageSliceViewport & Pick<IStackViewport, 'setStack'>;
 export type StackCalibrationViewport = ImageSliceViewport & {
@@ -17,3 +17,12 @@ export declare function viewportSupportsVolumeCompatibility(viewport: unknown):
 export declare function viewportSupportsVolumeId(viewport: unknown): viewport is VolumeIdViewport;
 export declare function viewportSupportsVolumeURI(viewport: unknown): viewport is VolumeURIViewport;
 export declare function viewportSupportsVolumeActors(viewport: unknown): viewport is VolumeActorViewport;
+export declare function isGenericViewport(viewport: unknown): viewport is IGenericViewport;
+export type DisplaySetPresentationViewport = IGenericViewport & {
+    getSourceDataId(): string | undefined;
+    getDefaultVOIRange(dataId?: string): VOIRange | undefined;
+};
+export declare function viewportSupportsDisplaySetPresentation(viewport: unknown): viewport is DisplaySetPresentationViewport;
+export declare function getViewportContentMode(viewport: unknown): ViewportContentMode | undefined;
+export declare function viewportIsInVolumeMode(viewport: unknown): boolean;
+export declare function viewportIsInStackMode(viewport: unknown): boolean;

package/dist/esm/utilities/viewportCapabilities.js

@@ -30,3 +30,25 @@ export function viewportSupportsVolumeActors(viewport) {
     return (viewportSupportsVolumeId(viewport) &&
         viewportHasMethod(viewport, 'getActors'));
 }
+export function isGenericViewport(viewport) {
+    return (viewportHasMethod(viewport, 'setDisplaySets') &&
+        viewportHasMethod(viewport, 'setDisplaySetPresentation') &&
+        viewportHasMethod(viewport, 'setViewState'));
+}
+export function viewportSupportsDisplaySetPresentation(viewport) {
+    return (isGenericViewport(viewport) &&
+        viewportHasMethod(viewport, 'getSourceDataId') &&
+        viewportHasMethod(viewport, 'getDefaultVOIRange'));
+}
+export function getViewportContentMode(viewport) {
+    return viewportHasMethod(viewport, 'getCurrentMode')
+        ? viewport.getCurrentMode()
+        : undefined;
+}
+export function viewportIsInVolumeMode(viewport) {
+    const mode = getViewportContentMode(viewport);
+    return mode === 'volume' || mode === 'volume3d';
+}
+export function viewportIsInStackMode(viewport) {
+    return getViewportContentMode(viewport) === 'stack';
+}

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.0.16";
+export declare const version = "5.1.1";

package/dist/esm/version.js

@@ -1 +1 @@
-export const version = '5.0.16';
+export const version = '5.1.1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "5.0.16",
+  "version": "5.1.1",
   "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.16",
+    "@cornerstonejs/utils": "5.1.1",
     "@kitware/vtk.js": "35.5.3",
     "comlink": "4.4.2",
     "gl-matrix": "3.4.3",
     "loglevel": "1.9.2"
   },
   "devDependencies": {
-    "@cornerstonejs/metadata": "5.0.16"
+    "@cornerstonejs/metadata": "5.1.1"
   },
   "peerDependencies": {
-    "@cornerstonejs/metadata": "5.0.16",
-    "@cornerstonejs/utils": "5.0.16"
+    "@cornerstonejs/metadata": "5.1.1",
+    "@cornerstonejs/utils": "5.1.1"
   },
   "contributors": [
     {
@@ -108,5 +108,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "902d3aeef74489bbdd2b1f525823effbf2bbfeb9"
+  "gitHead": "6db7e14877e923047e0c7a11467307cad64210e5"
 }

package/dist/esm/RenderingEngine/GenericViewport/genericViewportDataSetAccess.d.ts

@@ -1,35 +0,0 @@
-import type { IImage } from '../../types';
-import type { WSIClientLike } from '../../utilities/WSIUtilities';
-import type { ViewportDataReference } from './ViewportArchitectureTypes';
-export interface GenericViewportImageDataSet {
-    imageIds: string[];
-    [key: string]: unknown;
-}
-export interface GenericViewportPlanarDataSet extends GenericViewportImageDataSet {
-    kind?: 'planar';
-    initialImageIdIndex?: number;
-    volumeId?: string;
-    image?: IImage;
-    reference?: ViewportDataReference;
-}
-export interface GenericViewportSourceAliasDataSet {
-    kind: 'video' | 'ecg';
-    sourceDataId: string;
-}
-export interface GenericViewportWSIDataSet {
-    kind: 'wsi';
-    imageIds: string[];
-    options: {
-        miniNavigationOverlay?: boolean;
-        webClient: WSIClientLike;
-    };
-}
-export type GenericViewportRegisteredData = string | string[] | GenericViewportPlanarDataSet | GenericViewportSourceAliasDataSet | GenericViewportWSIDataSet;
-export declare function getGenericViewportRegisteredData(dataId: string): GenericViewportRegisteredData | undefined;
-export declare function getGenericViewportImageDataSet(dataId: string): GenericViewportImageDataSet | undefined;
-export declare function getGenericViewportPlanarDataSet(dataId: string): GenericViewportPlanarDataSet | undefined;
-export declare function getGenericViewportWSIDataSet(dataId: string): GenericViewportWSIDataSet | undefined;
-export declare function getGenericViewportSourceDataId(dataId: string): string;
-export declare function isGenericViewportImageDataSet(value: unknown): value is GenericViewportImageDataSet;
-export declare function isGenericViewportWSIDataSet(value: unknown): value is GenericViewportWSIDataSet;
-export declare function isGenericViewportSourceAliasDataSet(value: unknown): value is GenericViewportSourceAliasDataSet;

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

@@ -1,8 +0,0 @@
-declare const genericViewportDataSetMetadataProvider: {
-    VIEWPORT_V2_DATA_SET: string;
-    add(dataId: string, dataSet: unknown): void;
-    get(type: string, dataId: string): unknown;
-    remove(dataId: string): void;
-    clear(): void;
-};
-export default genericViewportDataSetMetadataProvider;

package/dist/esm/utilities/genericViewportDataSetMetadataProvider.js

@@ -1,23 +0,0 @@
-import { addProvider } from '../metaData';
-const VIEWPORT_V2_DATA_SET = 'genericViewportDataSet';
-let state = {};
-const genericViewportDataSetMetadataProvider = {
-    VIEWPORT_V2_DATA_SET,
-    add(dataId, dataSet) {
-        state[dataId] = dataSet;
-    },
-    get(type, dataId) {
-        if (type !== VIEWPORT_V2_DATA_SET) {
-            return;
-        }
-        return state[dataId];
-    },
-    remove(dataId) {
-        delete state[dataId];
-    },
-    clear() {
-        state = {};
-    },
-};
-addProvider(genericViewportDataSetMetadataProvider.get);
-export default genericViewportDataSetMetadataProvider;