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>
This commit is contained in:
1 parent
ea0963d75f
commit
8f2604509d
26 files changed
+970
-384
No files matched your search
@@ -1,14 +1,28 @@
|
||||
import log from '../log.js';
|
||||
import OHIFError from './OHIFError';
|
||||
import cornerstone from 'cornerstone-core';
|
||||
import cornerstoneTools from 'cornerstone-tools';
|
||||
|
||||
import getImageId from '../utils/getImageId.js';
|
||||
|
||||
const noop = () => {};
|
||||
|
||||
export class StudyPrefetcher {
|
||||
constructor(studies) {
|
||||
options = {
|
||||
order: 'closest',
|
||||
displaySetCount: 1,
|
||||
onImageCached: noop,
|
||||
requestType: 'prefetch',
|
||||
preventCache: false,
|
||||
prefetchDisplaySetsTimeout: 300,
|
||||
includeActiveDisplaySet: false,
|
||||
};
|
||||
|
||||
constructor(studies, options) {
|
||||
this.studies = studies || [];
|
||||
this.prefetchDisplaySetsTimeout = 300;
|
||||
this.lastActiveViewportElement = null;
|
||||
|
||||
if (options) {
|
||||
this.options = { ...this.options, ...options };
|
||||
this.options.requestType = 'prefetch';
|
||||
}
|
||||
|
||||
cornerstone.events.addEventListener(
|
||||
'cornerstoneimagecachefull.StudyPrefetcher',
|
||||
@@ -16,6 +30,9 @@ export class StudyPrefetcher {
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove previously set event listeners and stop prefetching.
|
||||
*/
|
||||
destroy() {
|
||||
this.stopPrefetching();
|
||||
cornerstone.events.removeEventListener(
|
||||
@@ -24,68 +41,117 @@ export class StudyPrefetcher {
|
||||
);
|
||||
}
|
||||
|
||||
static getInstance() {
|
||||
/**
|
||||
* Get StudyPrefetcher singleton instance.
|
||||
*
|
||||
* @param {array} studies
|
||||
* @param {object} options
|
||||
* @returns
|
||||
*/
|
||||
static getInstance(studies = [], options) {
|
||||
if (!StudyPrefetcher.instance) {
|
||||
StudyPrefetcher.instance = new StudyPrefetcher([]);
|
||||
StudyPrefetcher.instance = new StudyPrefetcher(studies, options);
|
||||
}
|
||||
|
||||
if (options) {
|
||||
this.options = { ...this.options, ...options };
|
||||
this.options.requestType = 'prefetch';
|
||||
}
|
||||
|
||||
return StudyPrefetcher.instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* OHIF study metadata instances.
|
||||
*
|
||||
* @param {array} studies
|
||||
*/
|
||||
setStudies(studies) {
|
||||
this.stopPrefetching();
|
||||
this.studies = studies;
|
||||
}
|
||||
|
||||
prefetch() {
|
||||
/**
|
||||
* Get previously prefetched element.
|
||||
*
|
||||
* @returns {HTMLElement} Previously prefetched element.
|
||||
*/
|
||||
getElement() {
|
||||
return this.element;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prefetch related display sets based on cornerstone viewport element
|
||||
* with previously set options.
|
||||
*
|
||||
* @param {*} element
|
||||
* @param {string} displaySetInstanceUID the display set instance uid
|
||||
* @returns
|
||||
*/
|
||||
prefetch(element, displaySetInstanceUID) {
|
||||
if (!this.studies || !this.studies.length) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.element = element;
|
||||
this.enabledElement = cornerstone.getEnabledElement(element);
|
||||
|
||||
this.stopPrefetching();
|
||||
this.prefetchDisplaySets();
|
||||
this.prefetchDisplaySets(displaySetInstanceUID);
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop prefetching images.
|
||||
*/
|
||||
stopPrefetching() {
|
||||
cornerstoneTools.requestPoolManager.clearRequestStack('prefetch');
|
||||
}
|
||||
|
||||
prefetchDisplaySetsAsync(timeout) {
|
||||
timeout = timeout || this.prefetchDisplaySetsTimeout;
|
||||
|
||||
/**
|
||||
* Prefetch display sets async.
|
||||
*
|
||||
* @param {HTMLElement} element cornerstone viewport element
|
||||
* @param {number} timeout
|
||||
*/
|
||||
prefetchDisplaySetsAsync(element, timeout) {
|
||||
this.enabledElement = cornerstone.getEnabledElement(element);
|
||||
timeout = timeout || this.options.prefetchDisplaySetsTimeout;
|
||||
clearTimeout(this.prefetchDisplaySetsHandler);
|
||||
this.prefetchDisplaySetsHandler = setTimeout(() => {
|
||||
this.prefetchDisplaySets();
|
||||
this.prefetchDisplaySets(element);
|
||||
}, timeout);
|
||||
}
|
||||
|
||||
prefetchDisplaySets() {
|
||||
// TODO: Allow passing in config
|
||||
let config = {
|
||||
order: 'closest',
|
||||
displaySetCount: 1,
|
||||
};
|
||||
|
||||
const displaySetsToPrefetch = this.getDisplaySetsToPrefetch(config);
|
||||
/**
|
||||
* Extract all image ids from all display sets to be fetched and
|
||||
* call method to add images to request pool manager.
|
||||
*
|
||||
* @param {string} displaySetInstanceUID the display set instance uid
|
||||
*/
|
||||
prefetchDisplaySets(displaySetInstanceUID) {
|
||||
const displaySetsToPrefetch = this.getDisplaySetsToPrefetch(
|
||||
displaySetInstanceUID
|
||||
);
|
||||
const imageIds = this.getImageIdsFromDisplaySets(displaySetsToPrefetch);
|
||||
|
||||
this.prefetchImageIds(imageIds);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add image ids to request pool manager.
|
||||
*
|
||||
* @param {array} imageIds
|
||||
*/
|
||||
prefetchImageIds(imageIds) {
|
||||
const nonCachedImageIds = this.filterCachedImageIds(imageIds);
|
||||
const requestPoolManager = cornerstoneTools.requestPoolManager;
|
||||
const requestType = 'prefetch';
|
||||
const preventCache = false;
|
||||
const noop = () => {};
|
||||
|
||||
nonCachedImageIds.forEach(imageId => {
|
||||
requestPoolManager.addRequest(
|
||||
{},
|
||||
imageId,
|
||||
requestType,
|
||||
preventCache,
|
||||
noop,
|
||||
this.options.requestType,
|
||||
this.options.preventCache,
|
||||
() => {},
|
||||
noop
|
||||
);
|
||||
});
|
||||
@@ -93,26 +159,45 @@ export class StudyPrefetcher {
|
||||
requestPoolManager.startGrabbing();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get study by cornerstone image instance.
|
||||
*
|
||||
* @param {object} image
|
||||
* @returns
|
||||
*/
|
||||
getStudy(image) {
|
||||
const StudyInstanceUID = cornerstone.metaData.get(
|
||||
'StudyInstanceUID',
|
||||
image.imageId
|
||||
);
|
||||
return OHIF.viewer.Studies.find(
|
||||
study => study.StudyInstanceUID === StudyInstanceUID
|
||||
const studies = this.studies;
|
||||
return studies.find(
|
||||
study => study.getData().StudyInstanceUID === StudyInstanceUID
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get study series by cornerstone image instance.
|
||||
*
|
||||
* @param {object} study OHIF study instance
|
||||
* @param {object} image cornerstone image instance object
|
||||
* @returns
|
||||
*/
|
||||
getSeries(study, image) {
|
||||
const SeriesInstanceUID = cornerstone.metaData.get(
|
||||
'SeriesInstanceUID',
|
||||
image.imageId
|
||||
);
|
||||
const studyMetadata = OHIF.viewerbase.getStudyMetadata(study);
|
||||
|
||||
return studyMetadata.getSeriesByUID(SeriesInstanceUID);
|
||||
return study.getSeriesByUID(SeriesInstanceUID);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get sop instance by cornerstone image instance.
|
||||
*
|
||||
* @param {array} series
|
||||
* @param {object} image
|
||||
* @returns
|
||||
*/
|
||||
getInstance(series, image) {
|
||||
const instanceMetadata = cornerstone.metaData.get(
|
||||
'instance',
|
||||
@@ -121,7 +206,33 @@ export class StudyPrefetcher {
|
||||
return series.getInstanceByUID(instanceMetadata.SOPInstanceUID);
|
||||
}
|
||||
|
||||
getActiveDisplaySet(displaySets, instance) {
|
||||
/**
|
||||
* Returns the display set with given uid.
|
||||
*
|
||||
* @param {string} displaySetInstanceUID the display set instance uid
|
||||
* @returns {object} displaySet
|
||||
*/
|
||||
getDisplaySetByUID(displaySetInstanceUID) {
|
||||
let displaySet;
|
||||
this.studies.forEach(study => {
|
||||
const ds = study.displaySets.find(
|
||||
ds => ds.displaySetInstanceUID === displaySetInstanceUID
|
||||
);
|
||||
if (ds) {
|
||||
displaySet = ds;
|
||||
}
|
||||
});
|
||||
return displaySet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get display set by SOPInstanceUID.
|
||||
*
|
||||
* @param {array} displaySets
|
||||
* @param {object} instance
|
||||
* @returns
|
||||
*/
|
||||
getDisplaySetBySOPInstanceUID(displaySets, instance) {
|
||||
return displaySets.find(displaySet => {
|
||||
return displaySet.images.some(displaySetImage => {
|
||||
return displaySetImage.SOPInstanceUID === instance.SOPInstanceUID;
|
||||
@@ -129,25 +240,48 @@ export class StudyPrefetcher {
|
||||
});
|
||||
}
|
||||
|
||||
getDisplaySetsToPrefetch(config) {
|
||||
/**
|
||||
* Get active viewport image based on cornerstone viewport element.
|
||||
* @returns
|
||||
*/
|
||||
getActiveViewportImage() {
|
||||
if (!this.enabledElement) {
|
||||
return;
|
||||
}
|
||||
|
||||
return this.enabledElement.image;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prefetch display sets based on cornerstone viewport element image.
|
||||
*
|
||||
* @param {string} displaySetInstanceUID the display set instance uid
|
||||
* @returns {array} displaySets
|
||||
*/
|
||||
getDisplaySetsToPrefetch(displaySetInstanceUID) {
|
||||
const image = this.getActiveViewportImage();
|
||||
|
||||
if (!image || !config || !config.displaySetCount) {
|
||||
if (!image) {
|
||||
return [];
|
||||
}
|
||||
|
||||
/*const study = this.getStudy(image);
|
||||
const study = this.getStudy(image);
|
||||
const series = this.getSeries(study, image);
|
||||
const instance = this.getInstance(series, image);*/
|
||||
const instance = this.getInstance(series, image);
|
||||
const displaySets = study.displaySets;
|
||||
const activeDisplaySet = null; //this.getActiveDisplaySet(displaySets, instance);
|
||||
const activeDisplaySet = displaySetInstanceUID
|
||||
? this.getDisplaySetByUID(displaySetInstanceUID)
|
||||
: this.getDisplaySetBySOPInstanceUID(displaySets, instance);
|
||||
|
||||
const prefetchMethodMap = {
|
||||
topdown: 'getFirstDisplaySets',
|
||||
downward: 'getNextDisplaySets',
|
||||
upward: 'getPreviousDisplaySets',
|
||||
closest: 'getClosestDisplaySets',
|
||||
all: 'getAllDisplaySets',
|
||||
};
|
||||
|
||||
const prefetchOrder = config.order;
|
||||
const prefetchOrder = this.options.order;
|
||||
const methodName = prefetchMethodMap[prefetchOrder];
|
||||
const getDisplaySets = this[methodName];
|
||||
|
||||
@@ -163,18 +297,59 @@ export class StudyPrefetcher {
|
||||
this,
|
||||
displaySets,
|
||||
activeDisplaySet,
|
||||
config.displaySetCount
|
||||
this.options.displaySetCount,
|
||||
this.options.includeActiveDisplaySet
|
||||
);
|
||||
}
|
||||
|
||||
getFirstDisplaySets(displaySets, activeDisplaySet, displaySetCount) {
|
||||
/**
|
||||
* Get all display sets.
|
||||
*
|
||||
* @param {array} displaySets
|
||||
* @param {object} activeDisplaySet
|
||||
* @param {number} displaySetCount
|
||||
* @param {boolean} includeActiveDisplaySet
|
||||
* @returns
|
||||
*/
|
||||
getAllDisplaySets(
|
||||
displaySets,
|
||||
activeDisplaySet,
|
||||
displaySetCount,
|
||||
includeActiveDisplaySet
|
||||
) {
|
||||
const length = displaySets.length;
|
||||
const selectedDisplaySets = [];
|
||||
|
||||
for (let i = 0; i < length; i++) {
|
||||
const displaySet = displaySets[i];
|
||||
selectedDisplaySets.push(displaySet);
|
||||
}
|
||||
|
||||
return selectedDisplaySets;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all display sets in order after the active display set.
|
||||
*
|
||||
* @param {array} displaySets
|
||||
* @param {object} activeDisplaySet
|
||||
* @param {number} displaySetCount
|
||||
* @param {boolean} includeActiveDisplaySet
|
||||
* @returns
|
||||
*/
|
||||
getFirstDisplaySets(
|
||||
displaySets,
|
||||
activeDisplaySet,
|
||||
displaySetCount,
|
||||
includeActiveDisplaySet
|
||||
) {
|
||||
const length = displaySets.length;
|
||||
const selectedDisplaySets = [];
|
||||
|
||||
for (let i = 0; i < length && displaySetCount; i++) {
|
||||
const displaySet = displaySets[i];
|
||||
|
||||
if (displaySet !== activeDisplaySet) {
|
||||
if (includeActiveDisplaySet || displaySet !== activeDisplaySet) {
|
||||
selectedDisplaySets.push(displaySet);
|
||||
displaySetCount--;
|
||||
}
|
||||
@@ -183,21 +358,78 @@ export class StudyPrefetcher {
|
||||
return selectedDisplaySets;
|
||||
}
|
||||
|
||||
getNextDisplaySets(displaySets, activeDisplaySet, displaySetCount) {
|
||||
/**
|
||||
* Get all display sets before the active display set.
|
||||
*
|
||||
* @param {array} displaySets
|
||||
* @param {object} activeDisplaySet
|
||||
* @param {number} displaySetCount
|
||||
* @param {boolean} includeActiveDisplaySet
|
||||
* @returns
|
||||
*/
|
||||
getPreviousDisplaySets(
|
||||
displaySets,
|
||||
activeDisplaySet,
|
||||
displaySetCount,
|
||||
includeActiveDisplaySet
|
||||
) {
|
||||
const activeDisplaySetIndex = displaySets.indexOf(activeDisplaySet);
|
||||
const begin = activeDisplaySetIndex + 1;
|
||||
const end = Math.min(begin + displaySetCount, displaySets.length);
|
||||
const end = includeActiveDisplaySet
|
||||
? activeDisplaySetIndex + 1
|
||||
: activeDisplaySetIndex;
|
||||
const previousDisplaySets = displaySets.slice(0, end);
|
||||
return previousDisplaySets.reverse().slice(0, displaySetCount);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all display sets after the active display set.
|
||||
*
|
||||
* @param {array} displaySets
|
||||
* @param {object} activeDisplaySet
|
||||
* @param {number} displaySetCount
|
||||
* @param {boolean} includeActiveDisplaySet
|
||||
* @returns
|
||||
*/
|
||||
getNextDisplaySets(
|
||||
displaySets,
|
||||
activeDisplaySet,
|
||||
displaySetCount,
|
||||
includeActiveDisplaySet
|
||||
) {
|
||||
const activeDisplaySetIndex = displaySets.indexOf(activeDisplaySet);
|
||||
const begin = includeActiveDisplaySet
|
||||
? activeDisplaySetIndex
|
||||
: activeDisplaySetIndex + 1;
|
||||
const end = Math.min(begin + displaySetCount, displaySets.length);
|
||||
return displaySets.slice(begin, end);
|
||||
}
|
||||
|
||||
getClosestDisplaySets(displaySets, activeDisplaySet, displaySetCount) {
|
||||
/**
|
||||
* Get all display set closest to the active display set.
|
||||
*
|
||||
* @param {array} displaySets
|
||||
* @param {object} activeDisplaySet
|
||||
* @param {number} displaySetCount
|
||||
* @param {boolean} includeActiveDisplaySet
|
||||
* @returns
|
||||
*/
|
||||
getClosestDisplaySets(
|
||||
displaySets,
|
||||
activeDisplaySet,
|
||||
displaySetCount,
|
||||
includeActiveDisplaySet
|
||||
) {
|
||||
const activeDisplaySetIndex = displaySets.indexOf(activeDisplaySet);
|
||||
const length = displaySets.length;
|
||||
const selectedDisplaySets = [];
|
||||
let left = activeDisplaySetIndex - 1;
|
||||
let right = activeDisplaySetIndex + 1;
|
||||
|
||||
if (includeActiveDisplaySet) {
|
||||
selectedDisplaySets.push(displaySets[activeDisplaySetIndex]);
|
||||
displaySetCount--;
|
||||
}
|
||||
|
||||
while ((left >= 0 || right < length) && displaySetCount) {
|
||||
if (left >= 0) {
|
||||
selectedDisplaySets.push(displaySets[left]);
|
||||
@@ -215,6 +447,12 @@ export class StudyPrefetcher {
|
||||
return selectedDisplaySets;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all image ids from display sets.
|
||||
*
|
||||
* @param {array} displaySets
|
||||
* @returns {array} image ids
|
||||
*/
|
||||
getImageIdsFromDisplaySets(displaySets) {
|
||||
let imageIds = [];
|
||||
|
||||
@@ -225,9 +463,19 @@ export class StudyPrefetcher {
|
||||
return imageIds;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all image ids from a given display set.
|
||||
*
|
||||
* @param {array} displaySet
|
||||
* @returns
|
||||
*/
|
||||
getImageIdsFromDisplaySet(displaySet) {
|
||||
const imageIds = [];
|
||||
|
||||
if (!displaySet.images || displaySet.images.length < 1) {
|
||||
return [];
|
||||
}
|
||||
|
||||
// TODO: This duplicates work done by the stack manager
|
||||
displaySet.images.forEach(image => {
|
||||
const numFrames = image.numFrames;
|
||||
@@ -245,15 +493,30 @@ export class StudyPrefetcher {
|
||||
return imageIds;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter cached image ids from a set of image ids.
|
||||
*
|
||||
* @param {array} imageIds
|
||||
* @returns {array} images not cached
|
||||
*/
|
||||
filterCachedImageIds(imageIds) {
|
||||
return imageIds.filter(imageId => !this.isImageCached(imageId));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if image id is cached in cornerstone.
|
||||
*
|
||||
* @param {string} imageId
|
||||
* @returns
|
||||
*/
|
||||
isImageCached(imageId) {
|
||||
const image = cornerstone.imageCache.imageCache[imageId];
|
||||
return image && image.sizeInBytes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Warns that cache is full and stops prefetching.
|
||||
*/
|
||||
cacheFullHandler = () => {
|
||||
log.warn('Cache full');
|
||||
this.stopPrefetching();
|
||||
|
||||
Reference in new issue
Block a user