Merge pull request #217 from OpenImaging/image-to-frame

Rename Image as Frame
OpenImaging · Nov 8, 2021 · ed9cd4e · ed9cd4e
2 parents 50eacf0 + 9bb6de1
commit ed9cd4e
Show file tree

Hide file tree

Showing 29 changed files with 320 additions and 277 deletions.
diff --git a/client/src/components/ControlPanel.vue b/client/src/components/ControlPanel.vue
@@ -10,7 +10,7 @@ import UserAvatar from './UserAvatar.vue';
 import ScanDecision from './ScanDecision.vue';
 
 export default {
-  name: 'Dataset',
+  name: 'Frame',
   components: {
     EvaluationResults,
     UserAvatar,
@@ -31,10 +31,10 @@ export default {
     ]),
     ...mapGetters([
       'currentViewData',
-      'nextDataset',
-      'getDataset',
-      'previousDataset',
-      'currentDataset',
+      'nextFrame',
+      'getFrame',
+      'previousFrame',
+      'currentFrame',
     ]),
     ...mapMutations([
       'updateExperiment',
@@ -52,7 +52,7 @@ export default {
       return this.currentViewData.lockOwner;
     },
     representation() {
-      return this.currentDataset && this.proxyManager.getRepresentations()[0];
+      return this.currentFrame && this.proxyManager.getRepresentations()[0];
     },
     winMin() {
       return this.representation.getPropertyDomainByName('windowWidth').min;
@@ -90,7 +90,7 @@ export default {
         this.representation.setWindowLevel(value);
       }
     },
-    currentDataset() {
+    currentFrame() {
       this.updateWinLev();
     },
     experimentId(newValue, oldValue) {
@@ -151,11 +151,11 @@ export default {
     updateImage() {
       if (this.direction === 'back') {
         this.$router
-          .push(this.previousDataset ? this.previousDataset : '')
+          .push(this.previousFrame ? this.previousFrame : '')
           .catch(this.handleNavigationError);
       } else if (this.direction === 'forward') {
         this.$router
-          .push(this.nextDataset ? this.nextDataset : '')
+          .push(this.nextFrame ? this.nextFrame : '')
           .catch(this.handleNavigationError);
       } else if (this.direction === 'previous') {
         this.$router
@@ -383,7 +383,7 @@ export default {
                         style="text-align: right"
                       >
                         <v-btn
-                          :disabled="!previousDataset"
+                          :disabled="!previousFrame"
                           @mousedown="handleKeyPress('back')"
                           small
                           depressed
@@ -392,7 +392,7 @@ export default {
                           <v-icon>fa-caret-left</v-icon>
                         </v-btn>
                         <v-btn
-                          :disabled="!nextDataset"
+                          :disabled="!nextFrame"
                           @mousedown="handleKeyPress('forward')"
                           small
                           depressed

diff --git a/client/src/components/EmailDialog.vue b/client/src/components/EmailDialog.vue
@@ -23,15 +23,15 @@ export default defineComponent({
   },
   setup() {
     const screenshots = computed(() => store.state.screenshots);
-    const currentDataset = computed(() => store.getters.currentDataset);
+    const currentFrame = computed(() => store.getters.currentFrame);
     const currentScan = computed(() => store.getters.currentScan);
     const { removeScreenshot } = store.commit;
 
     const user = inject('user') as User;
 
     return {
       screenshots,
-      currentDataset,
+      currentFrame,
       currentScan,
       removeScreenshot,
       user,
@@ -59,7 +59,7 @@ export default defineComponent({
         this.initialize();
       }
     },
-    currentDataset(value) {
+    currentFrame(value) {
       if (value) {
         this.initialize();
       }

diff --git a/client/src/components/ExperimentsView.vue b/client/src/components/ExperimentsView.vue
@@ -25,8 +25,8 @@ export default {
       'experimentScans',
       'loadingExperiment',
       'scans',
-      'scanDatasets',
-      'datasets',
+      'scanFrames',
+      'frames',
     ]),
     ...mapGetters(['currentScan', 'currentExperiment']),
     orderedExperiments() {
@@ -53,8 +53,8 @@ export default {
         };
       });
     },
-    getIdOfFirstDatasetInScan(scanId) {
-      return `${this.scanDatasets[scanId][0]}`;
+    getIdOfFirstFrameInScan(scanId) {
+      return `${this.scanFrames[scanId][0]}`;
     },
     decisionToRating(decisions) {
       if (decisions.length === 0) return {};
@@ -125,7 +125,7 @@ export default {
               class="body-1"
             >
               <v-btn
-                :to="getIdOfFirstDatasetInScan(scan.id)"
+                :to="getIdOfFirstFrameInScan(scan.id)"
                 class="ml-0 px-1 scan-name"
                 href
                 text

diff --git a/client/src/components/KeyboardShortcutDialog.vue b/client/src/components/KeyboardShortcutDialog.vue
@@ -11,8 +11,8 @@ export default defineComponent({
   },
   data: () => ({
     shortcuts: [
-      ['Next dataset', [['→']]],
-      ['Previous dataset', [['←']]],
+      ['Next frame', [['→']]],
+      ['Previous frame', [['←']]],
       [
         'Change slices',
         [

diff --git a/client/src/components/Navbar.vue b/client/src/components/Navbar.vue
@@ -21,7 +21,7 @@ export default defineComponent({
     KeyboardShortcutDialog,
   },
   props: {
-    datasetView: {
+    frameView: {
       type: Boolean,
       default: false,
     },
@@ -40,7 +40,7 @@ export default defineComponent({
       'screenshots',
     ]),
     ...mapGetters([
-      'currentDataset',
+      'currentFrame',
     ]),
     notes() {
       if (this.currentScan) {
@@ -87,7 +87,7 @@ export default defineComponent({
     </v-tabs>
     <v-spacer />
 
-    <div v-if="datasetView">
+    <div v-if="frameView">
       <v-btn
         @click="keyboardShortcutDialog = true"
         icon
@@ -96,7 +96,7 @@ export default defineComponent({
         <v-icon>keyboard</v-icon>
       </v-btn>
       <v-btn
-        :disabled="!currentDataset"
+        :disabled="!currentFrame"
         @click="emailDialog = true"
         icon
         class="mr-4"

diff --git a/client/src/components/VtkViewer.vue b/client/src/components/VtkViewer.vue
@@ -2,7 +2,7 @@
 import Vue from 'vue';
 import { mapState, mapGetters, mapMutations } from 'vuex';
 
-import { cleanDatasetName } from '@/utils/helper';
+import { cleanFrameName } from '@/utils/helper';
 import fill2DView from '../utils/fill2DView';
 import { getView } from '../vtk/viewManager';
 
@@ -23,12 +23,12 @@ export default {
     screenshotContainer: document.createElement('div'),
   }),
   computed: {
-    ...mapState(['proxyManager', 'loadingDataset', 'xSlice', 'ySlice', 'zSlice', 'iIndexSlice', 'jIndexSlice', 'kIndexSlice']),
-    ...mapGetters(['currentDataset', 'currentScan']),
+    ...mapState(['proxyManager', 'loadingFrame', 'xSlice', 'ySlice', 'zSlice', 'iIndexSlice', 'jIndexSlice', 'kIndexSlice']),
+    ...mapGetters(['currentFrame', 'currentScan']),
     representation() {
       return (
-        // force add dependency on currentDataset
-        this.currentDataset
+        // force add dependency on currentFrame
+        this.currentFrame
         && this.proxyManager.getRepresentation(null, this.view)
       );
     },
@@ -94,7 +94,7 @@ export default {
       this.initializeSlice();
       this.initializeView();
     },
-    currentDataset() {
+    currentFrame() {
       this.representation.setSlice(this.slice);
     },
     currentScan() {
@@ -139,7 +139,7 @@ export default {
       fill2DView(this.view);
       if (this.name !== 'default') {
         this.modifiedSubscription = this.representation.onModified(() => {
-          if (!this.loadingDataset) {
+          if (!this.loadingFrame) {
             this.slice = this.representation.getSlice();
           }
         });
@@ -173,7 +173,7 @@ export default {
       this.setCurrentScreenshot({
         name: `${this.currentScan.experiment}/${
           this.currentScan.name
-        }/${cleanDatasetName(this.currentDataset.name)}/${this.displayName}`,
+        }/${cleanFrameName(this.currentFrame.name)}/${this.displayName}`,
         dataURL,
       });
     },

diff --git a/client/src/django.ts b/client/src/django.ts
@@ -93,8 +93,8 @@ const djangoClient = {
     const { data } = await apiClient.post('/scan-decisions', { scan: scanId, decision, note: comment });
     return data;
   },
-  async images(scanId: string) {
-    const { data } = await apiClient.get('/images', {
+  async frames(scanId: string) {
+    const { data } = await apiClient.get('/frames', {
       params: { scan: scanId },
     });
     const { results } = data;

diff --git a/client/src/router.ts b/client/src/router.ts
@@ -2,7 +2,7 @@ import Vue from 'vue';
 import Router from 'vue-router';
 
 import Projects from './views/Projects.vue';
-import Dataset from './views/Dataset.vue';
+import Frame from './views/Frame.vue';
 import Login from './views/Login.vue';
 
 Vue.use(Router);
@@ -21,9 +21,9 @@ export default new Router({
     },
     // Order matters
     {
-      path: '/:datasetId?',
-      name: 'dataset',
-      component: Dataset,
+      path: '/:frameId?',
+      name: 'frame',
+      component: Frame,
     },
     {
       path: '*',