All files / packages/core/src/loaders volumeLoader.ts

56.52% Statements 65/115
42.85% Branches 27/63
73.33% Functions 11/15
56.31% Lines 58/103

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                                                                                      51x 51x   51x 51x 2x     51x           51x   51x 51x 51x 51x 51x   51x             1x                                         51x 51x 51x   51x                   51x     51x   51x                       51x                             75x 75x       75x   75x 75x                                       825x                   56x           51x   51x 51x     51x                                   161x       7x               7x 7x   7x       7x   7x                                 7x 7x       7x           7x       7x       7x           7x   7x 7x 7x 7x 7x   7x                         7x                                                                                                                                                                                                                 96x                         2x   2x   2x    
import '@kitware/vtk.js/Rendering/Profiles/Volume';
 
import vtkImageData from '@kitware/vtk.js/Common/DataModel/ImageData';
import type { vtkImageData as vtkImageDataType } from '@kitware/vtk.js/Common/DataModel/ImageData';
import vtkDataArray from '@kitware/vtk.js/Common/Core/DataArray';
import cloneDeep from 'lodash.clonedeep';
 
import { ImageVolume } from '../cache/classes/ImageVolume';
import type * as Types from '../types';
import cache from '../cache/cache';
import Events from '../enums/Events';
import eventTarget from '../eventTarget';
import triggerEvent from '../utilities/triggerEvent';
import { uuidv4 } from '../utilities';
import { Point3, Metadata, EventTypes, Mat3 } from '../types';
 
interface VolumeLoaderOptions {
  imageIds: Array<string>;
}
 
interface DerivedVolumeOptions {
  volumeId: string;
  targetBuffer?: {
    type: 'Float32Array' | 'Uint8Array';
    sharedArrayBuffer?: boolean;
  };
}
interface LocalVolumeOptions {
  scalarData: Float32Array | Uint8Array;
  metadata: Metadata;
  dimensions: Point3;
  spacing: Point3;
  origin: Point3;
  direction: Mat3;
}
 
function createInternalVTKRepresentation({
  dimensions,
  metadata,
  spacing,
  direction,
  origin,
  scalarData,
}): vtkImageDataType {
  const { PhotometricInterpretation } = metadata;
 
  let numComponents = 1;
  if (PhotometricInterpretation === 'RGB') {
    numComponents = 3;
  }
 
  const scalarArray = vtkDataArray.newInstance({
    name: 'Pixels',
    numberOfComponents: numComponents,
    values: scalarData,
  });
 
  const imageData = vtkImageData.newInstance();
 
  imageData.setDimensions(dimensions);
  imageData.setSpacing(spacing);
  imageData.setDirection(direction);
  imageData.setOrigin(origin);
  imageData.getPointData().setScalars(scalarArray);
 
  return imageData;
}
 
/**
 * This module deals with VolumeLoaders and loading volumes
 */
 
const volumeLoaders = {};
 
let unknownVolumeLoader;
 
/**
 * 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
): Types.IVolumeLoadObject {
  const colonIndex = volumeId.indexOf(':');
  const scheme = volumeId.substring(0, colonIndex);
  const loader = volumeLoaders[scheme];
 
  Iif (loader === undefined || loader === null) {
    if (unknownVolumeLoader !== undefined) {
      return unknownVolumeLoader(volumeId, options);
    }
 
    throw new Error(
      'loadVolumeFromVolumeLoader: no volume loader for volumeId'
    );
  }
 
  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<Types.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: Types.IImageVolume) => {
    volume.imageData = createInternalVTKRepresentation(volume);
    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<Record<string, any>> {
  if (volumeId === undefined) {
    throw new Error(
      'createAndCacheVolume: parameter volumeId must not be undefined'
    );
  }
 
  let volumeLoadObject = cache.getVolumeLoadObject(volumeId);
 
  if (volumeLoadObject !== undefined) {
    return volumeLoadObject.promise;
  }
 
  volumeLoadObject = loadVolumeFromVolumeLoader(volumeId, options);
 
  volumeLoadObject.promise.then((volume: Types.IImageVolume) => {
    volume.imageData = createInternalVTKRepresentation(volume);
  });
 
  cache.putVolumeLoadObject(volumeId, volumeLoadObject).catch((err) => {
    throw err;
  });
 
  return volumeLoadObject.promise;
}
 
/**
 * Based on a referencedVolumeId, it will build and cache a new volume. If
 * no scalarData is specified in the options, an empty derived volume will be
 * created that matches the image metadata of the referenceVolume. If scalarData
 * is given, it will be used to generate the intensity values for the derivedVolume.
 * Finally, it will save the volume in the cache.
 * @param referencedVolumeId - the volumeId from which the new volume will get its metadata
 * @param options - DerivedVolumeOptions {uid: derivedVolumeUID, targetBuffer: { type: FLOAT32Array | Uint8Array}, scalarData: if provided}
 *
 * @returns ImageVolume
 */
