larvitar 2.0.6 → 2.0.8

package/README.md

@@ -8,8 +8,8 @@
 
 ## Dicom Image Toolkit for CornerstoneJS
 
-### Current version: 2.0.6
-### Latest Published Release: 2.0.6
+### Current version: 2.0.8
+### Latest Published Release: 2.0.8
 
 This library provides common DICOM functionalities to be used in web-applications: it's wrapper that simplifies the use of cornerstone-js environment.
 

package/dist/imaging/imageRendering.d.ts

@@ -3,7 +3,7 @@
  *         rendering images in html canvas using cornerstone
  */
 import cornerstone from "cornerstone-core";
-import { Image, Series, StoreViewportOptions, Viewport } from "./types";
+import { Image, Series, StoreViewport, StoreViewportOptions, Viewport } from "./types";
 /**
  * Purge the cornestone internal cache
  * If seriesId is passed as argument only imageIds of the series are purged from internal cache
@@ -174,65 +174,5 @@ export declare const rotateImageRight: (elementId: string | HTMLElement) => void
  * @param {Object} defaultProps - Optional default properties
  * @return {Object} data - A data dictionary with parsed tags' values
  */
-declare const getSeriesData: (series: Series, defaultProps: StoreViewportOptions) => {
-    loading: number;
-    ready: boolean;
-    minSliceId: number;
-    maxSliceId: number;
-    sliceId: number;
-    pendingSliceId?: number | undefined;
-    minTimeId: number;
-    maxTimeId: number;
-    timeId: number;
-    timestamp: number;
-    timestamps: number[];
-    timeIds: number[];
-    rows: number;
-    cols: number;
-    spacing_x: number;
-    spacing_y: number;
-    thickness: number;
-    minPixelValue: number;
-    maxPixelValue: number;
-    isColor: boolean;
-    isMultiframe: boolean;
-    isTimeserie: boolean;
-    isPDF: boolean;
-    viewport: {
-        scale: number;
-        rotation: number;
-        translation: {
-            x: number;
-            y: number;
-        };
-        voi: {
-            windowCenter: number;
-            windowWidth: number;
-        };
-        rows: number;
-        cols: number;
-        spacing_x: number;
-        spacing_y: number;
-        thickness: number;
-    };
-    default: {
-        scale: number;
-        rotation: number;
-        translation: {
-            x: number;
-            y: number;
-        };
-        voi: {
-            windowCenter: number;
-            windowWidth: number;
-            invert: boolean;
-        };
-    };
-} & {
-    imageIndex: number;
-    imageId: string;
-    numberOfSlices: number;
-    numberOfTemporalPositions: number;
-    timeIndex?: number | undefined;
-};
+declare const getSeriesData: (series: Series, defaultProps: StoreViewportOptions) => StoreViewport;
 export {};

package/dist/imaging/imageStore.d.ts

@@ -2,6 +2,7 @@
  *  @desc This file provides functionalities
  *        for data config store.
  */
+import type { StoreViewport } from "./types.d";
 type StoreSeries = {
     imageIds: string[];
     progress: number;
@@ -15,12 +16,12 @@ type Store = {
         [seriesUID: string]: StoreSeries;
     };
     viewports: {
-        [key: string]: typeof DEFAULT_VIEWPORT;
+        [key: string]: StoreViewport;
     };
     [key: string]: any;
 };
 type SetPayload = ["errorLog" | "leftActiveTool" | "rightActiveTool", string] | [
-    "isColor" | "isMultiframe" | "isPDF" | "isTimeserie" | "ready",
+    ("isColor" | "isMultiframe" | "isPDF" | "waveform" | "isTimeserie" | "ready"),
     string,
     boolean
 ] | [
@@ -43,62 +44,6 @@ type SetPayload = ["errorLog" | "leftActiveTool" | "rightActiveTool", string] |
     number,
     boolean
 ];
