fix: 🐛 Add DicomLoaderService & FileLoaderService to fix SR, PDF, and SEG support in local file and WADO-RS-only use cases (#862)

* fix: 🐛 Local file: failing when retrieving segmentation data

Fix segmentation data retrieval issues for local file. Changed from
fecthing to use cornerstone loadAndCache method

BREAKING CHANGE: DICOM Seg

Closes: part of #838

* Switch SEG retrieval to WADO-RS

* Forgot a debugger

* refactor: 💡 Code refactor. Minor changes into methods

* fix: 🐛 Load local files: PDF

Items:
1. FileLoaderService: used for serveral operations on local files(load it,  get list of studies, group them, accepting dicom and pdf)
2. DicomLoaderService: used for loading dicom based on dataset and studies. Depending on type of dicom loader might change. WIP
3. Refactor PDF and handleSegmentationStorage to use DicomLoaderService

* fix: 🐛 Code review

* fix: 🐛 Code review. Changed:Folder organization and dicom file

Move fileLoaderService and others to a specific folder. When loading
dicom file change to only retrieve the file(not use cornerstone to cache
or anything else).

* fix: 🐛 Code review. Move dicomLoaderService to core

Moved dicomLoaderService to ohif/core and localFileLoaders to a specific
folder.

* fix: 🐛 Code review

Simplified method to get study for dicom file. Added error handling on
file loading. DicomLoaderService to be exposed on ohif/core/utils
instead.

* fix: 🐛 Reduce local load to one method only

Reduced local file load to one method only

* fix: 🐛 HTML to use dicomLoaderService. Prefer wadors than (uri)

* fix: 🐛 Code implementation for multiframe files

* fix: 🐛 Code review. Default local loader to dicom

Closes: 838

* fix: 🐛 Code review. Use relative path to require DICOMWeb

Closes: 838

* fix: 🐛 Code review. Fix unit test. Added DicomLoaderService mod

Closes: 838

* fix: 🐛 Code review. Add 'Seg' on left thumb

When getting/creating dataset get modality for file/image read

Closes: 838

platform/core/src/classes/metadata/StudyMetadata.js

@@ -129,6 +129,7 @@ export class StudyMetadata extends Metadata {
         );
 
         if (displaySet) {
+          displaySet.sopClassModule = true;
           displaySets.push(displaySet);
 
           return;
@@ -214,7 +215,7 @@ export class StudyMetadata extends Metadata {
    * @returns {boolean} True on success, false on failure.
    */
   addDisplaySet(displaySet) {
-    if (displaySet instanceof ImageSet) {
+    if (displaySet instanceof ImageSet || displaySet.sopClassModule) {
       this._displaySets.push(displaySet);
       return true;
     }

platform/core/src/studies/services/wado/retrieveMetadata.js

@@ -402,6 +402,7 @@ async function resultDataToStudyMetadata(server, studyInstanceUid, resultData) {
         baseWadoRsUri: baseWadoRsUri,
         wadouri: WADOProxy.convertURL(wadouri, server),
         wadorsuri: WADOProxy.convertURL(wadorsuri, server),
+        wadoRoot: server.wadoRoot,
         imageRendering: server.imageRendering,
         thumbnailRendering: server.thumbnailRendering,
       };

platform/core/src/utils/dicomLoaderService.js

@@ -0,0 +1,199 @@
+import cornerstone from 'cornerstone-core';
+import cornerstoneWADOImageLoader from 'cornerstone-wado-image-loader';
+import { api } from 'dicomweb-client';
+import DICOMWeb from '../DICOMWeb';
+
+const getImageId = imageObj => {
+  if (!imageObj) {
+    return;
+  }
+
+  return typeof imageObj.getImageId === 'function'
+    ? imageObj.getImageId()
+    : imageObj.url;
+};
+
+const findImageIdOnStudies = (studies, displaySetInstanceUid) => {
+  const study = studies.find(study => {
+    const displaySet = study.displaySets.some(
+      displaySet => displaySet.displaySetInstanceUid === displaySetInstanceUid
+    );
+    return displaySet;
+  });
+  const { seriesList = [] } = study;
+  const { instances = [] } = seriesList[0] || {};
+  const instance = instances[0];
+
+  return getImageId(instance);
+};
+
+const someInvalidStrings = strings => {
+  const stringsArray = Array.isArray(strings) ? strings : [strings];
+  const emptyString = string => !string;
+  let invalid = stringsArray.some(emptyString);
+  return invalid;
+};
+
+const getImageInstance = dataset => {
+  return dataset && dataset.images && dataset.images[0];
+};
+
+const getImageInstanceId = imageInstance => {
+  return getImageId(imageInstance);
+};
+
+const fetchIt = (url, headers = DICOMWeb.getAuthorizationHeader()) => {
+  return fetch(url, headers).then(response => response.arrayBuffer());
+};
+
+const cornerstoneRetriever = imageId => {
+  return cornerstone.loadAndCacheImage(imageId).then(image => {
+    return image && image.data && image.data.byteArray.buffer;
+  });
+};
+
+const wadorsRetriever = (
+  url,
+  studyInstanceUID,
+  seriesInstanceUID,
+  sopInstanceUID,
+  headers = DICOMWeb.getAuthorizationHeader()
+) => {
+  const config = {
+    url,
+    headers,
+  };
+  const dicomWeb = new api.DICOMwebClient(config);
+
+  return dicomWeb.retrieveInstance({
+    studyInstanceUID,
+    seriesInstanceUID,
+    sopInstanceUID,
+  });
+};
+
+const getImageLoaderType = imageId => {
+  const loaderRegExp = /^\w+\:/;
+  const loaderType = loaderRegExp.exec(imageId);
+
+  return (
+    (loaderRegExp.lastIndex === 0 &&
+      loaderType &&
+      loaderType[0] &&
+      loaderType[0].replace(':', '')) ||
+    ''
+  );
+};
+
+const DicomLoaderService = new (class {
+  getLocalData(dataset, studies) {
+    if (dataset && dataset.localFile) {
+      // Use referenced imageInstance
+      const imageInstance = getImageInstance(dataset);
+      let imageId = getImageInstanceId(imageInstance);
+
+      // or Try to get it from studies
+      if (someInvalidStrings(imageId)) {
+        imageId = findImageIdOnStudies(studies, dataset.displaySetInstanceUid);
+      }
+
+      if (!someInvalidStrings(imageId)) {
+        return cornerstoneWADOImageLoader.wadouri.loadFileRequest(imageId);
+      }
+    }
+  }
+
+  getDataByImageType(dataset) {
+    const imageInstance = getImageInstance(dataset);
+
+    if (imageInstance) {
+      const imageId = getImageInstanceId(imageInstance);
+      let getDicomDataMethod = fetchIt;
+      const loaderType = getImageLoaderType(imageId);
+
+      switch (loaderType) {
+        case 'dicomfile':
+          getDicomDataMethod = cornerstoneRetriever.bind(this, imageId);
+          break;
+        case 'wadors':
+          const url = imageInstance.getData().wadoRoot;
+          const studyInstanceUID = imageInstance.getStudyInstanceUID();
+          const seriesInstanceUID = imageInstance.getSeriesInstanceUID();
+          const sopInstanceUID = imageInstance.getSOPInstanceUID();
+          const invalidParams = someInvalidStrings([
+            url,
+            studyInstanceUID,
+            seriesInstanceUID,
+            sopInstanceUID,
+          ]);
+          if (invalidParams) {
+            return;
+          }
+
+          getDicomDataMethod = wadorsRetriever.bind(
+            this,
+            url,
+            studyInstanceUID,
+            seriesInstanceUID,
+            sopInstanceUID
+          );
+          break;
+        case 'wadouri':
+          // Strip out the image loader specifier
+          imageId = imageId.substring(imageId.indexOf(':') + 1);
+
+          if (someInvalidStrings(imageId)) {
+            return;
+          }
+          getDicomDataMethod = fetchIt.bind(this, imageId);
+          break;
+      }
+
+      return getDicomDataMethod();
+    }
+  }
+
+  getDataByDatasetType(dataset) {
+    const {
+      studyInstanceUid,
+      seriesInstanceUid,
+      sopInstanceUid,
+      authorizationHeaders,
+      wadoRoot,
+      wadoUri,
+    } = dataset;
+    // Retrieve wadors or just try to fetch wadouri
+    if (!someInvalidStrings(wadoRoot)) {
+      return wadorsRetriever(
+        wadoRoot,
+        studyInstanceUid,
+        seriesInstanceUid,
+        sopInstanceUid,
+        authorizationHeaders
+      );
+    } else if (!someInvalidStrings(wadoUri)) {
+      return fetchIt(wadoUri, { headers: authorizationHeaders });
+    }
+  }
+
+  *getLoaderIterator(dataset, studies) {
+    yield this.getLocalData(dataset, studies);
+    yield this.getDataByImageType(dataset);
+    yield this.getDataByDatasetType(dataset);
+  }
+
+  findDicomDataPromise(dataset, studies) {
+    const loaderIterator = this.getLoaderIterator(dataset, studies);
+    // it returns first valid retriever method.
+    for (const loader of loaderIterator) {
+      if (loader) {
+        return loader;
+      }
+    }
+
+    // in case of no valid loader
+    throw new Error('Invalid dicom data loader');
+  }
+})();
+
+export default DicomLoaderService;

platform/core/src/utils/getWADORSImageId.js

@@ -5,11 +5,16 @@ function getWADORSImageUrl(instance, frame) {
     return;
   }
 
-  // We need to sum 1 because WADO-RS frame number is 1-based
-  frame = frame ? parseInt(frame) + 1 : 1;
+  // Use null to obtain an imageId which represents the instance
+  if (frame === null) {
+    wadorsuri = wadorsuri.replace(/frames\/(\d+)/, '');
+  } else {
+    // We need to sum 1 because WADO-RS frame number is 1-based
+    frame = frame ? parseInt(frame) + 1 : 1;
 
-  // Replaces /frame/1 by /frame/{frame}
-  wadorsuri = wadorsuri.replace(/frames\/(\d+)/, `frames/${frame}`);
+    // Replaces /frame/1 by /frame/{frame}
+    wadorsuri = wadorsuri.replace(/frames\/(\d+)/, `frames/${frame}`);
+  }
 
   return wadorsuri;
 }

platform/core/src/utils/index.js

@@ -8,6 +8,7 @@ import sortBy from './sortBy.js';
 import studyMetadataManager from './studyMetadataManager';
 import updateMetaDataManager from './updateMetaDataManager.js';
 import writeScript from './writeScript.js';
+import DicomLoaderService from './dicomLoaderService.js';
 
 const utils = {
   guid,
@@ -21,6 +22,7 @@ const utils = {
   // Updates WADO-RS metaDataManager
   updateMetaDataManager,
   DICOMTagDescriptions,
+  DicomLoaderService,
 };
 
 export {
@@ -35,6 +37,7 @@ export {
   // Updates WADO-RS metaDataManager
   updateMetaDataManager,
   DICOMTagDescriptions,
+  DicomLoaderService,
 };
 
 export default utils;

platform/core/src/utils/index.test.js

@@ -14,6 +14,7 @@ describe('Top level exports', () => {
       // Updates WADO-RS metaDataManager
       'updateMetaDataManager',
       'DICOMTagDescriptions',
+      'DicomLoaderService',
     ].sort();
 
     const exports = Object.keys(utils.default).sort();