@cornerstonejs/dicom-image-loader 2.0.0-beta.7 → 2.0.0

package/dist/esm/imageLoader/wadors/metaData/getValue.d.ts

@@ -0,0 +1,3 @@
+import type { WADORSMetaDataElement } from '../../../types';
+declare function getValue<ReturnType = unknown>(element: WADORSMetaDataElement, index?: number, defaultValue?: ReturnType): ReturnType;
+export default getValue;

package/dist/esm/imageLoader/wadors/metaData/getValue.js

@@ -0,0 +1,14 @@
+function getValue(element, index, defaultValue) {
+    index = index || 0;
+    if (!element) {
+        return defaultValue;
+    }
+    if (!element.Value) {
+        return defaultValue;
+    }
+    if (Array.isArray(element.Value) && element.Value.length <= index) {
+        return defaultValue;
+    }
+    return element.Value[index];
+}
+export default getValue;

package/dist/esm/imageLoader/wadors/metaData/index.d.ts

@@ -0,0 +1,7 @@
+export { default as getNumberString } from './getNumberString';
+export { default as getNumberValue } from './getNumberValue';
+export { default as getNumberValues } from './getNumberValues';
+export { default as metaDataProvider } from './metaDataProvider';
+export { default as getValue } from './getValue';
+export { getFirstNumberValue } from './getFirstNumberValue';
+export { getUSEnhancedRegions } from './USHelpers';

package/dist/esm/imageLoader/wadors/metaData/index.js

@@ -0,0 +1,7 @@
+export { default as getNumberString } from './getNumberString';
+export { default as getNumberValue } from './getNumberValue';
+export { default as getNumberValues } from './getNumberValues';
+export { default as metaDataProvider } from './metaDataProvider';
+export { default as getValue } from './getValue';
+export { getFirstNumberValue } from './getFirstNumberValue';
+export { getUSEnhancedRegions } from './USHelpers';

package/dist/esm/imageLoader/wadors/metaData/metaDataProvider.d.ts

@@ -0,0 +1,14 @@
+declare function metaDataProvider(type: any, imageId: any): {};
+export declare function getImageUrlModule(imageId: any, metaData: any): {
+    isVideo: string | false;
+    rendered: any;
+    thumbnail: any;
+};
+export declare function getCineModule(imageId: any, metaData: any): {
+    cineRate: string;
+    numberOfFrames: number;
+};
+export declare function getTransferSyntax(imageId: any, metaData: any): {
+    transferSyntaxUID: string;
+};
+export default metaDataProvider;

package/dist/esm/imageLoader/wadors/metaData/metaDataProvider.js

