feat(HP): Added new 3D hanging protocols to be used in the new layout…

… selector (#3844)
OHIF · Dec 8, 2023 · 59576d6 · 59576d6
1 parent 78d4bea
commit 59576d6
Show file tree

Hide file tree

Showing 8 changed files with 952 additions and 292 deletions.
diff --git a/extensions/cornerstone/src/getHangingProtocolModule.ts b/extensions/cornerstone/src/getHangingProtocolModule.ts
@@ -1,295 +1,10 @@
-import { Types } from '@ohif/core';
-
-const mpr: Types.HangingProtocol.Protocol = {
-  id: 'mpr',
-  name: 'Multi-Planar Reconstruction',
-  locked: true,
-  createdDate: '2021-02-23',
-  modifiedDate: '2023-08-15',
-  availableTo: {},
-  editableBy: {},
-  // Unknown number of priors referenced - so just match any study
-  numberOfPriorsReferenced: 0,
-  protocolMatchingRules: [],
-  imageLoadStrategy: 'nth',
-  callbacks: {
-    // Switches out of MPR mode when the layout change button is used
-    onLayoutChange: [
-      {
-        commandName: 'toggleHangingProtocol',
-        commandOptions: { protocolId: 'mpr' },
-        context: 'DEFAULT',
-      },
-    ],
-    // Turns off crosshairs when switching out of MPR mode
-    onProtocolExit: [
-      {
-        commandName: 'cleanUpCrosshairs',
-      },
-    ],
-  },
-  displaySetSelectors: {
-    activeDisplaySet: {
-      seriesMatchingRules: [
-        {
-          weight: 1,
-          attribute: 'isReconstructable',
-          constraint: {
-            equals: {
-              value: true,
-            },
-          },
-          required: true,
-        },
-      ],
-    },
-  },
-  stages: [
-    {
-      name: 'MPR 1x3',
-      viewportStructure: {
-        layoutType: 'grid',
-        properties: {
-          rows: 1,
-          columns: 3,
-          layoutOptions: [
-            {
-              x: 0,
-              y: 0,
-              width: 1 / 3,
-              height: 1,
-            },
-            {
-              x: 1 / 3,
-              y: 0,
-              width: 1 / 3,
-              height: 1,
-            },
-            {
-              x: 2 / 3,
-              y: 0,
-              width: 1 / 3,
-              height: 1,
-            },
-          ],
-        },
-      },
-      viewports: [
-        {
-          viewportOptions: {
-            viewportId: 'mpr-axial',
-            toolGroupId: 'mpr',
-            viewportType: 'volume',
-            orientation: 'axial',
-            initialImageOptions: {
-              preset: 'middle',
-            },
-            syncGroups: [
-              {
-                type: 'voi',
-                id: 'mpr',
-                source: true,
-                target: true,
-              },
-            ],
-          },
-          displaySets: [
-            {
-              id: 'activeDisplaySet',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            viewportId: 'mpr-sagittal',
-            toolGroupId: 'mpr',
-            viewportType: 'volume',
-            orientation: 'sagittal',
-            initialImageOptions: {
-              preset: 'middle',
-            },
-            syncGroups: [
-              {
-                type: 'voi',
-                id: 'mpr',
-                source: true,
-                target: true,
-              },
-            ],
-          },
-          displaySets: [
-            {
-              id: 'activeDisplaySet',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            viewportId: 'mpr-coronal',
-            toolGroupId: 'mpr',
-            viewportType: 'volume',
-            orientation: 'coronal',
-            initialImageOptions: {
-              preset: 'middle',
-            },
-            syncGroups: [
-              {
-                type: 'voi',
-                id: 'mpr',
-                source: true,
-                target: true,
-              },
-            ],
-          },
-          displaySets: [
-            {
-              id: 'activeDisplaySet',
-            },
-          ],
-        },
-      ],
-    },
-  ],
-};
-
-const mprAnd3DVolumeViewport = {
-  id: 'mprAnd3DVolumeViewport',
-  locked: true,
-  name: 'mpr',
-  createdDate: '2023-03-15T10:29:44.894Z',
-  modifiedDate: '2023-03-15T10:29:44.894Z',
-  availableTo: {},
-  editableBy: {},
-  protocolMatchingRules: [],
-  imageLoadStrategy: 'interleaveCenter',
-  displaySetSelectors: {
-    mprDisplaySet: {
-      seriesMatchingRules: [
-        {
-          weight: 1,
-          attribute: 'isReconstructable',
-          constraint: {
-            equals: {
-              value: true,
-            },
-          },
-          required: true,
-        },
-        {
-          attribute: 'Modality',
-          constraint: {
-            equals: {
-              value: 'CT',
-            },
-          },
-          required: true,
-        },
-      ],
-    },
-  },
-  stages: [
-    {
-      id: 'mpr3Stage',
-      name: 'mpr',
-      viewportStructure: {
-        layoutType: 'grid',
-        properties: {
-          rows: 2,
-          columns: 2,
-        },
-      },
-      viewports: [
-        {
-          viewportOptions: {
-            toolGroupId: 'mpr',
-            viewportType: 'volume',
-            orientation: 'axial',
-            initialImageOptions: {
-              preset: 'middle',
-            },
-            syncGroups: [
-              {
-                type: 'voi',
-                id: 'mpr',
-                source: true,
-                target: true,
-              },
-            ],
-          },
-          displaySets: [
-            {
-              id: 'mprDisplaySet',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'volume3d',
-            viewportType: 'volume3d',
-            orientation: 'coronal',
-            customViewportProps: {
-              hideOverlays: true,
-            },
-          },
-          displaySets: [
-            {
-              id: 'mprDisplaySet',
-              options: {
-                displayPreset: 'CT-Bone',
-              },
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'mpr',
-            viewportType: 'volume',
-            orientation: 'coronal',
-            initialImageOptions: {
-              preset: 'middle',
-            },
-            syncGroups: [
-              {
-                type: 'voi',
-                id: 'mpr',
-                source: true,
-                target: true,
-              },
-            ],
-          },
-          displaySets: [
-            {
-              id: 'mprDisplaySet',
-            },
-          ],
-        },
-        {
-          viewportOptions: {
-            toolGroupId: 'mpr',
-            viewportType: 'volume',
-            orientation: 'sagittal',
-            initialImageOptions: {
-              preset: 'middle',
-            },
-            syncGroups: [
-              {
-                type: 'voi',
-                id: 'mpr',
-                source: true,
-                target: true,
-              },
-            ],
-          },
-          displaySets: [
-            {
-              id: 'mprDisplaySet',
-            },
-          ],
-        },
-      ],
-    },
-  ],
-};
+import { fourUp } from './hps/fourUp';
+import { main3D } from './hps/main3D';
+import { mpr } from './hps/mpr';
+import { mprAnd3DVolumeViewport } from './hps/mprAnd3DVolumeViewport';
+import { only3D } from './hps/only3D';
+import { primary3D } from './hps/primary3D';
+import { primaryAxial } from './hps/primaryAxial';
 
 function getHangingProtocolModule() {
   return [
@@ -301,6 +16,26 @@ function getHangingProtocolModule() {
       name: mprAnd3DVolumeViewport.id,
       protocol: mprAnd3DVolumeViewport,
     },
+    {
+      name: fourUp.id,
+      protocol: fourUp,
+    },
+    {
+      name: main3D.id,
+      protocol: main3D,
+    },
+    {
+      name: primaryAxial.id,
+      protocol: primaryAxial,
+    },
+    {
+      name: only3D.id,
+      protocol: only3D,
+    },
+    {
+      name: primary3D.id,
+      protocol: primary3D,
+    },
   ];
 }