feat: Add a new hanging protocol @ohif/mn (#3305)

* feat: Add a new hanging protocol @ohif/mn

* Add @ohif/seg example

* PR comments and a couple more fixes to make things cleaner

* PR comment

* Added an example to cause the PR checks to rerun

platform/core/src/services/HangingProtocolService/HangingProtocolService.ts

@@ -9,7 +9,9 @@ import * as HangingProtocol from '../../types/HangingProtocol';
 import {
   isDisplaySetFromUrl,
   sopInstanceLocation,
-} from './isDisplaySetFromUrl';
+} from './custom-attribute/isDisplaySetFromUrl';
+import numberOfDisplaySetsWithImages from './custom-attribute/numberOfDisplaySetsWithImages';
+import seriesDescriptionsFromDisplaySets from './custom-attribute/seriesDescriptionsFromDisplaySets';
 
 type Protocol = HangingProtocol.Protocol | HangingProtocol.ProtocolGenerator;
 
@@ -93,6 +95,16 @@ export default class HangingProtocolService extends PubSubService {
       name: 'Gets the position of the specified sop instance',
       callback: sopInstanceLocation,
     },
+    seriesDescriptions: {
+      name: 'seriesDescriptions',
+      description: 'List of Series Descriptions',
+      callback: seriesDescriptionsFromDisplaySets,
+    },
+    numberOfDisplaySetsWithImages: {
+      name: 'numberOfDisplaySetsWithImages',
+      desription: 'Number of displays sets with images',
+      numberOfDisplaySetsWithImages,
+    },
   };
   listeners = {};
   registeredImageLoadStrategies = {};

platform/core/src/services/HangingProtocolService/custom-attribute/isDisplaySetFromUrl.ts

