larvitar 3.0.0-beta.6 → 3.1.0

package/dist/imaging/imageLoading.d.ts

@@ -41,6 +41,12 @@ export declare const registerResliceLoader: () => void;
  * @function registerMultiFrameImageLoader
  */
 export declare const registerMultiFrameImageLoader: () => void;
+/**
+ * Register custom SingleFrame ImageLoader
+ * @instance
+ * @function registerSingleFrameImageLoader
+ */
+export declare const registerSingleFrameImageLoader: () => void;
 /**
  * Register custom DSA ImageLoader
  * @instance

package/dist/imaging/imageParsing.d.ts

@@ -2,7 +2,7 @@
  *  @desc  This file provides functionalities for parsing DICOM image files
  */
 import { DataSet } from "dicom-parser";
-import { ImageObject } from "./types";
+import { ImageObject, MetaData } from "./types";
 import { getImageManager } from "./imageManagers";
 import type { ExtendedMetaDataTypes } from "./MetaDataTypes";
 /**
@@ -28,6 +28,14 @@ export declare const readFiles: (entries: File[]) => Promise<unknown>;
  * @returns {Promise} - Return a promise which will resolve to a image object or fail if an error occurs
  */
 export declare const readFile: (entry: File) => Promise<ImageObject>;
+/**
+ * Convert QIDO metadata to a more readable format
+ * @instance
+ * @function convertQidoMetadata
+ * @param {Object} data - QIDO metadata object
+ * @returns {MetaData} - Return a metadata object
+ */
+export declare const convertQidoMetadata: (data: any) => MetaData;
 /**
  * Parse metadata from dicom parser dataSet object
  * @instance

package/dist/imaging/imageRendering.d.ts

@@ -92,10 +92,13 @@ export declare const resizeViewport: (elementId: string | HTMLElement) => void;
  * @function renderImage
  * @param {Object} seriesStack - The original series data object
  * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
- * @param {Object} defaultProps - Optional default props
+ * @param {Object | undefined} options - Optional properties
  * @return {Promise} Return a promise which will resolve when image is displayed
  */
-export declare const renderImage: (seriesStack: Series, elementId: string | HTMLElement, defaultProps: StoreViewportOptions) => Promise<true>;
+export declare const renderImage: (seriesStack: Series, elementId: string | HTMLElement, options?: {
+    defaultProps?: StoreViewportOptions;
+    cached?: boolean;
+}) => Promise<true>;
 /**
  * Redraw the cornerstone image
  * @instance

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

@@ -0,0 +1,29 @@
+/** @module imaging/loaders/singleFrameLoader
+ *  @desc  This file is a custom DICOM loader for single frame of multiframe images
+ */
+import { ImageLoader } from "cornerstone-core";
+import type { ImageObject, MetaData } from "../types";
+/**
+ * Set the single frame cache
+ * @export
+ * @function setSingleFrameCache
+ * @param {Array} data - Pixel data array
+ * @param {MetaData} metadata - Metadata object
+ * @returns {ImageObject} - Image object
+ */
+export declare const setSingleFrameCache: (data: Uint8ClampedArray, metadata: MetaData) => Promise<ImageObject>;
+/**
+ * Clear single frame cache
+ * @export
+ * @function clearSingleFrameCache
+ * @param {String} imageId - Optional Image tag
+ */
+export declare const clearSingleFrameCache: (imageId?: string) => void;
+/**
+ * Custom MultiFrame Loader Function
+ * @export
+ * @function loadSingleFrameImage
+ * @param {String} imageId - ImageId tag
+ * @returns {Function} Custom Image Creation Function
+ */
+export declare const loadSingleFrameImage: ImageLoader;

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { parseDicom } from "dicom-parser";
 import cornerstoneFileImageLoader from "cornerstone-file-image-loader";
 import { default as cornerstoneDICOMImageLoader } from "cornerstone-wado-image-loader";
 declare const segModule: any;
+import { logger, setLogLevel } from "./logger";
 import { checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory } from "./imaging/monitors/memory";
 import { getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor } from "./imaging/monitors/performance";
 import store from "./imaging/imageStore";
@@ -17,8 +18,8 @@ import { buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDI
 import { anonymize } from "./imaging/imageAnonymization";
 import { customizeByteArray } from "./imaging/imageCustomization";
 import { buildLayer, updateLayer, getActiveLayer, setActiveLayer } from "./imaging/imageLayers";
-import { initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, registerDsaImageLoader, updateLoadedStack, reset } from "./imaging/imageLoading";
-import { readFile, readFiles, parseDataSet, clearImageParsing } from "./imaging/imageParsing";
+import { initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, registerSingleFrameImageLoader, registerDsaImageLoader, updateLoadedStack, reset } from "./imaging/imageLoading";
+import { readFile, readFiles, parseDataSet, clearImageParsing, convertQidoMetadata } from "./imaging/imageParsing";
 import { clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, 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";
@@ -30,6 +31,7 @@ import { buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, get
 import { getDicomImageId, cacheImage, cacheImages, loadAndCacheImageStack, loadAndCacheDsaImageStack } from "./imaging/loaders/dicomLoader";
 import { loadReslicedImage } from "./imaging/loaders/resliceLoader";
 import { loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache } from "./imaging/loaders/multiframeLoader";
+import { setSingleFrameCache, clearSingleFrameCache, loadSingleFrameImage } from "./imaging/loaders/singleFrameLoader";
 import { populateDsaImageIds } from "./imaging/loaders/dsaImageLoader";
 import { resetFileLoader, getFileCustomImageId } from "./imaging/loaders/fileLoader";
 import { getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB } from "./imaging/imageColormaps";
@@ -37,7 +39,7 @@ import { applyDSAShift } from "./imaging/postProcessing/applyDSA";
 import { saveAnnotations, loadAnnotations } from "./imaging/tools/io";
 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, registerDsaImageLoader, updateLoadedStack, reset, readFile, readFiles, parseDataSet, clearImageParsing, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, 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, 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, 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, updateTemporalViewportData };
+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, updateImage, 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, 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, updateTemporalViewportData, logger, setLogLevel };
 export declare const updateLarvitarManager: (...args: any) => any;
 export declare const populateLarvitarManager: (...args: any) => any;
 export declare const getLarvitarManager: (...args: any) => any;