export Easync function createAndCacheDerivedVolume(
  referencedVolumeId: string,
  options: DerivedVolumeOptions
): Promise<ImageVolume> {
  const referencedVolume = cache.getVolume(referencedVolumeId);
 
  if (!referencedVolume) {
    throw new Error(
      `Cannot created derived volume: Referenced volume with id ${referencedVolumeId} does not exist.`
    );
  }
 
  let { volumeId } = options;
  const { targetBuffer } = options;
 
  Iif (volumeId === undefined) {
    volumeId = uuidv4();
  }
 
  const { metadata, dimensions, spacing, origin, direction, scalarData } =
    referencedVolume;
  const scalarLength = scalarData.length;
 
  let numBytes, TypedArray;
 
  // If target buffer is provided
  if (targetBuffer) {
    if (targetBuffer.type === 'Float32Array') {
      numBytes = scalarLength * 4;
      TypedArray = Float32Array;
    } else if (targetBuffer.type === 'Uint8Array') {
      numBytes = scalarLength;
      TypedArray = Uint8Array;
    } else {
      throw new Error('TargetBuffer should be Float32Array or Uint8Array');
    }
  } else {
    // Use float32 if no targetBuffer is provided
    numBytes = scalarLength * 4;
    TypedArray = Float32Array;
  }
 
  // check if there is enough space in unallocated + image Cache
  const isCacheable = cache.isCacheable(numBytes);
  if (!isCacheable) {
    throw new Error(Events.CACHE_SIZE_EXCEEDED);
  }
 
  let volumeScalarData;
  Iif (targetBuffer?.sharedArrayBuffer) {
    const buffer = new SharedArrayBuffer(numBytes);
    volumeScalarData = new TypedArray(buffer);
  } else {
    volumeScalarData = new TypedArray(scalarLength);
  }
 
  // Todo: handle more than one component for segmentation (RGB)
  const scalarArray = vtkDataArray.newInstance({
    name: 'Pixels',
    numberOfComponents: 1,
    values: volumeScalarData,
  });
 
  const derivedImageData = vtkImageData.newInstance();
 
  derivedImageData.setDimensions(dimensions);
  derivedImageData.setSpacing(spacing);
  derivedImageData.setDirection(direction);
  derivedImageData.setOrigin(origin);
  derivedImageData.getPointData().setScalars(scalarArray);
 
  const derivedVolume = new ImageVolume({
    volumeId,
    metadata: cloneDeep(metadata),
    dimensions: [dimensions[0], dimensions[1], dimensions[2]],
    spacing,
    origin,
    direction,
    imageData: derivedImageData,
    scalarData: volumeScalarData,
    sizeInBytes: numBytes,
    referencedVolumeId,
  });
 
  const volumeLoadObject = {
    promise: Promise.resolve(derivedVolume),
  };
 
  await cache.putVolumeLoadObject(volumeId, volumeLoadObject);
 
  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 options -  { scalarData, metadata, dimensions, spacing, origin, direction }
 * @param volumeId - Id of the generated volume
 *
 * @returns ImageVolume
 */
export function createLocalVolume(
  options: LocalVolumeOptions,
  volumeId: string,
  preventCache = false
): ImageVolume {
  const { scalarData, metadata, dimensions, spacing, origin, direction } =
    options;
 
  if (
    !scalarData ||
    !(scalarData instanceof Uint8Array || scalarData instanceof Float32Array)
  ) {
    throw new Error(
      'To use createLocalVolume you should pass scalarData of type Uint8Array or Float32Array'
    );
  }
 
  // Todo: handle default values for spacing, origin, direction if not provided
  if (volumeId === undefined) {
    volumeId = uuidv4();
  }
 
  const cachedVolume = cache.getVolume(volumeId);
 
  if (cachedVolume) {
    return cachedVolume as ImageVolume;
  }
 
  const scalarLength = dimensions[0] * dimensions[1] * dimensions[2];
 
  const numBytes = scalarData ? scalarData.buffer.byteLength : scalarLength * 4;
 
  // check if there is enough space in unallocated + image Cache
  const isCacheable = cache.isCacheable(numBytes);
  if (!isCacheable) {
    throw new Error(Events.CACHE_SIZE_EXCEEDED);
  }
 
  const scalarArray = vtkDataArray.newInstance({
    name: 'Pixels',
    numberOfComponents: 1,
    values: scalarData,
  });
 
  const imageData = vtkImageData.newInstance();
 
  imageData.setDimensions(dimensions);
  imageData.setSpacing(spacing);
  imageData.setDirection(direction);
  imageData.setOrigin(origin);
  imageData.getPointData().setScalars(scalarArray);
 
  const derivedVolume = new ImageVolume({
    volumeId,
    metadata: cloneDeep(metadata),
    dimensions: [dimensions[0], dimensions[1], dimensions[2]],
    spacing,
    origin,
    direction,
    imageData: imageData,
    scalarData,
    sizeInBytes: numBytes,
  });
 
  if (preventCache) {
    return derivedVolume;
  }
 
  const volumeLoadObject = {
    promise: Promise.resolve(derivedVolume),
  };
  cache.putVolumeLoadObject(volumeId, volumeLoadObject);
 
  return derivedVolume;
}
 
/**
 * 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: Types.VolumeLoaderFn
): void {
  volumeLoaders[scheme] = volumeLoader;
}
 
/**
 * 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: Types.VolumeLoaderFn
): Types.VolumeLoaderFn | undefined {
  const oldVolumeLoader = unknownVolumeLoader;
 
  unknownVolumeLoader = volumeLoader;
 
  return oldVolumeLoader;
}