larvitar 2.0.5 → 2.0.7

package/imaging/tools/interaction.ts

@@ -1,266 +0,0 @@
-/** @module imaging/tools/interaction
- *  @desc  This file provides functionalities for
- *         tools interactions
- */
-
-// external libraries
-import { throttle } from "lodash";
-import * as keyCodes from "keycode-js";
-import cornerstone from "cornerstone-core";
-import cornerstoneTools from "cornerstone-tools";
-
-// internal libraries
-import { DEFAULT_MOUSE_KEYS } from "./default";
-import { setToolActive } from "./main";
-import { isElement } from "../imageUtils";
-import store, { set as setStore } from "../imageStore";
-import { updateViewportData } from "../imageRendering";
-import type { ToolMouseKeys } from "./types";
-
-/**
- * TOOLS INTERACTIONS TODOS:
- * - enable touch controls
- * - rework active tools / ui labels sync (we can get all active tools from cornerstoneTools state, then check the button / input method to update the correct label, or update all props scale, translation and voi)
- * - use config to setup all interactions (mouse left/right, keyboard shortcuts, touch inputs)
- */
-
-/**
- * Global event callbacks
- */
-let onKeyDownFn: ((evt: KeyboardEvent) => void) | null = null;
-let onKeyUpFn: ((evt: KeyboardEvent) => void) | null = null;
-
-/**
- * Setup mouse handler modifiers and keyboard shortcuts:
- * register a tool on right button and another one
- * when pressing a modifier (ctrl/shift/alt) + right button
- * The activation take place on all active viewports (we added a check to activate only on viewports
- * in which the tool has been added previously)
- * Improvements could be:
- * - "restore previous active tool" instead of passed "default" tool
- * - manage left button (an idea could be to cycle over object keys for both buttons)
- * - possibility to change modifier keys
- * @param {Object} config - see tools/default
- */
-
-export function addMouseKeyHandlers(config: ToolMouseKeys) {
-  if (!config) {
-    config = DEFAULT_MOUSE_KEYS;
-  }
-
-  if (onKeyDownFn) {
-    document.removeEventListener("keydown", onKeyDownFn);
-  }
-  if (onKeyUpFn) {
-    document.removeEventListener("keyup", onKeyUpFn);
-  }
-
-  // Prevent context menu on right click
-  document.addEventListener("contextmenu", evt => {
-    evt.preventDefault();
-    return false;
-  });
-
-  // get all enabled viewports. Then, filter only viewport in which the target tool had been added previously.
-  let allViewports = cornerstone.getEnabledElements().map(enel => enel.element);
-
-  // Define behaviour on key down: activate registered tool
-  function onKeyDown(evt: KeyboardEvent) {
-    // keyboard shortcuts (activate on left mouse button)
-    let codes = config.keyboard_shortcuts
-      ? Object.keys(config.keyboard_shortcuts).map(
-          // @ts-ignore
-          key => keyCodes[key]
-        )
-      : [];
-
-    if (codes.includes(evt.keyCode) && evt.altKey) {
-      evt.preventDefault(); // avoid browser menu selections
-
-      let key = Object.keys(config.keyboard_shortcuts)
-        // @ts-ignore
-        .filter(key => keyCodes[key] == evt.keyCode) // TODO keyCode is deprecated
-        .pop();
-
-      if (!key) {
-        console.warn("Key not found in config.keyboard_shortcuts");
-        return;
-      }
-
-      let toolName = config.keyboard_shortcuts[key];
-
-      if (config.debug) console.log("active", toolName);
-
-      const viewports = allViewports.filter(viewport =>
-        cornerstoneTools.getToolForElement(viewport, toolName)
-      );
-
-      setToolActive(
-        toolName,
-        { mouseButtonMask: 1 },
-        viewports.map(v => v.id)
-      );
-
-      document.addEventListener("keydown", onKeyDown, { once: true });
-    }
-    // right drag + shift
-    else if (
-      config.mouse_button_right &&
-      config.mouse_button_right.shift &&
-      evt.keyCode == keyCodes.KEY_SHIFT
-    ) {
-      if (config.debug) console.log("active", config.mouse_button_right.shift);
-      const viewports = allViewports.filter(viewport =>
-        cornerstoneTools.getToolForElement(
-          viewport,
-          config.mouse_button_right.shift
-        )
-      );
-
-      setToolActive(
-        config.mouse_button_right.shift,
-        { mouseButtonMask: 2 },
-        viewports.map(v => v.id)
-      );
-      document.addEventListener("keyup", onKeyUp, { once: true });
-    }
-    // right drag + ctrl
-    else if (
-      config.mouse_button_right &&
-      config.mouse_button_right.ctrl &&
-      evt.keyCode == keyCodes.KEY_CONTROL
-    ) {
-      if (config.debug) console.log("active", config.mouse_button_right.ctrl);
-      const viewports = allViewports.filter(viewport =>
-        cornerstoneTools.getToolForElement(
-          viewport,
-          config.mouse_button_right.ctrl
-        )
-      );
-
-      setToolActive(
-        config.mouse_button_right.ctrl,
-        { mouseButtonMask: 2 },
-        viewports.map(v => v.id)
-      );
-      document.addEventListener("keyup", onKeyUp, { once: true });
-    }
-    // leave default
-    else {
-      document.addEventListener("keydown", onKeyDown, { once: true });
-      return;
-    }
-  }
-
-  // Define behaviour on key up: restore original tool
-  function onKeyUp(e: KeyboardEvent) {
-    if (config.debug)
-      console.log("active default", config.mouse_button_right.default);
-    const viewports = allViewports.filter(viewport =>
-      cornerstoneTools.getToolForElement(
-        viewport,
-        config.mouse_button_right.default
-      )
-    );
-    setToolActive(
-      config.mouse_button_right.default,
-      { mouseButtonMask: 2 },
-      viewports.map(v => v.id)
-    );
-    document.addEventListener("keydown", onKeyDown, { once: true });
-  }
-
-  // activate default on mouse right, if any
-  if (config.mouse_button_right && config.mouse_button_right.default) {
-    const viewports = allViewports.filter(viewport =>
-      cornerstoneTools.getToolForElement(
-        viewport,
-        config.mouse_button_right.default
-      )
-    );
-    setToolActive(
-      config.mouse_button_right.default,
-      { mouseButtonMask: 2 },
-      viewports.map(v => v.id)
-    );
-  }
-
-  // activate default on mouse left, if any
-  if (config.mouse_button_left && config.mouse_button_left.default) {
-    const viewports = allViewports.filter(viewport =>
-      cornerstoneTools.getToolForElement(
-        viewport,
-        config.mouse_button_left.default
-      )
-    );
-    setToolActive(
-      config.mouse_button_left.default,
-      { mouseButtonMask: 1 },
-      viewports.map(v => v.id)
-    );
-  }
-
-  document.addEventListener("keydown", onKeyDown, { once: true });
-
-  onKeyDownFn = onKeyDown;
-  onKeyUpFn = onKeyUp;
-}
-
-/**
- *
- */
-export function removeMouseKeyHandlers() {
-  if (!onKeyDownFn) return;
-  document.removeEventListener("keydown", onKeyDownFn);
-  onKeyDownFn = null;
-  onKeyUpFn = null;
-}
-
-/**
- * Add event handlers to mouse move
- * @instance
- * @function toggleMouseHandlers
- * @param {String | HTMLElement} elementId - The html div id used for rendering or its DOM HTMLElement
- * @param {Boolean} disable - If true disable handlers, default is false
- */
-export const toggleMouseToolsListeners = function (
-  elementId: string | HTMLElement,
-  disable: boolean
-) {
-  let element = isElement(elementId)
-    ? (elementId as HTMLElement)
-    : document.getElementById(elementId as string);
-  if (!element) {
-    console.error("invalid html element: " + elementId);
-    return;
-  }
-
-  // mouse move handler (throttled)
-  let mouseMoveHandler = throttle(function (evt) {
-    let activeTool =
-      evt.detail.buttons == 1
-        ? store.get("leftActiveTool")
-        : store.get("rightActiveTool");
-    updateViewportData(evt.srcElement.id, evt.detail.viewport, activeTool);
-  }, 250);
-
-  // mouse wheel handler
-  function mouseWheelHandler(evt: any) {
-    // TODO-ts fix type (should be a cornerstoneTools event type)
-    // @mronzoni does cornerstoneTools have a type for this event?
-    setStore(["sliceId", evt.target.id, evt.detail.newImageIdIndex]);
-    updateViewportData(evt.srcElement.id, evt.detail, "mouseWheel");
-  }
-
-  if (disable) {
-    element.removeEventListener("cornerstonetoolsmousedrag", mouseMoveHandler);
-    element.removeEventListener(
-      "cornerstonetoolsstackscroll",
-      mouseWheelHandler
-    );
-    return;
-  }
-
-  element.addEventListener("cornerstonetoolsmousedrag", mouseMoveHandler);
-  element.addEventListener("cornerstonetoolsstackscroll", mouseWheelHandler);
-};