@@ -1,4 +1,4 @@
-import { getSplitParam } from '../../utils';
+import { getSplitParam } from '../../../utils';
 
 /** Indicates if the given display set is the one specified in the
  * displaySet parameter in the URL
@@ -31,7 +31,7 @@ const isDisplaySetFromUrl = (displaySet): boolean => {
  * Returns undefined to fallback to the defaultValue
  */
 function sopInstanceLocation(displaySets) {
-  const displaySet = displaySets[0];
+  const displaySet = displaySets?.[0];
   if (!displaySet) return;
   const initialSOPInstanceUID = getSplitParam('initialsopinstanceuid');
   if (!initialSOPInstanceUID) return;

platform/core/src/services/HangingProtocolService/custom-attribute/numberOfDisplaySetsWithImages.ts

@@ -0,0 +1,5 @@
+export default (study, extraData) => {
+  const ret = extraData?.displaySets?.filter(ds => ds.numImageFrames>0)?.length;
+  console.log("number of display sets with images", ret);
+  return ret;
+};

platform/core/src/services/HangingProtocolService/custom-attribute/seriesDescriptionsFromDisplaySets.ts

@@ -0,0 +1 @@
+export default (study, extraData) => extraData?.displaySets?.map(ds => ds.SeriesDescription);

platform/viewer/cypress/integration/customization/HangingProtocol.spec.js

@@ -2,7 +2,7 @@ describe('OHIF HP', () => {
   const beforeSetup = () => {
     cy.checkStudyRouteInViewer(
       '1.3.6.1.4.1.25403.345050719074.3824.20170125113417.1',
-      '&hangingProtocolId=@ohif/hp-extension.mn'
+      '&hangingProtocolId=@ohif/mnGrid'
     );
     cy.expectMinimumThumbnails(3);
     cy.initCornerstoneToolsAliases();

platform/viewer/cypress/integration/customization/OHIFDoubleClick.spec.js

@@ -2,7 +2,7 @@ describe('OHIF Double Click', () => {
   beforeEach(() => {
     cy.checkStudyRouteInViewer(
       '1.3.6.1.4.1.25403.345050719074.3824.20170125113417.1',
-      '&hangingProtocolId=@ohif/hp-extension.mn'
+      '&hangingProtocolId=@ohif/mnGrid'
     );
     cy.expectMinimumThumbnails(3);
     cy.initCornerstoneToolsAliases();

platform/viewer/public/config/e2e.js

@@ -14,7 +14,7 @@ window.config = {
     {
       friendlyName: 'StaticWado test data',
       namespace: '@ohif/extension-default.dataSourcesModule.dicomweb',
-      sourceName: 'dicomweb',
+      sourceName: 'e2e',
       configuration: {
         // The most important field to set for static WADO
         staticWado: true,
@@ -32,6 +32,51 @@ window.config = {
         singlepart: 'video,thumbnail,pdf',
       },
     },
+    {
+      friendlyName: 'Static WADO Local Data',
+      namespace: '@ohif/extension-default.dataSourcesModule.dicomweb',
+      sourceName: 'local',
+      configuration: {
+        name: 'DCM4CHEE',
+        qidoRoot: '/dicomweb',
+        wadoRoot: '/dicomweb',
+        qidoSupportsIncludeField: false,
+        supportsReject: true,
+        supportsStow: true,
+        imageRendering: 'wadors',
+        thumbnailRendering: 'wadors',
+        enableStudyLazyLoad: true,
+        supportsFuzzyMatching: false,
+        supportsWildcard: true,
+        staticWado: true,
+        singlepart: 'bulkdata,video,pdf',
+      },
+    },
+    {
+      friendlyName: 'dcmjs DICOMWeb Server',
+      namespace: '@ohif/extension-default.dataSourcesModule.dicomweb',
+      sourceName: 'ohif',
+      configuration: {
+        name: 'aws',
+        // old server
+        // wadoUriRoot: 'https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/wado',
+        // qidoRoot: 'https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs',
+        // wadoRoot: 'https://server.dcmjs.org/dcm4chee-arc/aets/DCM4CHEE/rs',
+        // new server
+        wadoUriRoot: 'https://domvja9iplmyu.cloudfront.net/dicomweb',
+        qidoRoot: 'https://domvja9iplmyu.cloudfront.net/dicomweb',
+        wadoRoot: 'https://domvja9iplmyu.cloudfront.net/dicomweb',
+        qidoSupportsIncludeField: false,
+        supportsReject: false,
+        imageRendering: 'wadors',
+        thumbnailRendering: 'wadors',
+        enableStudyLazyLoad: true,
+        supportsFuzzyMatching: false,
+        supportsWildcard: true,
+        staticWado: true,
+        singlepart: 'bulkdata,video,pdf',
+      },
+    },
     // {
     //   friendlyName: 'StaticWado default data',
     //   namespace: '@ohif/extension-default.dataSourcesModule.dicomweb',
@@ -92,93 +137,6 @@ window.config = {
   //       ))
   //   },
   // },
-  defaultDataSourceName: 'dicomweb',
-  hotkeys: [
-    {
-      commandName: 'incrementActiveViewport',
-      label: 'Next Viewport',
-      keys: ['right'],
-    },
-    {
-      commandName: 'decrementActiveViewport',
-      label: 'Previous Viewport',
-      keys: ['left'],
-    },
-    { commandName: 'rotateViewportCW', label: 'Rotate Right', keys: ['r'] },
-    { commandName: 'rotateViewportCCW', label: 'Rotate Left', keys: ['l'] },
-    { commandName: 'invertViewport', label: 'Invert', keys: ['i'] },
-    {
-      commandName: 'flipViewportHorizontal',
-      label: 'Flip Horizontally',
-      keys: ['h'],
-    },
-    {
-      commandName: 'flipViewportVertical',
-      label: 'Flip Vertically',
-      keys: ['v'],
-    },
-    { commandName: 'scaleUpViewport', label: 'Zoom In', keys: ['+'] },
-    { commandName: 'scaleDownViewport', label: 'Zoom Out', keys: ['-'] },
-    { commandName: 'fitViewportToWindow', label: 'Zoom to Fit', keys: ['='] },
-    { commandName: 'resetViewport', label: 'Reset', keys: ['space'] },
-    { commandName: 'nextImage', label: 'Next Image', keys: ['down'] },
-    { commandName: 'previousImage', label: 'Previous Image', keys: ['up'] },
-    // {
-    //   commandName: 'previousViewportDisplaySet',
-    //   label: 'Previous Series',
-    //   keys: ['pagedown'],
-    // },
-    // {
-    //   commandName: 'nextViewportDisplaySet',
-    //   label: 'Next Series',
-    //   keys: ['pageup'],
-    // },
-    { commandName: 'setZoomTool', label: 'Zoom', keys: ['z'] },
-    // ~ Window level presets
-    {
-      commandName: 'windowLevelPreset1',
-      label: 'W/L Preset 1',
-      keys: ['1'],
-    },
-    {
-      commandName: 'windowLevelPreset2',
-      label: 'W/L Preset 2',
-      keys: ['2'],
-    },
-    {
-      commandName: 'windowLevelPreset3',
-      label: 'W/L Preset 3',
-      keys: ['3'],
-    },
-    {
-      commandName: 'windowLevelPreset4',
-      label: 'W/L Preset 4',
-      keys: ['4'],
-    },
-    {
-      commandName: 'windowLevelPreset5',
-      label: 'W/L Preset 5',
-      keys: ['5'],
-    },
-    {
-      commandName: 'windowLevelPreset6',
-      label: 'W/L Preset 6',
-      keys: ['6'],
-    },
-    {
-      commandName: 'windowLevelPreset7',
-      label: 'W/L Preset 7',
-      keys: ['7'],
-    },
-    {
-      commandName: 'windowLevelPreset8',
-      label: 'W/L Preset 8',
-      keys: ['8'],
-    },
-    {
-      commandName: 'windowLevelPreset9',
-      label: 'W/L Preset 9',
-      keys: ['9'],
-    },
-  ],
+  defaultDataSourceName: 'e2e',
+  hotkeys: [],
 };