larvitar 2.0.13 → 2.0.15

package/README.md

@@ -8,8 +8,9 @@
 
 ## Dicom Image Toolkit for CornerstoneJS
 
-### Current version: 2.0.13
-### Latest Published Release: 2.0.13
+### Current version: 2.0.15
+
+### Latest Published Release: 2.0.15
 
 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/imageUtils.d.ts

@@ -148,9 +148,10 @@ export declare const getDistanceBetweenSlices: (seriesData: Series, sliceIndex1:
  * @function getImageMetadata
  * @param {String} seriesId - The seriesUID
  * @param {String} instanceUID - The SOPInstanceUID
+ * @param {number} frameId - Optional FrameId
  * @return {Array} - List of metadata objects: tag, name and value
  */
-export declare const getImageMetadata: (seriesId: string, instanceUID: string) => ({
+export declare const getImageMetadata: (seriesId: string, instanceUID: string, frameId?: number) => ({
     tag: string;
     name: string;
     value: string | number | number[] | MetaDataTypes[] | null | undefined;

package/dist/imaging/tools/custom/contourTool.d.ts

@@ -380,15 +380,15 @@ export class ContoursTool {
      */
     fireModifiedEvent(element: any, measurementData: any): void;
     fireCompletedEvent(element: any, measurementData: any): void;
-    set spacing(arg: any);
+    set spacing(value: any);
     get spacing(): any;
-    set activeHandleRadius(arg: any);
+    set activeHandleRadius(value: any);
     get activeHandleRadius(): any;
-    set completeHandleRadius(arg: any);
+    set completeHandleRadius(value: any);
     get completeHandleRadius(): any;
-    set alwaysShowHandles(arg: any);
+    set alwaysShowHandles(value: any);
     get alwaysShowHandles(): any;
-    set invalidColor(arg: any);
+    set invalidColor(value: any);
     get invalidColor(): any;
     /**
      * Ends the active drawing loop and removes the polygon.

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../decs.d.ts" />
 declare const VERSION: string;
 import cornerstone from "cornerstone-core";
 import cornerstoneTools from "cornerstone-tools";

package/dist/larvitar.js

@@ -1690,7 +1690,6 @@ class EditMaskTool extends BaseBrushTool {
     //   });
     // }
   }
-
   activeCallback(element, options) {
     switch (options.force) {
       case "delete":
@@ -3940,7 +3939,6 @@ class RectangleRoiOverlayTool extends BaseAnnotationTool {
         // showMinMax: false,
         // showHounsfieldUnits: true,
       },
-
       svgCursor: rectangleRoiCursor
     };
     super(props, defaultProps);
@@ -80593,8 +80591,8 @@ const updateLoadedStack = function (seriesData, allSeriesStack, customId, sliceI
     if (!allSeriesStack[id]) {
         let series = {
             currentImageIdIndex: 0,
-            imageIds: [],
-            instanceUIDs: {},
+            imageIds: [], // (ordered)
+            instanceUIDs: {}, // instanceUID: imageId (ordered)
             instances: {},
             seriesDescription: seriesDescription,
             larvitarSeriesInstanceUID: lid,
@@ -81894,6 +81892,7 @@ const updateViewportData = function (elementId, viewportData, activeTool) {
     // TODO: understand how to handle synchronized tools
     switch (activeTool) {
         case "Wwwc":
+        case "Wwwl":
         case "WwwcRegion":
             if (viewportData.voi) {
                 (0, imageStore_1.set)([
@@ -81937,6 +81936,7 @@ const updateViewportData = function (elementId, viewportData, activeTool) {
             }
             break;
         default:
+            console.warn("unknown tool: " + activeTool);
             break;
     }
 };
@@ -82333,8 +82333,8 @@ const INITIAL_STORE_DATA = {
 };
 // default viewport object
 const DEFAULT_VIEWPORT = {
-    loading: 0,
-    ready: false,
+    loading: 0, // from 0 to 100 (%)
+    ready: false, // true when currentImageId is rendered
     minSliceId: 0,
     maxSliceId: 0,
     sliceId: 0,
@@ -83563,8 +83563,8 @@ const getReslicedMetadata = function (reslicedSeriesId, fromOrientation, toOrien
             x00280100: sampleMetadata.x00280100,
             x00280103: sampleMetadata.x00280103,
             // resliced series sizes
-            x00280010: toSize[1],
-            x00280011: toSize[0],
+            x00280010: toSize[1], // rows
+            x00280011: toSize[0], // cols
             // resliced series spacing
             x00280030: [toSpacing[1], toSpacing[0]],
             x00180050: [toSpacing[2]],
@@ -83650,8 +83650,8 @@ const getCmprMetadata = function (reslicedSeriesId, imageLoaderName, header // T
             // Bits Allocated
             x00280103: header.repr,
             // resliced series sizes
-            x00280010: header.rows,
-            x00280011: header.cols,
+            x00280010: header.rows, // rows
+            x00280011: header.cols, // cols
             // resliced series spacing
             x00280030: [header.spacing[1], header.spacing[0]],
             x00180050: [header.distance_btw_slices],
@@ -83681,8 +83681,8 @@ const getCmprMetadata = function (reslicedSeriesId, imageLoaderName, header // T
             // x00020010: sampleMetadata.x00020010,
             // x00200052: sampleMetadata.x00200052,
             // data needed to obtain a good rendering
-            x00281050: [header.wwwl[1] / 2],
-            x00281051: [header.wwwl[0]],
+            x00281050: [header.wwwl[1] / 2], // [wl]
+            x00281051: [header.wwwl[0]], // [ww]
             x00281052: header.intercept,
             x00281053: header.slope,
             // new image orientation (IOP)
@@ -83803,15 +83803,19 @@ exports.getDistanceBetweenSlices = getDistanceBetweenSlices;
  * @function getImageMetadata
  * @param {String} seriesId - The seriesUID
  * @param {String} instanceUID - The SOPInstanceUID
+ * @param {number} frameId - Optional FrameId
  * @return {Array} - List of metadata objects: tag, name and value
  */
-const getImageMetadata = function (seriesId, instanceUID) {
+const getImageMetadata = function (seriesId, instanceUID, frameId) {
     const seriesData = (0, commonLoader_1.getSeriesDataFromLarvitarManager)(seriesId);
     if (seriesData === undefined || seriesData === null) {
         console.log(`Invalid Series ID: ${seriesId}`);
         return [];
     }
-    const imageId = seriesData.instanceUIDs[instanceUID];
+    // manage imageID if the image is a multiframe stack
+    const imageId = seriesData.isMultiframe
+        ? seriesData.instanceUIDs[instanceUID] + "?frame=" + frameId
+        : seriesData.instanceUIDs[instanceUID];
     if (imageId === undefined) {
         console.log(`Invalid InstanceUID ID: ${instanceUID}`);
         return [];
@@ -84384,7 +84388,7 @@ const getImageFrame = function (metadata, dataSet) {
         rows: imagePixelModule.rows,
         columns: imagePixelModule.columns,
         bitsAllocated: imagePixelModule.bitsAllocated,
-        pixelRepresentation: imagePixelModule.pixelRepresentation,
+        pixelRepresentation: imagePixelModule.pixelRepresentation, // 0 = unsigned,
         smallestPixelValue: imagePixelModule.smallestPixelValue,
         largestPixelValue: imagePixelModule.largestPixelValue,
         redPaletteColorLookupTableDescriptor: imagePixelModule.redPaletteColorLookupTableDescriptor,
@@ -84393,7 +84397,7 @@ const getImageFrame = function (metadata, dataSet) {
         redPaletteColorLookupTableData: imagePixelModule.redPaletteColorLookupTableData,
         greenPaletteColorLookupTableData: imagePixelModule.greenPaletteColorLookupTableData,
         bluePaletteColorLookupTableData: imagePixelModule.bluePaletteColorLookupTableData,
-        pixelData: undefined,
+        pixelData: undefined, // populated later after decoding,
         ImageData: undefined
     };
 };
@@ -84823,7 +84827,7 @@ let createCustomImage = function (id, imageId, frameIndex, metadata) {
                 color: cornerstone_wado_image_loader_1.default.isColorImage(imageFrame.photometricInterpretation),
                 columnPixelSpacing: pixelSpacing[1]
                     ? pixelSpacing[1]
-                    : pixelSpacing,
+                    : pixelSpacing, // check for specific spacing value
                 columns: imageFrame.columns,
                 data: dataSet ? dataSet : undefined,
                 height: imageFrame.rows,
@@ -84834,17 +84838,17 @@ let createCustomImage = function (id, imageId, frameIndex, metadata) {
                 invert: imageFrame.photometricInterpretation === "MONOCHROME1",
                 minPixelValue: imageFrame.smallestPixelValue,
                 maxPixelValue: imageFrame.largestPixelValue,
-                render: undefined,
+                render: undefined, // set below
                 rowPixelSpacing: pixelSpacing[0]
                     ? pixelSpacing[0]
-                    : pixelSpacing,
+                    : pixelSpacing, // check for specific spacing value
                 rows: imageFrame.rows,
                 sizeInBytes: getSizeInBytes(),
                 slope: rescaleSlope ? rescaleSlope : 1,
                 width: imageFrame.columns,
                 windowCenter: windowCenter,
                 windowWidth: windowWidth,
-                decodeTimeInMS: undefined,
+                decodeTimeInMS: undefined, // TODO
                 loadTimeInMS: undefined // TODO
             };
             // add function to return pixel data
@@ -85050,11 +85054,11 @@ const buildNrrdImage = function (volume, seriesId, custom_header) {
     let intercept = header.volume.intercept;
     let slope = header.volume.slope;
     let metadata = {
-        x00280010: rows,
-        x00280011: cols,
-        x00200037: iop,
-        x00280030: ps,
-        x00180050: [thickness][0],
+        x00280010: rows, // Rows
+        x00280011: cols, // Columns
+        x00200037: iop, // ImageOrientationPatient
+        x00280030: ps, // PixelSpacing
+        x00180050: [thickness][0], // SliceThickness
         x00281052: intercept ? [intercept] : [0],
         x00281053: slope ? [slope] : [1],
         x00200052: header.volume.imageIds
@@ -85299,7 +85303,7 @@ let createCustomImage = function (imageId, metadata, pixelData, dataSet) {
         invert: imageFrame.photometricInterpretation === "MONOCHROME1",
         minPixelValue: imageFrame.smallestPixelValue,
         maxPixelValue: imageFrame.largestPixelValue,
-        render: undefined,
+        render: undefined, // set below
         rowPixelSpacing: pixelSpacing ? pixelSpacing[0] : undefined,
         rows: imageFrame.rows,
         sizeInBytes: getSizeInBytes(),
@@ -85480,7 +85484,7 @@ let createCustomImage = function (imageId, metadata, pixelData, dataSet // depre
         invert: imageFrame.photometricInterpretation === "MONOCHROME1",
         minPixelValue: imageFrame.smallestPixelValue,
         maxPixelValue: imageFrame.largestPixelValue,
-        render: undefined,
+        render: undefined, // set below
         rowPixelSpacing: pixelSpacing ? pixelSpacing[0] : undefined,
         rows: imageFrame.rows,
         sizeInBytes: getSizeInBytes(),
@@ -86127,7 +86131,7 @@ const DEFAULT_TOOLS = {
         name: "StackScroll",
         viewports: "all",
         configuration: {
-            loop: false,
+            loop: false, // default false
             allowSkipping: true // default true
         },
         options: {
@@ -86142,8 +86146,8 @@ const DEFAULT_TOOLS = {
         name: "StackScrollMouseWheel",
         viewports: "all",
         configuration: {
-            loop: false,
-            allowSkipping: true,
+            loop: false, // default false
+            allowSkipping: true, // default true
             invert: false
         },
         options: {},
@@ -86517,7 +86521,7 @@ exports.DEFAULT_SETTINGS = DEFAULT_SETTINGS;
  * Shortcut and mouse bindings defaults
  */
 const DEFAULT_MOUSE_KEYS = {
-    debug: true,
+    debug: true, // log changes
     mouse_button_left: {
         shift: "Zoom",
         ctrl: "Pan",
@@ -88977,7 +88981,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.13","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"}}');
+module.exports = JSON.parse('{"name":"larvitar","keywords":["DICOM","imaging","medical","cornerstone"],"version":"2.0.15","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"}}');
 
 /***/ })