larvitar 1.5.13 → 2.0.0

package/imaging/imageStore.js

@@ -1,322 +0,0 @@
-/** @module imaging/imageStore
- *  @desc This file provides functionalities
- *        for data config store.
- */
-
-import { defineVue } from "../modules/vuex/larvitar";
-import larvitar from "../modules/vuex/larvitar";
-
-// external libraries
-import { get as _get } from "lodash";
-
-// default viewport store object
-const DEFAULT_VIEWPORT = {
-  loading: 0, // from 0 to 100 (%)
-  ready: false, // true when currentImageId is rendered
-  minSliceId: 0,
-  maxSliceId: 0,
-  sliceId: 0,
-  minTimeId: 0,
-  maxTimeId: 0,
-  timeId: 0,
-  timestamp: 0,
-  timestamps: [],
-  timeIds: [],
-  rows: 0,
-  cols: 0,
-  spacing_x: 0.0,
-  spacing_y: 0.0,
-  thickness: 0.0,
-  minPixelValue: 0,
-  maxPixelValue: 0,
-  isColor: false,
-  isMultiframe: false,
-  isTimeserie: false,
-  isPDF: false,
-  viewport: {
-    scale: 0.0,
-    rotation: 0.0,
-    translation: {
-      x: 0.0,
-      y: 0.0
-    },
-    voi: {
-      windowCenter: 0.0,
-      windowWidth: 0.0
-    }
-  },
-  default: {
-    scale: 0.0,
-    rotation: 0.0,
-    translation: {
-      x: 0.0,
-      y: 0.0
-    },
-    rotation: 0.0,
-    voi: {
-      windowCenter: 0.0,
-      windowWidth: 0.0
-    }
-  }
-};
-
-/**
- * The Larvitar Internal Store
- */
-export let larvitar_store = null;
-
-/** Class representing the Larvitar Store. */
-class Larvitar_Store {
-  /**
-   * Create the Larvitar Store
-   * @param {Obj} vuex_store - The Vuex store
-   * @param {String} vuex_module - The name of the vuex store module, can be null
-   */
-  constructor(vuex_store, vuex_module) {
-    this.VUEX_STORE = vuex_store ? true : false;
-    this.vuex_store = vuex_store;
-    this.vuex_module = vuex_module;
-    this.state = {
-      series: {}, // seriesUID: {imageIds:[], progress:value}
-      leftActiveTool: "Wwwc",
-      rightActiveTool: "Zoom",
-      colormapId: "gray",
-      viewports: {},
-      errorLog: null,
-      temp: {}
-    };
-  }
-
-  /**
-   * Enable the VUEX storage method
-   * @function enableVuex
-   * @param {String} vuex_module - The name of the vuex store module, can be null
-   */
-  enableVuex(vuex_module) {
-    // VUEX IS ENABLED BY DEFAULT
-    this.VUEX_STORE = true;
-    this.vuex_module = vuex_module;
-  }
-
-  /**
-   * Disable the VUEX storage method
-   * @function disableVuex
-   */
-  disableVuex() {
-    // VUEX IS ENABLED BY DEFAULT
-    this.VUEX_STORE = false;
-    this.vuex_module = null;
-  }
-
-  /**
-   * Add a viewport into the store
-   * @function addViewport
-   * @param {String} viewportId - The viewport id
-   */
-  addViewport(viewportId) {
-    if (this.VUEX_STORE) {
-      let dispatch = "addViewport";
-      let route = this.vuex_module
-        ? this.vuex_module + "/" + dispatch
-        : dispatch;
-      this.vuex_store.dispatch(route, viewportId);
-    } else {
-      this.state.viewports[viewportId] = {};
-      this.state.viewports[viewportId] = DEFAULT_VIEWPORT;
-    }
-  }
-
-  /**
-   * Delete a viewport from the store
-   * @function deleteViewport
-   * @param {String} viewportId - The viewport id
-   */
-  deleteViewport(viewportId) {
-    if (this.VUEX_STORE) {
-      let dispatch = "deleteViewport";
-      let route = this.vuex_module
-        ? this.vuex_module + "/" + dispatch
-        : dispatch;
-      this.vuex_store.dispatch(route, viewportId);
-    } else {
-      delete this.state.viewports[viewportId];
-    }
-  }
-
-  /**
-   * Add a serie into the store
-   * @function addSeriesIds
-   * @param {String} seriesId - The serie's id
-   * @param {Array} imageIds - The array of image ids
-   */
-  addSeriesIds(seriesId, imageIds) {
-    if (this.VUEX_STORE) {
-      let dispatch = "addSeriesIds";
-      let route = this.vuex_module
-        ? this.vuex_module + "/" + dispatch
-        : dispatch;
-      this.vuex_store.dispatch(route, [seriesId, imageIds]);
-    } else {
-      if (this.state.series[seriesId] == null) {
-        this.state.series[seriesId] = {};
-      }
-      this.state.series[seriesId]["imageIds"] = imageIds;
-    }
-  }
-
-  /**
-   * Remove a serie from the store
-   * @function removeSeriesIds
-   * @param {String} seriesId - The serie's id
-   */
-  removeSeriesIds(seriesId) {
-    if (this.VUEX_STORE) {
-      let dispatch = "removeSeriesIds";
-      let route = this.vuex_module
-        ? this.vuex_module + "/" + dispatch
-        : dispatch;
-      this.vuex_store.dispatch(route, seriesId);
-    } else {
-      delete this.state.series[seriesId];
-    }
-  }
-
-  /**
-   * Removes all the series from the store
-   * @function resetSeriesIds
-   */
-  resetSeriesIds(seriesId) {
-    if (this.VUEX_STORE) {
-      let dispatch = "resetSeriesIds";
-      let route = this.vuex_module
-        ? this.vuex_module + "/" + dispatch
-        : dispatch;
-      this.vuex_store.dispatch(route, seriesId);
-    } else {
-      delete this.state.series[seriesId];
-    }
-  }
-
-  /**
-   * Set a value into store
-   * @function set
-   * @param {field} field - The name of the field to be updated
-   * @param {Object} data - The data object
-   */
-  set(field, data) {
-    if (this.VUEX_STORE) {
-      let dispatch = "set" + field[0].toUpperCase() + field.slice(1);
-      let route = this.vuex_module
-        ? this.vuex_module + "/" + dispatch
-        : dispatch;
-      this.vuex_store.dispatch(route, data);
-    } else {
-      if (field == "scale" || field == "rotation" || field == "translation") {
-        this.state["viewports"][data[0]]["viewport"][field] = data[1];
-      } else if (field == "contrast") {
-        this.state["viewports"][data[0]]["viewport"]["voi"]["windowWidth"] =
-          data[1];
-        this.state["viewports"][data[0]]["viewport"]["voi"]["windowCenter"] =
-          data[2];
-      } else if (field == "dimensions") {
-        this.state["viewports"][data[0]]["rows"] = data[1];
-        this.state["viewports"][data[0]]["cols"] = data[2];
-      } else if (field == "spacing") {
-        this.state["viewports"][data[0]]["spacing_x"] = data[1];
-        this.state["viewports"][data[0]]["spacing_y"] = data[2];
-      } else if (field == "thickness") {
-        this.state["viewports"][data[0]]["thickness"] = data[1];
-      } else if (field == "minPixelValue") {
-        this.state["viewports"][data[0]]["minPixelValue"] = data[1];
-      } else if (field == "maxPixelValue") {
-        this.state["viewports"][data[0]]["maxPixelValue"] = data[1];
-      } else if (field == "renderingStatus") {
-        this.state["viewports"][data[0]]["ready"] = data[1];
-      } else if (field == "loadingProgress") {
-        this.state["viewports"][data[0]]["loading"] = data[1];
-      } else if (field == "minSliceId") {
-        this.state["viewports"][data[0]]["minSliceId"] = data[1];
-      } else if (field == "maxSliceId") {
-        this.state["viewports"][data[0]]["maxSliceId"] = data[1];
-      } else if (field == "sliceId") {
-        this.state["viewports"][data[0]]["sliceId"] = data[1];
-      } else if (field == "minTimeId") {
-        this.state["viewports"][data[0]]["minTimeId"] = data[1];
-      } else if (field == "maxTimeId") {
-        this.state["viewports"][data[0]]["maxTimeId"] = data[1];
-      } else if (field == "timeId") {
-        this.state["viewports"][data[0]]["timeId"] = data[1];
-      } else if (field == "timestamp") {
-        this.state["viewports"][data[0]]["timestamp"] = data[1];
-      } else if (field == "timestamps") {
-        this.state["viewports"][data[0]]["timestamps"] = data[1];
-      } else if (field == "timeIds") {
-        this.state["viewports"][data[0]]["timeIds"] = data[1];
-      } else if (field == "isColor") {
-        this.state["viewports"][data[0]]["isColor"] = data[1];
-      } else if (field == "isMultiframe") {
-        this.state["viewports"][data[0]]["isMultiframe"] = data[1];
-      } else if (field == "isPDF") {
-        this.state["viewports"][data[0]]["isPDF"] = data[1];
-      } else if (field == "isTimeserie") {
-        this.state["viewports"][data[0]]["isTimeserie"] = data[1];
-      } else if (field == "defaultViewport") {
-        this.state["viewports"][data[0]]["default"]["scale"] = data[1];
-        this.state["viewports"][data[0]]["default"]["rotation"] = data[2];
-        this.state["viewports"][data[0]]["default"]["translation"]["x"] =
-          data[3];
-        this.state["viewports"][data[0]]["default"]["translation"]["y"] =
-          data[4];
-        this.state["viewports"][data[0]]["default"]["voi"]["windowWidth"] =
-          data[5];
-        this.state["viewports"][data[0]]["default"]["voi"]["windowCenter"] =
-          data[6];
-      } else if (field == "progress") {
-        this.state.series[data[0]]["progress"] = data[1];
-      } else {
-        if (Array.isArray(data)) {
-          this.state[field][data[0]] = data[1];
-        } else {
-          this.state[field] = data;
-        }
-      }
-    }
-  }
-
-  /**
-   * Get a value from the store
-   * @function get
-   * @param {Array} args - The array of arguments
-   * @return {Object} - The stored value
-   */
-  get(...args) {
-    if (this.VUEX_STORE) {
-      if (this.vuex_module) {
-        args.unshift(this.vuex_module);
-      }
-      return _get(this.vuex_store.state, args, "error");
-    } else {
-      return _get(this.state, args, "error");
-    }
-  }
-}
-
-/**
- * Instancing the store
- * @param {Object} vuexStore - The app vuex store [optional]
- * @param {String} vuexModule - The name of the vuex store module, can be null
- * @param {Boolean} registerModule - If true, the module is registered under Vuex global store
- * @param {Object} _Vue - The Vue instance
- */
-
-export function initLarvitarStore(vuexStore, vuexModule, registerModule, _Vue) {
-  if (vuexStore) {
-    larvitar_store = new Larvitar_Store(vuexStore, vuexModule);
-    if (registerModule) {
-      defineVue(_Vue);
-      vuexStore.registerModule(vuexModule, larvitar);
-    }
-  } else {
-    larvitar_store = new Larvitar_Store();
-  }
-}

