larvitar 2.0.7 → 2.0.9

package/README.md

@@ -8,8 +8,8 @@
 
 ## Dicom Image Toolkit for CornerstoneJS
 
-### Current version: 2.0.7
-### Latest Published Release: 2.0.7
+### Current version: 2.0.9
+### Latest Published Release: 2.0.9
 
 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
@@ -130,7 +130,7 @@ export declare const updateViewportData: (elementId: string, viewportData: Viewp
  * @param {String} viewport - The viewport tag name
  * @param {Object} data - The viewport data object
  */
-export declare const storeViewportData: (image: cornerstone.Image, elementId: string, viewport: Viewport, data: any) => void;
+export declare const storeViewportData: (image: cornerstone.Image, elementId: string, viewport: Viewport, data: ReturnType<typeof getSeriesData>) => void;
 /**
  * Invert pixels of an image
  * @instance
@@ -166,3 +166,13 @@ export declare const rotateImageLeft: (elementId: string | HTMLElement) => void;
  * @param {Object} elementId - The html div id used for rendering or its DOM HTMLElement
  */
 export declare const rotateImageRight: (elementId: string | HTMLElement) => void;
+/**
+ * Get series metadata from default props and series' metadata
+ * @instance
+ * @function getSeriesData
+ * @param {Object} series - The parsed data series
+ * @param {Object} defaultProps - Optional default properties
+ * @return {Object} data - A data dictionary with parsed tags' values
+ */
+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,67 +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;
-    imageIndex?: number;
-    imageId?: string;
-    numberOfSlices?: number;
-    numberOfTemporalPositions?: number;
-    timeIndex?: number;
-    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;
@@ -115,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/waveforms/ecg.d.ts

@@ -3,6 +3,13 @@
  *        rendering ecg waveforms using plotly.js
  */
 import Plotly from "plotly.js-dist-min";
+/**
+ * Get default layout for the plotly plot
+ * @instance
+ * @function getDefaultECGLayout
+ * @returns {Object} defaultECGLayout - Default layout for the plotly plot
+ */
+export declare const getDefaultECGLayout: () => Partial<Plotly.Layout>;
 /**
  * Render ECG waveform in a div
  * @instance
@@ -13,9 +20,10 @@ import Plotly from "plotly.js-dist-min";
  * @param {number} numberOfframes - Number of frames in the image
  * @param {number} frameTime - Time interval of each frame in the image
  * @param {number} frameId - FrameId of the image to be rendered
+ * @param {Object} customLayout - Custom layout for the plotly plot
  * @returns {Object} traceData - Plotly trace data
  */
-export declare const renderECG: (data: number[], divId: string, colorMarker: string, numberOfFrames: number, frameTime: number, frameId?: number) => Partial<Plotly.PlotData>[];
+export declare const renderECG: (data: number[], divId: string, colorMarker: string, numberOfFrames: number, frameTime: number, frameId: number, customLayout?: Partial<Plotly.Layout>) => Partial<Plotly.PlotData>[];
 /**
  * Sync ECG waveform with rendered image on click
  * @instance

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import { getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanc
 import store from "./imaging/imageStore";
 import { parseContours } from "./imaging/imageContours";
 import { parseECG } from "./imaging/parsers/ecg";
-import { renderECG, syncECGFrame, updateECGFrame } from "./imaging/waveforms/ecg";
+import { renderECG, syncECGFrame, updateECGFrame, getDefaultECGLayout } from "./imaging/waveforms/ecg";
 import { getImagePresets, setImagePreset, setImageCustomPreset } from "./imaging/imagePresets";
 import { getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata } from "./imaging/imageUtils";
 import { buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage } from "./imaging/imageIo";
@@ -32,4 +32,4 @@ import { fileManager, resetFileLoader, resetFileManager, populateFileManager, ge
 import { getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB } from "./imaging/imageColormaps";
 import { saveAnnotations, loadAnnotations } from "./imaging/tools/io";
 import { addMouseKeyHandlers, removeMouseKeyHandlers, toggleMouseToolsListeners } from "./imaging/tools/interaction";
-export { VERSION, cornerstone, cornerstoneTools, parseDicom, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, syncECGFrame, updateECGFrame, renderECG, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, anonymize, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, updateLoadedStack, readFile, readFiles, parseDataSet, clearImageParsing, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, updateLarvitarManager, populateLarvitarManager, getLarvitarManager, getLarvitarImageTracker, resetLarvitarManager, removeSeriesFromLarvitarManager, getSeriesDataFromLarvitarManager, getImageFrame, getSopInstanceUIDFromLarvitarManager, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, fileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId, addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig, csToolsCreateStack, csToolsUpdateImageIds, csToolsUpdateImageIndex, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, exportAnnotations, DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool, saveAnnotations, loadAnnotations, addMouseKeyHandlers, removeMouseKeyHandlers, initSegmentationModule, addSegmentationMask, setActiveLabelmap, setActiveSegment, undoLastStroke, redoLastStroke, setBrushProps, hexToRgb, rgbToHex, clearSegmentationState, deleteMask, enableBrushTool, disableBrushTool, toggleContourMode, toggleVisibility, getActiveLabelmapBuffer };
+export { VERSION, cornerstone, cornerstoneTools, parseDicom, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, renderECG, syncECGFrame, updateECGFrame, getDefaultECGLayout, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, anonymize, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, updateLoadedStack, readFile, readFiles, parseDataSet, clearImageParsing, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, updateLarvitarManager, populateLarvitarManager, getLarvitarManager, getLarvitarImageTracker, resetLarvitarManager, removeSeriesFromLarvitarManager, getSeriesDataFromLarvitarManager, getImageFrame, getSopInstanceUIDFromLarvitarManager, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, fileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId, addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig, csToolsCreateStack, csToolsUpdateImageIds, csToolsUpdateImageIndex, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, exportAnnotations, DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool, saveAnnotations, loadAnnotations, addMouseKeyHandlers, removeMouseKeyHandlers, initSegmentationModule, addSegmentationMask, setActiveLabelmap, setActiveSegment, undoLastStroke, redoLastStroke, setBrushProps, hexToRgb, rgbToHex, clearSegmentationState, deleteMask, enableBrushTool, disableBrushTool, toggleContourMode, toggleVisibility, getActiveLabelmapBuffer };