copper3d 3.0.1 → 3.1.0

package/dist/types/Utils/segmentation/CommToolsData.d.ts

@@ -1,177 +0,0 @@
-import { IProtected, IGUIStates, INrrdStates, ICursorPage, IConvertObjType, INewMaskData, IKeyBoardSettings } from "./coreTools/coreType";
-import { MaskVolume } from "./core/index";
-export declare class CommToolsData {
-    baseCanvasesSize: number;
-    private _reusableSliceBuffer;
-    private _reusableBufferWidth;
-    private _reusableBufferHeight;
-    /** Whether the keyboard-config dialog is open (suppresses all shortcuts). */
-    protected _configKeyBoard: boolean;
-    /** Active keyboard shortcut bindings. */
-    protected _keyboardSettings: IKeyBoardSettings;
-    nrrd_states: INrrdStates;
-    cursorPage: ICursorPage;
-    gui_states: IGUIStates;
-    protectedData: IProtected;
-    constructor(container: HTMLElement, mainAreaContainer: HTMLElement, options?: {
-        layers?: string[];
-    });
-    /**
-     * Get MaskVolume for a specific layer
-     *
-     * @param layer - Layer name: "layer1", "layer2", or "layer3"
-     * @returns MaskVolume instance for the specified layer
-     *
-     * @example
-     * ```ts
-     * const volume = this.getVolumeForLayer("layer1");
-     * volume.setVoxel(x, y, z, 255);
-     * ```
-     */
-    getVolumeForLayer(layer: string): MaskVolume;
-    /**
-     * Get MaskVolume for the currently active layer
-     *
-     * @returns MaskVolume instance for the current layer
-     *
-     * @example
-     * ```ts
-     * const volume = this.getCurrentVolume();
-     * const slice = volume.getSliceImageData(50, 'z');
-     * ```
-     */
-    getCurrentVolume(): MaskVolume;
-    /**
-     * Get all three MaskVolume instances
-     *
-     * @returns Object containing all three layer volumes
-     *
-     * @example
-     * ```ts
-     * const { layer1, layer2, layer3 } = this.getAllVolumes();
-     * layer1.clear();
-     * ```
-     */
-    getAllVolumes(): INewMaskData;
-    private generateSystemCanvases;
-    private generateLayerTargets;
-    /**
-     * Rewrite this {clearPaint} function under DrawToolCore
-     */
-    clearPaint(): void;
-    /**
-     * Rewrite this {undoLastPainting} function under DrawToolCore
-     */
-    undoLastPainting(): void;
-    /**
-     * Rewrite this {redoLastPainting} function under DrawToolCore
-     */
-    redoLastPainting(): void;
-    /**
-     * Rewrite this {clearStoreImages} function under NrrdTools
-     */
-    clearStoreImages(): void;
-    /**
-     * Rewrite this {resizePaintArea} function under NrrdTools
-     */
-    resizePaintArea(factor: number): void;
-    /**
-     * Rewrite this {setIsDrawFalse} function under NrrdTools
-     */
-    setIsDrawFalse(target: number): void;
-    /**
-     * Rewrite this {updateOriginAndChangedWH} function under NrrdTools
-     */
-    updateOriginAndChangedWH(): void;
-    /**
-     * Rewrite this {flipDisplayImageByAxis} function under NrrdTools
-     */
-    flipDisplayImageByAxis(): void;
-    /**
-     * Rewrite this {resetPaintAreaUIPosition} function under NrrdTools
-     */
-    resetPaintAreaUIPosition(l?: number, t?: number): void;
-    /**
-     * Rewrite this {resetPaintAreaUIPosition} function under NrrdTools
-     */
-    setEmptyCanvasSize(axis?: "x" | "y" | "z"): void;
-    /**
-     * Rewrite this {convertCursorPoint} function under NrrdTools
-     */
-    convertCursorPoint(from: "x" | "y" | "z", to: "x" | "y" | "z", cursorNumX: number, cursorNumY: number, currentSliceIndex: number): IConvertObjType | undefined;
-    /**
-     * Rewrite this {resetLayerCanvas} function under NrrdTools
-     */
-    resetLayerCanvas(): void;
-    /**
-     * Rewrite this {setSyncsliceNum} function under NrrdTools
-     */
-    setSyncsliceNum(): void;
-    /**
-     * Rewrite this {redrawDisplayCanvas} function under NrrdTools
-     */
-    redrawDisplayCanvas(): void;
-    /**
-     * Get a painted mask image based on current axis and input slice index.
-     *
-     * Phase 3: Reads directly from MaskVolume.
-     *
-     * @param axis "x" | "y" | "z"
-     * @param sliceIndex number
-     * @returns Object with index and image, or undefined
-     */
-    filterDrawedImage(axis: "x" | "y" | "z", sliceIndex: number): {
-        index: number;
-        image: ImageData;
-    } | undefined;
-    /**
-     * Get or create a reusable ImageData buffer for the given axis.
-     *
-     * Reuses the same buffer across multiple slice renders to avoid
-     * allocating a new ImageData per layer per slice switch.
-     * The buffer is only reallocated when slice dimensions change (axis switch).
-     *
-     * @param axis - Axis: "x", "y", or "z"
-     * @returns Reusable ImageData buffer with correct dimensions
-     */
-    getOrCreateSliceBuffer(axis: "x" | "y" | "z"): ImageData | null;
-    /**
-     * Render a layer's slice into a reusable buffer and draw to the target canvas.
-     *
-     * Uses MaskVolume.renderLabelSliceInto() for zero-allocation rendering.
-     * The caller should obtain the buffer via getOrCreateSliceBuffer() and reuse
-     * it across multiple layer renders.
-     *
-     * @param layer - Layer name: "layer1", "layer2", or "layer3"
-     * @param axis - Axis: "x", "y", or "z"
-     * @param sliceIndex - Slice index
-     * @param buffer - Reusable ImageData buffer (from getOrCreateSliceBuffer)
-     * @param targetCtx - Canvas context to draw the result onto
-     * @param scaledWidth - Target display width
-     * @param scaledHeight - Target display height
-     */
-    renderSliceToCanvas(layer: string, axis: "x" | "y" | "z", sliceIndex: number, buffer: ImageData, targetCtx: CanvasRenderingContext2D, scaledWidth: number, scaledHeight: number): void;
-    /**
-     * Invalidate the reusable buffer (e.g. when switching datasets).
-     * The buffer will be lazily recreated on next use.
-     */
-    invalidateSliceBuffer(): void;
-    /**
-     * Apply the same flip transform used by flipDisplayImageByAxis() to any
-     * canvas context.  This ensures mask overlays align with the flipped CT image.
-     *
-     * The flip is its own inverse (applying twice = identity), so it works for
-     * both directions: volume→display (rendering) and display→volume (storing).
-     *
-     * @param ctx    Target 2D context (must be wrapped in save/restore by caller).
-     * @param width  Canvas width in pixels.
-     * @param height Canvas height in pixels.
-     * @param axis   Current viewing axis.
-     */
-    applyMaskFlipForAxis(ctx: CanvasRenderingContext2D, width: number, height: number, axis: "x" | "y" | "z"): void;
-    /**
-     * Composite all layer canvases to the master display canvas.
-     * Only draws layers whose visibility is enabled.
-     */
-    compositeAllLayers(): void;
-}