-export declare const DEFAULT_VIEWPORT: {
-    loading: number;
-    ready: boolean;
-    minSliceId: number;
-    maxSliceId: number;
-    sliceId: number;
-    pendingSliceId?: number;
-    minTimeId: number;
-    maxTimeId: number;
-    timeId: number;
-    timestamp: number;
-    timestamps: number[];
-    timeIds: number[];
-    rows: number;
-    cols: number;
-    spacing_x: number;
-    spacing_y: number;
-    thickness: number;
-    minPixelValue: number;
-    maxPixelValue: number;
-    isColor: boolean;
-    isMultiframe: boolean;
-    isTimeserie: boolean;
-    isPDF: boolean;
-    viewport: {
-        scale: number;
-        rotation: number;
-        translation: {
-            x: number;
-            y: number;
-        };
-        voi: {
-            windowCenter: number;
-            windowWidth: number;
-        };
-        rows: number;
-        cols: number;
-        spacing_x: number;
-        spacing_y: number;
-        thickness: number;
-    };
-    default: {
-        scale: number;
-        rotation: number;
-        translation: {
-            x: number;
-            y: number;
-        };
-        voi: {
-            windowCenter: number;
-            windowWidth: number;
-            invert: boolean;
-        };
-    };
-};
-export type Viewport = typeof DEFAULT_VIEWPORT;
 export declare const set: (payload: SetPayload) => void;
 declare const _default: {
     initialize: () => void;
@@ -110,10 +55,11 @@ declare const _default: {
     setSliceId: (elementId: string, imageIndex: number) => void;
     setPendingSliceId: (elementId: string, imageIndex: number) => void;
     setMaxSliceId: (elementId: string, imageIndex: number) => void;
+    setTimeId: (elementId: string, timeIndex: number) => void;
     get: (props: string | string[]) => any;
     addStoreListener: (listener: (data: Store) => {}) => (data: Store) => {};
     removeStoreListener: () => undefined;
-    addViewportListener: (elementId: string, listener: (data: typeof DEFAULT_VIEWPORT) => {}) => void;
+    addViewportListener: (elementId: string, listener: (data: StoreViewport) => {}) => void;
     removeViewportListener: (elementId: string) => void;
     addSeriesListener: (seriesId: string, listener: (data: StoreSeries) => {}) => void;
     removeSeriesListener: (seriesId: string) => void;

package/dist/imaging/loaders/commonLoader.d.ts

@@ -13,7 +13,7 @@ import type { ImageObject, MetaData, Series } from "../types";
  * @param {number} sliceIndex - Optional custom index to overwrite slice index as default one
  */
 export declare const updateLarvitarManager: (imageObject: ImageObject, customId?: string, sliceIndex?: number) => {
-    [key: string]: Series | import("./nrrdLoader").NrrdSeries;
+    [key: string]: Series | import("../types").NrrdSeries;
 };
 /**
  * This function can be called in order to populate the Larvitar manager
@@ -24,7 +24,7 @@ export declare const updateLarvitarManager: (imageObject: ImageObject, customId?
  * @returns {manager} the Larvitar manager
  */
 export declare const populateLarvitarManager: (seriesId: string, seriesData: Series) => {
-    [key: string]: Series | import("./nrrdLoader").NrrdSeries;
+    [key: string]: Series | import("../types").NrrdSeries;
 };
 /**
  * Return the common data loader manager
@@ -33,7 +33,7 @@ export declare const populateLarvitarManager: (seriesId: string, seriesData: Ser
  * @returns {Object} the loader manager
  */
 export declare const getLarvitarManager: () => {
-    [key: string]: Series | import("./nrrdLoader").NrrdSeries;
+    [key: string]: Series | import("../types").NrrdSeries;
 };
 /**
  * Return the common image tracker
@@ -64,7 +64,7 @@ export declare const removeSeriesFromLarvitarManager: (seriesId: string) => void
  * @param {String} seriesId The Id of the series
  * @return {Object} larvitar manager data
  */
-export declare const getSeriesDataFromLarvitarManager: (seriesId: string) => Series | import("./nrrdLoader").NrrdSeries | null;
+export declare const getSeriesDataFromLarvitarManager: (seriesId: string) => Series | import("../types").NrrdSeries | null;
 /**
  * Compute and return image frame
  * @instance

package/dist/imaging/loaders/nrrdLoader.d.ts

@@ -3,56 +3,7 @@
  *        custom NRRD Loader
  */
 import { ImageLoader } from "cornerstone-core";
-import type { Instance, Volume, MetaData } from "../types";
-import { DataSet } from "dicom-parser";
-type NrrdInputVolume = {
-    header: {
-        sizes: number[];
-        "space directions": number[][];
-        "space origin": [number, number];
-        kinds: string[];
-        type: string;
-    };
-    data: Uint16Array;
-};
-export type NrrdSeries = {
-    currentImageIdIndex: number;
-    imageIds: string[];
-    instances: {
-        [key: string]: Instance;
-    };
-    instanceUIDs: {
-        [key: string]: string;
-    };
-    numberOfImages: number;
-    seriesDescription: string;
-    seriesUID: string;
-    customLoader: string;
-    nrrdHeader: NrrdHeader;
-    bytes: number;
-    dataSet?: DataSet;
-    metadata?: MetaData;
-    ecgData?: number[];
-};
-type NrrdHeader = {
-    volume: Volume;
-    intercept: number;
-    slope: number;
-    repr: string;
-    phase: string;
-    study_description: string;
-    series_description: string;
-    acquisition_date: string;
-    [imageId: string]: string | number | Volume | NrrdInstance;
-};
-type NrrdInstance = {
-    instanceUID: string;
-    seriesDescription: string;
-    seriesModality: string;
-    patientName: string;
-    bitsAllocated: number;
-    pixelRepresentation: string;
-};
+import type { NrrdHeader, NrrdInputVolume, NrrdSeries } from "../types";
 /**
  * Build the data structure for the provided image orientation
  * @instance
@@ -110,4 +61,3 @@ export declare const getNrrdSerieDimensions: () => {
     coronal: number[];
     sagittal: number[];
 };
-export {};

package/dist/larvitar.js

@@ -81931,18 +81931,24 @@ const storeViewportData = function (image, elementId, viewport, data) {
     (0, imageStore_1.set)(["maxPixelValue", elementId, image.maxPixelValue]);
     // slice id from 0 to n - 1
     (0, imageStore_1.set)(["minSliceId", elementId, 0]);
-    (0, imageStore_1.set)(["sliceId", elementId, data.imageIndex]);
+    if (data.imageIndex) {
+        (0, imageStore_1.set)(["sliceId", elementId, data.imageIndex]);
+    }
     const pendingSliceId = imageStore_1.default.get(["viewports", elementId, "pendingSliceId"]);
     if (data.imageIndex == pendingSliceId) {
         (0, imageStore_1.set)(["pendingSliceId", elementId, undefined]);
     }
-    (0, imageStore_1.set)(["maxSliceId", elementId, data.numberOfSlices - 1]);
+    if (data.numberOfSlices) {
+        (0, imageStore_1.set)(["maxSliceId", elementId, data.numberOfSlices - 1]);
+    }
     if (data.isTimeserie) {
         (0, imageStore_1.set)(["minTimeId", elementId, 0]);
         (0, imageStore_1.set)(["timeId", elementId, data.timeIndex || 0]);
-        (0, imageStore_1.set)(["maxTimeId", elementId, data.numberOfTemporalPositions - 1]);
-        let maxSliceId = data.numberOfSlices * data.numberOfTemporalPositions - 1;
-        (0, imageStore_1.set)(["maxSliceId", elementId, maxSliceId]);
+        if (data.numberOfSlices && data.numberOfTemporalPositions) {
+            (0, imageStore_1.set)(["maxTimeId", elementId, data.numberOfTemporalPositions - 1]);
+            let maxSliceId = data.numberOfSlices * data.numberOfTemporalPositions - 1;
+            (0, imageStore_1.set)(["maxSliceId", elementId, maxSliceId]);
+        }
         (0, imageStore_1.set)(["timestamp", elementId, data.timestamp]);
         (0, imageStore_1.set)(["timestamps", elementId, data.timestamps]);
         (0, imageStore_1.set)(["timeIds", elementId, data.timeIds]);
@@ -81984,6 +81990,7 @@ const storeViewportData = function (image, elementId, viewport, data) {
     (0, imageStore_1.set)(["isMultiframe", elementId, data.isMultiframe]);
     (0, imageStore_1.set)(["isTimeserie", elementId, data.isTimeserie]);
     (0, imageStore_1.set)(["isPDF", elementId, false]);
+    (0, imageStore_1.set)(["waveform", elementId, data.waveform]);
 };
 exports.storeViewportData = storeViewportData;
 /**
@@ -82150,6 +82157,7 @@ const getSeriesData = function (series, defaultProps) {
         : null;
     data.isColor = series.color;
     data.isPDF = series.isPDF;
+    data.waveform = series.waveform;
     if (instance) {
         data.rows = instance.metadata.x00280010;
         data.cols = instance.metadata.x00280011;
@@ -82277,7 +82285,7 @@ exports.resliceSeries = resliceSeries;
  *        for data config store.
  */
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.set = exports.DEFAULT_VIEWPORT = void 0;
+exports.set = void 0;
 // external libraries
 const lodash_1 = __webpack_require__(6486);
 // Larvitar store object
@@ -82296,7 +82304,7 @@ const INITIAL_STORE_DATA = {
     viewports: {}
 };
 // default viewport object
-exports.DEFAULT_VIEWPORT = {
+const DEFAULT_VIEWPORT = {
     loading: 0,
     ready: false,
     minSliceId: 0,
@@ -82320,6 +82328,7 @@ exports.DEFAULT_VIEWPORT = {
     isMultiframe: false,
     isTimeserie: false,
     isPDF: false,
+    waveform: false,
     viewport: {
         scale: 0.0,
         rotation: 0.0,
@@ -82386,6 +82395,7 @@ const setValue = (store, data) => {
         case "isColor":
         case "isMultiframe":
         case "isPDF":
+        case "waveform":
         case "isTimeserie":
         case "ready":
             if (!viewport) {
@@ -82547,7 +82557,7 @@ exports["default"] = {
     // add/remove viewports
     addViewport: (name) => {
         validateStore();
-        STORE.viewports[name] = (0, lodash_1.cloneDeep)(exports.DEFAULT_VIEWPORT);
+        STORE.viewports[name] = (0, lodash_1.cloneDeep)(DEFAULT_VIEWPORT);
     },
     deleteViewport: (name) => {
         validateStore();
@@ -82580,6 +82590,9 @@ exports["default"] = {
     setMaxSliceId: (elementId, imageIndex) => {
         (0, exports.set)(["maxSliceId", elementId, imageIndex]);
     },
+    setTimeId: (elementId, timeIndex) => {
+        (0, exports.set)(["timeId", elementId, timeIndex]);
+    },
     // get
     get: (props) => {
         validateStore();
@@ -84918,6 +84931,15 @@ const imageUtils_1 = __webpack_require__(8345);
 const commonLoader_1 = __webpack_require__(326);
 // global module variables
 let customImageLoaderCounter = 0;
+/*
+ * This module provides the following functions to be exported:
+ * buildNrrdImage(volume, seriesId, custom_header)
+ * getNrrdImageId(customLoaderName)
+ * loadNrrdImage(imageId)
+ * getImageIdFromSlice(sliceNumber, orientation)
+ * getSliceNumberFromImageId(imageId, orientation)
+ * getNrrdSerieDimensions()
+ */
 // TODO-ts: why it's different from cornerstone type ?
 // type Image = {
 //   imageId: string;
@@ -86799,6 +86821,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.generateCSV = exports.exportAnnotations = exports.saveAnnotations = exports.loadAnnotations = void 0;
+// deprecated file, to be removed
+// TODO-ts remove this file @mronzoni
+// @ts-nocheck
 // external libraries
 const cornerstone_core_1 = __importDefault(__webpack_require__(7371));
 const cornerstone_tools_1 = __importDefault(__webpack_require__(4030));
@@ -88911,7 +88936,7 @@ module.exports = JSON.parse('{"x00000000":{"tag":"x00000000","vr":"UL","vm":"1",
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"larvitar","keywords":["DICOM","imaging","medical","cornerstone"],"version":"2.0.6","description":"typescript library for parsing, loading, rendering and interacting with DICOM images","repository":{"url":"https://github.com/dvisionlab/Larvitar.git","type":"git"},"main":"dist/larvitar.js","types":"dist/index.d.ts","files":["dist"],"scripts":{"coverage":"typescript-coverage-report","generate-docs":"node_modules/.bin/jsdoc -c jsdoc.json","build":"webpack --config ./bundler/webpack.prod.js && cp ./dist/larvitar.js ./docs/examples/larvitar.js","dev":"webpack --progress --config ./bundler/webpack.dev.js && cp ./dist/larvitar.js ./docs/examples/larvitar.js","dev-wip":"webpack serve --config ./bundler/webpack.dev-wip.js"},"author":"Simone Manini <simone.manini@dvisionlab.com> (https://www.dvisionlab.com)","contributors":["Mattia Ronzoni <mattia.ronzoni@dvisionlab.com> (https://www.dvisionlab.com)","Sara Zanchi <sara.zanchi@dvisionlab.com> (https://www.dvisionlab.com)","Ale Re <ale.re@dvisionlab.com> (https://www.dvisionlab.com)","Laura Borghesi Re <laura.borghesi@dvisionlab.com> (https://www.dvisionlab.com)"],"license":"MIT","dependencies":{"@rollup/plugin-commonjs":"^17.1.0","cornerstone-core":"^2.6.1","cornerstone-file-image-loader":"^0.3.0","cornerstone-tools":"^6.0.7","cornerstone-wado-image-loader":"^4.13.2","cornerstone-web-image-loader":"^2.1.1","crypto-js":"^4.1.1","dicom-character-set":"^1.0.3","dicom-parser":"^1.8.13","docdash":"^1.2.0","hammerjs":"^2.0.8","jpeg-lossless-decoder-js":"^2.0.7","keycode-js":"^3.1.0","lodash":"^4.17.15","pako":"^1.0.10","papaparse":"^5.3.0","plotly.js-dist-min":"^2.27.1","uuid":"^8.3.2"},"devDependencies":{"@babel/core":"^7.21.8","@types/cornerstone-core":"^2.3.0","@types/crypto-js":"^4.1.1","@types/hammerjs":"^2.0.41","@types/lodash":"^4.14.192","@types/papaparse":"^5.3.7","@types/plotly.js":"^2.12.30","@types/plotly.js-dist-min":"^2.3.4","@types/uuid":"^9.0.1","babel-loader":"^9.1.2","clean-webpack-plugin":"^4.0.0","copy-webpack-plugin":"^11.0.0","fs":"^0.0.1-security","html-loader":"^4.2.0","html-webpack-plugin":"^5.5.0","ip":"^1.1.8","jsdoc":"^3.6.4","portfinder-sync":"^0.0.2","ts-loader":"^9.4.2","typescript":"^5.0.2","typescript-coverage-report":"^0.7.0","webpack":"^5.76.3","webpack-bundle-analyzer":"^4.8.0","webpack-cli":"^5.0.1","webpack-dev-server":"^4.13.1"}}');
+module.exports = JSON.parse('{"name":"larvitar","keywords":["DICOM","imaging","medical","cornerstone"],"version":"2.0.8","description":"typescript library for parsing, loading, rendering and interacting with DICOM images","repository":{"url":"https://github.com/dvisionlab/Larvitar.git","type":"git"},"main":"dist/larvitar.js","types":"dist/index.d.ts","files":["dist","imaging/**/*.d.ts"],"scripts":{"coverage":"typescript-coverage-report","generate-docs":"node_modules/.bin/jsdoc -c jsdoc.json","build":"webpack --config ./bundler/webpack.prod.js && cp ./dist/larvitar.js ./docs/examples/larvitar.js","dev":"webpack --progress --config ./bundler/webpack.dev.js && cp ./dist/larvitar.js ./docs/examples/larvitar.js","dev-wip":"webpack serve --config ./bundler/webpack.dev-wip.js"},"author":"Simone Manini <simone.manini@dvisionlab.com> (https://www.dvisionlab.com)","contributors":["Mattia Ronzoni <mattia.ronzoni@dvisionlab.com> (https://www.dvisionlab.com)","Sara Zanchi <sara.zanchi@dvisionlab.com> (https://www.dvisionlab.com)","Ale Re <ale.re@dvisionlab.com> (https://www.dvisionlab.com)","Laura Borghesi Re <laura.borghesi@dvisionlab.com> (https://www.dvisionlab.com)"],"license":"MIT","dependencies":{"@rollup/plugin-commonjs":"^17.1.0","cornerstone-core":"^2.6.1","cornerstone-file-image-loader":"^0.3.0","cornerstone-tools":"^6.0.7","cornerstone-wado-image-loader":"^4.13.2","cornerstone-web-image-loader":"^2.1.1","crypto-js":"^4.1.1","dicom-character-set":"^1.0.3","dicom-parser":"^1.8.13","docdash":"^1.2.0","hammerjs":"^2.0.8","jpeg-lossless-decoder-js":"^2.0.7","keycode-js":"^3.1.0","lodash":"^4.17.15","pako":"^1.0.10","papaparse":"^5.3.0","plotly.js-dist-min":"^2.27.1","uuid":"^8.3.2"},"devDependencies":{"@babel/core":"^7.21.8","@types/cornerstone-core":"^2.3.0","@types/crypto-js":"^4.1.1","@types/hammerjs":"^2.0.41","@types/lodash":"^4.14.192","@types/papaparse":"^5.3.7","@types/plotly.js":"^2.12.30","@types/plotly.js-dist-min":"^2.3.4","@types/uuid":"^9.0.1","babel-loader":"^9.1.2","clean-webpack-plugin":"^4.0.0","copy-webpack-plugin":"^11.0.0","fs":"^0.0.1-security","html-loader":"^4.2.0","html-webpack-plugin":"^5.5.0","ip":"^1.1.8","jsdoc":"^3.6.4","portfinder-sync":"^0.0.2","ts-loader":"^9.4.2","typescript":"^5.0.2","typescript-coverage-report":"^0.7.0","webpack":"^5.76.3","webpack-bundle-analyzer":"^4.8.0","webpack-cli":"^5.0.1","webpack-dev-server":"^4.13.1"}}');
 
 /***/ })