feat: Add DICOM SEG support and MPR, referenceLines and StackSync and more (#3015)

* feat: add initial sop class handler for SEG * feat: move segmentation service * update segmentation service methods * fix: viewport data structure * feat: Add initial render for the DICOM SEG for each displaySet * fix: various wrong architectural dependencies between services * feat: initial separate SEG display in each viewport * feat: refactore viewport action bar * initial work for SEG hydration * fix: various bugs regarding drag and dropping different viewports * fix: rendering issues for multiple seg displaysets * fix: bugs for thumbnail and hydration * feat: fix the initial segment color * update after rebase * feat: initial design for the segmentation group table * feat: initial new design for the segmentation panel * feat: segmentation panel * feat: make segmentation appear on all related viewports * fix: segmentation load bug based on functional groups * initial work for segmentation crosshairs * fix: various stylings and functionality * fix: various stylings for the seg panel * fix: overflow styles * feat: add more ui components * feat: added segmentation config * feat: add jump to segment * feat: add jump to segment for DICOM SEG viewport * fix: bugs after rebase * feat: jump in segmentation viewport * fix: mpr support for seg * feat: add more icons * feat: new icons * feat: add new side panel * feat: add segmentation config * feat: add loading indicator to ohif * feat: make hanging protocols follow matching rules for viewports * feat: enhance drag and drop to be hanging protocol aware * fix: mpr restore previous layout * fix: crosshairs toggle * fix: add auth headers to the dicom loader via dicomwebclient * fix: bug for crosshairs toggle in mpr * fix: seg viewport reusing old toolGroup * feat: add loading animation with lottie * fix: various bugs for Segmentation hydration in mpr * feat: change outline alpha to outline opacity * feat: loading indicator for seg viewport * fix: various segmentation group styles * fix: local mode for seg * feat: add animation for the highlight * fix: loading indicatro to show segment indices * feat: enhance modality drop down ui * fix: panels * fix: download form * fix: layout shift in loading indicator * fix: loading indicator to have correct values * fix: update software number * fix: image jump between MPR and default * fix: segmentation cleanup and cine service cleanup * fix: segmentation toolgroup clena up * fix: highlight interval should not trigger again * fix: issue with multiframe sorting * rename: change onSeriesChange to onArrowsClick * fix: buttons for tmtv and layout shift * fix: various bugs wrt crosshairs * fix: crosshairs re init on reset camera * fix: middle slice calculation different from cs middle reset camera * fix: reset camera should reset viewport camera * fix: loading segments in MPR mode * fix: tmtv hp back to before * fix: layout shift * feat: orientation markers for volume viewport * fix: capture for volume viewports * fix: memory leak for back to worklist * fix: loading bar bg color * fix: side panel for only one panel * fix: react select style in production * fix: various styling for segmentation groups * fix: various ui styles * feat: add new segmentation config styles * fix: hover state for segmentation item * fix: side panel layout shift * temp add panels * try to fix scrollbar for thimbnail * fix: scroll not appearing for side panels * feat: changed styles for scrollbar * feat: add cpu fallback warning * fix: webworker destroy * fix: select styles * fix: orientation marker color and position * fix: capture screenshot for volume viewports * fix: hide segment visibility on mpr * fix: reloading an already loaded seg displayset * feat: add is equal * fix: mpr jump to measurements * apply review comments * fix: optimization for the segmentation load * fix: remove unnecessary context menu and hp service reset * fix: segmentation service wrt brush settings * feat: initial work for the stack synchronization * fix: add validateDisplaySetSelectorsForNewDisplaySets to make sure drag and drop can follow requirements * fix: various react proptypes * fix: thumbnails for the tmtv and change default props to default params * feat: make showing loading indicator configurable and add docs * bump versions and add more docs * fix demo * update cornerstone versions * apply review comments * feat: add reference lines * fix build * fix unit tests * add reference lines icon * fix: e2e tests * fix static wado config * docs: add segmentation service docs * fix: docker build * fix: keep camera and bump versions * Try re-enabling minification to fix deploy previews Co-authored-by: Erik Ziegler <erik.sweed@gmail.com>
2022-11-16 14:19:52 -05:00
1 parent 08c58b0634
commit 83ea228d86
@@ -0,0 +1,252 @@
+import { cache as cs3DCache, Enums, volumeLoader } from '@cornerstonejs/core';
+import { utils } from '@ohif/core';
+
+import getCornerstoneViewportType from '../../utils/getCornerstoneViewportType';
+import {
+  StackViewportData,
+  VolumeViewportData,
+} from '../../types/CornerstoneCacheService';
+
+const VOLUME_IMAGE_LOADER_SCHEME = 'streaming-wadors';
+const VOLUME_LOADER_SCHEME = 'cornerstoneStreamingImageVolume';
+
+class CornerstoneCacheService {
+  stackImageIds: Map<string, string[]> = new Map();
+  volumeImageIds: Map<string, string[]> = new Map();
+
+  constructor(servicesManager) {
+    this.servicesManager = servicesManager;
+  }
+
+  public getCacheSize() {
+    return cs3DCache.getCacheSize();
+  }
+
+  public getCacheFreeSpace() {
+    return cs3DCache.getBytesAvailable();
+  }
+
+  public async createViewportData(
+    displaySets: unknown[],
+    viewportOptions: Record<string, unknown>,
+    dataSource: unknown,
+    initialImageIndex?: number
+  ): Promise<StackViewportData | VolumeViewportData> {
+    let viewportType = viewportOptions.viewportType as string;
+
+    // Todo: Since Cornerstone 3D currently doesn't support segmentation
+    // on stack viewport, we should check if whether the the displaySets
+    // that are about to be displayed are referenced in a segmentation
+    // as a reference volume, if so, we should hang a volume viewport
+    // instead of a stack viewport
+    if (this._shouldRenderSegmentation(displaySets)) {
+      viewportType = 'volume';
+
+      // update viewportOptions to reflect the new viewport type
+      viewportOptions.viewportType = viewportType;
+    }
+
+    const cs3DViewportType = getCornerstoneViewportType(viewportType);
+    let viewportData: StackViewportData | VolumeViewportData;
+
+    if (cs3DViewportType === Enums.ViewportType.STACK) {
+      viewportData = await this._getStackViewportData(
+        dataSource,
+        displaySets,
+        initialImageIndex
+      );
+    }
+
+    if (cs3DViewportType === Enums.ViewportType.ORTHOGRAPHIC) {
+      viewportData = await this._getVolumeViewportData(dataSource, displaySets);
+    }
+
+    viewportData.viewportType = cs3DViewportType;
+
+    return viewportData;
+  }
+
+  public async invalidateViewportData(
+    viewportData: VolumeViewportData,
+    invalidatedDisplaySetInstanceUID: string,
+    dataSource,
+    DisplaySetService
+  ) {
+    if (viewportData.viewportType === Enums.ViewportType.STACK) {
+      throw new Error('Invalidation of StackViewport is not supported yet');
+    }
+
+    // Todo: grab the volume and get the id from the viewport itself
+    const volumeId = `${VOLUME_LOADER_SCHEME}:${invalidatedDisplaySetInstanceUID}`;
+
+    const volume = cs3DCache.getVolume(volumeId);
+
+    if (volume) {
+      cs3DCache.removeVolumeLoadObject(volumeId);
+    }
+
+    const displaySets = viewportData.data.map(({ displaySetInstanceUID }) =>
+      DisplaySetService.getDisplaySetByUID(displaySetInstanceUID)
+    );
+
+    const newViewportData = await this._getVolumeViewportData(
+      dataSource,
+      displaySets
+    );
+
+    return newViewportData;
+  }
+
+  private _getStackViewportData(
+    dataSource,
+    displaySets,
+    initialImageIndex
+  ): StackViewportData {
+    // For Stack Viewport we don't have fusion currently
+    const displaySet = displaySets[0];
+
+    let stackImageIds = this.stackImageIds.get(
+      displaySet.displaySetInstanceUID
+    );
+
+    if (!stackImageIds) {
+      stackImageIds = this._getCornerstoneStackImageIds(displaySet, dataSource);
+      this.stackImageIds.set(displaySet.displaySetInstanceUID, stackImageIds);
+    }
+
+    const { displaySetInstanceUID, StudyInstanceUID } = displaySet;
+
+    const StackViewportData: StackViewportData = {
+      viewportType: Enums.ViewportType.STACK,
+      data: {
+        StudyInstanceUID,
+        displaySetInstanceUID,
+        imageIds: stackImageIds,
+      },
+    };
+
+    if (typeof initialImageIndex === 'number') {
+      StackViewportData.data.initialImageIndex = initialImageIndex;
+    }
+
+    return StackViewportData;
+  }
+
+  private async _getVolumeViewportData(
+    dataSource,
+    displaySets
+  ): Promise<VolumeViewportData> {
+    // Todo: Check the cache for multiple scenarios to see if we need to
+    // decache the volume data from other viewports or not
+
+    const volumeData = [];
+
+    for (const displaySet of displaySets) {
+      // Don't create volumes for the displaySets that have custom load
+      // function (e.g., SEG, RT, since they rely on the reference volumes
+      // and they take care of their own loading after they are created in their
+      // getSOPClassHandler method
+
+      if (displaySet.load && displaySet.load instanceof Function) {
+        const { UserAuthenticationService } = this.servicesManager.services;
+        const headers = UserAuthenticationService.getAuthorizationHeader();
+        await displaySet.load({ headers });
+
+        volumeData.push({
+          studyInstanceUID: displaySet.StudyInstanceUID,
+          displaySetInstanceUID: displaySet.displaySetInstanceUID,
+        });
+
+        // Todo: do some cache check and empty the cache if needed
+        continue;
+      }
+
+      const volumeLoaderSchema =
+        displaySet.volumeLoaderSchema ?? VOLUME_LOADER_SCHEME;
+
+      const volumeId = `${volumeLoaderSchema}:${displaySet.displaySetInstanceUID}`;
+
+      let volumeImageIds = this.volumeImageIds.get(
+        displaySet.displaySetInstanceUID
+      );
+
+      let volume = cs3DCache.getVolume(volumeId);
+
+      if (!volumeImageIds || !volume) {
+        volumeImageIds = this._getCornerstoneVolumeImageIds(
+          displaySet,
+          dataSource
+        );
+
+        volume = await volumeLoader.createAndCacheVolume(volumeId, {
+          imageIds: volumeImageIds,
+        });
+
+        this.volumeImageIds.set(
+          displaySet.displaySetInstanceUID,
+          volumeImageIds
+        );
+      }
+
+      volumeData.push({
+        StudyInstanceUID: displaySet.StudyInstanceUID,
+        displaySetInstanceUID: displaySet.displaySetInstanceUID,
+        volume,
+        volumeId,
+        imageIds: volumeImageIds,
+      });
+    }
+
+    return {
+      viewportType: Enums.ViewportType.ORTHOGRAPHIC,
+      data: volumeData,
+    };
+  }
+
+  private _shouldRenderSegmentation(displaySets) {
+    const { SegmentationService } = this.servicesManager.services;
+
+    const viewportDisplaySetInstanceUIDs = displaySets.map(
+      ({ displaySetInstanceUID }) => displaySetInstanceUID
+    );
+
+    // check inside segmentations if any of them are referencing the displaySets
+    // that are about to be displayed
+    const segmentations = SegmentationService.getSegmentations();
+
+    for (const segmentation of segmentations) {
+      const segDisplaySetInstanceUID = segmentation.displaySetInstanceUID;
+
+      const shouldDisplaySeg = SegmentationService.shouldRenderSegmentation(
+        viewportDisplaySetInstanceUIDs,
+        segDisplaySetInstanceUID
+      );
+
+      if (shouldDisplaySeg) {
+        return true;
+      }
+    }
+  }
+
+  private _getCornerstoneStackImageIds(displaySet, dataSource): string[] {
+    return dataSource.getImageIdsForDisplaySet(displaySet);
+  }
+
+  private _getCornerstoneVolumeImageIds(displaySet, dataSource): string[] {
+    const stackImageIds = this._getCornerstoneStackImageIds(
+      displaySet,
+      dataSource
+    );
+
+    if (stackImageIds[0].startsWith('dicomfile')) {
+      return stackImageIds;
+    }
+
+    return stackImageIds.map(imageId => {
+      const imageURI = utils.imageIdToURI(imageId);
+      return `${VOLUME_IMAGE_LOADER_SCHEME}:${imageURI}`;
+    });
+  }
+}
+
+export default CornerstoneCacheService;
@@ -0,0 +1,10 @@
+import CornerstoneCacheService from './CornerstoneCacheService';
+
+export default function ExtendedCornerstoneCacheService(serviceManager) {
+  return {
+    name: 'CornerstoneCacheService',
+    create: ({ configuration = {} }) => {
+      return new CornerstoneCacheService(serviceManager);
+    },
+  };
+}