package/dist/types/Utils/segmentation/core/MigrationUtils.d.ts

@@ -1,97 +0,0 @@
-/**
- * Migration Utilities for MaskVolume
- *
- * Provides bidirectional conversion between the legacy per-slice
- * ImageData storage (`IPaintImages`) and the new contiguous 3D
- * volumetric storage (`MaskVolume`).
- *
- * These utilities enable:
- *  - **Forward migration**: Import existing annotation data into MaskVolume.
- *  - **Rollback compatibility**: Export MaskVolume back to IPaintImages.
- *
- * @example
- * ```ts
- * // Forward: legacy → volume
- * const volume = convertIPaintImagesToVolume(paintImages, { width: 512, height: 512, depth: 100 });
- *
- * // Backward: volume → legacy
- * const legacy = convertVolumeToIPaintImages(volume);
- * ```
- */
-import type { Dimensions } from './types';
-import { MaskVolume } from './MaskVolume';
-/**
- * A single painted slice (legacy format).
- */
-export interface IPaintImage {
-    index: number;
-    image: ImageData;
-}
-/**
- * Per-axis collection of painted slices (legacy format).
- */
-export interface IPaintImages {
-    x: IPaintImage[];
-    y: IPaintImage[];
-    z: IPaintImage[];
-}
-/**
- * Convert legacy per-slice ImageData storage into a MaskVolume.
- *
- * The function iterates over all three axes (`x`, `y`, `z`) and inserts
- * each slice into the volume using `setSliceFromImageData`.
- *
- * **Sparse data handling**: Slices that are absent from the arrays are
- * left as zero (the MaskVolume default). Duplicate indices are
- * overwritten in order (last wins).
- *
- * @param paintImages Legacy per-axis slice collection.
- * @param dimensions  Volume dimensions (must match the ImageData sizes).
- * @param channel     Target channel in the volume (default 0).
- *
- * @returns A new MaskVolume populated with the legacy data.
- *
- * @throws {Error} If a slice's ImageData dimensions don't match the
- *                 expected size for its axis.
- *
- * @example
- * ```ts
- * const volume = convertIPaintImagesToVolume(
- *   maskData.paintImagesLayer1,
- *   { width: 512, height: 512, depth: 100 },
- * );
- * ```
- */
-export declare function convertIPaintImagesToVolume(paintImages: IPaintImages, dimensions: Dimensions, channel?: number): MaskVolume;
-/**
- * Convert a MaskVolume back to legacy per-slice ImageData storage.
- *
- * Extracts **all** slices along the Z axis (axial) into an
- * `IPaintImages` structure. X and Y axes are left as empty arrays
- * since the legacy system can reconstruct them on demand.
- *
- * Only non-empty slices (those containing at least one non-zero pixel)
- * are included, matching the sparse behaviour of the original storage.
- *
- * @param volume  The MaskVolume to export.
- * @param channel Channel to extract (default 0).
- * @param options Export options.
- * @param options.includeAllAxes If true, also export X and Y axis slices
- *                               (expensive — use only if needed for full
- *                               backward compatibility). Default: false.
- * @param options.includeEmpty   If true, include slices that are entirely
- *                               zero. Default: false.
- *
- * @returns A legacy IPaintImages structure.
- *
- * @example
- * ```ts
- * const legacy = convertVolumeToIPaintImages(volume);
- * // legacy.z contains non-empty axial slices
- * // legacy.x and legacy.y are empty by default
- * ```
- */
-export declare function convertVolumeToIPaintImages(volume: MaskVolume, channel?: number, options?: {
-    includeAllAxes?: boolean;
-    includeEmpty?: boolean;
-}): IPaintImages;