@@ -0,0 +1,277 @@
+import * as dicomParser from 'dicom-parser';
+import { Enums, utilities } from '@cornerstonejs/core';
+import getNumberValues from './getNumberValues';
+import getNumberValue from './getNumberValue';
+import getOverlayPlaneModule from './getOverlayPlaneModule';
+import metaDataManager, { retrieveMultiframeMetadataImageId, } from '../metaDataManager';
+import getValue from './getValue';
+import { getMultiframeInformation, getFrameInformation, } from '../combineFrameInstance';
+import { extractOrientationFromMetadata, extractPositionFromMetadata, } from './extractPositioningFromMetadata';
+import { getImageTypeSubItemFromMetadata } from './NMHelpers';
+import isNMReconstructable from '../../isNMReconstructable';
+import { getInstanceModule, instanceModuleNames, } from '../../getInstanceModule';
+import { getUSEnhancedRegions } from './USHelpers';
+function metaDataProvider(type, imageId) {
+    const { MetadataModules } = Enums;
+    if (type === MetadataModules.MULTIFRAME) {
+        const { metadata, frame } = retrieveMultiframeMetadataImageId(imageId);
+        if (!metadata) {
+            return;
+        }
+        const { PerFrameFunctionalGroupsSequence, SharedFunctionalGroupsSequence, NumberOfFrames, } = getMultiframeInformation(metadata);
+        if (PerFrameFunctionalGroupsSequence || NumberOfFrames > 1) {
+            const { shared, perFrame } = getFrameInformation(PerFrameFunctionalGroupsSequence, SharedFunctionalGroupsSequence, frame);
+            return {
+                NumberOfFrames,
+                PerFrameFunctionalInformation: perFrame,
+                SharedFunctionalInformation: shared,
+            };
+        }
+        return {
+            NumberOfFrames,
+        };
+    }
+    const metaData = metaDataManager.get(imageId);
+    if (!metaData) {
+        return;
+    }
+    if (type === MetadataModules.GENERAL_STUDY) {
+        return {
+            studyDescription: getValue(metaData['00081030']),
+            studyDate: dicomParser.parseDA(getValue(metaData['00080020'])),
+            studyTime: dicomParser.parseTM(getValue(metaData['00080030'], 0, '')),
+            accessionNumber: getValue(metaData['00080050']),
+        };
+    }
+    if (type === MetadataModules.GENERAL_SERIES) {
+        return {
+            modality: getValue(metaData['00080060']),
+            seriesInstanceUID: getValue(metaData['0020000E']),
+            seriesNumber: getNumberValue(metaData['00200011']),
+            studyInstanceUID: getValue(metaData['0020000D']),
+            seriesDate: dicomParser.parseDA(getValue(metaData['00080021'])),
+            seriesTime: dicomParser.parseTM(getValue(metaData['00080031'], 0, '')),
+            acquisitionDate: dicomParser.parseDA(getValue(metaData['00080022'])),
+            acquisitionTime: dicomParser.parseTM(getValue(metaData['00080032'], 0, '')),
+        };
+    }
+    if (type === MetadataModules.GENERAL_IMAGE) {
+        return {
+            sopInstanceUID: getValue(metaData['00080018']),
+            instanceNumber: getNumberValue(metaData['00200013']),
+            lossyImageCompression: getValue(metaData['00282110']),
+            lossyImageCompressionRatio: getNumberValue(metaData['00282112']),
+            lossyImageCompressionMethod: getValue(metaData['00282114']),
+        };
+    }
+    if (type === MetadataModules.PATIENT) {
+        return {
+            patientID: getValue(metaData['00100020']),
+            patientName: getValue(metaData['00100010']),
+        };
+    }
+    if (type === MetadataModules.PATIENT_STUDY) {
+        return {
+            patientAge: getNumberValue(metaData['00101010']),
+            patientSize: getNumberValue(metaData['00101020']),
+            patientSex: getValue(metaData['00100040']),
+            patientWeight: getNumberValue(metaData['00101030']),
+        };
+    }
+    if (type === MetadataModules.NM_MULTIFRAME_GEOMETRY) {
+        const modality = getValue(metaData['00080060']);
+        const imageSubType = getImageTypeSubItemFromMetadata(metaData, 2);
+        return {
+            modality,
+            imageType: getValue(metaData['00080008']),
+            imageSubType,
+            imageOrientationPatient: extractOrientationFromMetadata(metaData),
+            imagePositionPatient: extractPositionFromMetadata(metaData),
+            sliceThickness: getNumberValue(metaData['00180050']),
+            spacingBetweenSlices: getNumberValue(metaData['00180088']),
+            pixelSpacing: getNumberValues(metaData['00280030'], 2),
+            numberOfFrames: getNumberValue(metaData['00280008']),
+            isNMReconstructable: isNMReconstructable(imageSubType) && modality.includes('NM'),
+        };
+    }
+    if (type === MetadataModules.IMAGE_PLANE) {
+        let imageOrientationPatient = extractOrientationFromMetadata(metaData);
+        let imagePositionPatient = extractPositionFromMetadata(metaData);
+        const pixelSpacing = getNumberValues(metaData['00280030'], 2);
+        let columnPixelSpacing = null;
+        let rowPixelSpacing = null;
+        let rowCosines = null;
+        let columnCosines = null;
+        let usingDefaultValues = false;
+        if (pixelSpacing) {
+            rowPixelSpacing = pixelSpacing[0];
+            columnPixelSpacing = pixelSpacing[1];
+        }
+        else {
+            usingDefaultValues = true;
+            rowPixelSpacing = 1;
+            columnPixelSpacing = 1;
+        }
+        if (imageOrientationPatient) {
+            rowCosines = [
+                parseFloat(imageOrientationPatient[0]),
+                parseFloat(imageOrientationPatient[1]),
+                parseFloat(imageOrientationPatient[2]),
+            ];
+            columnCosines = [
+                parseFloat(imageOrientationPatient[3]),
+                parseFloat(imageOrientationPatient[4]),
+                parseFloat(imageOrientationPatient[5]),
+            ];
+        }
+        else {
+            rowCosines = [0, 1, 0];
+            columnCosines = [0, 0, -1];
+            usingDefaultValues = true;
+            imageOrientationPatient = [...rowCosines, ...columnCosines];
+        }
+        if (!imagePositionPatient) {
+            imagePositionPatient = [0, 0, 0];
+            usingDefaultValues = true;
+        }
+        return {
+            frameOfReferenceUID: getValue(metaData['00200052']),
+            rows: getNumberValue(metaData['00280010']),
+            columns: getNumberValue(metaData['00280011']),
+            imageOrientationPatient,
+            rowCosines,
+            columnCosines,
+            imagePositionPatient,
+            sliceThickness: getNumberValue(metaData['00180050']),
+            sliceLocation: getNumberValue(metaData['00201041']),
+            pixelSpacing,
+            rowPixelSpacing,
+            columnPixelSpacing,
+            usingDefaultValues,
+        };
+    }
+    if (type === MetadataModules.ULTRASOUND_ENHANCED_REGION) {
+        return getUSEnhancedRegions(metaData);
+    }
+    if (type === MetadataModules.CALIBRATION) {
+        const modality = getValue(metaData['00080060']);
+        if (modality === 'US') {
+            const enhancedRegion = getUSEnhancedRegions(metaData);
+            return {
+                sequenceOfUltrasoundRegions: enhancedRegion,
+            };
+        }
+    }
+    if (type === MetadataModules.IMAGE_URL) {
+        return getImageUrlModule(imageId, metaData);
+    }
+    if (type === MetadataModules.CINE) {
+        return getCineModule(imageId, metaData);
+    }
+    if (type === MetadataModules.IMAGE_PIXEL) {
+        return {
+            samplesPerPixel: getNumberValue(metaData['00280002']),
+            photometricInterpretation: getValue(metaData['00280004']),
+            rows: getNumberValue(metaData['00280010']),
+            columns: getNumberValue(metaData['00280011']),
+            bitsAllocated: getNumberValue(metaData['00280100']),
+            bitsStored: getNumberValue(metaData['00280101']),
+            highBit: getValue(metaData['00280102']),
+            pixelRepresentation: getNumberValue(metaData['00280103']),
+            planarConfiguration: getNumberValue(metaData['00280006']),
+            pixelAspectRatio: getValue(metaData['00280034']),
+            smallestPixelValue: getNumberValue(metaData['00280106']),
+            largestPixelValue: getNumberValue(metaData['00280107']),
+            redPaletteColorLookupTableDescriptor: getNumberValues(metaData['00281101']),
+            greenPaletteColorLookupTableDescriptor: getNumberValues(metaData['00281102']),
+            bluePaletteColorLookupTableDescriptor: getNumberValues(metaData['00281103']),
+            redPaletteColorLookupTableData: getNumberValues(metaData['00281201']),
+            greenPaletteColorLookupTableData: getNumberValues(metaData['00281202']),
+            bluePaletteColorLookupTableData: getNumberValues(metaData['00281203']),
+        };
+    }
+    if (type === MetadataModules.VOI_LUT) {
+        return {
+            windowCenter: getNumberValues(metaData['00281050'], 1),
+            windowWidth: getNumberValues(metaData['00281051'], 1),
+        };
+    }
+    if (type === MetadataModules.MODALITY_LUT) {
+        return {
+            rescaleIntercept: getNumberValue(metaData['00281052']),
+            rescaleSlope: getNumberValue(metaData['00281053']),
+            rescaleType: getValue(metaData['00281054']),
+        };
+    }
+    if (type === MetadataModules.SOP_COMMON) {
+        return {
+            sopClassUID: getValue(metaData['00080016']),
+            sopInstanceUID: getValue(metaData['00080018']),
+        };
+    }
+    if (type === MetadataModules.PET_ISOTOPE) {
+        const radiopharmaceuticalInfo = getValue(metaData['00540016']);
+        if (radiopharmaceuticalInfo === undefined) {
+            return;
+        }
+        return {
+            radiopharmaceuticalInfo: {
+                radiopharmaceuticalStartTime: dicomParser.parseTM(getValue(radiopharmaceuticalInfo['00181072'], 0, '')),
+                radiopharmaceuticalStartDateTime: getValue(radiopharmaceuticalInfo['00181078'], 0, ''),
+                radionuclideTotalDose: getNumberValue(radiopharmaceuticalInfo['00181074']),
+                radionuclideHalfLife: getNumberValue(radiopharmaceuticalInfo['00181075']),
+            },
+        };
+    }
+    if (type === MetadataModules.OVERLAY_PLANE) {
+        return getOverlayPlaneModule(metaData);
+    }
+    if (type === 'transferSyntax') {
+        return getTransferSyntax(imageId, metaData);
+    }
+    if (type === MetadataModules.PET_SERIES) {
+        return {
+            correctedImage: getValue(metaData['00280051']),
+            units: getValue(metaData['00541001']),
+            decayCorrection: getValue(metaData['00541102']),
+        };
+    }
+    if (type === MetadataModules.PET_IMAGE) {
+        return {
+            frameReferenceTime: getNumberValue(metaData['00541300']),
+            actualFrameDuration: getNumberValue(metaData['00181242']),
+        };
+    }
+    if (type === 'instance') {
+        return getInstanceModule(imageId, metaDataProvider, instanceModuleNames);
+    }
+}
+export function getImageUrlModule(imageId, metaData) {
+    const { transferSyntaxUID } = getTransferSyntax(imageId, metaData);
+    const isVideo = utilities.isVideoTransferSyntax(transferSyntaxUID);
+    const imageUrl = imageId.substring(7);
+    const thumbnail = imageUrl.replace('/frames/', '/thumbnail/');
+    let rendered = imageUrl.replace('/frames/', '/rendered/');
+    if (isVideo) {
+        rendered = rendered.replace('/rendered/1', '/rendered');
+    }
+    return {
+        isVideo,
+        rendered,
+        thumbnail,
+    };
+}
+export function getCineModule(imageId, metaData) {
+    const cineRate = getValue(metaData['00180040']);
+    return {
+        cineRate,
+        numberOfFrames: getNumberValue(metaData['00280008']),
+    };
+}
+export function getTransferSyntax(imageId, metaData) {
+    return {
+        transferSyntaxUID: getValue(metaData['00020010']) ||
+            getValue(metaData['00083002']),
+    };
+}
+export default metaDataProvider;