package/imaging/tools/io.ts

@@ -1,229 +0,0 @@
-/** @module imaging/tools/io
- *  @desc  This file provides functionalities for
- *         tools input/output
- */
-
-// external libraries
-import cornerstone from "cornerstone-core";
-import cornerstoneTools from "cornerstone-tools";
-import { each, map, assign, invert } from "lodash";
-import { unparse } from "papaparse";
-
-// internal libraries
-import { setToolEnabled } from "./main";
-import type { ToolState } from "./types";
-import { fileManager } from "../loaders/fileLoader";
-
-declare global {
-  interface Document {
-    documentMode?: any;
-  }
-  interface Navigator {
-    msSaveBlob?: (blob: any, defaultName?: string) => boolean;
-  }
-}
-
-/**
- * Load annotation from json object
- * @param {Object} jsonData - The previously saved tools state
- */
-export const loadAnnotations = function (jsonData: ToolState) {
-  // restore saved tool state
-  cornerstoneTools.globalImageIdSpecificToolStateManager.restoreToolState(
-    jsonData
-  );
-
-  // set all found tools to passive
-  let toolsInState: Set<string> = new Set();
-  for (let imageId in jsonData) {
-    for (let toolName in jsonData[imageId]) {
-      toolsInState.add(toolName);
-    }
-  }
-
-  toolsInState.forEach(toolName => {
-    // TODO-ts fix 'null' this after setToolEnabled is typed @mronzoni
-    setToolEnabled(toolName);
-  });
-
-  let enabledElementIds = map(
-    cornerstone.getEnabledElements(),
-    e => e.element.id
-  );
-
-  // FIXME error if called when image is not loaded
-  for (let elementId of enabledElementIds) {
-    let element = document.getElementById(elementId);
-    if (!element) {
-      console.warn(`Element ${elementId} not found`);
-      continue;
-    }
-    cornerstone.updateImage(element);
-  }
-};
-
-/**
- * Save annotations from current stack, download as json file if requested
- * @param {bool} download - True to download json
- * @param {string} filename - The json file name, @default state.json
- */
-export const saveAnnotations = function (
-  download: boolean,
-  filename = "state.json"
-) {
-  let currentToolState =
-    cornerstoneTools.globalImageIdSpecificToolStateManager.saveToolState();
-  if (download) {
-    // Convert JSON Array to string.
-    var json_string = JSON.stringify(currentToolState);
-    downloadFile(json_string, filename);
-  }
-
-  return currentToolState;
-};
-
-/**
- * Save annotation from current stack, download as csv file
- * containing only useful informations for user
- */
-export const exportAnnotations = function (
-  manager: typeof fileManager,
-  filename = "annotations.csv"
-) {
-  let currentToolState =
-    cornerstoneTools.globalImageIdSpecificToolStateManager.saveToolState();
-  let { fieldsArr: fields, data } = generateCSV(manager, currentToolState);
-  let csvstring = unparse({ fields, data });
-  downloadFile(csvstring, filename);
-};
-
-/**
- *
- * @param {*} stringContent
- * @param {*} filename
- */
-function downloadFile(stringContent: string, filename: string) {
-  // Convert string to BLOB.
-  var blob = new Blob([stringContent], { type: "text/plain;charset=utf-8" });
-  //Check the Browser.
-  var isIE = false || !!document.documentMode;
-  if (isIE && window.navigator.msSaveBlob) {
-    window.navigator.msSaveBlob(blob, filename);
-  } else {
-    var url = window.URL || window.webkitURL;
-    let link = url.createObjectURL(blob);
-    var a = document.createElement("a");
-    a.download = filename;
-    a.href = link;
-    document.body.appendChild(a);
-    a.click();
-    document.body.removeChild(a);
-  }
-}
-
-/**
- *
- * @param {*} allToolState
- */
-export function generateCSV(
-  manager: typeof fileManager,
-  allToolState: ToolState
-) {
-  let fields: Set<string> = new Set();
-  fields.add("imagePath");
-  fields.add("toolName");
-  let data: Object[] = [];
-  each(allToolState, (imageToolState, imageId) => {
-    // convert imageId to imagePath
-    let imagePath = invert(manager)[imageId];
-    each(imageToolState, (toolState, toolName) => {
-      // extract useful information from tool state
-      let extractedData = extractToolInfo(toolName, toolState.data);
-      each(extractedData, singledata => {
-        data.push(assign({ imagePath, toolName }, singledata));
-        // add all keys into fields set
-        each(Object.keys(singledata), k => fields.add(k));
-      });
-    });
-  });
-
-  let fieldsArr: string[] = Array.from(fields);
-
-  return {
-    fieldsArr,
-    data
-  };
-}
-
-/**
- *
- * @param {*} toolData
- */
-function extractToolInfo(
-  toolName: string,
-  toolData: ToolState["imageId"][keyof ToolState["imageId"]]
-) {
-  let dataArray: Object[] = [];
-  switch (toolName) {
-    case "RectangleRoi":
-    case "EllipticalRoi":
-      // This is an example for "length" tool, needs to be generalised
-      dataArray = map(toolData, data => {
-        return {
-          color: data.color,
-          x1: data.handles.start.x,
-          y1: data.handles.start.y,
-          x2: data.handles.end.x,
-          y2: data.handles.end.y,
-          length: data.length,
-          unit: data.unit,
-          textBox_x: data.textBox ? data.textBox.x : null,
-          textBox_y: data.textBox ? data.textBox.y : null,
-          boundingBox_w: data.textBox ? data.textBox.boundingBox.width : null,
-          boundingBox_h: data.textBox ? data.textBox.boundingBox.height : null,
-          boundingBox_l: data.textBox ? data.textBox.boundingBox.left : null,
-          boundingBox_t: data.textBox ? data.textBox.boundingBox.top : null
-        };
-      });
-      break;
-    case "FreehandRoi":
-      dataArray = map(toolData, data => {
-        return {
-          color: data.color,
-          // TODO how to export arrays ?
-          // x: map(data.handles.points, "x"),
-          // y: map(data.handles.points, "y"),
-          length: data.length,
-          unit: data.unit,
-          textBox_x: data.textBox ? data.textBox.x : null,
-          textBox_y: data.textBox ? data.textBox.y : null,
-          polyBoundingBox_h: data.polyBoundingBox.height,
-          polyBoundingBox_l: data.polyBoundingBox.left,
-          polyBoundingBox_t: data.polyBoundingBox.top,
-          polyBoundingBox_w: data.polyBoundingBox.width
-        };
-      });
-      break;
-    case "ArrowAnnotate":
-      dataArray = map(toolData, data => {
-        return {
-          color: data.color ? data.color : null,
-          text: data.text,
-          x1: data.handles.start.x,
-          y1: data.handles.start.y,
-          x2: data.handles.end.x,
-          y2: data.handles.end.y,
-          textBox_x: data.textBox ? data.textBox.x : null,
-          textBox_y: data.textBox ? data.textBox.y : null,
-          boundingBox_w: data.textBox ? data.textBox.boundingBox.width : null,
-          boundingBox_h: data.textBox ? data.textBox.boundingBox.height : null,
-          boundingBox_l: data.textBox ? data.textBox.boundingBox.left : null,
-          boundingBox_t: data.textBox ? data.textBox.boundingBox.top : null
-        };
-      });
-      break;
-    default:
-  }
-
-  return dataArray;
-}