Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 | 1x 1x 1x 1x 1x 1x | import {
imageLoader,
Enums,
eventTarget,
imageLoadPoolManager,
cache,
getConfiguration as getCoreConfiguration,
} from '@cornerstonejs/core';
import { addToolState, getToolState } from './state';
import {
getStackData,
requestType,
priority,
clearFromImageIds,
getPromiseRemovedHandler,
} from './stackPrefetchUtils';
import { roundNumber } from '../../utilities';
let configuration = {
maxImagesToPrefetch: Infinity,
// Fetch up to 2 image before and after
minBefore: 2,
maxAfter: 2,
// Increment the cache size by 10 images
directionExtraImages: 10,
preserveExistingPool: false,
};
let resetPrefetchTimeout;
// Starting the prefetch quickly isn't an issue as the main image is already being
// loaded, so a 5 ms prefetch delay is fine
const resetPrefetchDelay = 5;
/**
* Call this to enable stack context sensitive prefetch. Should be called
* before stack data is set in order to start prefetch after load first image.
* This will add a STACK_NEW_IMAGE to detect when a new image is displayed, and then
* update the prefetch stack. The context sensitive prefetch reacts to the
* initial display, or significant moves, the already loaded images, the
* cache size and the direction of navigation. The behaviour is:
*
* 1. On navigating to a new image initially, or one that is at a different position:
* * Fetch the next/previous 2 images
* 2. If the user is navigating forward/backward by less than 5 images, then
* * Prefetch additional images in the direction of navigation, up to 100
* 3. If all the images in a given prefetch have completed, then:
* * Use the last prefetched image size as an image size for the stack
* * Fetch up to 1/4 of the cache size images near the current image
*
* This is designed to:
* * Get nearby images immediately so that they are available for navigation
* * Under the assumption that users might click and view an image, then
* navigate to next/previous image to see the exact image they want
* * Not interfere with loading other viewports if they are still loading
* * Load priority is prefetch, and minimal images are requested initially
* * Load an entire series if it will fit in memory
* * Allows navigating to other parts of the series and display images immediately
* * Have images available for CINE/navigation in one direction even when
* there is more image data than will fit in memory.
* * Up to 100 images in the direction of travel will be prefetched
*
* @param element - to prefetch on
*/
const enable = (element): void => {
const stack = getStackData(element);
if (!stack || !stack.imageIds || stack.imageIds.length === 0) {
console.warn('CornerstoneTools.stackPrefetch: No images in stack.');
return;
}
updateToolState(element);
prefetch(element);
element.removeEventListener(Enums.Events.STACK_NEW_IMAGE, onImageUpdated);
element.addEventListener(Enums.Events.STACK_NEW_IMAGE, onImageUpdated);
const promiseRemovedHandler = getPromiseRemovedHandler(element);
eventTarget.removeEventListener(
Enums.Events.IMAGE_CACHE_IMAGE_REMOVED,
promiseRemovedHandler
);
eventTarget.addEventListener(
Enums.Events.IMAGE_CACHE_IMAGE_REMOVED,
promiseRemovedHandler
);
};
function prefetch(element) {
const stack = getStackData(element);
if (!stack?.imageIds?.length) {
console.warn('CornerstoneTools.stackPrefetch: No images in stack.');
return;
}
// Get the stackPrefetch tool data
const stackPrefetchData = getToolState(element);
if (!stackPrefetchData) {
return;
}
const stackPrefetch = stackPrefetchData || {};
// If all the requests are complete, disable the stackPrefetch tool
stackPrefetch.enabled &&= stackPrefetch.indicesToRequest?.length;
// Make sure the tool is still enabled
if (stackPrefetch.enabled === false) {
return;
}
// Remove an imageIdIndex from the list of indices to request
// This fires when the individual image loading deferred is resolved
function removeFromList(imageIdIndex) {
const index = stackPrefetch.indicesToRequest.indexOf(imageIdIndex);
if (index > -1) {
// Don't remove last element if imageIdIndex not found
stackPrefetch.indicesToRequest.splice(index, 1);
}
}
// Remove all already cached images from the
// IndicesToRequest array.
const indicesToRequestCopy = stackPrefetch.indicesToRequest.slice();
const { currentImageIdIndex } = stack;
indicesToRequestCopy.forEach((imageIdIndex) => {
const imageId = stack.imageIds[imageIdIndex];
if (!imageId) {
return;
}
const distance = Math.abs(currentImageIdIndex - imageIdIndex);
// For nearby objects, ensure the last accessed time is updated
// by using getImageLoadObject.
// For more distant objects, just check if available, but dont
// change the access time.
// This allows throwing data that hasn't been accessed and is not
// nearby.
const imageCached =
distance < 6
? cache.getImageLoadObject(imageId)
: cache.isLoaded(imageId);
if (imageCached) {
// Already in cache
removeFromList(imageIdIndex);
}
});
// Stop here if there are no images left to request
// After those in the cache have been removed
if (!stackPrefetch.indicesToRequest.length) {
return;
}
// Clear the requestPool of prefetch requests, if needed.
if (!configuration.preserveExistingPool) {
imageLoadPoolManager.filterRequests(clearFromImageIds(stack));
}
function doneCallback(imageId) {
const imageIdIndex = stack.imageIds.indexOf(imageId);
removeFromList(imageIdIndex);
const image = cache.getCachedImageBasedOnImageURI(imageId);
const { stats } = stackPrefetch;
const decodeTimeInMS = image?.image?.decodeTimeInMS || 0;
if (decodeTimeInMS) {
stats.imageIds.set(imageId, decodeTimeInMS);
stats.decodeTimeInMS += decodeTimeInMS;
const loadTimeInMS = image?.image?.loadTimeInMS || 0;
stats.loadTimeInMS += loadTimeInMS;
}
if (!stackPrefetch.indicesToRequest.length) {
if (image?.sizeInBytes) {
const { sizeInBytes } = image;
const usage = cache.getMaxCacheSize() / 4 / sizeInBytes;
if (!stackPrefetch.cacheFill) {
stats.initialTime = Date.now() - stats.start;
stats.initialSize = stats.imageIds.size;
updateToolState(element, usage);
prefetch(element);
} else if (stats.imageIds.size) {
stats.fillTime = Date.now() - stats.start;
const { size } = stats.imageIds;
stats.fillSize = size;
console.log(
'Done cache fill',
stats.fillTime,
'ms',
size,
'items',
'average total time',
roundNumber(stats.fillTime / size),
'ms',
'average load',
roundNumber(stats.loadTimeInMS / size),
'ms',
'average decode',
roundNumber(stats.decodeTimeInMS / size),
'ms'
);
}
}
}
}
const requestFn = (imageId, options) =>
imageLoader
.loadAndCacheImage(imageId, options)
.then(() => doneCallback(imageId));
const { useNorm16Texture, preferSizeOverAccuracy } =
getCoreConfiguration().rendering;
const useNativeDataType = useNorm16Texture || preferSizeOverAccuracy;
indicesToRequestCopy.forEach((imageIdIndex) => {
const imageId = stack.imageIds[imageIdIndex];
// IMPORTANT: Request type should be passed if not the 'interaction'
// highest priority will be used for the request type in the imageRetrievalPool
const options = {
targetBuffer: {
type: useNativeDataType ? undefined : 'Float32Array',
},
preScale: {
enabled: true,
},
useNativeDataType,
requestType,
};
imageLoadPoolManager.addRequest(
requestFn.bind(null, imageId, options),
requestType,
// Additional details
{
imageId,
},
priority
// addToBeginning
);
});
}
function onImageUpdated(e) {
// Start prefetching again (after a delay)
// When the user has scrolled to a new image
clearTimeout(resetPrefetchTimeout);
resetPrefetchTimeout = setTimeout(function () {
const element = e.target;
// If playClip is enabled and the user loads a different series in the viewport
// An exception will be thrown because the element will not be enabled anymore
try {
updateToolState(element);
prefetch(element);
} catch (error) {
return;
}
}, resetPrefetchDelay);
}
// Not a full signum, but good enough for direction.
const signum = (x) => (x < 0 ? -1 : 1);
const updateToolState = (element, usage?: number) => {
const stack = getStackData(element);
if (!stack || !stack.imageIds || stack.imageIds.length === 0) {
console.warn('CornerstoneTools.stackPrefetch: No images in stack.');
return;
}
const { currentImageIdIndex } = stack;
let { maxAfter = 2, minBefore = 2 } = configuration;
const { directionExtraImages = 10 } = configuration;
// Use the currentImageIdIndex from the stack as the initialImageIdIndex
const stackPrefetchData = getToolState(element) || {
indicesToRequest: [],
currentImageIdIndex,
stackCount: 0,
enabled: true,
direction: 1,
stats: {
start: Date.now(),
imageIds: new Map(),
decodeTimeInMS: 0,
loadTimeInMS: 0,
totalBytes: 0,
},
};
const delta = currentImageIdIndex - stackPrefetchData.currentImageIdIndex;
stackPrefetchData.direction = signum(delta);
stackPrefetchData.currentImageIdIndex = currentImageIdIndex;
stackPrefetchData.enabled = true;
if (stackPrefetchData.stackCount < 100) {
stackPrefetchData.stackCount += directionExtraImages;
}
if (Math.abs(delta) > maxAfter || !delta) {
// Not incrementing by 1, so stop increasing the data size
// TODO - consider reversing the CINE playback
stackPrefetchData.stackCount = 0;
if (usage) {
// The usage of the cache that this stack can use
const positionFraction = currentImageIdIndex / stack.imageIds.length;
minBefore = Math.ceil(usage * positionFraction);
maxAfter = Math.ceil(usage * (1 - positionFraction));
stackPrefetchData.cacheFill = true;
} else {
stackPrefetchData.cacheFill = false;
}
} else if (delta < 0) {
minBefore += stackPrefetchData.stackCount;
maxAfter = 0;
} else {
maxAfter += stackPrefetchData.stackCount;
minBefore = 0;
}
const minIndex = Math.max(0, currentImageIdIndex - minBefore);
const maxIndex = Math.min(
stack.imageIds.length - 1,
currentImageIdIndex + maxAfter
);
// Order these correctly initially
const indicesToRequest = [];
for (let i = currentImageIdIndex + 1; i <= maxIndex; i++) {
indicesToRequest.push(i);
}
for (let i = currentImageIdIndex - 1; i >= minIndex; i--) {
indicesToRequest.push(i);
}
stackPrefetchData.indicesToRequest = indicesToRequest;
addToolState(element, stackPrefetchData);
};
function disable(element) {
clearTimeout(resetPrefetchTimeout);
element.removeEventListener(Enums.Events.STACK_NEW_IMAGE, onImageUpdated);
const promiseRemovedHandler = getPromiseRemovedHandler(element);
eventTarget.removeEventListener(
Enums.Events.IMAGE_CACHE_IMAGE_REMOVED,
promiseRemovedHandler
);
const stackPrefetchData = getToolState(element);
// If there is actually something to disable, disable it
if (stackPrefetchData && stackPrefetchData.data.length) {
stackPrefetchData.enabled = false;
// Don't worry about clearing the requests - there aren't that many too be bothersome
}
}
function getConfiguration() {
return configuration;
}
function setConfiguration(config) {
configuration = config;
}
const stackContextPrefetch = {
enable,
disable,
getConfiguration,
setConfiguration,
};
export default stackContextPrefetch;
|