package/dist/types/Utils/segmentation/coreTools/coreType.d.ts

@@ -1,363 +0,0 @@
-interface ICommXYZ {
-    x: any;
-    y: any;
-    z: any;
-}
-interface ICommXY {
-    x: any;
-    y: any;
-}
-interface ISkipSlicesDictType {
-    [key: string]: any;
-}
-interface IDownloadImageConfig {
-    axis: "x" | "y" | "z";
-    currentIndex: number;
-    drawingCanvas: HTMLCanvasElement;
-    originWidth: number;
-    originHeight: number;
-}
-interface IConvertObjType {
-    currentIndex: number;
-    oldIndex: number;
-    convertCursorNumX: number;
-    convertCursorNumY: number;
-}
-interface IDragPrameters {
-    move: number;
-    y: number;
-    h: number;
-    sensivity: number;
-    handleOnDragMouseUp: (ev: MouseEvent) => void;
-    handleOnDragMouseDown: (ev: MouseEvent) => void;
-    handleOnDragMouseMove: (ev: MouseEvent) => void;
-}
-interface IDrawingEvents {
-    handleOnDrawingMouseDown: (ev: MouseEvent) => void;
-    handleOnDrawingMouseMove: (ev: MouseEvent) => void;
-    handleOnPanMouseMove: (ev: MouseEvent) => void;
-    handleOnDrawingMouseUp: (ev: MouseEvent) => void;
-    handleOnDrawingMouseLeave: (ev: MouseEvent) => void;
-    handleOnDrawingBrushCricleMove: (ev: MouseEvent) => void;
-    handleMouseZoomSliceWheel: (e: WheelEvent) => void;
-    handleSphereWheel: (e: WheelEvent) => void;
-}
-interface IContrastEvents {
-    move_x: number;
-    move_y: number;
-    x: number;
-    y: number;
-    w: number;
-    h: number;
-    handleOnContrastMouseDown: (ev: MouseEvent) => void;
-    handleOnContrastMouseMove: (ev: MouseEvent) => void;
-    handleOnContrastMouseUp: (ev: MouseEvent) => void;
-    handleOnContrastMouseLeave: (ev: MouseEvent) => void;
-}
-interface IPaintImages {
-    x: Array<IPaintImage>;
-    y: Array<IPaintImage>;
-    z: Array<IPaintImage>;
-}
-interface IPaintImage {
-    index: number;
-    image: ImageData;
-}
-/**
- * Import MaskVolume from core module
- * (imported where needed, not here to avoid circular deps)
- */
-type MaskVolume = any;
-/**
- * New mask data structure using MaskVolume for true 3D storage.
- * Dynamic N-layer support: keyed by layer id (e.g. 'layer1', 'layer2', ...).
- */
-type INewMaskData = Record<string, MaskVolume>;
-/**
- * A paired canvas + 2D context for a single annotation layer.
- * Stored atomically in IProtected.layerTargets to prevent canvas/ctx desync.
- */
-interface ILayerRenderTarget {
-    canvas: HTMLCanvasElement;
-    ctx: CanvasRenderingContext2D;
-}
-/**
- * Mask data storage using volumetric MaskVolume (Phase 3)
- *
- * Phase 2 legacy ImageData storage has been removed.
- * All mask data now stored in 3D volumes for memory efficiency.
- */
-type IMaskData = {
-    volumes: INewMaskData;
-};
-interface IProtected {
-    container: HTMLElement;
-    mainAreaContainer: HTMLElement;
-    allSlicesArray: Array<ICommXYZ>;
-    displaySlices: Array<any>;
-    backUpDisplaySlices: Array<any>;
-    skipSlicesDic: ISkipSlicesDictType;
-    currentShowingSlice: any;
-    mainPreSlices: any;
-    Is_Draw: boolean;
-    axis: "x" | "y" | "z";
-    maskData: IMaskData;
-    previousDrawingImage?: ImageData;
-    /** Dynamic per-layer canvas+ctx pairs. Replaces hardcoded LayerOne/Two/Three fields. */
-    layerTargets: Map<string, ILayerRenderTarget>;
-    canvases: {
-        originCanvas: HTMLCanvasElement | any;
-        drawingCanvas: HTMLCanvasElement;
-        displayCanvas: HTMLCanvasElement;
-        drawingCanvasLayerMaster: HTMLCanvasElement;
-        drawingSphereCanvas: HTMLCanvasElement;
-        emptyCanvas: HTMLCanvasElement;
-    };
-    ctxes: {
-        displayCtx: CanvasRenderingContext2D;
-        drawingCtx: CanvasRenderingContext2D;
-        emptyCtx: CanvasRenderingContext2D;
-        drawingSphereCtx: CanvasRenderingContext2D;
-        drawingLayerMasterCtx: CanvasRenderingContext2D;
-    };
-}
-interface IGUIStates {
-    mainAreaSize: number;
-    dragSensitivity: number;
-    Eraser: boolean;
-    globalAlpha: number;
-    lineWidth: number;
-    color: string;
-    pencil: boolean;
-    fillColor: string;
-    brushColor: string;
-    brushAndEraserSize: number;
-    cursor: string;
-    layer: string;
-    cal_distance: "tumour" | "skin" | "nipple" | "ribcage";
-    sphere: boolean;
-    calculator: boolean;
-    readyToUpdate: boolean;
-    defaultPaintCursor: string;
-    max_sensitive: number;
-    clear: () => void;
-    clearAll: () => void;
-    undo: () => void;
-    redo: () => void;
-    downloadCurrentMask: () => void;
-    resetZoom: () => void;
-    /** Currently active channel (1-8). Channel 0 is transparent/erased. */
-    activeChannel: number;
-    /** Layer visibility state: { layer1: true, layer2: true, layer3: true } */
-    layerVisibility: Record<string, boolean>;
-    /** Per-layer channel visibility: { layer1: { 1: true, ..., 8: true }, ... } */
-    channelVisibility: Record<string, Record<number, boolean>>;
-}
-interface IKeyBoardSettings {
-    draw: string;
-    undo: string;
-    redo: string;
-    contrast: string[];
-    crosshair: string;
-    mouseWheel: "Scroll:Zoom" | "Scroll:Slice";
-}
-interface INrrdStates {
-    originWidth: number;
-    originHeight: number;
-    nrrd_x_mm: number;
-    nrrd_y_mm: number;
-    nrrd_z_mm: number;
-    nrrd_x_pixel: number;
-    nrrd_y_pixel: number;
-    nrrd_z_pixel: number;
-    changedWidth: number;
-    changedHeight: number;
-    oldIndex: number;
-    currentIndex: number;
-    maxIndex: number;
-    minIndex: number;
-    RSARatio: number;
-    voxelSpacing: number[];
-    spaceOrigin: number[];
-    dimensions: number[];
-    loadMaskJson: boolean;
-    ratios: ICommXYZ;
-    contrastNum: number;
-    showContrast: boolean;
-    isCursorSelect: boolean;
-    cursorPageX: number;
-    cursorPageY: number;
-    sphereOrigin: ICommXYZ;
-    tumourSphereOrigin: ICommXYZ | null;
-    skinSphereOrigin: ICommXYZ | null;
-    ribSphereOrigin: ICommXYZ | null;
-    nippleSphereOrigin: ICommXYZ | null;
-    tumourColor: "#00ff00";
-    skinColor: "#FFEB3B";
-    ribcageColor: "#2196F3";
-    nippleColor: "#E91E63";
-    spherePlanB: boolean;
-    sphereRadius: number;
-    Mouse_Over_x: number;
-    Mouse_Over_y: number;
-    Mouse_Over: boolean;
-    stepClear: number;
-    sizeFoctor: number;
-    clearAllFlag: boolean;
-    previousPanelL: number;
-    previousPanelT: number;
-    switchSliceFlag: boolean;
-    layers: string[];
-    getMask: (sliceData: Uint8Array, layerId: string, channelId: number, sliceIndex: number, axis: "x" | "y" | "z", width: number, height: number, clearFlag: boolean) => void;
-    onClearLayerVolume: (layerId: string) => void;
-    onChannelColorChanged: (layerId: string, channel: number, color: {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    }) => void;
-    getSphere: (sphereOrigin: number[], sphereRadius: number) => void;
-    getCalculateSpherePositions: (tumourSphereOrigin: ICommXYZ | null, skinSphereOrigin: ICommXYZ | null, ribSphereOrigin: ICommXYZ | null, nippleSphereOrigin: ICommXYZ | null, aixs: "x" | "y" | "z") => void;
-    drawStartPos: ICommXY;
-}
-interface IDragOpts {
-    showNumber?: boolean;
-    getSliceNum?: (index: number, contrastNum: number) => void;
-}
-interface IDrawOpts {
-    getMaskData?: (sliceData: Uint8Array, layerId: string, channelId: number, sliceIndex: number, axis: "x" | "y" | "z", width: number, height: number, clearFlag?: boolean) => void;
-    onClearLayerVolume?: (layerId: string) => void;
-    getSphereData?: (sphereOrigin: number[], sphereRadius: number) => void;
-    getCalculateSpherePositionsData?: (tumourSphereOrigin: ICommXYZ | null, skinSphereOrigin: ICommXYZ | null, ribSphereOrigin: ICommXYZ | null, nippleSphereOrigin: ICommXYZ | null, aixs: "x" | "y" | "z") => void;
-}
-interface ICursorPage {
-    x: {
-        cursorPageX: number;
-        cursorPageY: number;
-        index: number;
-        updated: boolean;
-    };
-    y: {
-        cursorPageX: number;
-        cursorPageY: number;
-        index: number;
-        updated: boolean;
-    };
-    z: {
-        cursorPageX: number;
-        cursorPageY: number;
-        index: number;
-        updated: boolean;
-    };
-}
-interface IGuiParameterSettings {
-    globalAlpha: {
-        name: "Opacity";
-        min: number;
-        max: number;
-        step: number;
-    };
-    pencil: {
-        name: "Pencil";
-        onChange: () => void;
-    };
-    sphere: {
-        name: "Sphere";
-        onChange: () => void;
-    };
-    brushAndEraserSize: {
-        name: "BrushAndEraserSize";
-        min: number;
-        max: number;
-        step: number;
-        onChange: () => void;
-    };
-    Eraser: {
-        name: "Eraser";
-        onChange: () => void;
-    };
-    calculator: {
-        name: "Calculator";
-        onChange: () => void;
-    };
-    cal_distance: {
-        name: "CalculatorDistance";
-        onChange: (val: "tumour" | "skin" | "ribcage" | "nipple") => void;
-    };
-    clear: {
-        name: "Clear";
-    };
-    clearAll: {
-        name: "ClearAll";
-    };
-    undo: {
-        name: "Undo";
-    };
-    redo: {
-        name: "Redo";
-    };
-    resetZoom: {
-        name: "ResetZoom";
-    };
-    windowHigh: {
-        name: "ImageContrast";
-        value: null;
-        min: number;
-        max: number;
-        step: number;
-        onChange: (value: number) => void;
-        onFinished: () => void;
-    };
-    windowLow: {
-        name: "WindowLow";
-        value: null;
-        min: number;
-        max: number;
-        step: number;
-        onChange: (value: number) => void;
-        onFinished: () => void;
-    };
-    advance: {
-        layer: {
-            name: "Layer";
-            value: string[];
-        };
-        cursor: {
-            name: "CursorIcon";
-            value: ["crosshair", "pencil", "dot"];
-        };
-        mainAreaSize: {
-            name: "Zoom";
-            min: number;
-            max: number;
-            step: number;
-            onFinished: null;
-        };
-        dragSensitivity: {
-            name: "DragSensitivity";
-            min: number;
-            max: number;
-            step: number;
-        };
-        pencilSettings: {
-            lineWidth: {
-                name: "OuterLineWidth";
-                min: number;
-                max: number;
-                step: number;
-            };
-            color: {
-                name: "Color";
-            };
-            fillColor: {
-                name: "FillColor";
-            };
-        };
-        BrushSettings: {
-            brushColor: {
-                name: "BrushColor";
-            };
-        };
-    };
-}
-export { ICommXYZ, ICommXY, IDownloadImageConfig, IConvertObjType, IDragPrameters, IDrawingEvents, IContrastEvents, IProtected, IGUIStates, IDragOpts, IDrawOpts, INrrdStates, IPaintImage, IPaintImages, ISkipSlicesDictType, IMaskData, INewMaskData, ILayerRenderTarget, ICursorPage, IGuiParameterSettings, IKeyBoardSettings };