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 | 428x 428x 114x 114x 114x 114x 114x 114x 114x 114x 384x 384x 384x 384x 114x 114x 114x 114x 114x 114x 122x 122x 122x 122x 122x 122x 122x 122x 122x 4062x 122x 122x 122x 58x 58x 58x 58x 56x 2x 2x 2x 2x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 376x 376x 376x 376x 376x 8x 8x 8x 8x 8x 8x 1284x 8024x 428x 428x 428x 122x | import '@kitware/vtk.js/Rendering/Profiles/Volume';
import { ImageVolume } from '../cache/classes/ImageVolume';
import cache from '../cache/cache';
import Events from '../enums/Events';
import type VoxelManagerEnum from '../enums/VoxelManagerEnum';
import eventTarget from '../eventTarget';
import triggerEvent from '../utilities/triggerEvent';
import uuidv4 from '../utilities/uuidv4';
import VoxelManager from '../utilities/VoxelManager';
import type {
Point3,
Metadata,
EventTypes,
Mat3,
IImageVolume,
VolumeLoaderFn,
PixelDataTypedArray,
IVolumeLoadObject,
PixelDataTypedArrayString,
IStreamingImageVolume,
} from '../types';
import {
createAndCacheLocalImage,
createAndCacheDerivedImages,
} from './imageLoader';
import { generateVolumePropsFromImageIds } from '../utilities/generateVolumePropsFromImageIds';
import type { StreamingDynamicImageVolume } from '../cache';
import { cornerstoneStreamingImageVolumeLoader } from './cornerstoneStreamingImageVolumeLoader';
interface VolumeLoaderOptions {
imageIds: string[];
progressiveRendering?: boolean;
}
interface DerivedVolumeOptions {
volumeId?: string;
targetBuffer?: {
type: PixelDataTypedArrayString;
};
voxelRepresentation?: VoxelManagerEnum;
}
export interface LocalVolumeOptions {
metadata: Metadata;
dimensions: Point3;
spacing: Point3;
origin: Point3;
direction: Mat3;
scalarData?: PixelDataTypedArray;
imageIds?: string[];
referencedImageIds?: string[];
referencedVolumeId?: string;
preventCache?: boolean;
targetBuffer?: {
type: PixelDataTypedArrayString;
};
}
/**
* This module deals with VolumeLoaders and loading volumes
*/
const volumeLoaders = {};
let unknownVolumeLoader =
cornerstoneStreamingImageVolumeLoader as unknown as VolumeLoaderFn;
/**
* Load a volume using a registered Cornerstone Volume Loader.
*
* The volume loader that is used will be
* determined by the volume loader scheme matching against the volumeId.
*
* @param volumeId - A Cornerstone Volume Object's volumeId
* @param options - Options to be passed to the Volume Loader. Options
* contain the ImageIds that is passed to the loader
*
* @returns An Object which can be used to act after a volume is loaded or loading fails
*
*/
function loadVolumeFromVolumeLoader(
volumeId: string,
options?: VolumeLoaderOptions
): IVolumeLoadObject {
const colonIndex = volumeId.indexOf(':');
const scheme = volumeId.substring(0, colonIndex);
let loader = volumeLoaders[scheme];
Iif (loader === undefined || loader === null) {
if (
unknownVolumeLoader == null ||
typeof unknownVolumeLoader !== 'function'
) {
throw new Error(
`No volume loader for scheme ${scheme} has been registered`
);
}
loader = unknownVolumeLoader;
}
const volumeLoadObject = loader(volumeId, options);
// Broadcast a volume loaded event once the image is loaded
volumeLoadObject.promise.then(
function (volume) {
triggerEvent(eventTarget, Events.VOLUME_LOADED, { volume });
},
function (error) {
const errorObject: EventTypes.VolumeLoadedFailedEventDetail = {
volumeId,
error,
};
triggerEvent(eventTarget, Events.VOLUME_LOADED_FAILED, errorObject);
}
);
return volumeLoadObject;
}
/**
* Loads a volume given a volumeId and optional priority and returns a promise which will resolve to
* the loaded image object or fail if an error occurred. The loaded image is not stored in the cache.
*
* @param volumeId - A Cornerstone Image Object's volumeId
* @param options - Options to be passed to the Volume Loader
*
* @returns An Object which can be used to act after an image is loaded or loading fails
*/
export function loadVolume(
volumeId: string,
options: VolumeLoaderOptions = { imageIds: [] }
): Promise<IImageVolume> {
Iif (volumeId === undefined) {
throw new Error('loadVolume: parameter volumeId must not be undefined');
}
let volumeLoadObject = cache.getVolumeLoadObject(volumeId);
Eif (volumeLoadObject !== undefined) {
return volumeLoadObject.promise;
}
volumeLoadObject = loadVolumeFromVolumeLoader(volumeId, options);
return volumeLoadObject.promise.then((volume: IImageVolume) => {
return volume;
});
}
/**
* Loads an image given an volumeId and optional priority and returns a promise which will resolve to
* the loaded image object or fail if an error occurred. The image is stored in the cache.
*
* @param volumeId - A Cornerstone Image Object's volumeId
* @param options - Options to be passed to the Volume Loader
*
* @returns Volume Loader Object
*/
export async function createAndCacheVolume(
volumeId: string,
options?: VolumeLoaderOptions
): Promise<IImageVolume | IStreamingImageVolume> {
Iif (volumeId === undefined) {
throw new Error(
'createAndCacheVolume: parameter volumeId must not be undefined'
);
}
let volumeLoadObject = cache.getVolumeLoadObject(volumeId);
Iif (volumeLoadObject !== undefined) {
return volumeLoadObject.promise;
}
volumeLoadObject = loadVolumeFromVolumeLoader(volumeId, options);
cache.putVolumeLoadObject(volumeId, volumeLoadObject);
return volumeLoadObject.promise;
}
/**
* Creates and caches a new volume based on a reference volume's metadata.
*
* @param referencedVolumeId - The volumeId from which the new volume will get its metadata
* @param options - Configuration options for the derived volume
* @param options.volumeId - Optional custom ID for the derived volume. If not provided, a UUID will be generated
* @param options.targetBuffer - Specifies the data type of the volume buffer
* @param options.targetBuffer.type - The array type to use: Float32Array | Uint8Array | Uint16Array | Uint32Array
* @param options.scalarData - Optional scalar data to populate the volume. If not provided, an empty volume is created
* @returns The created {@link IImageVolume} instance
* @throws Error if the referenced volume does not exist in the cache
*/
export function createAndCacheDerivedVolume(
referencedVolumeId: string,
options: DerivedVolumeOptions
): IImageVolume {
const referencedVolume = cache.getVolume(referencedVolumeId);
Iif (!referencedVolume) {
throw new Error(
`Cannot created derived volume: Referenced volume with id ${referencedVolumeId} does not exist.`
);
}
let { volumeId } = options;
const { voxelRepresentation } = options;
Iif (volumeId === undefined) {
volumeId = uuidv4();
}
const { metadata, dimensions, spacing, origin, direction } = referencedVolume;
const referencedImageIds = referencedVolume.isDynamicVolume()
? (
referencedVolume as StreamingDynamicImageVolume
).getCurrentDimensionGroupImageIds()
: (referencedVolume.imageIds ?? []);
// Todo: fix later
// const byteLength = referencedImageIds.reduce((total, imageId) => {
// const image = cache.getImage(imageId);
// return total + image.sizeInBytes;
// }, 0);
// const isCacheable = cache.isCacheable(byteLength);
// if (!isCacheable) {
// throw new Error(
// `Cannot created derived volume: Referenced volume with id ${referencedVolumeId} does not exist.`
// );
// }
// put the imageIds into the cache synchronously since they are just empty
// images
const derivedImages = createAndCacheDerivedImages(referencedImageIds, {
targetBuffer: options.targetBuffer,
voxelRepresentation,
});
const dataType = derivedImages[0].dataType;
const derivedVolumeImageIds = derivedImages.map((image) => image.imageId);
const derivedVolume = new ImageVolume({
volumeId,
dataType,
metadata: structuredClone(metadata),
dimensions: [dimensions[0], dimensions[1], dimensions[2]],
spacing,
origin,
direction,
referencedVolumeId,
imageIds: derivedVolumeImageIds,
referencedImageIds: referencedVolume.imageIds ?? [],
}) as IImageVolume;
cache.putVolumeSync(volumeId, derivedVolume);
return derivedVolume;
}
export async function createAndCacheVolumeFromImages(
volumeId: string,
imageIds: string[]
): Promise<IImageVolume> {
if (imageIds === undefined) {
throw new Error(
'createAndCacheVolumeFromImages: parameter imageIds must not be undefined'
);
}
if (volumeId === undefined) {
throw new Error(
'createAndCacheVolumeFromImages: parameter volumeId must not be undefined'
);
}
const cachedVolume = cache.getVolume(volumeId);
if (cachedVolume) {
return cachedVolume;
}
// check if imageIds are already in the cache
const imageIdsToLoad = imageIds.filter((imageId) => !cache.getImage(imageId));
if (imageIdsToLoad.length === 0) {
return createAndCacheVolumeFromImagesSync(volumeId, imageIds);
}
const volume = (await createAndCacheVolume(volumeId, {
imageIds,
})) as IImageVolume;
return volume;
}
export function createAndCacheVolumeFromImagesSync(
volumeId: string,
imageIds: string[]
): IImageVolume {
Iif (imageIds === undefined) {
throw new Error(
'createAndCacheVolumeFromImagesSync: parameter imageIds must not be undefined'
);
}
Iif (volumeId === undefined) {
throw new Error(
'createAndCacheVolumeFromImagesSync: parameter volumeId must not be undefined'
);
}
const cachedVolume = cache.getVolume(volumeId);
if (cachedVolume) {
return cachedVolume;
}
// Todo: implement rle based voxel manager here for ultrasound later
const volumeProps = generateVolumePropsFromImageIds(imageIds, volumeId);
const derivedVolume = new ImageVolume({
volumeId,
dataType: volumeProps.dataType,
metadata: structuredClone(volumeProps.metadata),
dimensions: volumeProps.dimensions,
spacing: volumeProps.spacing,
origin: volumeProps.origin,
direction: volumeProps.direction,
referencedVolumeId: volumeProps.referencedVolumeId,
imageIds: volumeProps.imageIds,
referencedImageIds: volumeProps.referencedImageIds,
}) as IImageVolume;
cache.putVolumeSync(volumeId, derivedVolume);
return derivedVolume;
}
/**
* Creates and cache a volume based on a set of provided properties including
* dimensions, spacing, origin, direction, metadata, scalarData. It should be noted that
* scalarData should be provided for this function to work. If a volume with the same
* Id exists in the cache it returns it immediately.
* @param volumeId - Id of the generated volume
* @param options - Object containing scalarData, metadata, dimensions, spacing, origin, direction
* @returns ImageVolume
*/
export function createLocalVolume(
volumeId: string,
options = {} as LocalVolumeOptions
): IImageVolume {
const {
metadata,
dimensions,
spacing,
origin,
direction,
scalarData,
targetBuffer,
preventCache = false,
} = options;
// Check if the volume already exists in the cache
const cachedVolume = cache.getVolume(volumeId);
Iif (cachedVolume) {
return cachedVolume;
}
const sliceLength = dimensions[0] * dimensions[1];
const dataType = scalarData
? (scalarData.constructor.name as PixelDataTypedArrayString)
: (targetBuffer?.type ?? 'Float32Array');
const totalNumberOfVoxels = sliceLength * dimensions[2];
let byteLength;
switch (dataType) {
case 'Uint8Array':
case 'Int8Array':
byteLength = totalNumberOfVoxels;
break;
case 'Uint16Array':
case 'Int16Array':
byteLength = totalNumberOfVoxels * 2;
break;
case 'Float32Array':
byteLength = totalNumberOfVoxels * 4;
break;
}
const isCacheable = cache.isCacheable(byteLength);
Iif (!isCacheable) {
throw new Error(
`Cannot created derived volume: Volume with id ${volumeId} is not cacheable.`
);
}
// Create derived images
const imageIds = [];
const derivedImages = [];
for (let i = 0; i < dimensions[2]; i++) {
const imageId = `${volumeId}_slice_${i}`;
imageIds.push(imageId);
const sliceData = scalarData.subarray(
i * sliceLength,
(i + 1) * sliceLength
);
const derivedImage = createAndCacheLocalImage(imageId, {
scalarData: sliceData,
dimensions: [dimensions[0], dimensions[1]],
spacing: [spacing[0], spacing[1]],
origin,
direction,
targetBuffer: { type: dataType },
});
derivedImages.push(derivedImage);
}
// Create the image volume
const imageVolume = new ImageVolume({
volumeId,
metadata: structuredClone(metadata),
dimensions: [dimensions[0], dimensions[1], dimensions[2]],
spacing,
origin,
direction,
imageIds,
dataType,
});
// Create and set voxel manager
const voxelManager = VoxelManager.createImageVolumeVoxelManager({
imageIds,
dimensions,
numberOfComponents: 1,
id: volumeId,
});
imageVolume.voxelManager = voxelManager;
// use sync
Eif (!preventCache) {
cache.putVolumeSync(volumeId, imageVolume);
}
return imageVolume;
}
/**
* Registers an volumeLoader plugin with cornerstone for the specified scheme
*
* @param scheme - The scheme to use for this volume loader (e.g. 'dicomweb', 'wadouri', 'http')
* @param volumeLoader - A Cornerstone Volume Loader function
*/
export function registerVolumeLoader(
scheme: string,
volumeLoader: VolumeLoaderFn
): void {
volumeLoaders[scheme] = volumeLoader;
}
/** Gets the array of volume loader schemes */
export function getVolumeLoaderSchemes(): string[] {
return Object.keys(volumeLoaders);
}
/**
* Registers a new unknownVolumeLoader and returns the previous one
*
* @param volumeLoader - A Cornerstone Volume Loader
*
* @returns The previous Unknown Volume Loader
*/
export function registerUnknownVolumeLoader(
volumeLoader: VolumeLoaderFn
): VolumeLoaderFn | undefined {
const oldVolumeLoader = unknownVolumeLoader;
unknownVolumeLoader = volumeLoader;
return oldVolumeLoader;
}
export function getUnknownVolumeLoaderSchema(): string {
return unknownVolumeLoader.name;
}
/**
* Creates and caches a derived labelmap volume based on a referenced volume.
* This is basically a utility method since for the segmentations we have to specify
* Uint8Array as the targetBuffer type for now until we support other types.
*
* @param referencedVolumeId - The ID of the referenced volume.
* @param options - The options for creating the derived volume.
* @returns A promise that resolves to the created derived segmentation volume.
*/
export function createAndCacheDerivedLabelmapVolume(
referencedVolumeId: string,
options = {} as DerivedVolumeOptions
): IImageVolume {
return createAndCacheDerivedVolume(referencedVolumeId, {
...options,
targetBuffer: {
type: 'Uint8Array',
...options?.targetBuffer,
},
});
}
/**
* Creates a local segmentation volume.
*
* @param options - The options for creating the volume.
* @param volumeId - The ID of the volume.
* @param preventCache - Whether to prevent caching the volume.
* @returns A promise that resolves to the created image volume.
*/
export function createLocalLabelmapVolume(
options: LocalVolumeOptions,
volumeId: string,
preventCache = false
): IImageVolume {
if (!options.scalarData) {
options.scalarData = new Uint8Array(
options.dimensions[0] * options.dimensions[1] * options.dimensions[2]
);
}
return createLocalVolume(volumeId, { ...options, preventCache });
}
|