From 4faeebf2ef67fc6af23be53d024bda89ed085d7a Mon Sep 17 00:00:00 2001 From: Cameron Fraser Date: Wed, 16 Sep 2026 14:36:14 -0700 Subject: [PATCH 1/6] rename: `ThreadableVolumeLoader` -> `VolumeLoader` --- src/index.ts | 3 ++- src/loaders/IVolumeLoader.ts | 2 +- src/loaders/JsonImageInfoLoader.ts | 9 ++------- src/loaders/OmeZarrLoader.ts | 22 +++++++++++++++++----- src/loaders/OpenCellLoader.ts | 4 ++-- src/loaders/RawArrayLoader.ts | 9 ++------- src/loaders/TiffLoader.ts | 9 ++------- src/loaders/index.ts | 4 ++-- src/workers/VolumeLoadWorker.ts | 4 ++-- src/workers/VolumeLoaderContext.ts | 9 ++------- 10 files changed, 34 insertions(+), 41 deletions(-) diff --git a/src/index.ts b/src/index.ts index 5d541139c..226227633 100644 --- a/src/index.ts +++ b/src/index.ts @@ -33,7 +33,8 @@ import type { VolumeDims } from "./VolumeDims.js"; export type { ImageInfo } from "./ImageInfo.js"; export type { ControlPoint } from "./Lut.js"; export type { CreateLoaderOptions } from "./loaders/index.js"; -export type { IVolumeLoader, PerChannelCallback, ThreadableVolumeLoader } from "./loaders/IVolumeLoader.js"; +// TODO export `IVolumeLoader`, `ThreadableVolumeLoader` as `VolumeLoader` aliases? +export type { IVolumeLoader, PerChannelCallback, VolumeLoader } from "./loaders/IVolumeLoader.js"; export type { ZarrLoaderFetchOptions } from "./loaders/OmeZarrLoader.js"; export type { WorkerLoader } from "./workers/VolumeLoaderContext.js"; export { diff --git a/src/loaders/IVolumeLoader.ts b/src/loaders/IVolumeLoader.ts index f838c201d..90a6883c8 100644 --- a/src/loaders/IVolumeLoader.ts +++ b/src/loaders/IVolumeLoader.ts @@ -141,7 +141,7 @@ export interface IVolumeLoader { } /** Abstract class which allows loaders to accept and return types that are easier to transfer to/from a worker. */ -export abstract class ThreadableVolumeLoader implements IVolumeLoader { +export abstract class VolumeLoader implements IVolumeLoader { /** Unchanged from `IVolumeLoader`. See that interface for details. */ abstract loadDims(loadSpec: LoadSpec): Promise; diff --git a/src/loaders/JsonImageInfoLoader.ts b/src/loaders/JsonImageInfoLoader.ts index 244831c64..86168b979 100644 --- a/src/loaders/JsonImageInfoLoader.ts +++ b/src/loaders/JsonImageInfoLoader.ts @@ -1,9 +1,4 @@ -import { - ThreadableVolumeLoader, - type LoadSpec, - type RawChannelDataCallback, - type LoadedVolumeInfo, -} from "./IVolumeLoader.js"; +import { VolumeLoader, type LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./IVolumeLoader.js"; import { computeAtlasSize, type ImageInfo } from "../ImageInfo.js"; import type { VolumeDims } from "../VolumeDims.js"; import VolumeCache, { isChunk } from "../VolumeCache.js"; @@ -117,7 +112,7 @@ const convertImageInfo = (json: JsonImageInfo): ImageInfo => { }; }; -class JsonImageInfoLoader extends ThreadableVolumeLoader { +class JsonImageInfoLoader extends VolumeLoader { urls: string[]; jsonInfo: (JsonImageInfo | undefined)[]; syncChannels = false; diff --git a/src/loaders/OmeZarrLoader.ts b/src/loaders/OmeZarrLoader.ts index 39feb5b9c..849482c26 100644 --- a/src/loaders/OmeZarrLoader.ts +++ b/src/loaders/OmeZarrLoader.ts @@ -8,8 +8,14 @@ import type { VolumeDims } from "../VolumeDims.js"; import VolumeCache from "../VolumeCache.js"; import { getDataRange } from "../utils/num_utils.js"; import SubscribableRequestQueue from "../utils/SubscribableRequestQueue.js"; -import type { RawChannelDataCallback, LoadedVolumeInfo, Region } from "./IVolumeLoader.js"; -import { ThreadableVolumeLoader, LoadSpec, box3ToRegion } from "./IVolumeLoader.js"; +import { + VolumeLoader, + LoadSpec, + type RawChannelDataCallback, + type LoadedVolumeInfo, + box3ToRegion, + Region, +} from "./IVolumeLoader.js"; import { composeSubregion, computePackedAtlasDims, @@ -90,7 +96,7 @@ const DEFAULT_FETCH_OPTIONS = { maxPrefetchChunks: 30, }; -class OMEZarrLoader extends ThreadableVolumeLoader { +class OMEZarrLoader extends VolumeLoader { /** The ID of the subscriber responsible for "actual loads" (non-prefetch requests) */ private loadSubscriber: SubscriberId | undefined; /** The ID of the subscriber responsible for prefetches, so that requests can be cancelled and reissued */ @@ -567,13 +573,19 @@ class OMEZarrLoader extends ThreadableVolumeLoader { } this.lowResWarmSubscriber = this.requestQueue.addSubscriber(); - const { plan, availableBytes } = planLowResPrefetch(this.sources, this.lowResCache.maxSize, MINIMUM_LOW_RES_CACHED_EXTENT); + const { plan, availableBytes } = planLowResPrefetch( + this.sources, + this.lowResCache.maxSize, + MINIMUM_LOW_RES_CACHED_EXTENT + ); for (const { sourceIndex, level, coords } of plan) { const coordsTCZYX = this.orderByTCZYX(coords, 0, sourceIndex); this.prefetchChunk(sourceIndex, level, coordsTCZYX, this.lowResWarmSubscriber, true); } if (plan.length > 0) { - console.info(`Prefetching ${plan.length} low-res chunks. ${(this.lowResCache.maxSize - availableBytes)/1_000_000}MB will be used.`); + console.info( + `Prefetching ${plan.length} low-res chunks. ${(this.lowResCache.maxSize - availableBytes) / 1_000_000}MB will be used.` + ); } } diff --git a/src/loaders/OpenCellLoader.ts b/src/loaders/OpenCellLoader.ts index 09fd84571..c782e3650 100644 --- a/src/loaders/OpenCellLoader.ts +++ b/src/loaders/OpenCellLoader.ts @@ -1,10 +1,10 @@ -import { ThreadableVolumeLoader, LoadSpec, RawChannelDataCallback, LoadedVolumeInfo } from "./IVolumeLoader.js"; +import { VolumeLoader, LoadSpec, RawChannelDataCallback, LoadedVolumeInfo } from "./IVolumeLoader.js"; import { computeAtlasSize, type ImageInfo } from "../ImageInfo.js"; import type { VolumeDims } from "../VolumeDims.js"; import { JsonImageInfoLoader } from "./JsonImageInfoLoader.js"; import { getDataRange } from "../utils/num_utils.js"; -class OpenCellLoader extends ThreadableVolumeLoader { +class OpenCellLoader extends VolumeLoader { async loadDims(_: LoadSpec): Promise { const d: VolumeDims = { shape: [1, 2, 27, 600, 600], diff --git a/src/loaders/RawArrayLoader.ts b/src/loaders/RawArrayLoader.ts index 4b6635df5..0a1480caa 100644 --- a/src/loaders/RawArrayLoader.ts +++ b/src/loaders/RawArrayLoader.ts @@ -1,9 +1,4 @@ -import { - ThreadableVolumeLoader, - type LoadSpec, - type RawChannelDataCallback, - type LoadedVolumeInfo, -} from "./IVolumeLoader.js"; +import { VolumeLoader, type LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./IVolumeLoader.js"; import { computePackedAtlasDims } from "./VolumeLoaderUtils.js"; import type { ImageInfo } from "../ImageInfo.js"; import type { VolumeDims } from "../VolumeDims.js"; @@ -94,7 +89,7 @@ const convertImageInfo = (json: RawArrayInfo, dtype: NumberType): ImageInfo => { }; }; -class RawArrayLoader extends ThreadableVolumeLoader { +class RawArrayLoader extends VolumeLoader { data: RawArrayData; jsonInfo: RawArrayInfo; diff --git a/src/loaders/TiffLoader.ts b/src/loaders/TiffLoader.ts index 003ebbbf5..75dff70ab 100644 --- a/src/loaders/TiffLoader.ts +++ b/src/loaders/TiffLoader.ts @@ -1,12 +1,7 @@ import { fromUrl, type GeoTIFF, type GeoTIFFImage } from "geotiff"; import { ErrorObject, deserializeError } from "serialize-error"; -import { - ThreadableVolumeLoader, - LoadSpec, - type RawChannelDataCallback, - type LoadedVolumeInfo, -} from "./IVolumeLoader.js"; +import { VolumeLoader, LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./IVolumeLoader.js"; import { computePackedAtlasDims, MAX_ATLAS_EDGE } from "./VolumeLoaderUtils.js"; import { VolumeLoadError, VolumeLoadErrorType, wrapVolumeLoadError } from "./VolumeLoadError.js"; import { type ImageInfo, CImageInfo } from "../ImageInfo.js"; @@ -128,7 +123,7 @@ const getPixelType = (pxSize: number): string => (pxSize === 1 ? "uint8" : pxSiz // Despite the class `TiffLoader` extends, this loader is not threadable, since geotiff internally uses features that // aren't available on workers. It uses its own specialized workers anyways. -class TiffLoader extends ThreadableVolumeLoader { +class TiffLoader extends VolumeLoader { private url: string[]; dims?: OMEDims; diff --git a/src/loaders/index.ts b/src/loaders/index.ts index 44cd55f8c..90c6a83c2 100644 --- a/src/loaders/index.ts +++ b/src/loaders/index.ts @@ -1,4 +1,4 @@ -import { ThreadableVolumeLoader } from "./IVolumeLoader.js"; +import { VolumeLoader } from "./IVolumeLoader.js"; import { OMEZarrLoader, type ZarrLoaderFetchOptions } from "./OmeZarrLoader.js"; import { JsonImageInfoLoader } from "./JsonImageInfoLoader.js"; import { RawArrayLoader, RawArrayLoaderOptions } from "./RawArrayLoader.js"; @@ -38,7 +38,7 @@ export function pathToFileType(path: string): VolumeFileFormat { export async function createVolumeLoader( path: string | string[], options?: CreateLoaderOptions -): Promise { +): Promise { const pathString = Array.isArray(path) ? path[0] : path; const fileType = options?.fileType || pathToFileType(pathString); const pathArrayForTiffLoader = Array.isArray(path) ? path : [path]; diff --git a/src/workers/VolumeLoadWorker.ts b/src/workers/VolumeLoadWorker.ts index fdd49120c..30e2a9f53 100644 --- a/src/workers/VolumeLoadWorker.ts +++ b/src/workers/VolumeLoadWorker.ts @@ -2,7 +2,7 @@ import { serializeError } from "serialize-error"; import VolumeCache from "../VolumeCache.js"; import { VolumeFileFormat, createVolumeLoader, pathToFileType } from "../loaders/index.js"; -import { ThreadableVolumeLoader } from "../loaders/IVolumeLoader.js"; +import { VolumeLoader } from "../loaders/IVolumeLoader.js"; import { VolumeLoadError } from "../loaders/VolumeLoadError.js"; import RequestQueue from "../utils/RequestQueue.js"; import SubscribableRequestQueue from "../utils/SubscribableRequestQueue.js"; @@ -15,7 +15,7 @@ import type { } from "./types.js"; import { WorkerEventType, WorkerMsgType, WorkerResponseResult } from "./types.js"; -type LoaderEntry = { loader: ThreadableVolumeLoader; copyOnLoad: boolean }; +type LoaderEntry = { loader: VolumeLoader; copyOnLoad: boolean }; // 250MB: same size as the regular cache, and large enough for many AICS ZARRs const LOW_RES_CACHE_DEFAULT_SIZE = 250_000_000; diff --git a/src/workers/VolumeLoaderContext.ts b/src/workers/VolumeLoaderContext.ts index ba814e1b6..21dfbf38d 100644 --- a/src/workers/VolumeLoaderContext.ts +++ b/src/workers/VolumeLoaderContext.ts @@ -4,12 +4,7 @@ import { throttledQueue } from "throttled-queue"; import { ImageInfo } from "../ImageInfo.js"; import { VolumeDims } from "../VolumeDims.js"; import { CreateLoaderOptions, PrefetchDirection, VolumeFileFormat, pathToFileType } from "../loaders/index.js"; -import { - ThreadableVolumeLoader, - LoadSpec, - RawChannelDataCallback, - LoadedVolumeInfo, -} from "../loaders/IVolumeLoader.js"; +import { VolumeLoader, LoadSpec, RawChannelDataCallback, LoadedVolumeInfo } from "../loaders/IVolumeLoader.js"; import { RawArrayLoader } from "../loaders/RawArrayLoader.js"; import { TiffLoader } from "../loaders/TiffLoader.js"; import type { @@ -239,7 +234,7 @@ class VolumeLoaderContext { * * Created with `VolumeLoaderContext.createLoader`. See its documentation for more. */ -class WorkerLoader extends ThreadableVolumeLoader { +class WorkerLoader extends VolumeLoader { private loaderId: number | undefined; private workerHandle: SharedLoadWorkerHandle; private context: VolumeLoaderContext; From a42b313ad8ba7f79ddd4339bb2184327c1cfd444 Mon Sep 17 00:00:00 2001 From: Cameron Fraser Date: Wed, 16 Sep 2026 14:45:47 -0700 Subject: [PATCH 2/6] remove `IVolumeLoader` from public --- public/index.ts | 6 +++--- public/types.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/public/index.ts b/public/index.ts index a97a982fe..8acd9b5f9 100644 --- a/public/index.ts +++ b/public/index.ts @@ -5,7 +5,7 @@ import { colormaps as colorizercolormaps, features as colorizerfeatures } from " import { CreateLoaderOptions, ImageInfo, - IVolumeLoader, + VolumeLoader, LoadSpec, Lut, JsonImageInfoLoader, @@ -1105,7 +1105,7 @@ function createTestVolume(dtype: NumberType): RawArrayLoaderOptions { }; } -async function createLoader(data: TestDataSpec): Promise { +async function createLoader(data: TestDataSpec): Promise { if (data.type === "opencell") { return [new OpenCellLoader()]; } @@ -1145,7 +1145,7 @@ async function createLoader(data: TestDataSpec): Promise { } } -async function loadVolume(name: string, loadSpec: LoadSpec, loader: IVolumeLoader): Promise { +async function loadVolume(name: string, loadSpec: LoadSpec, loader: VolumeLoader): Promise { const fullDims = await loader.loadDims(loadSpec); console.log(fullDims); diff --git a/public/types.ts b/public/types.ts index 55da80900..b9fa23a1d 100644 --- a/public/types.ts +++ b/public/types.ts @@ -1,6 +1,6 @@ import { Volume, Light } from "../src/index.js"; import { VolumeFileFormat } from "../src/loaders/index.js"; -import { IVolumeLoader } from "../src/loaders/IVolumeLoader.js"; +import { VolumeLoader } from "../src/loaders/IVolumeLoader.js"; import type { NumberType } from "../src/types.js"; export interface TestDataSpec { @@ -26,7 +26,7 @@ export interface State { timerId: number; scene: number; - loader: IVolumeLoader[]; + loader: VolumeLoader[]; density: number; maskAlpha: number; From fd3e9350fd2b200de962ddcb4ce1b64ef84048b3 Mon Sep 17 00:00:00 2001 From: Cameron Fraser Date: Wed, 16 Sep 2026 14:57:43 -0700 Subject: [PATCH 3/6] remove remaining references to `IVolumeLoader` --- src/Volume.ts | 10 +++++----- src/index.ts | 2 +- src/test/volume.test.ts | 7 +++++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/src/Volume.ts b/src/Volume.ts index 11fd7ebed..930442e50 100644 --- a/src/Volume.ts +++ b/src/Volume.ts @@ -4,7 +4,7 @@ import Channel from "./Channel.js"; import Histogram from "./Histogram.js"; import { Lut } from "./Lut.js"; import { getColorByChannelIndex } from "./constants/colors.js"; -import type { IVolumeLoader, PerChannelCallback } from "./loaders/IVolumeLoader.js"; +import type { PerChannelCallback, VolumeLoader } from "./loaders/IVolumeLoader.js"; import { cloneLoadSpec, defaultLoadSpec, LoadSpec, regionToBox3 } from "./loaders/IVolumeLoader.js"; import { pickLevelToLoadUnscaled } from "./loaders/VolumeLoaderUtils.js"; import type { NumberType, TypedArray } from "./types.js"; @@ -19,7 +19,7 @@ interface VolumeDataObserver { onVolumeLoadError: (vol: Volume, error: unknown) => void; } -export type VolumeEvent = { +export type VolumeEvents = { loadStart: void; }; @@ -28,10 +28,10 @@ export type VolumeEvent = { * @class * @param {ImageInfo} imageInfo */ -export default class Volume extends EventDispatcher { +export default class Volume extends EventDispatcher { public imageInfo: CImageInfo; public loadSpec: Required; - public loader?: IVolumeLoader; + public loader?: VolumeLoader; /** `LoadSpec` representing the minimum data required to display what's in the viewer (subregion, channels, etc.). * Used to intelligently issue load requests whenever required by a state change. Modify with `updateRequiredData`. */ @@ -78,7 +78,7 @@ export default class Volume extends EventDispatcher { private volumeDataObservers: VolumeDataObserver[]; private loaded: boolean; - constructor(imageInfo: ImageInfo = defaultImageInfo(), loadSpec: LoadSpec = new LoadSpec(), loader?: IVolumeLoader) { + constructor(imageInfo: ImageInfo = defaultImageInfo(), loadSpec: LoadSpec = new LoadSpec(), loader?: VolumeLoader) { super(); this.loaded = false; this.imageInfo = new CImageInfo(imageInfo); diff --git a/src/index.ts b/src/index.ts index 226227633..cb73bc2b0 100644 --- a/src/index.ts +++ b/src/index.ts @@ -34,7 +34,7 @@ export type { ImageInfo } from "./ImageInfo.js"; export type { ControlPoint } from "./Lut.js"; export type { CreateLoaderOptions } from "./loaders/index.js"; // TODO export `IVolumeLoader`, `ThreadableVolumeLoader` as `VolumeLoader` aliases? -export type { IVolumeLoader, PerChannelCallback, VolumeLoader } from "./loaders/IVolumeLoader.js"; +export type { PerChannelCallback, VolumeLoader } from "./loaders/IVolumeLoader.js"; export type { ZarrLoaderFetchOptions } from "./loaders/OmeZarrLoader.js"; export type { WorkerLoader } from "./workers/VolumeLoaderContext.js"; export { diff --git a/src/test/volume.test.ts b/src/test/volume.test.ts index 275673cc7..59918eb31 100644 --- a/src/test/volume.test.ts +++ b/src/test/volume.test.ts @@ -5,7 +5,7 @@ import VolumeMaker from "../VolumeMaker.js"; import { LUT_ARRAY_LENGTH } from "../Lut.js"; import Channel from "../Channel.js"; import { CImageInfo, ImageInfo } from "../ImageInfo.js"; -import { IVolumeLoader, LoadSpec } from "../loaders/IVolumeLoader.js"; +import { VolumeLoader, LoadSpec } from "../loaders/IVolumeLoader.js"; import { getDataRange } from "../utils/num_utils.js"; // PREPARE SOME TEST DATA TO TRY TO DISPLAY A VOLUME. @@ -60,13 +60,16 @@ const multiscaleTestimgdata: ImageInfo = { ], }; -function createTestLoader(multiscaleLevelDims: ImageInfo["multiscaleLevelDims"]): IVolumeLoader { +function createTestLoader(multiscaleLevelDims: ImageInfo["multiscaleLevelDims"]): VolumeLoader { return { loadDims: vi.fn().mockResolvedValue(multiscaleLevelDims), createVolume: vi.fn(), loadVolumeData: vi.fn(), setPrefetchPriority: vi.fn(), syncMultichannelLoading: vi.fn(), + createImageInfo: vi.fn(), + loadRawChannelData: vi.fn(), + updateFetchOptions: vi.fn(), }; } From 3cc3ecbf2e8aee4e16d34be864dc7bf2737fe6a4 Mon Sep 17 00:00:00 2001 From: Cameron Fraser Date: Wed, 16 Sep 2026 14:58:05 -0700 Subject: [PATCH 4/6] move `IVolumeLoader`'s docs to `VolumeLoader` --- src/loaders/IVolumeLoader.ts | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/src/loaders/IVolumeLoader.ts b/src/loaders/IVolumeLoader.ts index 90a6883c8..ed44a90ea 100644 --- a/src/loaders/IVolumeLoader.ts +++ b/src/loaders/IVolumeLoader.ts @@ -140,9 +140,14 @@ export interface IVolumeLoader { syncMultichannelLoading(sync: boolean): void; } -/** Abstract class which allows loaders to accept and return types that are easier to transfer to/from a worker. */ +/** + * Loads volume data from a source specified by a `LoadSpec`. + * + * Loaders may keep state for reuse between volume creation and volume loading, and should be kept alive until volume + * loading is complete. (See `createVolume`) + */ export abstract class VolumeLoader implements IVolumeLoader { - /** Unchanged from `IVolumeLoader`. See that interface for details. */ + /** Use `VolumeDims` to further refine a `LoadSpec` for use in `createVolume` */ abstract loadDims(loadSpec: LoadSpec): Promise; /** @@ -173,10 +178,18 @@ export abstract class VolumeLoader implements IVolumeLoader { onData: RawChannelDataCallback ): Promise; + /** Change which directions to prioritize when prefetching. Currently only implemented on `OMEZarrLoader`. */ setPrefetchPriority(_directions: PrefetchDirection[]): void { // no-op by default } + /** + * By default channel data can arrive out of order and at different times. + * This can cause the rendering to update in a way that is not visually appealing. + * In particular, during time series playback or Z slice playback, we would like + * to see all channels update at the same time. + * @param sync Set true to force all requested channels to load at the same time + */ syncMultichannelLoading(_sync: boolean): void { // default behavior is async, to update channels as they arrive, depending on each // loader's implementation details. @@ -194,6 +207,18 @@ export abstract class VolumeLoader implements IVolumeLoader { return vol; } + /** + * Begin loading a volume's data, as specified in its `LoadSpec`. + * + * Pass a callback to respond when this request loads a new channel. This callback will execute after the one + * assigned in `createVolume`, if any. + * + * The returned `Promise` resolves once all channels load, or rejects with any error that occurs during loading. + */ + // TODO make this return a promise that resolves when loading is done? + // TODO this is not cancellable in the sense that any async requests initiated here are not stored + // in a way that they can be interrupted. + // TODO explicitly passing a `LoadSpec` is now rarely useful. Remove? async loadVolumeData( volume: Volume, loadSpecOverride?: LoadSpec, From 8d4993e0b958efc1c737d30dc57e125923f5fa0b Mon Sep 17 00:00:00 2001 From: Cameron Fraser Date: Wed, 16 Sep 2026 14:58:30 -0700 Subject: [PATCH 5/6] delete `IVolumeLoader` --- src/loaders/IVolumeLoader.ts | 45 +----------------------------------- 1 file changed, 1 insertion(+), 44 deletions(-) diff --git a/src/loaders/IVolumeLoader.ts b/src/loaders/IVolumeLoader.ts index ed44a90ea..5dd9f4d1a 100644 --- a/src/loaders/IVolumeLoader.ts +++ b/src/loaders/IVolumeLoader.ts @@ -103,50 +103,7 @@ export type RawChannelDataCallback = ( * Loaders may keep state for reuse between volume creation and volume loading, and should be kept alive until volume * loading is complete. (See `createVolume`) */ -export interface IVolumeLoader { - /** Use VolumeDims to further refine a `LoadSpec` for use in `createVolume` */ - loadDims(loadSpec: LoadSpec): Promise; - - /** - * Create an empty `Volume` from a `LoadSpec`, which must be passed to `loadVolumeData` to begin loading. - * Optionally pass a callback to respond whenever new channel data is loaded into the volume. - */ - createVolume(loadSpec: LoadSpec, onChannelLoaded?: PerChannelCallback): Promise; - - /** - * Begin loading a volume's data, as specified in its `LoadSpec`. - * - * Pass a callback to respond when this request loads a new channel. This callback will execute after the one - * assigned in `createVolume`, if any. - * - * The returned `Promise` resolves once all channels load, or rejects with any error that occurs during loading. - */ - // TODO make this return a promise that resolves when loading is done? - // TODO this is not cancellable in the sense that any async requests initiated here are not stored - // in a way that they can be interrupted. - // TODO explicitly passing a `LoadSpec` is now rarely useful. Remove? - loadVolumeData(volume: Volume, loadSpec?: LoadSpec, onChannelLoaded?: PerChannelCallback): Promise; - - /** Change which directions to prioritize when prefetching. Currently only implemented on `OMEZarrLoader`. */ - setPrefetchPriority(directions: PrefetchDirection[]): void; - - /** - * By default channel data can arrive out of order and at different times. - * This can cause the rendering to update in a way that is not visually appealing. - * In particular, during time series playback or Z slice playback, we would like - * to see all channels update at the same time. - * @param sync Set true to force all requested channels to load at the same time - */ - syncMultichannelLoading(sync: boolean): void; -} - -/** - * Loads volume data from a source specified by a `LoadSpec`. - * - * Loaders may keep state for reuse between volume creation and volume loading, and should be kept alive until volume - * loading is complete. (See `createVolume`) - */ -export abstract class VolumeLoader implements IVolumeLoader { +export abstract class VolumeLoader { /** Use `VolumeDims` to further refine a `LoadSpec` for use in `createVolume` */ abstract loadDims(loadSpec: LoadSpec): Promise; From e662fe7810496ddab46fce63cbcaa6af6dccfc74 Mon Sep 17 00:00:00 2001 From: Cameron Fraser Date: Tue, 22 Sep 2026 23:41:56 -0700 Subject: [PATCH 6/6] rename: `IVolumeLoader` -> `VolumeLoader` --- public/types.ts | 2 +- src/View3d.ts | 2 +- src/Volume.ts | 10 ++++++++-- src/index.ts | 4 ++-- src/loaders/JsonImageInfoLoader.ts | 2 +- src/loaders/OmeZarrLoader.ts | 2 +- src/loaders/OpenCellLoader.ts | 2 +- src/loaders/RawArrayLoader.ts | 2 +- src/loaders/TiffLoader.ts | 2 +- src/loaders/{IVolumeLoader.ts => VolumeLoader.ts} | 0 src/loaders/VolumeLoaderUtils.ts | 2 +- src/loaders/index.ts | 2 +- src/test/RequestQueue.test.ts | 2 +- src/test/volume.test.ts | 2 +- src/workers/VolumeLoadWorker.ts | 2 +- src/workers/VolumeLoaderContext.ts | 2 +- src/workers/types.ts | 2 +- 17 files changed, 24 insertions(+), 18 deletions(-) rename src/loaders/{IVolumeLoader.ts => VolumeLoader.ts} (100%) diff --git a/public/types.ts b/public/types.ts index b9fa23a1d..dba221ee2 100644 --- a/public/types.ts +++ b/public/types.ts @@ -1,6 +1,6 @@ import { Volume, Light } from "../src/index.js"; import { VolumeFileFormat } from "../src/loaders/index.js"; -import { VolumeLoader } from "../src/loaders/IVolumeLoader.js"; +import { VolumeLoader } from "../src/loaders/VolumeLoader.js"; import type { NumberType } from "../src/types.js"; export interface TestDataSpec { diff --git a/src/View3d.ts b/src/View3d.ts index dd1a4ea01..8bd5c30f5 100644 --- a/src/View3d.ts +++ b/src/View3d.ts @@ -28,7 +28,7 @@ import { } from "./types.js"; import { IDrawableObject } from "./drawables/IDrawableObject.js"; import { Axis } from "./types.js"; -import { PerChannelCallback } from "./loaders/IVolumeLoader.js"; +import { PerChannelCallback } from "./loaders/VolumeLoader.js"; import { WorkerLoader } from "./workers/VolumeLoaderContext.js"; import Line3d from "./drawables/lines/Line3d.js"; import EventDispatcher from "./EventDispatcher.js"; diff --git a/src/Volume.ts b/src/Volume.ts index 930442e50..0310a33cf 100644 --- a/src/Volume.ts +++ b/src/Volume.ts @@ -4,8 +4,14 @@ import Channel from "./Channel.js"; import Histogram from "./Histogram.js"; import { Lut } from "./Lut.js"; import { getColorByChannelIndex } from "./constants/colors.js"; -import type { PerChannelCallback, VolumeLoader } from "./loaders/IVolumeLoader.js"; -import { cloneLoadSpec, defaultLoadSpec, LoadSpec, regionToBox3 } from "./loaders/IVolumeLoader.js"; +import { + cloneLoadSpec, + defaultLoadSpec, + LoadSpec, + regionToBox3, + type PerChannelCallback, + type VolumeLoader, +} from "./loaders/VolumeLoader.js"; import { pickLevelToLoadUnscaled } from "./loaders/VolumeLoaderUtils.js"; import type { NumberType, TypedArray } from "./types.js"; import { type ImageInfo, CImageInfo, defaultImageInfo } from "./ImageInfo.js"; diff --git a/src/index.ts b/src/index.ts index cb73bc2b0..a045ab385 100644 --- a/src/index.ts +++ b/src/index.ts @@ -10,7 +10,7 @@ import Histogram from "./Histogram.js"; import { Lut, remapControlPoints } from "./Lut.js"; import { type AxisName, type ColorizeFeature, type NumberType, type TripleViewPanes, ViewportCorner } from "./types.js"; import { VolumeFileFormat, createVolumeLoader, PrefetchDirection } from "./loaders/index.js"; -import { LoadSpec } from "./loaders/IVolumeLoader.js"; +import { LoadSpec } from "./loaders/VolumeLoader.js"; import { OMEZarrLoader } from "./loaders/OmeZarrLoader.js"; import { JsonImageInfoLoader } from "./loaders/JsonImageInfoLoader.js"; import { @@ -34,7 +34,7 @@ export type { ImageInfo } from "./ImageInfo.js"; export type { ControlPoint } from "./Lut.js"; export type { CreateLoaderOptions } from "./loaders/index.js"; // TODO export `IVolumeLoader`, `ThreadableVolumeLoader` as `VolumeLoader` aliases? -export type { PerChannelCallback, VolumeLoader } from "./loaders/IVolumeLoader.js"; +export type { PerChannelCallback, VolumeLoader } from "./loaders/VolumeLoader.js"; export type { ZarrLoaderFetchOptions } from "./loaders/OmeZarrLoader.js"; export type { WorkerLoader } from "./workers/VolumeLoaderContext.js"; export { diff --git a/src/loaders/JsonImageInfoLoader.ts b/src/loaders/JsonImageInfoLoader.ts index 86168b979..077f9a3a9 100644 --- a/src/loaders/JsonImageInfoLoader.ts +++ b/src/loaders/JsonImageInfoLoader.ts @@ -1,4 +1,4 @@ -import { VolumeLoader, type LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./IVolumeLoader.js"; +import { VolumeLoader, type LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./VolumeLoader.js"; import { computeAtlasSize, type ImageInfo } from "../ImageInfo.js"; import type { VolumeDims } from "../VolumeDims.js"; import VolumeCache, { isChunk } from "../VolumeCache.js"; diff --git a/src/loaders/OmeZarrLoader.ts b/src/loaders/OmeZarrLoader.ts index 849482c26..abd4f37a8 100644 --- a/src/loaders/OmeZarrLoader.ts +++ b/src/loaders/OmeZarrLoader.ts @@ -15,7 +15,7 @@ import { type LoadedVolumeInfo, box3ToRegion, Region, -} from "./IVolumeLoader.js"; +} from "./VolumeLoader.js"; import { composeSubregion, computePackedAtlasDims, diff --git a/src/loaders/OpenCellLoader.ts b/src/loaders/OpenCellLoader.ts index c782e3650..172005227 100644 --- a/src/loaders/OpenCellLoader.ts +++ b/src/loaders/OpenCellLoader.ts @@ -1,4 +1,4 @@ -import { VolumeLoader, LoadSpec, RawChannelDataCallback, LoadedVolumeInfo } from "./IVolumeLoader.js"; +import { VolumeLoader, LoadSpec, RawChannelDataCallback, LoadedVolumeInfo } from "./VolumeLoader.js"; import { computeAtlasSize, type ImageInfo } from "../ImageInfo.js"; import type { VolumeDims } from "../VolumeDims.js"; import { JsonImageInfoLoader } from "./JsonImageInfoLoader.js"; diff --git a/src/loaders/RawArrayLoader.ts b/src/loaders/RawArrayLoader.ts index 0a1480caa..64cf79687 100644 --- a/src/loaders/RawArrayLoader.ts +++ b/src/loaders/RawArrayLoader.ts @@ -1,4 +1,4 @@ -import { VolumeLoader, type LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./IVolumeLoader.js"; +import { VolumeLoader, type LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./VolumeLoader.js"; import { computePackedAtlasDims } from "./VolumeLoaderUtils.js"; import type { ImageInfo } from "../ImageInfo.js"; import type { VolumeDims } from "../VolumeDims.js"; diff --git a/src/loaders/TiffLoader.ts b/src/loaders/TiffLoader.ts index 75dff70ab..0387d5d94 100644 --- a/src/loaders/TiffLoader.ts +++ b/src/loaders/TiffLoader.ts @@ -1,7 +1,7 @@ import { fromUrl, type GeoTIFF, type GeoTIFFImage } from "geotiff"; import { ErrorObject, deserializeError } from "serialize-error"; -import { VolumeLoader, LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./IVolumeLoader.js"; +import { VolumeLoader, LoadSpec, type RawChannelDataCallback, type LoadedVolumeInfo } from "./VolumeLoader.js"; import { computePackedAtlasDims, MAX_ATLAS_EDGE } from "./VolumeLoaderUtils.js"; import { VolumeLoadError, VolumeLoadErrorType, wrapVolumeLoadError } from "./VolumeLoadError.js"; import { type ImageInfo, CImageInfo } from "../ImageInfo.js"; diff --git a/src/loaders/IVolumeLoader.ts b/src/loaders/VolumeLoader.ts similarity index 100% rename from src/loaders/IVolumeLoader.ts rename to src/loaders/VolumeLoader.ts diff --git a/src/loaders/VolumeLoaderUtils.ts b/src/loaders/VolumeLoaderUtils.ts index 8e9ca63d3..0101a6770 100644 --- a/src/loaders/VolumeLoaderUtils.ts +++ b/src/loaders/VolumeLoaderUtils.ts @@ -1,7 +1,7 @@ import { Box3, Vector2, Vector3 } from "three"; import { CImageInfo, type ImageInfo } from "../ImageInfo.js"; -import { LoadSpec, type Region, regionToBox3 } from "./IVolumeLoader.js"; +import { LoadSpec, type Region, regionToBox3 } from "./VolumeLoader.js"; export const MAX_ATLAS_EDGE = 4096; diff --git a/src/loaders/index.ts b/src/loaders/index.ts index 90c6a83c2..6e1f6630e 100644 --- a/src/loaders/index.ts +++ b/src/loaders/index.ts @@ -1,4 +1,4 @@ -import { VolumeLoader } from "./IVolumeLoader.js"; +import { VolumeLoader } from "./VolumeLoader.js"; import { OMEZarrLoader, type ZarrLoaderFetchOptions } from "./OmeZarrLoader.js"; import { JsonImageInfoLoader } from "./JsonImageInfoLoader.js"; import { RawArrayLoader, RawArrayLoaderOptions } from "./RawArrayLoader.js"; diff --git a/src/test/RequestQueue.test.ts b/src/test/RequestQueue.test.ts index 1db3a8885..72656b5a2 100644 --- a/src/test/RequestQueue.test.ts +++ b/src/test/RequestQueue.test.ts @@ -4,7 +4,7 @@ import { Vector3 } from "three"; import type { TypedArray } from "zarrita"; import RequestQueue, { type Request } from "../utils/RequestQueue.js"; -import { LoadSpec, loadSpecToString, regionToBox3 } from "../loaders/IVolumeLoader.js"; +import { LoadSpec, loadSpecToString, regionToBox3 } from "../loaders/VolumeLoader.js"; // Fixes a type error where process is undefined declare const process: { diff --git a/src/test/volume.test.ts b/src/test/volume.test.ts index 59918eb31..2d151a8fe 100644 --- a/src/test/volume.test.ts +++ b/src/test/volume.test.ts @@ -5,7 +5,7 @@ import VolumeMaker from "../VolumeMaker.js"; import { LUT_ARRAY_LENGTH } from "../Lut.js"; import Channel from "../Channel.js"; import { CImageInfo, ImageInfo } from "../ImageInfo.js"; -import { VolumeLoader, LoadSpec } from "../loaders/IVolumeLoader.js"; +import { VolumeLoader, LoadSpec } from "../loaders/VolumeLoader.js"; import { getDataRange } from "../utils/num_utils.js"; // PREPARE SOME TEST DATA TO TRY TO DISPLAY A VOLUME. diff --git a/src/workers/VolumeLoadWorker.ts b/src/workers/VolumeLoadWorker.ts index 30e2a9f53..81bd9533c 100644 --- a/src/workers/VolumeLoadWorker.ts +++ b/src/workers/VolumeLoadWorker.ts @@ -2,7 +2,7 @@ import { serializeError } from "serialize-error"; import VolumeCache from "../VolumeCache.js"; import { VolumeFileFormat, createVolumeLoader, pathToFileType } from "../loaders/index.js"; -import { VolumeLoader } from "../loaders/IVolumeLoader.js"; +import { VolumeLoader } from "../loaders/VolumeLoader.js"; import { VolumeLoadError } from "../loaders/VolumeLoadError.js"; import RequestQueue from "../utils/RequestQueue.js"; import SubscribableRequestQueue from "../utils/SubscribableRequestQueue.js"; diff --git a/src/workers/VolumeLoaderContext.ts b/src/workers/VolumeLoaderContext.ts index 21dfbf38d..8e325ee03 100644 --- a/src/workers/VolumeLoaderContext.ts +++ b/src/workers/VolumeLoaderContext.ts @@ -4,7 +4,7 @@ import { throttledQueue } from "throttled-queue"; import { ImageInfo } from "../ImageInfo.js"; import { VolumeDims } from "../VolumeDims.js"; import { CreateLoaderOptions, PrefetchDirection, VolumeFileFormat, pathToFileType } from "../loaders/index.js"; -import { VolumeLoader, LoadSpec, RawChannelDataCallback, LoadedVolumeInfo } from "../loaders/IVolumeLoader.js"; +import { VolumeLoader, LoadSpec, RawChannelDataCallback, LoadedVolumeInfo } from "../loaders/VolumeLoader.js"; import { RawArrayLoader } from "../loaders/RawArrayLoader.js"; import { TiffLoader } from "../loaders/TiffLoader.js"; import type { diff --git a/src/workers/types.ts b/src/workers/types.ts index d39805031..36a4e86bd 100644 --- a/src/workers/types.ts +++ b/src/workers/types.ts @@ -3,7 +3,7 @@ import type { ErrorObject } from "serialize-error"; import type { ImageInfo } from "../ImageInfo.js"; import type { VolumeDims } from "../VolumeDims.js"; import type { CreateLoaderOptions, PrefetchDirection } from "../loaders/index.js"; -import type { LoadSpec, LoadedVolumeInfo } from "../loaders/IVolumeLoader.js"; +import type { LoadSpec, LoadedVolumeInfo } from "../loaders/VolumeLoader.js"; import type { TypedArray, NumberType } from "../types.js"; import type { ZarrLoaderFetchOptions } from "../loaders/OmeZarrLoader.js";