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

extensions/test-extension/src/custom-attribute/numberOfDisplaySetsWithImages.ts

@@ -1,5 +0,0 @@
-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;
-};

extensions/test-extension/src/custom-attribute/seriesDescriptionsFromDisplaySets.ts

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

extensions/test-extension/src/custom-context-menu/findingsContextMenu.ts

@@ -38,12 +38,12 @@ const findingsContextMenu = {
         },
 
         // The example below shows how to include a delegating sub-menu,
-        // Only available on the @ohif/hp-extension.mn hanging protocol
+        // Only available on the @ohif/mnGrid hanging protocol
         // To demonstrate, select the 3x1 layout from the protocol menu
         // and right click on a measurement.
         {
           label: 'IncludeSubMenu',
-          selector: ({ protocol }) => protocol?.id === '@ohif/hp-extension.mn',
+          selector: ({ protocol }) => protocol?.id === '@ohif/mnGrid',
           delegating: true,
           subMenu: 'orientationSelectionSubMenu',
         },

extensions/test-extension/src/hp/hpMN.ts

@@ -1,257 +0,0 @@
-import { Types } from '@ohif/core';
-
-/**
- * This hanging protocol has multiple stages, which are enabled when
- * there are enough display sets with images to fill the stage, and
- * are passive when there is at least one display set.
- * Enabled display sets are navigated to by default, while passive ones
- * are navigated to manually using the ctrl+end keyboard shortcut.
- */
-const hpMN: Types.HangingProtocol.Protocol = {
-  hasUpdatedPriorsInformation: false,
-  id: '@ohif/hp-extension.mn',
-  description: 'Has various hanging protocol layouts for use in testing',
-  name: '2x2',
-  protocolMatchingRules: [
-    {
-      id: 'OneOrMoreSeries',
-      weight: 1,
-      attribute: 'numberOfDisplaySetsWithImages',
-      constraint: {
-        greaterThan: 1,
-      },
-    },
-  ],
-  toolGroupIds: ['default'],
-  displaySetSelectors: {
-    defaultDisplaySetId: {
-      seriesMatchingRules: [
-        {
-          attribute: 'numImageFrames',
-          constraint: {
-            greaterThan: { value: 0 },
-          },
-        },
-      ],
-    },
-  },
-  defaultViewport: {
-    viewportOptions: {
-      viewportType: 'stack',
-      toolGroupId: 'default',
-      allowUnmatchedView: true,
-    },
-    displaySets: [
-      {
-        id: 'defaultDisplaySetId',
-        matchedDisplaySetsIndex: -1,
-      },
-    ],
-  },
-  stages: [
-    {
-      id: '2x2',
-      stageActivation: {
-        enabled: {
-          minViewportsMatched: 4,
-        },
-      },
-      viewportStructure: {
-        layoutType: 'grid',
-        properties: {
-          rows: 2,
-          columns: 2,
-        },
-      },
-      viewports: [
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              id: 'defaultDisplaySetId',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              matchedDisplaySetsIndex: 1,
-              id: 'defaultDisplaySetId',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              matchedDisplaySetsIndex: 2,
-              id: 'defaultDisplaySetId',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              matchedDisplaySetsIndex: 3,
-              id: 'defaultDisplaySetId',
-            },
-          ],
-        },
-      ],
-    },
-
-    // 3x1 stage
-    {
-      id: '3x1',
-      // Obsolete settings:
-      requiredViewports: 1,
-      preferredViewports: 3,
-      // New equivalent:
-      stageActivation: {
-        enabled: {
-          minViewportsMatched: 3,
-        },
-      },
-      viewportStructure: {
-        layoutType: 'grid',
-        properties: {
-          rows: 1,
-          columns: 3,
-        },
-      },
-      viewports: [
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              id: 'defaultDisplaySetId',
-              reuseId: '0-0',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              matchedDisplaySetsIndex: 1,
-              id: 'defaultDisplaySetId',
-              reuseId: '1-0',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              matchedDisplaySetsIndex: 2,
-              id: 'defaultDisplaySetId',
-              reuseId: '0-1',
-            },
-          ],
-        },
-      ],
-    },
-
-    // A 2x1 stage
-    {
-      id: '2x1',
-      requiredViewports: 1,
-      preferredViewports: 2,
-      stageActivation: {
-        enabled: {
-          minViewportsMatched: 2,
-        },
-      },
-      viewportStructure: {
-        layoutType: 'grid',
-        properties: {
-          rows: 1,
-          columns: 2,
-        },
-      },
-      viewports: [
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              id: 'defaultDisplaySetId',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              matchedDisplaySetsIndex: 1,
-              id: 'defaultDisplaySetId',
-            },
-          ],
-        },
-      ],
-    },
-
-    // A 1x1 stage - should be automatically activated if there is only 1 viewable instance
-    {
-      id: '1x1',
-      requiredViewports: 1,
-      preferredViewports: 1,
-      stageActivation: {
-        enabled: {
-          minViewportsMatched: 1,
-        },
-      },
-      viewportStructure: {
-        layoutType: 'grid',
-        properties: {
-          rows: 1,
-          columns: 1,
-        },
-      },
-      viewports: [
-        {
-          viewportOptions: {
-            toolGroupId: 'default',
-            allowUnmatchedView: true,
-          },
-          displaySets: [
-            {
-              id: 'defaultDisplaySetId',
-            },
-          ],
-        },
-      ],
-    },
-  ],
-  numberOfPriorsReferenced: -1,
-};
-
-export default hpMN;