package/dist/esm/imageLoader/wadors/metaDataManager.d.ts

@@ -0,0 +1,19 @@
+import type { WADORSMetaData } from '../../types';
+declare let metadataByImageURI: any[];
+declare function retrieveMultiframeMetadataImageId(imageId: any): {
+    metadata: any;
+    frame: number;
+};
+declare function isMultiframe(metadata: any): boolean;
+declare function add(imageId: string, metadata: WADORSMetaData): void;
+declare function get(imageId: string): WADORSMetaData;
+declare function remove(imageId: any): void;
+declare function purge(): void;
+export { metadataByImageURI, isMultiframe, retrieveMultiframeMetadataImageId };
+declare const _default: {
+    add: typeof add;
+    get: typeof get;
+    remove: typeof remove;
+    purge: typeof purge;
+};
+export default _default;

package/dist/esm/imageLoader/wadors/metaDataManager.js

@@ -0,0 +1,68 @@
+import imageIdToURI from '../imageIdToURI';
+import { combineFrameInstance } from './combineFrameInstance';
+let metadataByImageURI = [];
+let multiframeMetadataByImageURI = {};
+import getValue from './metaData/getValue';
+function _retrieveMultiframeMetadataImageURI(imageURI) {
+    const lastSlashIdx = imageURI.indexOf('/frames/') + 8;
+    const imageIdFrameless = imageURI.slice(0, lastSlashIdx);
+    const frame = parseInt(imageURI.slice(lastSlashIdx), 10);
+    const metadata = metadataByImageURI[`${imageIdFrameless}1`];
+    return {
+        metadata,
+        frame,
+    };
+}
+function retrieveMultiframeMetadataImageId(imageId) {
+    const imageURI = imageIdToURI(imageId);
+    return _retrieveMultiframeMetadataImageURI(imageURI);
+}
+function isMultiframe(metadata) {
+    const numberOfFrames = getValue(metadata['00280008']);
+    return numberOfFrames && numberOfFrames > 1;
+}
+function add(imageId, metadata) {
+    const imageURI = imageIdToURI(imageId);
+    Object.defineProperty(metadata, 'isMultiframe', {
+        value: isMultiframe(metadata),
+        enumerable: false,
+    });
+    metadataByImageURI[imageURI] = metadata;
+}
+function get(imageId) {
+    const imageURI = imageIdToURI(imageId);
+    const metadata = metadataByImageURI[imageURI];
+    if (metadata && !metadata?.isMultiframe) {
+        return metadata;
+    }
+    const cachedMetadata = multiframeMetadataByImageURI[imageURI];
+    if (cachedMetadata) {
+        return cachedMetadata;
+    }
+    const retrievedMetadata = _retrieveMultiframeMetadataImageURI(imageURI);
+    if (!retrievedMetadata || !retrievedMetadata.metadata) {
+        return;
+    }
+    const { metadata: firstFrameMetadata, frame } = retrievedMetadata;
+    if (firstFrameMetadata) {
+        const combined = combineFrameInstance(frame, firstFrameMetadata);
+        multiframeMetadataByImageURI[imageURI] = combined;
+        return combined;
+    }
+}
+function remove(imageId) {
+    const imageURI = imageIdToURI(imageId);
+    metadataByImageURI[imageURI] = undefined;
+    multiframeMetadataByImageURI[imageURI] = undefined;
+}
+function purge() {
+    metadataByImageURI = [];
+    multiframeMetadataByImageURI = {};
+}
+export { metadataByImageURI, isMultiframe, retrieveMultiframeMetadataImageId };
+export default {
+    add,
+    get,
+    remove,
+    purge,
+};

