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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 2x 2x 2x 1x 135x 135x 135x 135x 135x 338x 2x 1x 358x 333x 1x 126x 126x 126x 126x 1x 70x 70x 70x 12x 70x 70x 70x 70x 70x 1x 70x 1x 357x 357x 480x 480x 357x 123x 123x 357x 1x 357x 357x 424x 424x 357x 67x 67x 197x 197x 196x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 131x 131x 131x 1x 130x 130x 130x 130x 130x 1x 1x 129x 1x 128x 1x 127x 2x 125x 125x 125x 125x 125x 125x 125x 125x 4x 4x 285x 1x 284x 284x 262x 22x 22x 5x 5x 4x 1x 158x 158x 158x 30x 30x 30x 30x 30x 30x 158x 158x 158x 30x 158x 153x 5x 70x 70x 70x 70x 70x 70x 70x 70x 70x 70x 70x 70x 70x 70x 70x 70x 1x 157x 1x 156x 156x 59x 97x 97x 1x 1x 1x 1363x 1363x 1363x 111x 1252x 1252x 1x 1x 1x 1x 1x 1x 1x 1x 128x 1x 127x 127x 1x 126x 126x 126x 126x 1x 72x 1x 71x 71x 1x 70x 70x 70x 70x 1x 1x 251x 1x 140x 1x 1x 70x 70x 70x 70x 70x 1x | import {
ICache,
IImage,
IGeometry,
IImageLoadObject,
IVolumeLoadObject,
IGeometryLoadObject,
ICachedImage,
ICachedVolume,
ICachedGeometry,
EventTypes,
IImageVolume,
} from '../types';
import { triggerEvent, imageIdToURI } from '../utilities';
import eventTarget from '../eventTarget';
import Events from '../enums/Events';
import { ImageVolume } from './classes/ImageVolume';
const ONE_GB = 1073741824;
/**
* Stores images, volumes and geometry.
* There are two sizes - the max cache size, that controls the overal maximum
* size, and the instance size, which controls how big any single object can
* be. Defaults are 3 GB and 2 GB - 8 bytes (just enough to allow allocating it
* without crashing).
* The 3 gb is tuned to the chromium garbage collection cycle to allow image volumes
* to be used/discarded.
*/
class Cache implements ICache {
// used to store image data (2d)
private readonly _imageCache = new Map<string, ICachedImage>(); // volatile space
// used to store volume data (3d)
private readonly _volumeCache = new Map<string, ICachedVolume>(); // non-volatile space
// Todo: contour for now, but will be used for surface, etc.
private readonly _geometryCache: Map<string, ICachedGeometry>;
private _imageCacheSize = 0;
private _volumeCacheSize = 0;
private _maxCacheSize = 3 * ONE_GB;
private _maxInstanceSize = 2 * ONE_GB - 8;
constructor() {
// used to store object data (contour, surface, etc.)
this._geometryCache = new Map();
}
/**
* Set the maximum cache Size
*
* Maximum cache size should be set before adding the data. If set after,
* and it is smaller than the current size, will cause issues.
*
* @param newMaxCacheSize - new maximum cache size
*
*/
public setMaxCacheSize = (newMaxCacheSize: number): void => {
if (!newMaxCacheSize || typeof newMaxCacheSize !== 'number') {
const errorMessage = `New max cacheSize ${this._maxCacheSize} should be defined and should be a number.`;
throw new Error(errorMessage);
}
this._maxCacheSize = newMaxCacheSize;
};
/**
* Checks if there is enough space in the cache for requested byte size
*
* It returns false, if the sum of volatile (image) cache and unallocated cache
* is less than the requested byteLength
*
* @param byteLength - byte length of requested byte size
*
* @returns - boolean indicating if there is enough space in the cache
*/
public isCacheable = (byteLength: number): boolean => {
Iif (byteLength > this._maxInstanceSize) {
return false;
}
const unallocatedSpace = this.getBytesAvailable();
const imageCacheSize = this._imageCacheSize;
const availableSpace = unallocatedSpace + imageCacheSize;
return availableSpace > byteLength;
};
/**
* Returns maximum CacheSize allowed
*
* @returns maximum allowed cache size
*/
public getMaxCacheSize = (): number => this._maxCacheSize;
/**
* Returns maximum size of a single instance (volume or single image)
*
* @returns maximum instance size
*/
public getMaxInstanceSize = (): number => this._maxInstanceSize;
/**
* Returns current size of the cache
*
* @returns current size of the cache
*/
public getCacheSize = (): number =>
this._imageCacheSize + this._volumeCacheSize;
/**
* Returns the unallocated size of the cache
*
*/
public getBytesAvailable(): number {
return this.getMaxCacheSize() - this.getCacheSize();
}
/**
* Deletes the imageId from the image cache
*
* @param imageId - imageId
*
*/
private _decacheImage = (imageId: string) => {
const { imageLoadObject } = this._imageCache.get(imageId);
// Cancel any in-progress loading
Iif (imageLoadObject.cancelFn) {
imageLoadObject.cancelFn();
}
Iif (imageLoadObject.decache) {
imageLoadObject.decache();
}
this._imageCache.delete(imageId);
};
/**
* Deletes the volumeId from the volume cache
*
* @param volumeId - volumeId
*
*/
private _decacheVolume = (volumeId: string) => {
const cachedVolume = this._volumeCache.get(volumeId);
const { volumeLoadObject, volume } = cachedVolume;
if (volume.cancelLoading) {
volume.cancelLoading();
}
Eif (volume.imageData) {
volume.imageData.delete();
}
// if we had views for the images of the volume, we need to restore them
// to avoid memory leaks
this._restoreImagesFromBuffer(volume);
Iif (volumeLoadObject.cancelFn) {
// Cancel any in-progress loading
volumeLoadObject.cancelFn();
}
if (volumeLoadObject.decache) {
volumeLoadObject.decache();
}
this._volumeCache.delete(volumeId);
};
/**
* Deletes all the images and volumes in the cache
*
* Relevant events are fired for each decached image (IMAGE_CACHE_IMAGE_REMOVED) and
* the decached volume (VOLUME_CACHE_VOLUME_REMOVED).
*
* @fires Events.IMAGE_CACHE_IMAGE_REMOVED
* @fires Events.VOLUME_CACHE_VOLUME_REMOVED
*
*/
public purgeCache = (): void => {
const imageIterator = this._imageCache.keys();
/* eslint-disable no-constant-condition */
while (true) {
const { value: imageId, done } = imageIterator.next();
if (done) {
break;
}
this.removeImageLoadObject(imageId);
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, { imageId });
}
this.purgeVolumeCache();
};
/**
* Deletes all the volumes in the cache
*/
public purgeVolumeCache = (): void => {
const volumeIterator = this._volumeCache.keys();
/* eslint-disable no-constant-condition */
while (true) {
const { value: volumeId, done } = volumeIterator.next();
if (done) {
break;
}
this.removeVolumeLoadObject(volumeId);
triggerEvent(eventTarget, Events.VOLUME_CACHE_VOLUME_REMOVED, {
volumeId,
});
}
};
/**
* Purges the cache if necessary based on the requested number of bytes
*
* 1) it sorts the volatile (image) cache based on the most recent used images
* and starts purging from the oldest ones.
* Note: for a volume, if the volume-related image Ids is provided, it starts
* by purging the none-related image Ids (those that are not related to the
* current volume)
* 2) For a volume, if we purge all images that won't be included in this volume and still
* don't have enough unallocated space, purge images that will be included
* in this volume until we have enough space. These will need to be
* re-fetched, but we must do this not to straddle over the given memory
* limit, even for a short time, as this may crash the application.
*
* @fires Events.IMAGE_CACHE_IMAGE_REMOVED
*
* @param numBytes - Number of bytes for the image/volume that is
* going to be stored inside the cache
* @param volumeImageIds - list of imageIds that correspond to the
* volume whose numberOfBytes we want to store in the cache.
* @returns bytesAvailable or undefined in purging cache
* does not successfully make enough space for the requested number of bytes
*/
public decacheIfNecessaryUntilBytesAvailable(
numBytes: number,
volumeImageIds?: Array<string>
): number | undefined {
let bytesAvailable = this.getBytesAvailable();
// If max cache size has not been exceeded, do nothing
if (bytesAvailable >= numBytes) {
return bytesAvailable;
}
let cachedImages = Array.from(this._imageCache.values());
// Cache size has been exceeded, create list of images sorted by timeStamp
// So we can purge the least recently used image
function compare(a, b) {
if (a.timeStamp > b.timeStamp) {
return 1;
}
if (a.timeStamp < b.timeStamp) {
return -1;
}
return 0;
}
cachedImages.sort(compare);
let cachedImageIds = cachedImages.map((im) => im.imageId);
let imageIdsToPurge = cachedImageIds;
// if we are making space for a volume, we start by purging the imageIds
// that are not related to the volume
Eif (volumeImageIds) {
imageIdsToPurge = cachedImageIds.filter(
(id) => !volumeImageIds.includes(id)
);
}
// Remove images (that are not related to the volume) from volatile cache
// until the requested number of bytes become available
for (const imageId of imageIdsToPurge) {
this.removeImageLoadObject(imageId);
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, { imageId });
bytesAvailable = this.getBytesAvailable();
Eif (bytesAvailable >= numBytes) {
return bytesAvailable;
}
}
// Remove the imageIds (both volume related and not related)
cachedImages = Array.from(this._imageCache.values());
cachedImageIds = cachedImages.map((im) => im.imageId);
// Remove volume-image Ids from volatile cache until the requested number of bytes
// become available
for (const imageId of cachedImageIds) {
this.removeImageLoadObject(imageId);
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, { imageId });
bytesAvailable = this.getBytesAvailable();
if (bytesAvailable >= numBytes) {
return bytesAvailable;
}
}
// Technically we should not reach here, since isCacheable will throw an
// error if unallocated + volatile (image) cache cannot fit the upcoming
// number of bytes
}
/**
* Puts a new image load object into the cache
*
* First, it creates a CachedImage object and put it inside the imageCache for
* the imageId. After the imageLoadObject promise resolves to an image,
* it: 1) adds the image into the correct CachedImage object 2) increments the
* cache size, 3) triggers IMAGE_CACHE_IMAGE_ADDED 4) Purge the cache if
* necessary -- if the cache size is greater than the maximum cache size, it
* iterates over the imageCache and decache them one by one until the cache
* size becomes less than the maximum allowed cache size
*
* @fires Events.IMAGE_CACHE_IMAGE_ADDED
* @fires Events.CACHE_SIZE_EXCEEDED if the cache size exceeds the maximum
*
* @param imageId - ImageId for the image
* @param imageLoadObject - The object that is loading or loaded the image
*/
public putImageLoadObject(
imageId: string,
imageLoadObject: IImageLoadObject
): Promise<any> {
Iif (imageId === undefined) {
throw new Error('putImageLoadObject: imageId must not be undefined');
}
Iif (imageLoadObject.promise === undefined) {
throw new Error(
'putImageLoadObject: imageLoadObject.promise must not be undefined'
);
}
if (this._imageCache.has(imageId)) {
throw new Error('putImageLoadObject: imageId already in cache');
}
Iif (
imageLoadObject.cancelFn &&
typeof imageLoadObject.cancelFn !== 'function'
) {
throw new Error(
'putImageLoadObject: imageLoadObject.cancel must be a function'
);
}
const cachedImage: ICachedImage = {
loaded: false,
imageId,
sharedCacheKey: undefined, // The sharedCacheKey for this imageId. undefined by default
imageLoadObject,
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._imageCache.set(imageId, cachedImage);
return imageLoadObject.promise
.then((image: IImage) => {
if (!this._imageCache.get(imageId)) {
// If the image has been purged before being loaded, we stop here.
console.warn(
'The image was purged from the cache before it completed loading.'
);
return;
}
if (
image.sizeInBytes === undefined ||
Number.isNaN(image.sizeInBytes)
) {
throw new Error(
'putImageLoadObject: image.sizeInBytes must not be undefined'
);
}
if (image.sizeInBytes.toFixed === undefined) {
throw new Error(
'putImageLoadObject: image.sizeInBytes is not a number'
);
}
// check if there is enough space in unallocated + image Cache
if (!this.isCacheable(image.sizeInBytes)) {
throw new Error(Events.CACHE_SIZE_EXCEEDED);
}
// if there is, decache if necessary
this.decacheIfNecessaryUntilBytesAvailable(image.sizeInBytes);
cachedImage.loaded = true;
cachedImage.image = image;
cachedImage.sizeInBytes = image.sizeInBytes;
this.incrementImageCacheSize(cachedImage.sizeInBytes);
const eventDetails: EventTypes.ImageCacheImageAddedEventDetail = {
image: cachedImage,
};
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_ADDED, eventDetails);
cachedImage.sharedCacheKey = image.sharedCacheKey;
})
.catch((error) => {
// console.warn(error)
this._imageCache.delete(imageId);
throw error;
});
}
/**
* Returns the object that is loading a given imageId
*
* @param imageId - Image ID
* @returns IImageLoadObject
*/
public getImageLoadObject(imageId: string): IImageLoadObject {
if (imageId === undefined) {
throw new Error('getImageLoadObject: imageId must not be undefined');
}
const cachedImage = this._imageCache.get(imageId);
if (cachedImage === undefined) {
return;
}
// Bump time stamp for cached image
cachedImage.timeStamp = Date.now();
return cachedImage.imageLoadObject;
}
/**
* It checks the imageCache for the provided imageId, and returns true
* if the image is loaded, false otherwise. Note, this only checks the imageCache
* and does not check the volume cache.
* @param imageId - image Id to check
* @returns boolean
*/
public isLoaded(imageId: string): boolean {
const cachedImage = this._imageCache.get(imageId);
if (!cachedImage) {
return false;
}
return cachedImage.loaded;
}
/**
* Returns the volume that contains the requested imageId. It will check the
* imageIds inside the volume to find a match.
*
* @param imageId - ImageId
* @returns - Volume object
*/
public getVolumeContainingImageId(imageId: string): {
volume: IImageVolume;
imageIdIndex: number;
} {
const volumeIds = Array.from(this._volumeCache.keys());
const imageIdToUse = imageIdToURI(imageId);
for (const volumeId of volumeIds) {
const cachedVolume = this._volumeCache.get(volumeId);
const { volume } = cachedVolume;
Iif (!volume?.imageIds?.length) {
return;
}
const imageIdIndex = volume.getImageURIIndex(imageIdToUse);
Eif (imageIdIndex > -1) {
return { volume, imageIdIndex };
}
}
}
/**
* Returns the cached image from the imageCache for the requested imageId.
* It first strips the imageId to remove the data loading scheme.
*
* @param imageId - Image ID
* @returns cached image
*/
public getCachedImageBasedOnImageURI(
imageId: string
): ICachedImage | undefined {
const imageURIToUse = imageIdToURI(imageId);
const cachedImageIds = Array.from(this._imageCache.keys());
const foundImageId = cachedImageIds.find((imageId) => {
return imageIdToURI(imageId) === imageURIToUse;
});
if (!foundImageId) {
return;
}
return this._imageCache.get(foundImageId);
}
/**
* Puts a new image load object into the cache
*
* First, it creates a CachedVolume object and put it inside the volumeCache for
* the volumeId. After the volumeLoadObject promise resolves to a volume,
* it: 1) adds the volume into the correct CachedVolume object inside volumeCache
* 2) increments the cache size, 3) triggers VOLUME_CACHE_VOLUME_ADDED 4) Purge
* the cache if necessary -- if the cache size is greater than the maximum cache size, it
* iterates over the imageCache (not volumeCache) and decache them one by one
* until the cache size becomes less than the maximum allowed cache size
*
* @fires Events.VOLUME_CACHE_VOLUME_ADDED
*
* @param volumeId - volumeId of the volume
* @param volumeLoadObject - The object that is loading or loaded the volume
*/
public putVolumeLoadObject(
volumeId: string,
volumeLoadObject: IVolumeLoadObject
): Promise<any> {
Iif (volumeId === undefined) {
throw new Error('putVolumeLoadObject: volumeId must not be undefined');
}
Iif (volumeLoadObject.promise === undefined) {
throw new Error(
'putVolumeLoadObject: volumeLoadObject.promise must not be undefined'
);
}
Iif (this._volumeCache.has(volumeId)) {
throw new Error(
`putVolumeLoadObject: volumeId:${volumeId} already in cache`
);
}
Iif (
volumeLoadObject.cancelFn &&
typeof volumeLoadObject.cancelFn !== 'function'
) {
throw new Error(
'putVolumeLoadObject: volumeLoadObject.cancel must be a function'
);
}
// todo: @Erik there are two loaded flags, one inside cachedVolume and the other
// inside the volume.loadStatus.loaded, the actual all pixelData loaded is the
// loadStatus one. This causes confusion
const cachedVolume: ICachedVolume = {
loaded: false,
volumeId,
volumeLoadObject,
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._volumeCache.set(volumeId, cachedVolume);
return volumeLoadObject.promise
.then((volume: IImageVolume) => {
Iif (!this._volumeCache.get(volumeId)) {
// If the image has been purged before being loaded, we stop here.
console.warn(
'The image was purged from the cache before it completed loading.'
);
return;
}
Iif (Number.isNaN(volume.sizeInBytes)) {
throw new Error(
'putVolumeLoadObject: volume.sizeInBytes must not be undefined'
);
}
Iif (volume.sizeInBytes.toFixed === undefined) {
throw new Error(
'putVolumeLoadObject: volume.sizeInBytes is not a number'
);
}
// this.isCacheable is called at the volume loader, before requesting
// the images of the volume
this.decacheIfNecessaryUntilBytesAvailable(
volume.sizeInBytes,
// @ts-ignore: // todo ImageVolume does not have imageIds
volume.imageIds
);
// cachedVolume.loaded = true
cachedVolume.volume = volume;
cachedVolume.sizeInBytes = volume.sizeInBytes;
this.incrementVolumeCacheSize(cachedVolume.sizeInBytes);
const eventDetails: EventTypes.VolumeCacheVolumeAddedEventDetail = {
volume: cachedVolume,
};
triggerEvent(
eventTarget,
Events.VOLUME_CACHE_VOLUME_ADDED,
eventDetails
);
})
.catch((error) => {
this._volumeCache.delete(volumeId);
throw error;
});
}
/**
* Returns the object that is loading a given volumeId
*
* @param volumeId - Volume ID
* @returns IVolumeLoadObject
*/
public getVolumeLoadObject = (volumeId: string): IVolumeLoadObject => {
if (volumeId === undefined) {
throw new Error('getVolumeLoadObject: volumeId must not be undefined');
}
const cachedVolume = this._volumeCache.get(volumeId);
if (cachedVolume === undefined) {
return;
}
// Bump time stamp for cached volume (not used for anything for now)
cachedVolume.timeStamp = Date.now();
return cachedVolume.volumeLoadObject;
};
public getGeometry = (geometryId: string): IGeometry => {
if (geometryId == null) {
throw new Error('getGeometry: geometryId must not be undefined');
}
const cachedGeometry = this._geometryCache.get(geometryId);
if (cachedGeometry === undefined) {
return;
}
// Bump time stamp for cached geometry (not used for anything for now)
cachedGeometry.timeStamp = Date.now();
return cachedGeometry.geometry;
};
/**
* Returns the image associated with the imageId
*
* @param imageId - image ID
* @returns Image
*/
public getImage = (imageId: string): IImage => {
if (imageId === undefined) {
throw new Error('getImage: imageId must not be undefined');
}
const cachedImage = this._imageCache.get(imageId);
if (cachedImage === undefined) {
return;
}
// Bump time stamp for cached volume (not used for anything for now)
cachedImage.timeStamp = Date.now();
return cachedImage.image;
};
/**
* Returns the volume associated with the volumeId
*
* @param volumeId - Volume ID
* @returns Volume
*/
public getVolume = (volumeId: string): IImageVolume => {
Iif (volumeId === undefined) {
throw new Error('getVolume: volumeId must not be undefined');
}
const cachedVolume = this._volumeCache.get(volumeId);
if (cachedVolume === undefined) {
return;
}
// Bump time stamp for cached volume (not used for anything for now)
cachedVolume.timeStamp = Date.now();
return cachedVolume.volume;
};
/**
* Retrieves an array of image volumes from the cache.
* @returns An array of image volumes.
*/
public getVolumes = (): Array<IImageVolume> => {
const cachedVolumes = Array.from(this._volumeCache.values());
return cachedVolumes.map((cachedVolume) => cachedVolume.volume);
};
/**
* Filters the cached volumes by the specified reference volume ID.
* @param volumeId - The ID of the reference volume.
* @returns An array of image volumes that have the specified reference volume ID.
*/
public filterVolumesByReferenceId = (
volumeId: string
): Array<IImageVolume> => {
const cachedVolumes = this.getVolumes();
return cachedVolumes.filter((volume) => {
return volume.referencedVolumeId === volumeId;
});
};
/**
* Removes the image loader associated with a given Id from the cache
*
* It increases the cache size after removing the image.
*
* @fires Events.IMAGE_CACHE_IMAGE_REMOVED
*
* @param imageId - Image ID
*/
public removeImageLoadObject = (imageId: string): void => {
if (imageId === undefined) {
throw new Error('removeImageLoadObject: imageId must not be undefined');
}
const cachedImage = this._imageCache.get(imageId);
if (cachedImage === undefined) {
throw new Error(
'removeImageLoadObject: imageId was not present in imageCache'
);
}
this.incrementImageCacheSize(-cachedImage.sizeInBytes);
const eventDetails = {
image: cachedImage,
imageId,
};
triggerEvent(eventTarget, Events.IMAGE_CACHE_IMAGE_REMOVED, eventDetails);
this._decacheImage(imageId);
};
/**
* Removes the volume loader associated with a given Id from the cache
*
* It increases the cache size after removing the image.
*
* @fires Events.VOLUME_CACHE_VOLUME_REMOVED
*
* @param imageId - ImageId
*/
public removeVolumeLoadObject = (volumeId: string): void => {
if (volumeId === undefined) {
throw new Error('removeVolumeLoadObject: volumeId must not be undefined');
}
const cachedVolume = this._volumeCache.get(volumeId);
if (cachedVolume === undefined) {
throw new Error(
'removeVolumeLoadObject: volumeId was not present in volumeCache'
);
}
this.incrementVolumeCacheSize(-cachedVolume.sizeInBytes);
const eventDetails = {
volume: cachedVolume,
volumeId,
};
triggerEvent(eventTarget, Events.VOLUME_CACHE_VOLUME_REMOVED, eventDetails);
this._decacheVolume(volumeId);
};
putGeometryLoadObject = (
geometryId: string,
geometryLoadObject: IGeometryLoadObject
): Promise<void> => {
if (geometryId == undefined) {
throw new Error(
'putGeometryLoadObject: geometryId must not be undefined'
);
}
if (this._geometryCache.has(geometryId)) {
throw new Error(
'putGeometryLoadObject: geometryId already present in geometryCache'
);
}
const cachedGeometry: ICachedGeometry = {
geometryId,
geometryLoadObject,
loaded: false,
timeStamp: Date.now(),
sizeInBytes: 0,
};
this._geometryCache.set(geometryId, cachedGeometry);
return geometryLoadObject.promise
.then((geometry: IGeometry) => {
if (!this._geometryCache.has(geometryId)) {
console.warn(
'putGeometryLoadObject: geometryId was removed from geometryCache'
);
return;
}
if (Number.isNaN(geometry.sizeInBytes)) {
throw new Error(
'putGeometryLoadObject: geometry.sizeInBytes is not a number'
);
}
// Todo: fix is cacheable
cachedGeometry.loaded = true;
cachedGeometry.geometry = geometry;
cachedGeometry.sizeInBytes = geometry.sizeInBytes;
// this._incrementGeometryCacheSize(geometry.sizeInBytes);
const eventDetails = {
geometry,
geometryId,
};
triggerEvent(
eventTarget,
Events.GEOMETRY_CACHE_GEOMETRY_ADDED,
eventDetails
);
return;
})
.catch((error) => {
this._geometryCache.delete(geometryId);
throw error;
});
};
/**
* Increases the image cache size with the provided increment
*
* @param increment - bytes length
*/
public incrementImageCacheSize = (increment: number) => {
this._imageCacheSize += increment;
};
/**
* Increases the cache size with the provided increment
*
* @param increment - bytes length
*/
public incrementVolumeCacheSize = (increment: number) => {
this._volumeCacheSize += increment;
};
/**
* Decreases the image cache size with the provided decrement
*
* @param decrement - bytes length
*/
public decrementImageCacheSize = (decrement: number) => {
this._imageCacheSize -= decrement;
};
/**
* Decreases the cache size with the provided decrement
*
* @param decrement - bytes length
*/
public decrementVolumeCacheSize = (decrement: number) => {
this._volumeCacheSize -= decrement;
};
/**
* This function will restore the images' pixel data from the shared array buffer
* back to the individual images when the volume is purged from cache. It ensures
* that each image retrieves its correct portion of data from the buffer based on
* the previously stored offset and length information.
*
* @param volumeId - The volumeId whose images need to be restored.
*/
private _restoreImagesFromBuffer(volume: IImageVolume) {
Iif (!(volume instanceof ImageVolume)) {
console.warn(
'Volume is not an ImageVolume. Cannot restore images from buffer.'
);
return;
}
// Retrieve the scalar data and the offset map from the volume
const scalarData = volume.getScalarData();
const imageCacheOffsetMap = volume.imageCacheOffsetMap;
Eif (imageCacheOffsetMap.size === 0) {
// This happens during testing and isn't an issue
// console.warn('No cached images to restore for this volume.');
return;
}
// Iterate over each image and restore its pixel data from the shared buffer
for (const [imageId, { offset }] of imageCacheOffsetMap) {
const image = this.getImage(imageId);
if (!image) {
console.warn(`Image with id ${imageId} not found in cache.`);
continue;
}
const viewPixelData = image.getPixelData();
const length = viewPixelData.length;
// Create a new view of the buffer for this specific image
// @ts-ignore
const pixelData = new viewPixelData.constructor(
scalarData.buffer,
offset,
length
);
// Restore the original getPixelData function and pixelData
image.getPixelData = () => pixelData;
if (image.imageFrame) {
image.imageFrame.pixelData = pixelData;
}
delete image.bufferView;
// Optionally, increment the image cache size again if needed
this.incrementImageCacheSize(image.sizeInBytes);
}
console.log(`Images restored from buffer for volume ${volume.volumeId}.`);
}
}
/**
* This module deals with Caching of images and volumes
* The cache has two main components: a volatile portion for images and a
* non-volatile portion for volumes. Individual 2D images are volatile and
* will be replaced by new images hitting the cache. When you allocate volumes,
* these are non-volatile and reserve a block of memory from the cache.
* Volumes must be released manually.
* We will have a shared block of memory allocated for the entire cache, e.g. 1GB
* which will be shared for images and volumes.
*
* **When a new image is added:**
* We check if there is enough unallocated + volatile space for the single image
*
* if so
* - We allocate the image in image cache, and if necessary oldest images
* are decached to match the maximumCacheSize criteria
* - If a volume contains that imageId, copy it over using TypedArray's set method.
* If no volumes contain the imageId, the image is fetched by image loaders
*
* If not (cache is mostly/completely full with volumes)
* - throw that the cache does not have enough working space to allocate the image
*
*
* **When a new volume is added:**
* Check if there is enough unallocated + volatile space to allocate the volume:
*
* If so:
* - Decache oldest images which won't be included in this volume until
* we have enough free space for the volume
* - If not enough space from previous space, decache images that will be included
* in the volume until we have enough free space (These will need to be re-fetched,
* but we must do this not to straddle over the given memory limit, even for a
* short time, as this may crash the app)
* - At this point, if any of the frames (indexed by imageId) are present in the volatile
* image cache, copy these over to the volume now
*
* If not (cache is mostly/completely full with volumes),
* - throw that the cache does not have enough working space to allocate the volume.
*
*/
const cache = new Cache();
export default cache;
export { Cache }; // for documentation
|