larvitar 4.0.0-alpha.7 → 4.0.0-alpha.9

package/dist/imaging/MetaDataTypes.d.ts

@@ -1,6 +1,7 @@
 export type ExtendedMetaDataTypes = MetaDataTypes & {
     [key: string]: unknown;
 };
+export declare const arrayTags: string[];
 export type MetaDataTypes = {
     x20000010?: number;
     x2000001e?: MetaDataTypes[];

package/dist/imaging/imageParsing.d.ts

@@ -4,7 +4,7 @@
 import { DataSet } from "dicom-parser";
 import { ImageObject, MetaData } from "./types";
 import { getImageManager } from "./imageManagers";
-import type { ExtendedMetaDataTypes } from "./MetaDataTypes";
+import { type ExtendedMetaDataTypes } from "./MetaDataTypes";
 /**
  * Reset series stack object and its internal data
  * @instance

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

@@ -2,7 +2,7 @@
  *  @desc  This file provides definitions
  *         for default tools
  */
-import type { ToolConfig, ToolMouseKeys, ToolSettings, ToolStyle } from "./types";
+import type { CursorOptions, ToolConfig, ToolMouseKeys, ToolSettings, ToolStyle } from "./types";
 declare const DEFAULT_TOOLS_3D: {
     [key: string]: ToolConfig;
 };
@@ -21,6 +21,18 @@ declare const DEFAULT_TOOLS: {
 declare const dvTools: {
     [key: string]: any;
 };
+/**
+ * D/Vision Lab 3D custom tools
+ */
+declare const dvTools3D: {
+    [key: string]: any;
+};
+/**
+ * D/Vision Lab MPR custom tools
+ */
+declare const dvToolsMPR: {
+    [key: string]: any;
+};
 /**
  * Tools default style
  * Available font families :
@@ -29,6 +41,30 @@ declare const dvTools: {
  * Arial, Lucida Grande, sans-serif;
  */
 declare const DEFAULT_STYLE: ToolStyle;
+declare const DEFAULT_STYLE_3D: {
+    global: {
+        angleArcLineDash: string;
+        color: string;
+        colorHighlighted: string;
+        colorLocked: string;
+        colorSelected: string;
+        lineDash: string;
+        lineWidth: string;
+        markerSize: string;
+        shadow: boolean;
+        textBoxBackground: string;
+        textBoxColor: string;
+        textBoxColorHighlighted: string;
+        textBoxColorLocked: string;
+        textBoxColorSelected: string;
+        textBoxFontFamily: string;
+        textBoxFontSize: string;
+        textBoxLinkLineDash: string;
+        textBoxLinkLineWidth: string;
+        textBoxShadow: boolean;
+        textBoxVisibility: boolean;
+    };
+};
 /**
  * Tools default settings
  */
@@ -56,5 +92,27 @@ declare const setDefaultToolsProps: (newProps: Partial<ToolConfig>[]) => void;
  * NOTE: toolName must be unique
  * NOTE: toolClass must be a valid cornerstone tool
  */
-declare const registerExternalTool: (toolName: string, toolClass: any, toolVersion?: "MPR" | "3D" | "") => void;
-export { DEFAULT_TOOLS, DEFAULT_TOOLS_3D, DEFAULT_TOOLS_MPR, DEFAULT_STYLE, DEFAULT_SETTINGS, DEFAULT_MOUSE_KEYS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool };
+declare const registerExternalTool: (toolName: string, toolClass: any, toolVersion: "MPR" | "3D" | "" | undefined, toolCursor: string, cursorOptions: CursorOptions) => void;
+/**
+ * Register a custom tool cursor
+ * @param {String} toolName - The name of the tool
+ * @param {string} iconContent - The tool class
+ * @param {CursorOptions} cursorOptions - tthe  cursor options
+  ex.
+      const iconContent = `
+          <svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30">
+            <image href="data:image/svg+xml;base64,${measurementBase64}" width="30" height="30" style="filter: invert(100%);"/>
+          </svg>
+        `;
+      const cursorOptions = {
+        iconSize: 30,
+        mousePoint: { x: 15, y: 15 },
+        mousePointerGroupString: ``,
+        viewBox: {
+          x: 0,
+          y: 0
+        }
+      };
+ */
+export declare const registerCursor: (toolName: string, iconContent: string, cursorOptions: CursorOptions) => void;
+export { DEFAULT_TOOLS, DEFAULT_TOOLS_3D, DEFAULT_TOOLS_MPR, DEFAULT_STYLE, DEFAULT_STYLE_3D, DEFAULT_SETTINGS, DEFAULT_MOUSE_KEYS, dvTools, dvTools3D, dvToolsMPR, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool };

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

@@ -33,6 +33,12 @@ export type ToolStyle = {
     fontSize: number;
     backgroundColor: string;
 };
+export type CursorOptions = {
+    iconSize: number;
+    mousePoint: Coords;
+    mousePointerGroupString: string;
+    viewBox: Coords;
+};
 export type ToolSettings = {
     mouseEnabled: boolean;
     touchEnabled: boolean;

package/dist/imaging3d/tools/custom/exampleCustomTool.d.ts

@@ -1,4 +1,5 @@
 import { BaseTool } from "@cornerstonejs/tools";
+import { Viewport } from "@cornerstonejs/core";
 import * as EventTypes from "@cornerstonejs/tools/dist/esm/types/EventTypes";
 /**
  * WindowLevel tool manipulates the windowLevel applied to a viewport. It
@@ -14,16 +15,16 @@ declare class CustomWWWLTool extends BaseTool {
     touchDragCallback(evt: EventTypes.InteractionEventType): void;
     mouseDragCallback(evt: EventTypes.InteractionEventType): void;
     getPTScaledNewRange({ deltaPointsCanvas, lower, upper, clientHeight, viewport, volumeId, isPreScaled }: {
-        deltaPointsCanvas: any;
-        lower: any;
-        upper: any;
-        clientHeight: any;
-        viewport: any;
-        volumeId: any;
-        isPreScaled: any;
+        deltaPointsCanvas: number[];
+        lower: number;
+        upper: number;
+        clientHeight: number;
+        viewport: Viewport;
+        volumeId?: string;
+        isPreScaled: boolean;
     }): {
-        lower: any;
-        upper: any;
+        lower: number;
+        upper: number;
     };
     getNewRange({ viewport, deltaPointsCanvas, volumeId, lower, upper }: {
         viewport: any;

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

@@ -15,19 +15,29 @@ import type { RenderingEngine } from "@cornerstonejs/core";
  */
 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
+ * Set cornerstone tools custom configuration (extend default configuration)
+ * @function setToolsStyle
+ * @param {Object} style - the style object (see tools/defaults.js)
+ */
+export declare const setToolsStyle: (style?: ToolStyle) => void;
+/**
+ * Add a cornerstone 3D tool (grab it from original library or dvision custom 3D or MPR tools)
+ * @param {String} toolName
+ * @param {Partial<ToolConfig>} customConfig
+ * @param {String} type The type of tool to add (3D or MPR)
+ * @param {String} groupId The cornerstone3D Tool GroupID
  * @example larvitar.addTool("ScaleOverlay", {configuration:{minorTickLength: 10, majorTickLength: 25}}, "viewer")
  */
-export declare const addTool: (toolName: string, customConfig: Partial<ToolConfig>, groupId?: string) => void;
+export declare const addTool: (toolName: string, customConfig: Partial<ToolConfig>, groupId?: string, type?: 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
+ * @param {String[]} elementIds - the ids of the elements where the tools will be added
+ * @param {RenderingEngine} renderingEngine - the rendering engine where the tools will be added
+ * @param {String} type The type of tool to add (3D or MPR)
+ * @param {String} groupId The cornerstone3D Tool GroupID
  */
-export declare const addDefaultTools: (elementIds: string[], renderingEngine: RenderingEngine, type?: string) => void;
+export declare const addDefaultTools: (elementIds: string[], renderingEngine: RenderingEngine, type?: string, toolGroupId?: string) => void;
 /**
  * Set Tool "active" on all elements (ie, rendered and manipulable)
  * @param toolName - The tool name.
@@ -53,9 +63,10 @@ export declare const syncViewportsCamera: (id: string | undefined, targetViewpor
  * @param groupId - The id of the tool group to create. @default "default"
  * @param viewports
  * @param tools
+ * @param type - MPR or 3D
  * @returns toolGroup - The created tool group.
  */
-export declare const createToolGroup: (groupId?: string, viewports?: string[], tools?: any[]) => cornerstoneTools.Types.IToolGroup | undefined;
+export declare const createToolGroup: (groupId?: string, viewports?: string[], tools?: any[], type?: string) => cornerstoneTools.Types.IToolGroup | undefined;
 /**
  * Set slab thickness and mode for a given viewport
  * @function setSlab

package/dist/imaging3d/types.d.ts

@@ -1,4 +1,9 @@
 import { Enums } from "@cornerstonejs/core";
+export type { Types, VolumeViewport, StackViewport, BaseVolumeViewport } from "@cornerstonejs/core";
+export type { IEnabledElement, Point2, Point3 } from "@cornerstonejs/core/dist/esm/types";
+export type { Annotation, CanvasCoordinates, EventTypes, InteractionTypes, PublicToolProps, SVGDrawingHelper, TextBoxHandle, ToolHandle, ToolProps } from "@cornerstonejs/tools/dist/esm/types";
+export type { Handles } from "@cornerstonejs/tools/dist/esm/types/AnnotationTypes";
+export type { ROICachedStats } from "@cornerstonejs/tools/dist/esm/types/ToolSpecificAnnotationTypes";
 export type MprViewport = {
     viewportId: string;
     orientation: Enums.OrientationAxis;

package/dist/index.d.ts

@@ -24,7 +24,7 @@ import { clearImageCache, clearStandardImageCache, clearDSAImageCache, loadAndCa
 import { resliceSeries } from "./imaging/imageReslice";
 import { addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig } from "./imaging/imageTools";
 import { csToolsUpdateStack, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive } from "./imaging/tools/main";
-import { DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool } from "./imaging/tools/default";
+import { DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool, registerCursor } from "./imaging/tools/default";
 import { initSegmentationModule, addSegmentationMask, clearSegmentationState, deleteMask, setActiveLabelmap, setActiveSegment, enableBrushTool, disableBrushTool, undoLastStroke, redoLastStroke, setBrushProps, toggleContourMode, toggleVisibility, hexToRgb, rgbToHex, getActiveLabelmapBuffer } from "./imaging/tools/segmentation";
 import { getImageFrame } from "./imaging/loaders/commonLoader";
 import { buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions } from "./imaging/loaders/nrrdLoader";
@@ -52,7 +52,7 @@ import { convertMultiframeImageIds as _convertMultiframeImageIds } from "./imagi
 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, setSlab as _setSlab } from "./imaging3d/tools/main";
 import _CustomWWWLTool from "./imaging3d/tools/custom/exampleCustomTool";
 import { updateImageManager, populateImageManager, getImageManager, resetImageManager, removeDataFromImageManager, getDataFromImageManager, getSopInstanceUIDFromImageManager, getImageTracker, populateGSPSManager, getGSPSManager, resetGSPSManager, getFileManager, resetFileManager, populateFileManager, getDataFromFileManager } from "./imaging/imageManagers";
-export { _cornerstone, _cornerstoneDICOMImageLoader, _cornerstoneTools, _initializeCSTools, _initializeImageLoader, _readFiles, _renderImage, _renderMpr, _registerStreamingImageVolume, _convertMetadata, _loadAndCacheMetadata, _prefetchMetadataInformation, _convertMultiframeImageIds, _addDefaultTools, _addTool, _setToolActive, _setToolPassive, _setToolEnabled, _setToolDisabled, _syncViewportsCamera, _createToolGroup, _setSlab, _CustomWWWLTool, 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, _setSlab, _CustomWWWLTool, 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, registerCursor, 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;