fix(segmentation): Changes to fix problems with non hydrated/loaded segmentations to be viewable when switching hanging protocols (e.g. MPR)

[jbocce]

Context

Attempting to switch hanging protocols prior to a segmentation being hydrated/loaded causes various exceptions and blank viewports.

Changes & Results

Adding segmentation via data portal in MPR mode (and other hanging protocols).

Use volumeLoader.createAndCacheVolume to create the volume for a SEG display set. This produces a StreamingImageVolume which is essential for switching to hanging protocols like MPR. RTSTRUCT display sets are now marked as reconstructable.

For when multiple display sets occupy the active viewport, cache and restore each appropriately.

Added tests:

• launch MPR with unhydrated segmentation.
• launch MPR and then add (but not load) a segmentation from the overlay menu
• add (but not load) a segmentation from the overlay menu and then launch MPR

Testing

Three tests at the very least...

Test A

1. Open a study in the viewer
2. Add a segmentation using the data overlay menu. Be sure not to LOAD the segmentation (i.e. ignore any prompts to do so)
3. Switch to a different hanging protocol (e.g., MPR - Multiplanar Reformatting)
4. Ensure that the segmentation appears in the new layout

Test B

1. Open a study in the viewer.
2. Switch to a different hanging protocol (e.g., MPR - Multiplanar Reformatting)
3. Add a segmentation using the data overlay menu in one of the viewports. Be sure not to LOAD the segmentation (i.e. ignore any prompts to do so)
4. Ensure the segmentation appears and the viewports maintain the same view (i.e. just he appearance of the segmentation should change).

Test C

1. Open an study in the viewer.
2. Open a SEG from the thumbnail list either by dragging and dropping it into a viewport or by double clicking it. Be sure not to LOAD the segmentation (i.e. ignore any prompts to do so)
3. Switch to a different hanging protocol (e.g., MPR - Multiplanar Reformatting)
4. Ensure that the segmentation appears in the new layout

Checklist

PR

• My Pull Request title is descriptive, accurate and follows the
  semantic-release format and guidelines.

Code

• My code has been well-documented (function documentation, inline comments,
  etc.)

Public Documentation Updates

• The documentation page has been updated as necessary for any public API
  additions or removals.

Tested Environment

• OS: Windows 11
• Node version: 20.9.0
• Browser: Chrome 137.0.7151.69

[netlify]

✅ Deploy Preview for ohif-dev ready!

Name	Link
🔨 Latest commit	dbd75c7
🔍 Latest deploy log	https://app.netlify.com/projects/ohif-dev/deploys/685e1219aae36500086fd98d
😎 Deploy Preview	https://deploy-preview-5139--ohif-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[jbocce]

No longer is there need to set the overlay display set volumes separately.

[jbocce]

@wayfarer3130, here is where the various overlay display sets are added for the "active display set" of a hanging protocol.

[sedghi]

Thanks

Here are the things i found

1. Go here http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.14519.5.2.1.1706.8374.643249677828306008300337414785

Do the data overlay, see does not work

see https://share.cleanshot.com/MGnJgpFZ

[jbocce]

Thanks

Here are the things i found

1. Go here http://localhost:3000/viewer?StudyInstanceUIDs=1.3.6.1.4.1.14519.5.2.1.1706.8374.643249677828306008300337414785

Do the data overlay, see does not work

see https://share.cleanshot.com/MGnJgpFZ

This issue is related to the next issue I will be looking at regarding RTSTRUCT. I think the problem is that we get an exception when we try to overlay a SEG or RTSTRUCT on a series that is NOT referenced by the SEG or RTSTRUCT series. Can we leave this for now or should continue fixing all these scenarios in this PR?

[wayfarer3130]

I'm getting exceptions in tmtv mode when I double click various series in the initial view and drag/drop different series in, and then return to the original view. Sometimes it works to change views and sometimes it doesnt

[jbocce]

I'm getting exceptions in tmtv mode when I double click various series in the initial view and drag/drop different series in, and then return to the original view. Sometimes it works to change views and sometimes it doesnt

Thanks @wayfarer3130. But could you please give me some exact steps? It appears to work the same as in https://viewer-dev.ohif.org/

[jbocce]

I'm getting exceptions in tmtv mode when I double click various series in the initial view and drag/drop different series in, and then return to the original view. Sometimes it works to change views and sometimes it doesnt

Thanks @wayfarer3130. But could you please give me some exact steps? It appears to work the same as in https://viewer-dev.ohif.org/

Further on this... I have spent a bit of time double clicking series and dragging and dropping series in the TMTV HP. I discovered no specific exceptions that were bugs. I had https://viewer-dev.ohif.org/ side-by-side with this PR branch. Both behaved similarly.

The exceptions I did manage to receive were the following and were ALSO present in master (i.e. viewer-dev)

So @sedghi and @wayfarer3130 unless there are more specific steps and/or exceptions that need to be handled that are CAUSED by this PR, I will not look further.

ViewportGrid.tsx:118 Error: The displaySetInstanceUID 0e19c131-2724-3a1e-e8b9-487df67ed738 does not satisfy the required seriesMatching criteria for the protocol
    at HangingProtocolService._validateRequiredSelectors (HangingProtocolService.ts:1471:1)
    at HangingProtocolService.ts:1438:1
    at Array.forEach (<anonymous>)
    at HangingProtocolService._validateViewportSpecificMatch (HangingProtocolService.ts:1427:1)
    at HangingProtocolService.getViewportsRequireUpdate (HangingProtocolService.ts:713:1)
    at ViewportGrid.tsx:112:1
    at ViewportGrid.tsx:262:1

Route tmtv Error Boundary Error: Volumes being added to viewport fusionCoronal do not share the same FrameOfReferenceUID. This is not yet supported
    at VolumeViewport._isValidVolumeInputArray (BaseVolumeViewport.js:818:1)
    at VolumeViewport.setVolumes (BaseVolumeViewport.js:714:1)
    at VolumeViewport.setVolumes (VolumeViewport.js:101:1)
    at CornerstoneViewportService.setVolumesForViewport (CornerstoneViewportService.ts:895:1)
    at CornerstoneViewportService._setVolumeViewport (CornerstoneViewportService.ts:825:1)
    at CornerstoneViewportService._setDisplaySets (CornerstoneViewportService.ts:1030:1)
    at CornerstoneViewportService.setViewportData (CornerstoneViewportService.ts:468:1)
    at loadViewportData (OHIFCornerstoneViewport.tsx:296:1) null Route tmtv

ViewportGrid.tsx:118 Error: Cannot update viewport with multiple displaySets yet
    at HangingProtocolService.getViewportsRequireUpdate (HangingProtocolService.ts:685:1)
    at ViewportGrid.tsx:112:1
    at ViewportGrid.tsx:262:1

[sedghi]

Let's merge this and then if Bill got some time can report what he is seeing.