package/dist/esm/imageLoader/wadors/register.d.ts

@@ -0,0 +1 @@
+export default function (): void;

package/dist/esm/imageLoader/wadors/register.js

@@ -0,0 +1,7 @@
+import { metaData, registerImageLoader } from '@cornerstonejs/core';
+import loadImage from './loadImage';
+import { metaDataProvider } from './metaData';
+export default function () {
+    registerImageLoader('wadors', loadImage);
+    metaData.addProvider(metaDataProvider);
+}

package/dist/esm/imageLoader/wadouri/combineFrameInstanceDataset.d.ts

@@ -0,0 +1,22 @@
+declare function getDirectFrameInformation(dataSet: any, frame: any): {
+    NumberOfFrames: any;
+    PerFrameFunctionalInformation: {};
+    SharedFunctionalInformation: {};
+} | {
+    NumberOfFrames: any;
+    PerFrameFunctionalInformation?: undefined;
+    SharedFunctionalInformation?: undefined;
+};
+declare function getFrameInformation(PerFrameFunctionalGroupsSequence: any, SharedFunctionalGroupsSequence: any, frameNumber: any): {
+    shared: {};
+    perFrame: {};
+};
+declare function getMultiframeInformation(dataSet: any): {
+    NumberOfFrames: any;
+    PerFrameFunctionalGroupsSequence: any;
+    SharedFunctionalGroupsSequence: any;
+    otherElements: any;
+    otherAttributtes: any;
+};
+declare function combineFrameInstanceDataset(frameNumber: any, dataSet: any): any;
+export { combineFrameInstanceDataset, getMultiframeInformation, getFrameInformation, getDirectFrameInformation, };

