From b2128976a38a0491741f2856e67d7b3f9366afe9 Mon Sep 17 00:00:00 2001
From: Bill Wallace <wayfarer3130@gmail.com>
Date: Tue, 28 Mar 2023 11:18:33 -0400
Subject: [PATCH] Fix/hp validate match offset 2 (#3279)

* fix: Validate provided display sets other than 0

* Build fix
---
 README.md                                     |   3 +-
 .../default/src/getHangingProtocolModule.js   | 111 +++++++++++++++---
 .../HangingProtocolService.ts                 |  11 +-
 3 files changed, 104 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 0de590f74..f861a4803 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,8 @@
 <!-- markdownlint-disable -->
 <div align="center">
   <h1>OHIF Medical Imaging Viewer</h1>
-  <p><strong>The OHIF Viewer</strong> is a zero-footprint medical image viewer provided by the <a href="https://ohif.org/">Open Health Imaging Foundation (OHIF)</a>. It is a configurable and extensible progressive web application with out-of-the-box support for image archives which support <a href="https://www.dicomstandard.org/dicomweb/">DICOMweb</a>.</p>
+  <p><strong>The OHIF Viewer</strong> is a zero-footprint medical image viewer
+provided by the <a href="https://ohif.org/">Open Health Imaging Foundation (OHIF)</a>. It is a configurable and extensible progressive web application with out-of-the-box support for image archives which support <a href="https://www.dicomstandard.org/dicomweb/">DICOMweb</a>.</p>
 </div>
 
 
diff --git a/extensions/default/src/getHangingProtocolModule.js b/extensions/default/src/getHangingProtocolModule.js
index 42b7bde9d..3df2c9a56 100644
--- a/extensions/default/src/getHangingProtocolModule.js
+++ b/extensions/default/src/getHangingProtocolModule.js
@@ -98,7 +98,7 @@ const defaultProtocol = {
       viewportStructure: {
         layoutType: 'grid',
         properties: {
-          rows: 1,
+          rows: 2,
           columns: 2,
         },
       },
@@ -137,13 +137,7 @@ const defaultProtocol = {
           ],
         },
         {
-          viewportOptions: {
-            toolGroupId: 'default',
-            // initialImageOptions: {
-            //   index: 180,
-            //   preset: 'middle', // 'first', 'last', 'middle'
-            // },
-          },
+          viewportOptions: {},
           displaySets: [
             {
               id: 'defaultDisplaySetId',
@@ -154,10 +148,61 @@ const defaultProtocol = {
       ],
     },
 
+    {
+      name: '3x1',
+      // Indicate that the number of viewports needed is 2 filled viewports,
+      // but that 4 viewports are preferred.
+      stageActivation: {
+        enabled: {
+          minViewportsMatched: 3,
+        },
+      },
+
+      viewportStructure: {
+        layoutType: 'grid',
+        properties: {
+          rows: 1,
+          columns: 3,
+        },
+      },
+      viewports: [
+        {
+          viewportOptions: {
+            toolGroupId: 'default',
+          },
+          displaySets: [
+            {
+              id: 'defaultDisplaySetId',
+              matchedDisplaySetsIndex: 2,
+            },
+          ],
+        },
+        {
+          viewportOptions: {
+            toolGroupId: 'default',
+          },
+          displaySets: [
+            {
+              id: 'defaultDisplaySetId',
+              matchedDisplaySetsIndex: 1,
+            },
+          ],
+        },
+        {
+          viewportOptions: {},
+          displaySets: [
+            {
+              id: 'defaultDisplaySetId',
+            },
+          ],
+        },
+      ],
+    },
+
     // This is an example of a layout with more than one element in it
     // It can be navigated to using , and . (prev/next stage)
     {
-      name: '1x2',
+      name: '2x1',
       // Indicate that the number of viewports needed is 1 filled viewport,
       // but that 2 viewports are preferred.
       stageActivation: {
@@ -185,17 +230,42 @@ const defaultProtocol = {
           displaySets: [
             {
               id: 'defaultDisplaySetId',
+              // Shows the second index of this image set
+              matchedDisplaySetsIndex: 1,
             },
           ],
         },
         {
-          viewportOptions: {
-            toolGroupId: 'default',
-            // initialImageOptions: {
-            //   index: 180,
-            //   preset: 'middle', // 'first', 'last', 'middle'
-            // },
-          },
+          viewportOptions: {},
+          displaySets: [
+            {
+              id: 'defaultDisplaySetId',
+            },
+          ],
+        },
+      ],
+    },
+
+    {
+      name: '2x1',
+      // Indicate that the number of viewports needed is 1 filled viewport,
+      // but that 2 viewports are preferred.
+      stageActivation: {
+        enabled: {
+          minViewportsMatched: 3,
+        },
+      },
+
+      viewportStructure: {
+        layoutType: 'grid',
+        properties: {
+          rows: 2,
+          columns: 1,
+        },
+      },
+      viewports: [
+        {
+          viewportOptions: {},
           displaySets: [
             {
               id: 'defaultDisplaySetId',
@@ -204,8 +274,15 @@ const defaultProtocol = {
             },
           ],
         },
+        {
+          viewportOptions: {},
+          displaySets: [
+            {
+              id: 'defaultDisplaySetId',
+            },
+          ],
+        },
       ],
-      createdDate: '2021-02-23T18:32:42.850Z',
     },
   ],
 };
diff --git a/platform/core/src/services/HangingProtocolService/HangingProtocolService.ts b/platform/core/src/services/HangingProtocolService/HangingProtocolService.ts
index 01e8b0e0f..b366450d9 100644
--- a/platform/core/src/services/HangingProtocolService/HangingProtocolService.ts
+++ b/platform/core/src/services/HangingProtocolService/HangingProtocolService.ts
@@ -1011,6 +1011,7 @@ export default class HangingProtocolService extends PubSubService {
   ): HangingProtocol.DisplaySetMatchDetails {
     if (!matchDetails) return;
     if (offset === 0) return matchDetails;
+    const { matchingScores = [] } = matchDetails;
     if (offset === -1) {
       const { inDisplay } = options;
       if (!inDisplay) return matchDetails;
@@ -1022,13 +1023,14 @@ export default class HangingProtocolService extends PubSubService {
         ) {
           const match = matchDetails.matchingScores[i];
           return match.matchingScore > 0
-            ? matchDetails.matchingScores[i]
+            ? { matchingScores, ...matchDetails.matchingScores[i] }
             : null;
         }
       }
       return;
     }
-    return matchDetails.matchingScores[offset];
+    const matchFound = matchingScores[offset];
+    return matchFound ? { ...matchFound, matchingScores } : undefined;
   }
 
   protected validateDisplaySetSelectMatch(
@@ -1037,6 +1039,9 @@ export default class HangingProtocolService extends PubSubService {
     displaySetUID: string
   ): void {
     if (match.displaySetInstanceUID === displaySetUID) return;
+    if (!match.matchingScores) {
+      throw new Error('No matchingScores found in ' + match);
+    }
     for (const subMatch of match.matchingScores) {
       if (subMatch.displaySetInstanceUID === displaySetUID) return;
     }
@@ -1085,7 +1090,7 @@ export default class HangingProtocolService extends PubSubService {
       const reuseDisplaySetUID =
         id &&
         displaySetSelectorMap[
-        `${activeStudyUID}:${id}:${matchedDisplaySetsIndex || 0}`
+          `${activeStudyUID}:${id}:${matchedDisplaySetsIndex || 0}`
         ];
       const viewportDisplaySetMain = this.displaySetMatchDetails.get(id);