package/modules/vuex/larvitar.js

@@ -1,187 +0,0 @@
-// Larvitar Vuex instance
-var Vue = null;
-
-// default viewport store object
-const DEFAULT_VIEWPORT = {
-  ready: false, // true when currentImageId is rendered
-  minSliceId: 0,
-  maxSliceId: 0,
-  sliceId: 0,
-  minTimeId: 0,
-  maxTimeId: 0,
-  timeId: 0,
-  timestamp: 0,
-  timestamps: [],
-  timeIds: [],
-  rows: 0,
-  cols: 0,
-  spacing_x: 0.0,
-  spacing_y: 0.0,
-  thickness: 0.0,
-  minPixelValue: 0,
-  maxPixelValue: 0,
-  isColor: false,
-  isMultiframe: false,
-  isPDF: false,
-  isTimeserie: false,
-  viewport: {
-    scale: 0.0,
-    rotation: 0.0,
-    translation: {
-      x: 0.0,
-      y: 0.0
-    },
-    voi: {
-      windowCenter: 0.0,
-      windowWidth: 0.0
-    }
-  },
-  default: {
-    scale: 0.0,
-    translation: {
-      x: 0.0,
-      y: 0.0
-    },
-    voi: {
-      windowCenter: 0.0,
-      windowWidth: 0.0
-    }
-  }
-};
-
-export default {
-  namespaced: true,
-  state: {
-    colormapId: "gray",
-    leftActiveTool: "Wwwc",
-    rightActiveTool: "Wwwc",
-    series: {}, // seriesUID: {imageIds:[], progress:value}
-    viewports: {}
-  },
-  getters: {
-    viewport: state => id => state.viewports[id]
-  },
-  mutations: {
-    canvas: (state, { id, d }) => {
-      if (!state.viewports[id]) {
-        console.warn(`Can not update viewport ${id}: viewport not found.`);
-        return;
-      }
-
-      Vue.set(state.viewports[id], "viewport", {
-        ...state.viewports[id].viewport,
-        ...d
-      });
-    },
-    series: (state, { id, d }) =>
-      Vue.set(state.series, id, { ...state.series[id], ...d }),
-    viewport: (state, { id, d }) => {
-      if (!state.viewports[id]) {
-        console.warn(`Can not update viewport ${id}: viewport not found.`);
-        return;
-      }
-
-      Vue.set(state.viewports, id, { ...state.viewports[id], ...d });
-    },
-    leftActiveTool: (state, { d }) => {
-      state.leftActiveTool = d.value;
-    },
-    rightActiveTool: (state, { d }) => {
-      state.rightActiveTool = d.value;
-    }
-  },
-  actions: {
-    addViewport: ({ state }, viewportId) => {
-      if (!state.viewports[viewportId])
-        Vue.set(state.viewports, viewportId, DEFAULT_VIEWPORT);
-      // else preserve already stored viewport (remove it manually if you want to reset it)
-    },
-    deleteViewport: ({ state }, viewportId) =>
-      Vue.delete(state.viewports, viewportId),
-    setLeftActiveTool: ({ commit }, value) => {
-      commit("leftActiveTool", { d: { value } });
-    },
-    setRightActiveTool: ({ commit }, value) => {
-      commit("rightActiveTool", { d: { value } });
-    },
-    removeSeriesIds: ({ state }, seriesId) =>
-      Vue.delete(state.series, seriesId),
-    resetSeriesIds: ({ state }) => Vue.set(state.series, {}),
-    setErrorLog: () => {}, // TODO LT pass elementId
-
-    // Series fields setters
-    addSeriesIds: ({ commit }, [id, imageIds]) =>
-      commit("series", { id, d: { imageIds } }),
-    // !!! this is CACHE progress
-    setProgress: ({ commit }, [id, progress]) =>
-      commit("series", { id, d: { progress } }),
-    // Viewport fields setters
-    setDimensions: ({ commit }, [id, rows, cols]) =>
-      commit("viewport", { id, d: { rows, cols } }),
-    setRenderingStatus: ({ commit }, [id, ready]) =>
-      commit("viewport", { id, d: { ready } }),
-    setSpacing: ({ commit }, [id, spacing_x, spacing_y]) =>
-      commit("viewport", { id, d: { spacing_x, spacing_y } }),
-    setThickness: ({ commit }, [id, thickness]) =>
-      commit("viewport", { id, d: { thickness } }),
-    setMinPixelValue: ({ commit }, [id, minPixelValue]) =>
-      commit("viewport", { id, d: { minPixelValue } }),
-    setMaxPixelValue: ({ commit }, [id, maxPixelValue]) =>
-      commit("viewport", { id, d: { maxPixelValue } }),
-    setMinSliceId: ({ commit }, [id, minSliceId]) =>
-      commit("viewport", { id, d: { minSliceId } }),
-    setMaxSliceId: ({ commit }, [id, maxSliceId]) =>
-      commit("viewport", { id, d: { maxSliceId } }),
-    setSliceId: ({ commit }, [id, sliceId]) =>
-      commit("viewport", { id, d: { sliceId } }),
-    setMinTimeId: ({ commit }, [id, minTimeId]) =>
-      commit("viewport", { id, d: { minTimeId } }),
-    setMaxTimeId: ({ commit }, [id, maxTimeId]) =>
-      commit("viewport", { id, d: { maxTimeId } }),
-    setTimeId: ({ commit }, [id, timeId]) =>
-      commit("viewport", { id, d: { timeId } }),
-    setTimestamp: ({ commit }, [id, timestamp]) =>
-      commit("viewport", { id, d: { timestamp } }),
-    setTimestamps: ({ commit }, [id, timestamps]) =>
-      commit("viewport", { id, d: { timestamps } }),
-    setTimeIds: ({ commit }, [id, timeIds]) =>
-      commit("viewport", { id, d: { timeIds } }),
-    setIsColor: ({ commit }, [id, isColor]) =>
-      commit("viewport", { id, d: { isColor } }),
-    setIsMultiframe: ({ commit }, [id, isMultiframe]) =>
-      commit("viewport", { id, d: { isMultiframe } }),
-    setIsPDF: ({ commit }, [id, isPDF]) =>
-      commit("viewport", { id, d: { isPDF } }),
-    setIsTimeserie: ({ commit }, [id, isTimeserie]) =>
-      commit("viewport", { id, d: { isTimeserie } }),
-    setDefaultViewport: (
-      { commit },
-      [id, scale, rotation, x, y, windowWidth, windowCenter]
-    ) =>
-      commit("viewport", {
-        id,
-        d: {
-          default: {
-            scale,
-            rotation,
-            translation: { x, y },
-            voi: { windowWidth, windowCenter }
-          }
-        }
-      }),
-    // viewports[id].viewport properties
-    setScale: ({ commit }, [id, scale]) =>
-      commit("canvas", { id, d: { scale } }),
-    setRotation: ({ commit }, [id, rotation]) =>
-      commit("canvas", { id, d: { rotation } }),
-    setTranslation: ({ commit }, [id, translation]) =>
-      commit("canvas", { id, d: { translation } }),
-    setContrast: ({ commit }, [id, windowWidth, windowCenter]) =>
-      commit("canvas", { id, d: { voi: { windowWidth, windowCenter } } })
-  }
-};
-
-// define Vue instance from outside dependency
-export const defineVue = _Vue => {
-  Vue = _Vue;
-};