larvitar 3.6.3 → 3.6.4

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

@@ -1,29 +1,52 @@
 import { Image, TypedArray, KernelConfig } from "../types";
+/**
+ * Add custom kernel to the global object
+ * @function addCustomKernel
+ * @param {string} name - Name for the new kernel
+ * @param {KernelConfig} config - Kernel configuration (modality, label, size, kernel)
+ * @returns {void}
+ */
+export declare const addCustomKernel: (name: string, config: KernelConfig) => void;
+/**
+ * Get kernels
+ * @function getKernels
+ * @returns {ConvolutionKernels} - CONVOLUTION_KERNELS object
+ */
+export declare const getKernels: () => {
+    [x: string]: KernelConfig;
+};
 /**
  * Apply convolution filter to DICOM image
- * @param {Object} loadedImage - The DICOM image object
+ * @function applyConvolutionFilter
+ * @param {Image} 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;
+export declare const applyConvolutionFilter: (loadedImage: Image, filterName: string, generateImage?: boolean) => Partial<Image> | TypedArray;
 /**
  * Create the filtered image
- * @param {string} name - Name for the new kernel
- * @param {Object} config - Kernel configuration (modality, label, size, kernel)
+ * @function createFilteredImage
+ * @param {Image} loadedImage - the source image
+ * @param {number[]} filteredPixelArray - filtered pixel data
  * @returns {Partial<Image>} - Convolved pixel data
  */
-export declare function createFilteredImage(loadedImage: Image, filteredPixelArray: number[]): Partial<Image>;
+export declare const 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)
+ * Applies a Gaussian blur filter to a cornerstone image.
+ * @function applyGaussianBlur
+ * @param {Image} loadedImage - The cornerstone image object.
+ * @param {number} kernelSize - The size of the kernel.
+ * @param {number} strength - The sigma value for the Gaussian function.
+ * @returns {Partial<Image>} - The new, blurred cornerstone image object.
  */
-export declare function addCustomKernel(name: string, config: KernelConfig): void;
+export declare const applyGaussianBlur: (loadedImage: Image, kernelSize: number, strength: number) => Partial<Image>;
 /**
- * Get kernels
- * @returns {Object} - CONVOLUTION_KERNELS object
+ * Applies a sharpening filter to a cornerstone image.
+ * @function applySharpening
+ * @param {Image} loadedImage - The cornerstone image object.
+ * @param {number} kernelSize - The size of the kernel.
+ * @param {number} strength - The strength of the sharpening effect.
+ * @returns {Partial<Image>} - The new, sharpened cornerstone image object.
  */
-export declare function getKernels(): {
-    [x: string]: KernelConfig;
-};
+export declare const applySharpening: (loadedImage: Image, kernelSize: number, strength: number) => Partial<Image>;

package/dist/imaging/types.d.ts

@@ -344,6 +344,14 @@ export type KernelConfig = {
     size: number;
     kernel: number[][];
 };
+export type FilterImageFrame = {
+    width: number;
+    height: number;
+    pixelData: TypedArray;
+};
+export type ConvolutionKernels = {
+    [key: string]: KernelConfig;
+};
 export type RenderProps = {
     filterName?: string;
     cached?: boolean;

package/dist/index.d.ts

@@ -36,10 +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 { applyConvolutionFilter, applySharpening, applyGaussianBlur, 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, 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 { 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, applySharpening, applyGaussianBlur, 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;