extensions/test-extension/src/hp/index.ts

@@ -1,17 +0,0 @@
-import hpMN from './hpMN';
-
-const hangingProtocols = [
-  {
-    name: '@ohif/hp-extension.mn',
-    protocol: hpMN,
-  },
-];
-
-/**
- * Registers a single study hanging protocol which can be referenced as
- * `@ohif/hp-exgtension.mn`, that has initial layouts which show images
- * only display sets, up to a 2x2 view.
- */
-export default function getHangingProtocolModule() {
-  return hangingProtocols;
-}

extensions/test-extension/src/index.tsx

@@ -2,14 +2,11 @@ import { Types } from '@ohif/core';
 
 import { id } from './id';
 
-import getHangingProtocolModule from './hp';
 import getCustomizationModule from './getCustomizationModule';
 // import {setViewportZoomPan, storeViewportZoomPan } from './custom-viewport/setViewportZoomPan';
 import sameAs from './custom-attribute/sameAs';
 import numberOfDisplaySets from './custom-attribute/numberOfDisplaySets';
-import numberOfDisplaySetsWithImages from './custom-attribute/numberOfDisplaySetsWithImages';
 import maxNumImageFrames from './custom-attribute/maxNumImageFrames';
-import seriesDescriptionsFromDisplaySets from './custom-attribute/seriesDescriptionsFromDisplaySets';
 
 /**
  * The test extension provides additional behaviour for testing various
@@ -31,21 +28,11 @@ const testExtension: Types.Extensions.Extension = {
    */
   preRegistration: ({ servicesManager }: Types.Extensions.ExtensionParams) => {
     const { hangingProtocolService } = servicesManager.services;
-    hangingProtocolService.addCustomAttribute(
-      'seriesDescriptions',
-      'Series Descriptions',
-      seriesDescriptionsFromDisplaySets
-    );
     hangingProtocolService.addCustomAttribute(
       'numberOfDisplaySets',
       'Number of displays sets',
       numberOfDisplaySets
     );
-    hangingProtocolService.addCustomAttribute(
-      'numberOfDisplaySetsWithImages',
-      'Number of displays sets with images',
-      numberOfDisplaySetsWithImages
-    );
     hangingProtocolService.addCustomAttribute(
       'maxNumImageFrames',
       'Maximum of number of image frames',
@@ -58,9 +45,6 @@ const testExtension: Types.Extensions.Extension = {
     );
   },
 
-  /** Registers some additional hanging protocols.  See hp/index.tsx for more details */
-  getHangingProtocolModule,
-
   /** Registers some customizations */
   getCustomizationModule,
 };