larvitar 3.3.3 → 3.4.1

package/dist/imaging/imageLoading.d.ts

@@ -59,7 +59,7 @@ export declare const registerDsaImageLoader: () => void;
  * @function updateLoadedStack
  * @param {Object} seriesData - Cornerstone series object
  * @param {Object} allSeriesStack - Dict containing all series objects
- * @param {String} customId - Optional custom id to overwrite seriesUID as default one
+ * @param {String} customId - Optional custom id to overwrite uniqueUID as default one
  * @param {number} sliceIndex - Optional custom index to overwrite slice index as default one
  */
 export declare const updateLoadedStack: (seriesData: ImageObject, allSeriesStack: ReturnType<typeof getImageManager>, customId?: string, sliceIndex?: number) => void;

package/dist/imaging/imageManagers.d.ts

@@ -17,7 +17,7 @@ export declare const populateImageManager: (uniqueUID: string, data: Series) =>
  * @instance
  * @function updateImageManager
  * @param {Object} imageObject The single dicom object
- * @param {String} customId - Optional custom id to overwrite seriesUID as default one
+ * @param {String} customId - Optional custom id to overwrite uniqueUID as default one
  * @param {number} sliceIndex - Optional custom index to overwrite slice index as default one
  */
 export declare const updateImageManager: (imageObject: ImageObject, customId?: string, sliceIndex?: number) => {

package/dist/imaging/imageRendering.d.ts

@@ -9,9 +9,9 @@ import { RenderProps, Series, StoreViewport, Viewport } from "./types";
  * If seriesId is passed as argument only imageIds of the series are purged from internal cache
  * @instance
  * @function clearImageCache
- * @param {String} seriesId - The id of the serie
+ * @param {String} uniqueUID - The uniqueUID of the series
  */
-export declare const clearImageCache: (seriesId?: string) => void;
+export declare const clearImageCache: (uniqueUID?: string) => void;
 /**
  * Load and cache a single image
  * Add series's imageIds into store
@@ -64,6 +64,9 @@ export declare const renderFileImage: (file: File, elementId: string | HTMLEleme
 export declare const renderWebImage: (url: string, elementId: string | HTMLElement) => Promise<cornerstone.Image>;
 /**
  * Unrender an image on a html div using cornerstone
+ * Remove mouse listeners
+ * Remove uniqueUID from viewport store
+ * Remove ready flag from viewport store
  * @instance
  * @function disableViewport
  * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
@@ -71,13 +74,16 @@ export declare const renderWebImage: (url: string, elementId: string | HTMLEleme
 export declare const disableViewport: (elementId: string | HTMLElement) => void;
 /**
  * Unrender an image on a html div using cornerstone
- * Remove image from cornerstone cache and remove from store
+ * Remove mouse listeners
+ * Remove uniqueUID from viewport store
+ * Remove ready flag from viewport store
+ * Remove image from cornerstone cache
+ * Delete viewport from store
  * @instance
  * @function unloadViewport
  * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
- * @param {String} seriesId - The id of the serie
  */
-export declare const unloadViewport: (elementId: string, seriesId: string) => void;
+export declare const unloadViewport: (elementId: string) => void;
 /**
  * Resize a viewport using cornerstone resize
  * And forcing fit to window

package/dist/imaging/imageStore.d.ts

@@ -17,7 +17,7 @@ type Store = {
     leftActiveTool?: string;
     rightActiveTool?: string;
     series: {
-        [seriesUID: string]: StoreSeries;
+        [uniqueUID: string]: StoreSeries;
     };
     viewports: {
         [key: string]: StoreViewport;
@@ -32,7 +32,7 @@ type SetPayload = ["errorLog" | "leftActiveTool" | "rightActiveTool", string] |
     ("progress" | "loading" | "minPixelValue" | "maxPixelValue" | "minSliceId" | "maxSliceId" | "minTimeId" | "maxTimeId" | "rotation" | "scale" | "sliceId" | "timeId" | "thickness" | "numberOfFrames" | "numberOfTemporalPositions"),
     string,
     number
-] | ["cached", string, string, boolean] | ["timestamp", string, number | undefined] | ["seriesUID" | "modality", string, string | undefined] | ["pendingSliceId", string, number | undefined] | ["timestamps" | "timeIds" | "pixelShift", string, number[]] | [
+] | ["cached", string, string, boolean] | ["timestamp", string, number | undefined] | ["uniqueUID" | "modality", string, string | undefined] | ["pendingSliceId", string, number | undefined] | ["timestamps" | "timeIds" | "pixelShift", string, number[]] | [
     "contrast" | "dimensions" | "spacing" | "translation",
     string,
     number,
@@ -53,9 +53,9 @@ declare const _default: {
     initialize: () => void;
     addViewport: (name: string) => void;
     deleteViewport: (name: string) => void;
-    addSeriesId: (seriesId: string, imageIds: string[]) => void;
-    removeSeriesId: (seriesId: string) => void;
-    resetSeriesIds: () => void;
+    addImageIds: (uniqueUID: string, imageIds: string[]) => void;
+    removeImageIds: (uniqueUID: string) => void;
+    resetImageIds: () => void;
     setSliceId: (elementId: string, imageIndex: number) => void;
     setPendingSliceId: (elementId: string, imageIndex: number) => void;
     setMaxSliceId: (elementId: string, imageIndex: number) => void;
@@ -68,7 +68,7 @@ declare const _default: {
     removeStoreListener: () => undefined;
     addViewportListener: (elementId: string, listener: (data: StoreViewport) => {}) => void;
     removeViewportListener: (elementId: string) => void;
-    addSeriesListener: (seriesId: string, listener: (data: StoreSeries) => {}) => void;
-    removeSeriesListener: (seriesId: string) => void;
+    addSeriesListener: (uniqueUID: string, listener: (data: StoreSeries) => {}) => void;
+    removeSeriesListener: (uniqueUID: string) => void;
 };
 export default _default;

package/dist/imaging/imageUtils.d.ts

@@ -143,12 +143,12 @@ export declare const getDistanceBetweenSlices: (seriesData: Series, sliceIndex1:
 /**
  * @instance
  * @function getImageMetadata
- * @param {String} seriesId - The seriesUID
+ * @param {String} uniqueUID - The unique UID of the series
  * @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, frameId?: number) => ({
+export declare const getImageMetadata: (uniqueUID: string, instanceUID: string, frameId?: number) => ({
     tag: string;
     name: string;
     value: {

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

@@ -15,7 +15,7 @@ export declare const loadMultiFrameImage: ImageLoader;
  * Build the multiframe layout in the Image Manager
  * @export
  * @function buildMultiFrameImage
- * @param {String} seriesId - SeriesId tag
+ * @param {String} uniqueUID - the uniqueUID of the series
  * @param {Object} serie - parsed serie object
  */
 export declare const buildMultiFrameImage: (uniqueUID: string, serie: Series) => void;
@@ -31,6 +31,6 @@ export declare const getMultiFrameImageId: (customLoaderName: string) => string;
  * Clear the multiframe cache
  * @instance
  * @function clearMultiFrameCache
- * @param {String} seriesId - SeriesId tag
+ * @param {String} uniqueUID - the uniqueUID of the series
  */
-export declare const clearMultiFrameCache: (seriesId: string) => void;
+export declare const clearMultiFrameCache: (uniqueUID: string) => void;

package/dist/imaging/monitors/memory.d.ts

@@ -6,15 +6,15 @@
  * Check memory allocation and clear memory if needed
  * @instance
  * @function checkAndClearMemory
- * @param {Number} - Number of bytes to allocate
- * @param {Array} - Rendered Series ids
+ * @param {Number} bytes - Number of bytes to allocate
+ * @param {Array} renderedSeriesIds - Rendered Series ids
  */
 export declare const checkAndClearMemory: (bytes: number, renderedSeriesIds: string[]) => void;
 /**
  * Check memory allocation and returns false if js Heap size has reached its limit
  * @instance
  * @function checkMemoryAllocation
- * @param {Number} - Number of bytes to allocate
+ * @param {Number} bytes - Number of bytes to allocate
  * @return {Boolean} - Returns a boolean flag to warn the user about memory allocation limit
  */
 export declare const checkMemoryAllocation: (bytes: number) => boolean;
@@ -24,7 +24,7 @@ export declare const checkMemoryAllocation: (bytes: number) => boolean;
  * @function getUsedMemory
  * @return {Number} - Returns used JSHeapSize in bytes or NaN if not supported
  */
-export declare const getUsedMemory: () => any;
+export declare const getUsedMemory: () => number;
 /**
  * Check performance.memory browser support and returns available Js Heap Size in Mb
  * @instance
@@ -36,6 +36,6 @@ export declare const getAvailableMemory: () => number;
  * Check performance.memory browser support and returns available Js Heap Size in Mb
  * @instance
  * @function setAvailableMemory
- * @param {Number} - Number of GB to set as maximum custom memory limit
+ * @param {Number} value - Number of GB to set as maximum custom memory limit
  */
 export declare const setAvailableMemory: (value: number) => void;

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

@@ -28,7 +28,7 @@ export default class GspsTool extends BaseTool {
     handleElement(element: HTMLElement): Promise<EnabledElement | undefined>;
     retrieveLarvitarManager(imageId: string): {
         manager: ImageManager;
-        seriesId: string;
+        uniqueUID: string;
     };
 }
 export {};

package/dist/imaging/tools/main.d.ts

@@ -11,21 +11,16 @@ import type { ToolConfig, ToolSettings, ToolStyle } from "./types";
  * @example larvitar.initializeCSTools({showSVGCursors:false}, {color: "0000FF"});
  */
 declare const initializeCSTools: (settings?: ToolSettings, style?: ToolStyle) => void;
-/**
- * Create stack object to sync stack tools
- * @function csToolsCreateStack
- * @param {HTMLElement} element - The target html element.
- * @param {Array} imageIds - Stack image ids.
- * @param {number?} currentImageIndex - The current image id.
- */
-declare const csToolsCreateStack: (element: HTMLElement, imageIds: string[], currentImageIndex?: number) => void;
 /**
  * Update stack object to sync stack tools
- * @function csToolsUpdateImageIds
- * @param {String} elementId - The target html element id.
- * @param {Array} imageIds - Stack image ids.
+ * @function csToolsUpdateStack
+ * @param {string | HTMLElement} elementId - The target html element or its id.
+ * @param {Object} stack - The stack object.
  */
-export declare function csToolsUpdateImageIds(elementId: string, imageIds: string[]): void;
+export declare function csToolsUpdateStack(elementId: string | HTMLElement, stack: {
+    imageIds?: string[];
+    currentImageIdIndex?: number;
+}): void;
 /**
  * Add a cornerstone tool (grab it from original library or dvision custom tools)
  * @param {*} toolName
@@ -36,8 +31,11 @@ declare const addTool: (toolName: string, customConfig: Partial<ToolConfig>, tar
 /**
  * Add all default tools, as listed in tools/default.js
  * @function addDefaultTools
+ * @param {string | HTMLElement} elementId - The target html element or its id.
+ * @param {boolean} wwwcSync - Flag to enable synchronizer for wwwcSynchronizer. @default false
+ * @returns {void} - void
  */
-export declare const addDefaultTools: (elementId: string) => void;
+export declare const addDefaultTools: (elementId: string | HTMLElement, wwwcSync?: boolean) => void;
 /**
  * Set Tool "active" on all elements (ie, rendered and manipulable) & refresh cornerstone elements
  * @function setToolActive
@@ -77,4 +75,4 @@ declare const setToolPassive: (toolName: string, viewports?: string[]) => void;
  * @param {Object} style - the style object (see tools/defaults.js)
  */
 declare const setToolsStyle: (style?: ToolStyle) => void;
-export { initializeCSTools, setToolsStyle, csToolsCreateStack, addTool, setToolActive, setToolEnabled, setToolDisabled, setToolPassive };
+export { initializeCSTools, setToolsStyle, addTool, setToolActive, setToolEnabled, setToolDisabled, setToolPassive };

package/dist/index.d.ts

@@ -23,7 +23,7 @@ import { readFile, readFiles, parseDataSet, clearImageParsing, convertQidoMetada
 import { clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, redrawImage, resetViewports, updateViewportData, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, updateTemporalViewportData } from "./imaging/imageRendering";
 import { resliceSeries } from "./imaging/imageReslice";
 import { addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig } from "./imaging/imageTools";
-import { csToolsCreateStack, csToolsUpdateImageIds, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive } from "./imaging/tools/main";
+import { csToolsUpdateStack, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive } from "./imaging/tools/main";
 import { DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool } from "./imaging/tools/default";
 import { initSegmentationModule, addSegmentationMask, clearSegmentationState, deleteMask, setActiveLabelmap, setActiveSegment, enableBrushTool, disableBrushTool, undoLastStroke, redoLastStroke, setBrushProps, toggleContourMode, toggleVisibility, hexToRgb, rgbToHex, getActiveLabelmapBuffer } from "./imaging/tools/segmentation";
 import { getImageFrame } from "./imaging/loaders/commonLoader";
@@ -38,7 +38,7 @@ import { getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB }
 import { applyDSAShift } from "./imaging/postProcessing/applyDSA";
 import { addMouseKeyHandlers, removeMouseKeyHandlers, toggleMouseToolsListeners } from "./imaging/tools/interaction";
 import { updateImageManager, populateImageManager, getImageManager, resetImageManager, removeDataFromImageManager, getDataFromImageManager, getSopInstanceUIDFromImageManager, getImageTracker, populateGSPSManager, getGSPSManager, resetGSPSManager, getFileManager, resetFileManager, populateFileManager, getDataFromFileManager } from "./imaging/imageManagers";
-export { VERSION, cornerstone, cornerstoneTools, parseDicom, cornerstoneFileImageLoader, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, renderECG, unrenderECG, syncECGFrame, updateECGMarker, updateECGTotalTime, getDefaultECGLayout, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, exportImageToBase64, exportImageToBase64OriginalSizes, anonymize, customizeByteArray, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, registerSingleFrameImageLoader, registerDsaImageLoader, updateLoadedStack, reset, readFile, readFiles, parseDataSet, clearImageParsing, convertQidoMetadata, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, redrawImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, updateImageManager, populateImageManager, getImageManager, resetImageManager, removeDataFromImageManager, getDataFromImageManager, getSopInstanceUIDFromImageManager, getImageTracker, populateGSPSManager, getGSPSManager, resetGSPSManager, populateFileManager, getFileManager, resetFileManager, getDataFromFileManager, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, getImageFrame, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadAndCacheImageStack, loadAndCacheDsaImageStack, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, setSingleFrameCache, clearSingleFrameCache, loadSingleFrameImage, populateDsaImageIds, resetFileLoader, getFileCustomImageId, applyDSAShift, addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig, csToolsCreateStack, csToolsUpdateImageIds, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool, addMouseKeyHandlers, removeMouseKeyHandlers, initSegmentationModule, addSegmentationMask, setActiveLabelmap, setActiveSegment, undoLastStroke, redoLastStroke, setBrushProps, hexToRgb, rgbToHex, clearSegmentationState, deleteMask, enableBrushTool, disableBrushTool, toggleContourMode, toggleVisibility, getActiveLabelmapBuffer, updateTemporalViewportData, logger, setLogLevel };
+export { VERSION, cornerstone, cornerstoneTools, parseDicom, cornerstoneFileImageLoader, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, renderECG, unrenderECG, syncECGFrame, updateECGMarker, updateECGTotalTime, getDefaultECGLayout, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, exportImageToBase64, exportImageToBase64OriginalSizes, anonymize, customizeByteArray, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, registerSingleFrameImageLoader, registerDsaImageLoader, updateLoadedStack, reset, readFile, readFiles, parseDataSet, clearImageParsing, convertQidoMetadata, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, redrawImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, updateImageManager, populateImageManager, getImageManager, resetImageManager, removeDataFromImageManager, getDataFromImageManager, getSopInstanceUIDFromImageManager, getImageTracker, populateGSPSManager, getGSPSManager, resetGSPSManager, populateFileManager, getFileManager, resetFileManager, getDataFromFileManager, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, getImageFrame, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadAndCacheImageStack, loadAndCacheDsaImageStack, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, setSingleFrameCache, clearSingleFrameCache, loadSingleFrameImage, populateDsaImageIds, resetFileLoader, getFileCustomImageId, applyDSAShift, addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig, csToolsUpdateStack, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool, addMouseKeyHandlers, removeMouseKeyHandlers, initSegmentationModule, addSegmentationMask, setActiveLabelmap, setActiveSegment, undoLastStroke, redoLastStroke, setBrushProps, hexToRgb, rgbToHex, clearSegmentationState, deleteMask, enableBrushTool, disableBrushTool, toggleContourMode, toggleVisibility, getActiveLabelmapBuffer, updateTemporalViewportData, logger, setLogLevel };
 export declare const updateLarvitarManager: (...args: any) => any;
 export declare const populateLarvitarManager: (...args: any) => any;
 export declare const getLarvitarManager: (...args: any) => any;
@@ -52,3 +52,5 @@ export declare const getInstanceGSPSDict: (...args: any) => any;
 export declare const resetInstanceGSPSDict: (...args: any) => any;
 export declare const getFileImageId: (...args: any) => any;
 export declare const updateImage: (...args: any) => any;
+export declare const csToolsUpdateImageIds: (...args: any) => any;
+export declare const csToolsCreateStack: (...args: any) => any;