ohif-viewer/docs/latest/viewer/studyPrefetcher.md
Igor Octaviano 8f2604509d
feat: OHIF-1000: Study prefetcher (#2466)
* Enable study prefetcher and expose configs

* Fix progress for all images

* Enable study loading listener

* Add new default for displaying progress bar for series

* Use events instead of redux to improve performance

* Add documentation, resolve issues with different datasets

* CR Updates

* CR Updates

* CR Updates & Resolve issue when activating both stack and study prefetch

* Add upward and update display set logic

* Add new behavior to prefetching orders

* Rollback display set check and activate cache check

* Remove prefetch check

* Check if displayset has images

* Debounce check cache events

* Remove usued debounce flags

* Ignore prefetching same image

* Use new image instead of image rendered

* Continue prefetch after cache check

* Update prefetch logic after checking cache

* Remove log

* Update displayset count default to 3

* Update netlify config

Co-authored-by: Alireza <ar.sedghi@gmail.com>
2021-09-09 09:58:24 +02:00

1.7 KiB

Viewer: Study Prefetcher & Stack Prefetch

Prefetching the stack of images of the active viewport is enabled by default for cornerstone viewports via cornerstone tools's stack prefetch functionality.

In order to have a more customizable alternative for prefetching, OHIF provides a built-in study prefetcher functionality which allows the user to set the order in which the display sets are prefetched, the granularity, the timeout and whether or not display a progress bar in the display set (close to the thumbnail image) in the study browser.

You can customize these options via the viewer's configuration:

window.config = {
  /**
   * OHIF's study prefetcher configuration.
   *
   * @param {boolean} enabled Whether to enable/disable OHIF's study prefetcher
   * @param {('all'|'closest'|'downward'|'upward'|'topdown')} order Fetching order: all display sets, the closest ones, downward or top down fashion based on the currently selected display set
   * @param {number} displaySetCount How much display sets should be prefetched at once (note: this attribute is ignored if order was set to 'all')
   * @param {boolean} preventCache Prevent images to be cached in Cornerstone Tools's request pool manager
   * @param {number} prefetchDisplaySetsTimeout Prefetch timeout
   * @param {boolean} displayProgress Whether to display or not the progress bar in the display set
   * @param {boolean} includeActiveDisplaySet Include or not the active display set while prefetching
   */
  studyPrefetcher: {
    enabled: true,
    order: 'all',
    displaySetCount: 1,
    preventCache: false,
    prefetchDisplaySetsTimeout: 300,
    displayProgress: false,
    includeActiveDisplaySet: true,
  },
};