feat: Add interleaved HTJ2K and volume progressive loading (#4276)

extensions/cornerstone/src/index.tsx

@@ -42,6 +42,7 @@ import { createFrameViewSynchronizer } from './synchronizers/frameViewSynchroniz
 
 const { helpers: volumeLoaderHelpers } = csStreamingImageVolumeLoader;
 const { getDynamicVolumeInfo } = volumeLoaderHelpers ?? {};
+const { imageRetrieveMetadataProvider } = cornerstone.utilities;
 
 const Component = React.lazy(() => {
   return import(/* webpackPrefetch: true */ './Viewport/OHIFCornerstoneViewport');
@@ -55,6 +56,15 @@ const OHIFCornerstoneViewport = props => {
   );
 };
 
+const stackRetrieveOptions = {
+  retrieveOptions: {
+    single: {
+      streaming: true,
+      decodeLevel: 1,
+    },
+  },
+};
+
 /**
  *
  */
@@ -80,6 +90,21 @@ const cornerstoneExtension: Types.Extensions.Extension = {
     toolbarService.registerEventForToolbarUpdate(cornerstone.eventTarget, [
       cornerstoneTools.Enums.Events.TOOL_ACTIVATED,
     ]);
+
+    // Configure the interleaved/HTJ2K loader
+    imageRetrieveMetadataProvider.clear();
+    // The default volume interleaved options are to interleave the
+    // image retrieve, but don't perform progressive loading per image
+    // This interleaves images and replicates them for low-resolution depth volume
+    // reconstruction, which progressively improves
+    imageRetrieveMetadataProvider.add(
+      'volume',
+      cornerstone.ProgressiveRetrieveImages.interleavedRetrieveStages
+    );
+    // The default stack loading option is to progressive load HTJ2K images
+    // There are other possible options, but these need more thought about
+    // how to define them.
+    imageRetrieveMetadataProvider.add('stack', stackRetrieveOptions);
   },
 
   onModeExit: ({ servicesManager }: withAppTypes): void => {

extensions/cornerstone/src/init.tsx

@@ -99,7 +99,7 @@ export default async function init({
     hangingProtocolService,
     viewportGridService,
     stateSyncService,
-    studyPrefetcherService
+    studyPrefetcherService,
   } = servicesManager.services;
 
   window.services = servicesManager.services;
@@ -180,10 +180,12 @@ export default async function init({
   ); // this provider is required for Calibration tool
   metaData.addProvider(metadataProvider.get.bind(metadataProvider), 9999);
 
+  // These are set reasonably low to allow for interleaved retrieves and slower
+  // connections.
   imageLoadPoolManager.maxNumRequests = {
-    interaction: appConfig?.maxNumRequests?.interaction || 100,
-    thumbnail: appConfig?.maxNumRequests?.thumbnail || 75,
-    prefetch: appConfig?.maxNumRequests?.prefetch || 10,
+    interaction: appConfig?.maxNumRequests?.interaction || 10,
+    thumbnail: appConfig?.maxNumRequests?.thumbnail || 5,
+    prefetch: appConfig?.maxNumRequests?.prefetch || 5,
   };
 
   initWADOImageLoader(userAuthenticationService, appConfig, extensionManager);