larvitar 4.0.0-alpha.4 → 4.0.0-alpha.6

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

@@ -3,6 +3,12 @@
  *         for default tools
  */
 import type { ToolConfig, ToolMouseKeys, ToolSettings, ToolStyle } from "./types";
+declare const DEFAULT_TOOLS_3D: {
+    [key: string]: ToolConfig;
+};
+declare const DEFAULT_TOOLS_MPR: {
+    [key: string]: ToolConfig;
+};
 /**
  * These tools are added with `addDefaultTools()`
  */
@@ -50,4 +56,4 @@ declare const setDefaultToolsProps: (newProps: Partial<ToolConfig>[]) => void;
  * NOTE: toolClass must be a valid cornerstone tool
  */
 declare const registerExternalTool: (toolName: string, toolClass: any) => void;
-export { DEFAULT_TOOLS, DEFAULT_STYLE, DEFAULT_SETTINGS, DEFAULT_MOUSE_KEYS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool };
+export { DEFAULT_TOOLS, DEFAULT_TOOLS_3D, DEFAULT_TOOLS_MPR, DEFAULT_STYLE, DEFAULT_SETTINGS, DEFAULT_MOUSE_KEYS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool };

package/dist/imaging3d/tools/main.d.ts

@@ -2,18 +2,47 @@
  *  @desc  This file provides functionalities
  *         for initializing tools and stacks
  */
-import { RenderingEngine } from "@cornerstonejs/core";
+import * as cornerstoneTools from "@cornerstonejs/tools";
+import type { ToolConfig, ToolSettings, ToolStyle } from "../../imaging/tools/types";
+import type { RenderingEngine } from "@cornerstonejs/core";
+/**
+ * Initialize cornerstone tools with default configuration (extended with custom configuration)
+ * @function initializeCSTools
+ * @param {ToolSettings} settings - the settings object (see tools/default.js)
+ * @param {ToolStyle} style - the style object (see tools/default.js)
+ * @example larvitar.initializeCSTools({showSVGCursors:false}, {color: "0000FF"});
+ */
+export declare const initializeCSTools: (settings?: ToolSettings, style?: ToolStyle) => Promise<void>;
+/**
+ * Add a cornerstone tool (grab it from original library or dvision custom tools)
+ * @param {*} toolName
+ * @param {*} targetElementId
+ * @example larvitar.addTool("ScaleOverlay", {configuration:{minorTickLength: 10, majorTickLength: 25}}, "viewer")
+ */
+export declare const addTool: (toolName: string, customConfig: Partial<ToolConfig>, groupId?: string) => void;
 /**
  * @function addDefaultTools
  * @desc Adds default tools to the rendering engine (wwwl, pan, zoom, stackScroll)
  * @param elementId - the id of the element where the tools will be added
  * @param renderingEngine - the rendering engine where the tools will be added
  */
-export declare const addDefaultTools: (elementId: string, renderingEngine: RenderingEngine) => void;
+export declare const addDefaultTools: (elementIds: string[], renderingEngine: RenderingEngine, type?: string) => void;
 /**
- * @function addDefaultTools3D
- * @desc Adds default tools to the rendering engine (crosshairs)
- * @param elementIds - the ids of the elements where the tools will be added
- * @param renderingEngine - the rendering engine where the tools will be added
+ * Set Tool "active" on all elements (ie, rendered and manipulable)
+ * @param toolName - The tool name.
+ * @param options - The tool options (mouseButtonMask, etc). If not provided, the default options will be used.
+ * @param groupId - The tool group id. @default "default"
+ * @param doNotSetInStore - Flag to not set the active tool in the store. @default false
+ */
+export declare const setToolActive: (toolName: string, options?: Partial<ToolConfig["options"]>, groupId?: string, doNotSetInStore?: boolean) => void;
+export declare const setToolPassive: (toolName: string, groupId?: string, resetCursor?: boolean) => void;
+export declare const setToolEnabled: (toolName: string, groupId?: string, resetCursor?: boolean) => void;
+export declare const setToolDisabled: (toolName: string, groupId?: string, resetCursor?: boolean) => void;
+/**
+ * @function syncViewportsCamera
+ * @desc  Synchronizes the camera position of two (volume) viewports
+ * @param targetViewportId - the id of the target viewport where the camera will be synced
+ * @param sourceViewportId - the id of the source viewport from where the camera position will be taken
  */
-export declare const addDefaultTools3D: (elementIds: string[], renderingEngine: RenderingEngine) => void;
+export declare const syncViewportsCamera: (targetViewportId: string, sourceViewportId: string) => void;
+export declare const createToolGroup: (groupId?: string, viewports?: string[], tools?: string[]) => cornerstoneTools.Types.IToolGroup | undefined;

package/dist/index.d.ts

@@ -49,10 +49,9 @@ import { renderImage as _renderImage } from "./imaging3d/imageRendering";
 import { renderMpr as _renderMpr } from "./imaging3d/imageRendering";
 import { prefetchMetadataInformation as _prefetchMetadataInformation } from "./imaging3d/multiframe";
 import { convertMultiframeImageIds as _convertMultiframeImageIds } from "./imaging3d/multiframe";
-import { addDefaultTools as _addDefaultTools } from "./imaging3d/tools/main";
-import { addDefaultTools3D as _addDefaultTools3D } from "./imaging3d/tools/main";
+import { addDefaultTools as _addDefaultTools, initializeCSTools as _initializeCSTools, addTool as _addTool, setToolActive as _setToolActive, setToolPassive as _setToolPassive, setToolEnabled as _setToolEnabled, setToolDisabled as _setToolDisabled, syncViewportsCamera as _syncViewportsCamera, createToolGroup as _createToolGroup } from "./imaging3d/tools/main";
 import { updateImageManager, populateImageManager, getImageManager, resetImageManager, removeDataFromImageManager, getDataFromImageManager, getSopInstanceUIDFromImageManager, getImageTracker, populateGSPSManager, getGSPSManager, resetGSPSManager, getFileManager, resetFileManager, populateFileManager, getDataFromFileManager } from "./imaging/imageManagers";
-export { _cornerstone, _cornerstoneDICOMImageLoader, _cornerstoneTools, _initializeImageLoader, _readFiles, _renderImage, _renderMpr, _registerStreamingImageVolume, _convertMetadata, _loadAndCacheMetadata, _prefetchMetadataInformation, _convertMultiframeImageIds, _addDefaultTools, _addDefaultTools3D, 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 { _cornerstone, _cornerstoneDICOMImageLoader, _cornerstoneTools, _initializeCSTools, _initializeImageLoader, _readFiles, _renderImage, _renderMpr, _registerStreamingImageVolume, _convertMetadata, _loadAndCacheMetadata, _prefetchMetadataInformation, _convertMultiframeImageIds, _addDefaultTools, _addTool, _setToolActive, _setToolPassive, _setToolEnabled, _setToolDisabled, _syncViewportsCamera, _createToolGroup, 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 declare const updateLarvitarManager: (...args: any) => any;
 export declare const populateLarvitarManager: (...args: any) => any;
 export declare const getLarvitarManager: (...args: any) => any;