package/dist/esm/imageLoader/wadouri/combineFrameInstanceDataset.js

@@ -0,0 +1,69 @@
+function getDirectFrameInformation(dataSet, frame) {
+    if (!dataSet) {
+        return;
+    }
+    const { NumberOfFrames, PerFrameFunctionalGroupsSequence, SharedFunctionalGroupsSequence, } = getMultiframeInformation(dataSet);
+    if (PerFrameFunctionalGroupsSequence || NumberOfFrames > 1) {
+        const { shared, perFrame } = getFrameInformation(PerFrameFunctionalGroupsSequence, SharedFunctionalGroupsSequence, frame);
+        return {
+            NumberOfFrames,
+            PerFrameFunctionalInformation: perFrame,
+            SharedFunctionalInformation: shared,
+        };
+    }
+    return {
+        NumberOfFrames,
+    };
+}
+function getFrameInformation(PerFrameFunctionalGroupsSequence, SharedFunctionalGroupsSequence, frameNumber) {
+    const shared = {};
+    (SharedFunctionalGroupsSequence
+        ? Object.values(SharedFunctionalGroupsSequence.items[0].dataSet.elements)
+        : [])
+        .map((it) => (shared[it.tag] = it));
+    const perFrame = {};
+    (PerFrameFunctionalGroupsSequence
+        ? Object.values(PerFrameFunctionalGroupsSequence.items[frameNumber - 1].dataSet.elements)
+        : [])
+        .map((it) => (perFrame[it.tag] = it));
+    return {
+        shared,
+        perFrame,
+    };
+}
+function getMultiframeInformation(dataSet) {
+    if (!dataSet) {
+        return;
+    }
+    const { elements, ...otherAttributtes } = dataSet;
+    const { x52009230: PerFrameFunctionalGroupsSequence, x52009229: SharedFunctionalGroupsSequence, ...otherElements } = elements;
+    const NumberOfFrames = dataSet.intString('x00280008');
+    return {
+        NumberOfFrames,
+        PerFrameFunctionalGroupsSequence,
+        SharedFunctionalGroupsSequence,
+        otherElements,
+        otherAttributtes,
+    };
+}
+function combineFrameInstanceDataset(frameNumber, dataSet) {
+    if (!dataSet) {
+        return;
+    }
+    const { NumberOfFrames, PerFrameFunctionalGroupsSequence, SharedFunctionalGroupsSequence, otherElements, } = getMultiframeInformation(dataSet);
+    if (PerFrameFunctionalGroupsSequence || NumberOfFrames > 1) {
+        const { shared, perFrame } = getFrameInformation(PerFrameFunctionalGroupsSequence, SharedFunctionalGroupsSequence, frameNumber);
+        const newElements = {
+            elements: {
+                ...otherElements,
+                ...shared,
+                ...perFrame,
+            },
+        };
+        const clonedDataset = Object.create(dataSet);
+        const newDataset = Object.assign(clonedDataset, newElements);
+        return newDataset;
+    }
+    return dataSet;
+}
+export { combineFrameInstanceDataset, getMultiframeInformation, getFrameInformation, getDirectFrameInformation, };

