larvitar 3.5.5 → 3.6.0

package/dist/imaging/imageRendering.d.ts

@@ -3,7 +3,8 @@
  *         rendering images in html canvas using cornerstone
  */
 import cornerstone from "cornerstone-core";
-import { RenderProps, Series, StoreViewport, Viewport } from "./types";
+import { DisplayedArea, RenderProps, Series, StoreViewport, Viewport } from "./types";
+import { ViewportComplete } from "./tools/types";
 /**
  * Purge the cornestone internal cache
  * If seriesId is passed as argument only imageIds of the series are purged from internal cache
@@ -106,6 +107,23 @@ export declare const unloadViewport: (elementId: string) => void;
  * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
  */
 export declare const resizeViewport: (elementId: string | HTMLElement) => void;
+/**
+ * Check if the displayed image is anisotropic (row pixel spacing !== col pixel spacing)
+ * @instance
+ * @function isAnisotropic
+ * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
+ * @returns {Boolean}
+ */
+export declare const isAnisotropic: (elementId: string) => boolean;
+/**
+ * Retrieves Anisotropic Viewport displayedArea properties
+ * @instance
+ * @function getAnisotropicDisplayedArea
+ * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
+ * @param {ViewportComplete} viewport - The viewport
+ * @returns {DisplayedArea}
+ */
+export declare const getAnisotropicDisplayedArea: (id: string, viewport: ViewportComplete) => DisplayedArea | undefined;
 /**
  * Cache image and render it in a html div using cornerstone
  * @instance

package/dist/imaging/imageUtils.d.ts

@@ -2,7 +2,7 @@
  *  @desc This file provides utility functions for
  *        manipulating image pixels and image metadata
  */
-import type { CustomDataSet, MetaData, ReslicedInstance, Series } from "./types";
+import type { CustomDataSet, MetaData, ReslicedInstance, Series, TypedArray } from "./types";
 /**
  * @typedef {Object} CornerstoneSeries
  * @property {Array} imageIds Array of the instances imageIds
@@ -16,20 +16,30 @@ import type { CustomDataSet, MetaData, ReslicedInstance, Series } from "./types"
  * @param {Array} el - The image_orientation dicom tag
  */
 export declare const getNormalOrientation: (el: [number, number, number, number, number, number]) => number[];
+/**
+ * Get the min and max pixel value from pixelData
+ * @instance
+ * @function getMinPixelValue
+ * @param {Array} pixelData - Pixel data array
+ */
+export declare const getMinMaxPixelValue: (pixelData: number[] | TypedArray) => {
+    minPixelValue: number;
+    maxPixelValue: number;
+};
 /**
  * Get the min pixel value from pixelData
  * @instance
  * @function getMinPixelValue
  * @param {Array} pixelData - Pixel data array
  */
-export declare const getMinPixelValue: (pixelData: number[]) => number;
+export declare const getMinPixelValue: (pixelData: number[] | TypedArray) => number;
 /**
  * Get the max pixel value from pixelData
  * @instance
  * @function getMaxPixelValue
  * @param {Array} pixelData - Pixel data array
  */
-export declare const getMaxPixelValue: (pixelData: number[]) => number;
+export declare const getMaxPixelValue: (pixelData: number[] | TypedArray) => number;
 /**
  * Create the pixel representation string (type and length) from dicom tags
  * @instance

package/dist/imaging/postProcessing/applyKernel.d.ts

@@ -0,0 +1,29 @@
+import { Image, TypedArray, KernelConfig } from "../types";
+/**
+ * Apply convolution filter to DICOM image
+ * @param {Object} loadedImage - The DICOM image object
+ * @param {string} filterName - Name of the filter to apply
+ * @param {number} multiplier - Optional multiplier for kernel values (default: 1)
+ * @returns {TypedArray} - Convolved pixel data
+ */
+export declare function applyConvolutionFilter(loadedImage: Image, filterName: string, generateImage?: boolean, multiplier?: number): Partial<Image> | TypedArray;
+/**
+ * Create the filtered image
+ * @param {string} name - Name for the new kernel
+ * @param {Object} config - Kernel configuration (modality, label, size, kernel)
+ * @returns {Partial<Image>} - Convolved pixel data
+ */
+export declare function createFilteredImage(loadedImage: Image, filteredPixelArray: number[]): Partial<Image>;
+/**
+ * Add custom kernel to the global object
+ * @param {string} name - Name for the new kernel
+ * @param {Object} config - Kernel configuration (modality, label, size, kernel)
+ */
+export declare function addCustomKernel(name: string, config: KernelConfig): void;
+/**
+ * Get kernels
+ * @returns {Object} - CONVOLUTION_KERNELS object
+ */
+export declare function getKernels(): {
+    [x: string]: KernelConfig;
+};

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

