larvitar 2.0.0 → 2.0.3

package/README.md

@@ -8,8 +8,8 @@
 
 ## Dicom Image Toolkit for CornerstoneJS
 
-### Current version: 2.0.0
-### Latest Published Release: 2.0.0
+### Current version: 2.0.3
+### Latest Published Release: 2.0.3
 
 This library provides common DICOM functionalities to be used in web-applications: it's wrapper that simplifies the use of cornerstone-js environment.
 
@@ -107,7 +107,7 @@ Once you are done, upgrade the version (README and package.json) and build the l
 - `tools/custom/setLabelMap3D`
 - `tools/custom/thresholdsBrushTool` is a custom cornerstone tool for handling thresholds in a brush tool
 - `tools/default` default tools map and configuration
-- `tools/interaction` cornerstone interaction tools 
+- `tools/interaction` cornerstone interaction tools
 - `tools/io` import and export functionalities for tools
 - `tools/main` tools main functionalities
 - `tools/state` tools state management

package/dist/imaging/MetaDataReadable.d.ts

@@ -25,6 +25,7 @@ export type MetaDataReadable = {
     frameDelay?: number;
     rWaveTimeVector?: number[];
     isMultiframe?: boolean;
+    waveform?: boolean;
     temporalPositionIdentifier?: number;
     numberOfTemporalPositions?: number;
     contentTime?: number;

package/dist/imaging/MetaDataTypes.d.ts

@@ -3485,4 +3485,5 @@ export type MetaDataTypes = {
     x300e0004?: string;
     x300e0005?: string;
     x300e0008?: string;
+    x50003000?: MetaDataTypes[];
 };

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

@@ -32,6 +32,7 @@ export type NrrdSeries = {
     bytes: number;
     dataSet?: DataSet;
     metadata?: MetaData;
+    ecgData?: number[];
 };
 type NrrdHeader = {
     volume: Volume;

package/dist/imaging/parsers/ecg.d.ts

@@ -10,6 +10,6 @@ import { DataSet } from "dicom-parser";
  * @param {DataSet} dataSet - the DICOM dataset
  * @param {String} tag - the tag of the ECG signal
  * @param {Number} nSampling - the sampling rate
- * @returns {Array} An array of points representing the ECG signal
+ * @returns {void}
  */
-export declare function parseECG(dataSet: DataSet, tag: string, nSampling: number): number[];
+export declare function parseECG(seriesId: string, dataSet: DataSet, tag: string, nSampling?: number): void;

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

@@ -0,0 +1,18 @@
+declare const BorderMagnifyTool_base: any;
+export default class BorderMagnifyTool extends BorderMagnifyTool_base {
+    [x: string]: any;
+    constructor(props?: {});
+    /**
+     * Event handler for the "keydown" event to toggle the visibility of borders and info on "B" key press.
+     * @param {KeyboardEvent} event
+     * @returns {void}
+     */
+    handleKeyDown(event: KeyboardEvent): void;
+    /**
+     * Overrides the _drawMagnificationTool method to add configurable borders and display zoom/ROI dimensions.
+     * @param {*} evt
+     * @returns {void}
+     */
+    _drawMagnificationTool(evt: any): void;
+}
+export {};

package/dist/imaging/waveforms/ecg.d.ts

@@ -0,0 +1,39 @@
+/** @module waveforms/ecg
+ *  @desc This file provides utility functions for
+ *        rendering ecg waveforms using plotly.js
+ */
+import Plotly from "plotly.js-dist-min";
+/**
+ * Render ECG waveform in a div
+ * @instance
+ * @function renderECG
+ * @param {number[]} data - ECG waveform data
+ * @param {string} divId - DivId to render waveform in
+ * @param {string} colorMarker - Color of the marker
+ * @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
+ * @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>[];
+/**
+ * Sync ECG waveform with rendered image on click
+ * @instance
+ * @function syncECGFrame
+ * @param {Object} traceData - Plotly trace data
+ * @param {string} seriesId - SeriesId of the image
+ * @param {string} canvasId - CanvasId of the image
+ * @param {number} numberOfFrames - Number of frames in the image
+ * @param {string} divId - DivId to render waveform in
+ */
+export declare const syncECGFrame: (traceData: Partial<Plotly.PlotData>[], seriesId: string, canvasId: string, numberOfFrames: number, divId: string) => void;
+/**
+ * Sync ECG waveform with rendered image on click
+ * @instance
+ * @function updateECGFrame
+ * @param {Object} traceData - Plotly trace data
+ * @param {number} frameId - FrameId of the image
+ * @param {number} numberOfFrames - Number of frames in the image
+ * @param {string} divId - DivId to render waveform in
+ */
+export declare const updateECGFrame: (traceData: Partial<Plotly.PlotData>[], frameId: number, numberOfFrames: number, divId: string) => void;

package/dist/index.d.ts

@@ -9,6 +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 { 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";
@@ -31,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, 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, 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 };