package/dist/esm/imageLoader/wadouri/dataSetCacheManager.d.ts

@@ -0,0 +1,28 @@
+import type { DataSet } from 'dicom-parser';
+import type { LoadRequestFunction, DICOMLoaderDataSetWithFetchMore } from '../../types';
+import { loadedDataSets } from './loadedDataSets';
+export interface CornerstoneWadoLoaderCacheManagerInfoResponse {
+    cacheSizeInBytes: number;
+    numberOfDataSetsCached: number;
+}
+export interface CornerstoneWadoLoaderCachedPromise extends Promise<DataSet | DICOMLoaderDataSetWithFetchMore> {
+    cacheCount?: number;
+}
+declare function isLoaded(uri: string): boolean;
+declare function get(uri: string): DataSet;
+declare function update(uri: string, dataSet: DataSet): void;
+declare function load(uri: string, loadRequest: LoadRequestFunction, imageId: string): CornerstoneWadoLoaderCachedPromise;
+declare function unload(uri: string): void;
+export declare function getInfo(): CornerstoneWadoLoaderCacheManagerInfoResponse;
+declare function purge(): void;
+declare const _default: {
+    isLoaded: typeof isLoaded;
+    load: typeof load;
+    unload: typeof unload;
+    getInfo: typeof getInfo;
+    purge: typeof purge;
+    get: typeof get;
+    update: typeof update;
+};
+export default _default;
+export { loadedDataSets };