@@ -1,5 +1,5 @@
 import { EnabledElement } from "cornerstone-core";
-import { Image, Viewport } from "../types";
+import { DisplayedArea, Image, Viewport } from "../types";
 type ToolOptions = {
     mouseButtonMask?: number | number[];
     supportedInteractionTypes?: string[];
@@ -131,7 +131,7 @@ export type HandlePosition = {
 };
 export interface ViewportComplete extends Viewport {
     initialRotation: number;
-    displayedArea: any;
+    displayedArea: DisplayedArea;
     scale: number;
     rotation: number;
     vflip: boolean;

package/dist/imaging/types.d.ts

@@ -3,7 +3,7 @@ import { DataSet } from "dicom-parser";
 import { MetaDataTypes } from "./MetaDataTypes";
 import { MetaDataReadable } from "./MetaDataReadable";
 import { Element } from "dicom-parser";
-import { Overlay } from "./tools/types";
+import { Coords, DisplayAreaVisualizations, Overlay } from "./tools/types";
 export type tags = {
     [x: string]: Element;
 }[];
@@ -186,21 +186,15 @@ export interface Layer extends cornerstone.EnabledElementLayer {
 }
 export interface Viewport extends cornerstone.Viewport {
     newImageIdIndex: number;
-    displayedArea: {
-        tlhc: {
-            x: number;
-            y: number;
-        };
-        brhc: {
-            x: number;
-            y: number;
-        };
-        columnPixelSpacing: number;
-        rowPixelSpacing: number;
-        presentationSizeMode: string;
-    };
     overlayColor?: boolean | string;
 }
+export type DisplayedArea = {
+    tlhc?: Coords;
+    brhc?: Coords;
+    presentationSizeMode?: DisplayAreaVisualizations;
+    rowPixelSpacing?: number;
+    columnPixelSpacing?: number;
+};
 export type Contours = {
     [key: string]: {
         [key: string]: Array<{
@@ -338,7 +332,13 @@ type translation = {
     x: number;
     y: number;
 };
+export type KernelConfig = {
+    label: string;
+    size: number;
+    kernel: number[][];
+};
 export type RenderProps = {
+    filterName?: string;
     cached?: boolean;
     imageIndex?: number;
     scale?: number;

package/dist/index.d.ts

@@ -13,7 +13,7 @@ import { parseContours } from "./imaging/imageContours";
 import { parseECG } from "./imaging/parsers/ecg";
 import { renderECG, unrenderECG, syncECGFrame, updateECGMarker, updateECGTotalTime, 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 { getNormalOrientation, getMinPixelValue, getMaxPixelValue, getMinMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata } from "./imaging/imageUtils";
 import { buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, exportImageToBase64, exportImageToBase64OriginalSizes } from "./imaging/imageIo";
 import { anonymize } from "./imaging/imageAnonymization";
 import { customizeByteArray } from "./imaging/imageCustomization";
@@ -36,9 +36,10 @@ import { populateDsaImageIds } from "./imaging/loaders/dsaImageLoader";
 import { resetFileLoader, getFileCustomImageId } from "./imaging/loaders/fileLoader";
 import { getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB } from "./imaging/imageColormaps";
 import { applyDSAShift } from "./imaging/postProcessing/applyDSA";
+import { applyConvolutionFilter, addCustomKernel, getKernels } from "./imaging/postProcessing/applyKernel";
 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, clearStandardImageCache, clearDSAImageCache, 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 { 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, getMinMaxPixelValue, 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, clearStandardImageCache, clearDSAImageCache, 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, applyConvolutionFilter, addCustomKernel, getKernels, 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;