feat: add cache status for loadAndCache (#356)

* feat: add cache status for loadAndCache

* fix: tag & f

* Update docs

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: daron1337

README.md

@@ -8,9 +8,9 @@
 
 ## Dicom Image Toolkit for CornerstoneJS
 
-### Current version: 2.5.0
+### Current version: 2.5.1
 
-### Latest Published Release: 2.5.0
+### Latest Published Release: 2.5.1
 
 This library provides common DICOM functionalities to be used in web-applications: it's wrapper that simplifies the use of cornerstone-js environment.
 

dist/imaging/imageStore.d.ts

@@ -7,6 +7,9 @@ type StoreSeries = {
     imageIds: string[];
     progress: number;
     elementId: string;
+    cached: {
+        [imageId: string]: boolean;
+    };
 };
 type Store = {
     colormapId: string;
@@ -29,7 +32,7 @@ type SetPayload = ["errorLog" | "leftActiveTool" | "rightActiveTool", string] |
     ("progress" | "loading" | "minPixelValue" | "maxPixelValue" | "minSliceId" | "maxSliceId" | "minTimeId" | "maxTimeId" | "rotation" | "scale" | "sliceId" | "timeId" | "thickness" | "numberOfFrames" | "numberOfTemporalPositions"),
     string,
     number
-] | ["timestamp", string, number | undefined] | ["seriesUID" | "modality", string, string | undefined] | ["pendingSliceId", string, number | undefined] | ["timestamps" | "timeIds" | "pixelShift", string, number[]] | [
+] | ["cached", string, string, boolean] | ["timestamp", string, number | undefined] | ["seriesUID" | "modality", string, string | undefined] | ["pendingSliceId", string, number | undefined] | ["timestamps" | "timeIds" | "pixelShift", string, number[]] | [
     "contrast" | "dimensions" | "spacing" | "translation",
     string,
     number,

dist/larvitar.js

@@ -74,8 +74,8 @@ <h3> </h3>
 <h1 id="larvitar">Larvitar</h1>
 <p><a href="https://github.com/dvisionlab/Larvitar"><img src="https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&amp;prefix=%E2%89%A5&amp;suffix=%25&amp;query=$.typeCoverage.atLeast&amp;uri=https%3A%2F%2Fraw.githubusercontent.com%2Fplantain-00%2Ftype-coverage%2Fmaster%2Fpackage.json" alt="type-coverage"></a></p>
 <h2 id="dicom-image-toolkit-for-cornerstonejs">Dicom Image Toolkit for CornerstoneJS</h2>
-<h3 id="current-version%3A-2.5.0">Current version: 2.5.0</h3>
-<h3 id="latest-published-release%3A-2.5.0">Latest Published Release: 2.5.0</h3>
+<h3 id="current-version%3A-2.5.1">Current version: 2.5.1</h3>
+<h3 id="latest-published-release%3A-2.5.1">Latest Published Release: 2.5.1</h3>
 <p>This library provides common DICOM functionalities to be used in web-applications: it's wrapper that simplifies the use of cornerstone-js environment.</p>
 <h2 id="features%3A">Features:</h2>
 <ul>

dist/larvitar.js.map

@@ -460,6 +460,7 @@ const parseFile = function (file: File) {
               const positionerSecondaryAngle = metadata["x00181511"]
                 ? metadata["x00181511"]
                 : 0;
+              imageObject.metadata.biplane = {};
               imageObject.metadata.biplane.tag = tag;
               imageObject.metadata.biplane.referencedSOPInstanceUID =
                 referencedSOPInstanceUID;

docs/documentation/index.html

@@ -106,6 +106,7 @@ export function loadAndCacheImage(
     //check if it is a metadata-only object
     if (imageId && series.instances[imageId].metadata.pixelDataLength != 0) {
       cornerstone.loadAndCacheImage(imageId).then(function () {
+        setStore(["cached", series.larvitarSeriesInstanceUID, imageId, true]);
         const t1 = performance.now();
         console.debug(`Call to cacheImages took ${t1 - t0} milliseconds.`);
         console.debug(
@@ -170,6 +171,7 @@ export function loadAndCacheImages(
     //check if it is a metadata-only object
     if (imageId && series.instances[imageId].metadata.pixelDataLength != 0) {
       cornerstone.loadAndCacheImage(imageId).then(function () {
+        setStore(["cached", series.larvitarSeriesInstanceUID, imageId, true]);
         updateProgress();
         callback(response);
       });
@@ -698,7 +700,7 @@ export const updateImage = async function (
             );
           }
         }
-
+        setStore(["cached", series.larvitarSeriesInstanceUID, imageId, true]);
         setStore(["sliceId", id, imageIndex]);
         const pendingSliceId = store.get(["viewports", id, "pendingSliceId"]);
         if (imageIndex == pendingSliceId) {

docs/examples/larvitar.js

@@ -7,7 +7,12 @@
 import { get as _get, cloneDeep as _cloneDeep } from "lodash";
 import type { StoreViewport } from "./types.d";
 
-type StoreSeries = { imageIds: string[]; progress: number; elementId: string };
+type StoreSeries = {
+  imageIds: string[];
+  progress: number;
+  elementId: string;
+  cached: { [imageId: string]: boolean };
+};
 
 type Store = {
   colormapId: string;
@@ -57,6 +62,7 @@ type SetPayload =
       string,
       number
     ]
+  | ["cached", string, string, boolean]
   | ["timestamp", string, number | undefined]
   | ["seriesUID" | "modality", string, string | undefined]
   | ["pendingSliceId", string, number | undefined]
@@ -201,6 +207,15 @@ const setValue = (store: Store, data: SetPayload) => {
       triggerSeriesListener(k);
       break;
 
+    case "cached":
+      if (!store.series[k]) {
+        return;
+      }
+      v = v as [string, boolean];
+      store.series[k][field][v[0]] = v[1];
+      triggerSeriesListener(k);
+      break;
+
     case "seriesUID":
       if (!viewport) {
         return;
@@ -415,6 +430,11 @@ export default {
       STORE!.series[seriesId] = {} as StoreSeries;
     }
     STORE!.series[seriesId].imageIds = imageIds;
+    // for each imageId create a cached[imageId] = false
+    STORE!.series[seriesId].cached = {};
+    imageIds.forEach(imageId => {
+      STORE!.series[seriesId].cached[imageId] = false;
+    });
     triggerSeriesListener(seriesId);
   },
   removeSeriesId: (seriesId: string) => {

imaging/imageParsing.ts

@@ -8,7 +8,7 @@ import cornerstone from "cornerstone-core";
 
 // internal libraries
 import { loadAndCacheImage, loadAndCacheImages } from "../imageRendering";
-import store from "../imageStore";
+import store, { set as setStore } from "../imageStore";
 import type { Series, CachingResponse } from "../types";
 
 /*
@@ -85,6 +85,12 @@ export const loadAndCacheImageStack = async function (
           imageId &&
           seriesData.instances[imageId].metadata.pixelDataLength != 0
         ) {
+          setStore([
+            "cached",
+            seriesData.larvitarSeriesInstanceUID,
+            imageId,
+            true
+          ]);
           return cornerstone.loadAndCacheImage(imageId);
         } else {
           return Promise.resolve(undefined); // Return a resolved Promise with undefined
@@ -150,7 +156,12 @@ export const loadAndCacheDsaImageStack = async function (
           if (forceRecache) {
             cornerstone.imageCache.removeImageLoadObject(imageId);
           }
-
+          setStore([
+            "cached",
+            seriesData.larvitarSeriesInstanceUID,
+            imageId,
+            true
+          ]);
           return cornerstone.loadAndCacheImage(imageId);
         });
       Promise.all(dsaPromises).then(() => {