fix: Use @cornerstonejs/adapters (#3116)

Also update the sort series to be consistent, using a single version of the series sort, and fix an issue with longitudinal mode export.

extensions/cornerstone-dicom-sr/src/commandsModule.js

@@ -2,10 +2,11 @@ import { metaData, utilities } from '@cornerstonejs/core';
 
 import OHIF from '@ohif/core';
 import dcmjs from 'dcmjs';
+import { adaptersSR } from '@cornerstonejs/adapters';
 
 import getFilteredCornerstoneToolState from './utils/getFilteredCornerstoneToolState';
 
-const { MeasurementReport } = dcmjs.adapters.Cornerstone3D;
+const { MeasurementReport } = adaptersSR.Cornerstone3D;
 const { log } = OHIF;
 
 /**

extensions/cornerstone-dicom-sr/src/getSopClassHandlerModule.js

@@ -2,9 +2,9 @@ import { SOPClassHandlerName, SOPClassHandlerId } from './id';
 import { utils, classes } from '@ohif/core';
 import addMeasurement from './utils/addMeasurement';
 import isRehydratable from './utils/isRehydratable';
-import { adapters } from 'dcmjs';
+import { adaptersSR } from '@cornerstonejs/adapters';
 
-const { CodeScheme: Cornerstone3DCodeScheme } = adapters.Cornerstone3D;
+const { CodeScheme: Cornerstone3DCodeScheme } = adaptersSR.Cornerstone3D;
 
 const { ImageSet, MetadataProvider: metadataProvider } = classes;
 // TODO ->

extensions/cornerstone-dicom-sr/src/utils/getFilteredCornerstoneToolState.ts

@@ -39,7 +39,7 @@ function getFilteredCornerstoneToolState(
     const findingSites = [];
 
     // NOTE -> We use the CORNERSTONEJS coding schemeDesignator which we have
-    // defined in the dcmjs adapters
+    // defined in the @cornerstonejs/adapters
     if (measurementDataI.label) {
       if (additionalFindingTypes.includes(toolType)) {
         finding = {

extensions/cornerstone-dicom-sr/src/utils/hydrateStructuredReport.js

@@ -1,10 +1,10 @@
 import { utilities, metaData } from '@cornerstonejs/core';
 import OHIF, { DicomMetadataStore } from '@ohif/core';
 import getLabelFromDCMJSImportedToolData from './getLabelFromDCMJSImportedToolData';
-import { adapters } from 'dcmjs';
+import { adaptersSR } from '@cornerstonejs/adapters';
 
 const { guid } = OHIF.utils;
-const { MeasurementReport, CORNERSTONE_3D_TAG } = adapters.Cornerstone3D;
+const { MeasurementReport, CORNERSTONE_3D_TAG } = adaptersSR.Cornerstone3D;
 
 const CORNERSTONE_3D_TOOLS_SOURCE_NAME = 'Cornerstone3DTools';
 const CORNERSTONE_3D_TOOLS_SOURCE_VERSION = '0.1';

extensions/cornerstone-dicom-sr/src/utils/isRehydratable.js

@@ -1,6 +1,6 @@
-import { adapters } from 'dcmjs';
+import { adaptersSR } from '@cornerstonejs/adapters';
 
-const cornerstoneAdapters = adapters.Cornerstone3D;
+const cornerstoneAdapters = adaptersSR.Cornerstone3D;
 
 const supportedLegacyCornerstoneTags = ['cornerstoneTools@^4.0.0'];
 const CORNERSTONE_3D_TAG = cornerstoneAdapters.CORNERSTONE_3D_TAG;

extensions/cornerstone-dicom-sr/src/utils/isToolSupported.js

@@ -1,4 +1,4 @@
-import dcmjs from 'dcmjs';
+import { adaptersSR } from '@cornerstonejs/adapters';
 
 /**
  *  Checks if dcmjs has support to determined tool
@@ -7,7 +7,7 @@ import dcmjs from 'dcmjs';
  * @returns {boolean}
  */
 const isToolSupported = toolName => {
-  const adapter = dcmjs.adapters.Cornerstone3D;
+  const adapter = adaptersSR.Cornerstone3D;
   return !!adapter[toolName];
 };
 

extensions/cornerstone-dicom-sr/src/viewports/OHIFCornerstoneSRViewport.tsx

@@ -81,14 +81,23 @@ function OHIFCornerstoneSRViewport(props) {
     sendTrackedMeasurementsEvent = tracked?.[1];
   }
   if (!sendTrackedMeasurementsEvent) {
-    // if no panels from measurement-tracking extension is used, this code will trun
+    // if no panels from measurement-tracking extension is used, this code will run
     trackedMeasurements = null;
     sendTrackedMeasurementsEvent = (eventName, { displaySetInstanceUID }) => {
       MeasurementService.clearMeasurements();
-      hydrateStructuredReport(
+      const { SeriesInstanceUIDs } = hydrateStructuredReport(
         { servicesManager, extensionManager },
         displaySetInstanceUID
       );
+      const displaySets = DisplaySetService.getDisplaySetsForSeries(
+        SeriesInstanceUIDs[0]
+      );
+      if (displaySets.length) {
+        viewportGridService.setDisplaySetsForViewport({
+          viewportIndex: activeViewportIndex,
+          displaySetInstanceUIDs: [displaySets[0].displaySetInstanceUID],
+        });
+      }
     };
   }
 

extensions/cornerstone/package.json

@@ -43,6 +43,7 @@
   },
   "dependencies": {
     "@babel/runtime": "7.17.9",
+    "@cornerstonejs/adapters": "^0.2.1",
     "@cornerstonejs/core": "^0.27.1",
     "@cornerstonejs/streaming-image-volume-loader": "^0.11.2",
     "@cornerstonejs/tools": "^0.36.3",

extensions/default/src/DicomLocalDataSource/index.js

@@ -5,19 +5,37 @@ import dcmjs from 'dcmjs';
 const metadataProvider = OHIF.classes.MetadataProvider;
 const { EVENTS } = DicomMetadataStore;
 
-// Sorting SR modalities to be at the end of series list
-function customSort(seriesA, seriesB) {
-  const modalityA = seriesA.instances[0].Modality;
-  const modalityB = seriesB.instances[0].Modality;
+const END_MODALITIES = {
+  SR: true,
+  SEG: true,
+  DOC: true,
+};
 
-  if (modalityA === 'SR') {
-    return +1;
+const compareValue = (v1, v2, def = 0) => {
+  if (v1 === v2) return def;
+  if (v1 < v2) return -1;
+  return 1;
+};
+
+// Sorting SR modalities to be at the end of series list
+const customSort = (seriesA, seriesB) => {
+  const instanceA = seriesA.instances[0];
+  const instanceB = seriesB.instances[0];
+  const modalityA = instanceA.Modality;
+  const modalityB = instanceB.Modality;
+
+  const isEndA = END_MODALITIES[modalityA];
+  const isEndB = END_MODALITIES[modalityB];
+
+  if (isEndA && isEndB) {
+    // Compare by series date
+    return compareValue(instanceA.SeriesNumber, instanceB.SeriesNumber);
   }
-  if (modalityB === 'SR') {
-    return -1;
+  if (!isEndA && !isEndB) {
+    return compareValue(instanceB.SeriesNumber, instanceA.SeriesNumber);
   }
-  return 0;
-}
+  return isEndA ? -1 : 1;
+};
 
 function createDicomLocalApi(dicomLocalConfig) {
   const { name } = dicomLocalConfig;

extensions/default/src/DicomWebDataSource/qido.js

@@ -23,6 +23,7 @@
  * | offset           | {number}           |
  */
 import { DICOMWeb, utils } from '@ohif/core';
+import { sortStudySeries } from '@ohif/core/src/utils/sortStudy';
 
 const { getString, getName, getModalities } = DICOMWeb;
 
@@ -90,6 +91,8 @@ export function processSeriesResults(qidoSeries) {
     );
   }
 
+  sortStudySeries(series);
+
   return series;
 }
 

extensions/default/src/DicomWebDataSource/utils/isLowPriorityModality.js

@@ -1,5 +0,0 @@
-const LOW_PRIORITY_MODALITIES = Object.freeze(['SEG', 'KO', 'PR', 'SR', 'RTSTRUCT']);
-
-export default function isLowPriorityModality(Modality) {
-  return LOW_PRIORITY_MODALITIES.includes(Modality);
-}

extensions/default/src/DicomWebDataSource/utils/sortStudy.js

@@ -1,99 +0,0 @@
-import isLowPriorityModality from './isLowPriorityModality';
-
-/**
- * Series sorting criteria: series considered low priority are moved to the end
- * of the list and series number is used to break ties
- * @param {Object} firstSeries
- * @param {Object} secondSeries
- */
-function seriesInfoSortingCriteria(firstSeries, secondSeries) {
-  const aLowPriority = isLowPriorityModality(firstSeries.Modality);
-  const bLowPriority = isLowPriorityModality(secondSeries.Modality);
-  if (!aLowPriority && bLowPriority) {
-    return -1;
-  }
-  if (aLowPriority && !bLowPriority) {
-    return 1;
-  }
-
-  return firstSeries.SeriesNumber - secondSeries.SeriesNumber;
-}
-
-const seriesSortCriteria = {
-  default: (a, b) => a.SeriesNumber - b.SeriesNumber,
-  seriesInfoSortingCriteria,
-};
-
-const instancesSortCriteria = {
-  default: (a, b) => parseInt(a.InstanceNumber) - parseInt(b.InstanceNumber),
-};
-
-const sortingCriteria = {
-  seriesSortCriteria,
-  instancesSortCriteria,
-};
-
-/**
- * Sorts given series (given param is modified)
- * The default criteria is based on series number in ascending order.
- *
- * @param {Array} series List of series
- * @param {function} seriesSortingCriteria method for sorting
- * @returns {Array} sorted series object
- */
-const sortStudySeries = (
-  series,
-  seriesSortingCriteria = seriesSortCriteria.default,
-  sortFunction
-) => {
-  if (typeof sortFunction === 'function') return sortFunction(series);
-  else return series.sort(seriesSortingCriteria);
-};
-
-/**
- * Sorts given instancesList (given param is modified)
- * The default criteria is based on instance number in ascending order.
- *
- * @param {Array} instancesList List of series
- * @param {function} instancesSortingCriteria method for sorting
- * @returns {Array} sorted instancesList object
- */
-const sortStudyInstances = (
-  instancesList,
-  instancesSortingCriteria = instancesSortCriteria.default
-) => {
-  return instancesList.sort(instancesSortingCriteria);
-};
-
-/**
- * Sorts the series and instances (by default) inside a study instance based on sortingCriteria (given param is modified)
- * The default criteria is based on series and instance numbers in ascending order.
- *
- * @param {Object} study The study instance
- * @param {boolean} [deepSort = true] to sort instance also
- * @param {function} [seriesSortingCriteria = seriesSortCriteria.default] method for sorting series
- * @param {function} [instancesSortingCriteria = instancesSortCriteria.default] method for sorting instances
- * @returns {Object} sorted study object
- */
-export default function sortStudy(
-  study,
-  deepSort = true,
-  seriesSortingCriteria = seriesSortCriteria.default,
-  instancesSortingCriteria = instancesSortCriteria.default
-) {
-  if (!study || !study.series) {
-    throw new Error('Insufficient study data was provided to sortStudy');
-  }
-
-  sortStudySeries(study.series, seriesSortingCriteria);
-
-  if (deepSort) {
-    study.series.forEach(series => {
-      sortStudyInstances(series.instances, instancesSortingCriteria);
-    });
-  }
-
-  return study;
-}
-
-export { sortStudy, sortStudySeries, sortStudyInstances, sortingCriteria };

extensions/default/src/DicomWebDataSource/wado/retrieveMetadataLoaderAsync.js

@@ -1,5 +1,8 @@
 import dcmjs from 'dcmjs';
-import { sortStudySeries, sortingCriteria } from '../utils/sortStudy';
+import {
+  sortStudySeries,
+  sortingCriteria,
+} from '@ohif/core/src/utils/sortStudy';
 import RetrieveMetadataLoader from './retrieveMetadataLoader';
 
 /**

extensions/default/src/Panels/PanelStudyBrowser.tsx

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import { StudyBrowser, useImageViewer, useViewportGrid } from '@ohif/ui';
 import { utils } from '@ohif/core';
 
-const { formatDate } = utils;
+const { sortStudyInstances, formatDate } = utils;
 
 /**
  *
@@ -139,6 +139,7 @@ function PanelStudyBrowser({
       currentDisplaySets,
       thumbnailImageSrcMap
     );
+    sortStudyInstances(mappedDisplaySets);
 
     setDisplaySets(mappedDisplaySets);
     // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -300,6 +301,7 @@ function _mapDisplaySets(displaySets, thumbnailImageSrcMap) {
       seriesNumber: ds.SeriesNumber,
       modality: ds.Modality,
       seriesDate: ds.SeriesDate,
+      seriesTime: ds.SeriesTime,
       numInstances: ds.numImageFrames,
       StudyInstanceUID: ds.StudyInstanceUID,
       componentType,