@cornerstonejs/core 2.0.0-beta.2 → 2.0.0-beta.21

package/src/init.ts

@@ -1,271 +0,0 @@
-import { getGPUTier } from 'detect-gpu';
-import { SharedArrayBufferModes } from './enums';
-import { getRenderingEngines } from './RenderingEngine/getRenderingEngine';
-let csRenderInitialized = false;
-let useSharedArrayBuffer = true;
-let sharedArrayBufferMode = SharedArrayBufferModes.TRUE;
-import { deepMerge } from './utilities';
-import { Cornerstone3DConfig } from './types';
-// TODO: move sharedArrayBuffer into config.
-// TODO: change config into a class with methods to better control get/set
-const defaultConfig: Cornerstone3DConfig = {
-  gpuTier: undefined,
-  detectGPUConfig: {},
-  rendering: {
-    useCPURendering: false,
-    // GPU rendering options
-    preferSizeOverAccuracy: false,
-    useNorm16Texture: false, // _hasNorm16TextureSupport(),
-    strictZSpacingForVolumeViewport: true,
-  },
-  // cache
-  // ...
-};
-
-let config: Cornerstone3DConfig = {
-  gpuTier: undefined,
-  detectGPUConfig: {},
-  rendering: {
-    useCPURendering: false,
-    // GPU rendering options
-    preferSizeOverAccuracy: false,
-    useNorm16Texture: false, // _hasNorm16TextureSupport(),
-    strictZSpacingForVolumeViewport: true,
-  },
-  // cache
-  // ...
-};
-
-function _getGLContext(): RenderingContext {
-  // Create canvas element. The canvas is not added to the
-  // document itself, so it is never displayed in the
-  // browser window.
-  const canvas = document.createElement('canvas');
-  // Get WebGLRenderingContext from canvas element.
-  const gl =
-    canvas.getContext('webgl2') ||
-    canvas.getContext('webgl') ||
-    canvas.getContext('experimental-webgl');
-
-  return gl;
-}
-
-// https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/By_example/Detect_WebGL
-function _hasActiveWebGLContext() {
-  const gl = _getGLContext();
-
-  // Check if the context is either WebGLRenderingContext or WebGL2RenderingContext
-  return (
-    gl instanceof WebGLRenderingContext || gl instanceof WebGL2RenderingContext
-  );
-}
-
-function hasSharedArrayBuffer() {
-  try {
-    /*eslint-disable no-constant-condition */
-    if (new SharedArrayBuffer(0)) {
-      return true;
-    } else {
-      return false;
-    }
-  } catch {
-    return false;
-  }
-}
-
-// Todo: commenting this out until proper support for int16 textures
-// are added to browsers, current implementation is buggy
-// function _hasNorm16TextureSupport() {
-//   const gl = _getGLContext();
-
-//   if (gl) {
-//     const ext = (gl as WebGL2RenderingContext).getExtension(
-//       'EXT_texture_norm16'
-//     );
-
-//     if (ext) {
-//       return true;
-//     }
-//   }
-
-//   return false;
-// }
-
-/**
- * Initialize the cornerstone-core. If the browser has a webgl context and
- * the detected gpu (by detect-gpu library) indicates the GPU is not low end we
- * will use webgl GPU rendering. Otherwise we will use cpu rendering.
- *
- * @param configuration - A configuration object
- * @returns A promise that resolves to true cornerstone has been initialized successfully.
- * @category Initialization
- */
-async function init(configuration = config): Promise<boolean> {
-  if (csRenderInitialized) {
-    return csRenderInitialized;
-  }
-
-  // merge configs
-  config = deepMerge(defaultConfig, configuration);
-
-  // gpuTier
-  const hasWebGLContext = _hasActiveWebGLContext();
-  if (!hasWebGLContext) {
-    console.log('CornerstoneRender: GPU not detected, using CPU rendering');
-    config.rendering.useCPURendering = true;
-  } else {
-    config.gpuTier =
-      config.gpuTier || (await getGPUTier(config.detectGPUConfig));
-    console.log(
-      'CornerstoneRender: Using detect-gpu to get the GPU benchmark:',
-      config.gpuTier
-    );
-    if (config.gpuTier.tier < 1) {
-      console.log(
-        'CornerstoneRender: GPU is not powerful enough, using CPU rendering'
-      );
-      config.rendering.useCPURendering = true;
-    } else {
-      console.log('CornerstoneRender: using GPU rendering');
-    }
-  }
-
-  setUseSharedArrayBuffer(sharedArrayBufferMode);
-
-  csRenderInitialized = true;
-  return csRenderInitialized;
-}
-
-/**
- * It sets the useCPURenderingOnlyForDebugOrTests variable to the status value.
- * This only should be used for debugging or tests. DO NOT USE IT IF YOU ARE NOT
- * SURE WHAT YOU ARE DOING.
- * @param status - boolean
- * @category Initialization
- *
- */
-function setUseCPURendering(status: boolean): void {
-  config.rendering.useCPURendering = status;
-  csRenderInitialized = true;
-  _updateRenderingPipelinesForAllViewports();
-}
-
-function setPreferSizeOverAccuracy(status: boolean): void {
-  config.rendering.preferSizeOverAccuracy = status;
-  csRenderInitialized = true;
-  _updateRenderingPipelinesForAllViewports();
-}
-
-/**
- * Resets the cornerstone-core init state if it has been manually
- * initialized to force use the cpu rendering (e.g., for tests)
- * @category Initialization
- *
- */
-function resetUseCPURendering(): void {
-  config.rendering.useCPURendering = !_hasActiveWebGLContext();
-  _updateRenderingPipelinesForAllViewports();
-}
-
-/**
- * Returns whether or not we are using CPU rendering.
- * @returns true if we are using CPU rendering.
- * @category Initialization
- *
- */
-function getShouldUseCPURendering(): boolean {
-  return config.rendering.useCPURendering;
-}
-
-function setUseSharedArrayBuffer(mode: SharedArrayBufferModes | boolean): void {
-  if (mode == SharedArrayBufferModes.AUTO) {
-    sharedArrayBufferMode = SharedArrayBufferModes.AUTO;
-    const hasSharedBuffer = hasSharedArrayBuffer();
-    if (!hasSharedBuffer) {
-      useSharedArrayBuffer = false;
-      console.warn(
-        `CornerstoneRender: SharedArray Buffer not allowed, performance may be slower.
-        Try ensuring page is cross-origin isolated to enable SharedArrayBuffer.`
-      );
-    } else {
-      useSharedArrayBuffer = true;
-      // eslint-disable-next-line no-console
-      console.log('CornerstoneRender: using SharedArrayBuffer');
-    }
-    return;
-  }
-
-  if (mode == SharedArrayBufferModes.TRUE || mode == true) {
-    sharedArrayBufferMode = SharedArrayBufferModes.TRUE;
-    useSharedArrayBuffer = true;
-    return;
-  }
-
-  if (mode == SharedArrayBufferModes.FALSE || mode == false) {
-    sharedArrayBufferMode = SharedArrayBufferModes.FALSE;
-    useSharedArrayBuffer = false;
-    return;
-  }
-}
-
-function resetUseSharedArrayBuffer(): void {
-  setUseSharedArrayBuffer(sharedArrayBufferMode);
-}
-
-function getShouldUseSharedArrayBuffer(): boolean {
-  return useSharedArrayBuffer;
-}
-
-/**
- *
- * Returns whether or not cornerstone-core has been initialized.
- * @returns true if the cornerstone render has been initialized.
- * @category Initialization
- *
- */
-function isCornerstoneInitialized(): boolean {
-  return csRenderInitialized;
-}
-
-/**
- * This function returns a copy of the config object. This is used to prevent the
- * config object from being modified by other parts of the program.
- * @returns A copy of the config object.
- */
-function getConfiguration(): Cornerstone3DConfig {
-  // return a copy
-  // return JSON.parse(JSON.stringify(config));
-  return config;
-}
-
-function setConfiguration(c: Cornerstone3DConfig) {
-  config = c;
-  _updateRenderingPipelinesForAllViewports();
-}
-
-/**
- * Update rendering pipelines for all viewports in all rendering engines.
- * @returns {void}
- * @category Initialization
- */
-function _updateRenderingPipelinesForAllViewports(): void {
-  getRenderingEngines().forEach((engine) =>
-    engine
-      .getViewports()
-      .forEach((viewport) => viewport.updateRenderingPipeline?.())
-  );
-}
-
-export {
-  init,
-  getShouldUseCPURendering,
-  getShouldUseSharedArrayBuffer,
-  isCornerstoneInitialized,
-  setUseCPURendering,
-  setUseSharedArrayBuffer,
-  setPreferSizeOverAccuracy,
-  resetUseCPURendering,
-  resetUseSharedArrayBuffer,
-  getConfiguration,
-  setConfiguration,
-};

package/src/loaders/geometryLoader.ts

@@ -1,109 +0,0 @@
-import '@kitware/vtk.js/Rendering/Profiles/Geometry';
-
-import cache from '../cache';
-import { ContourSet } from '../cache/classes/ContourSet';
-import { GeometryType } from '../enums';
-import { IGeometry, PublicContourSetData } from '../types';
-
-type GeometryOptions = {
-  type: GeometryType;
-  geometryData: PublicContourSetData; // | PublicClosedSurfaceData, ...
-};
-
-/**
- * Todo: currently we are not targeting loading geometry from a file.
- * This is a placeholder for future work. For instance, separate loaders
- * for .vti, .vtk, .obj, .dat etc. can be created and registered here.
- */
-
-/**
- * It creates a geometry object and caches it
- * @param geometryId - A unique identifier for the geometry.
- * @param options - GeometryOptions
- * @returns A promise that resolves to a geometry object.
- */
-async function createAndCacheGeometry(
-  geometryId: string,
-  options: GeometryOptions
-): Promise<IGeometry> {
-  let geometry = cache.getGeometry(geometryId);
-
-  if (geometry) {
-    return geometry;
-  }
-
-  if (options.type === GeometryType.CONTOUR) {
-    geometry = _createContourSet(geometryId, options.geometryData);
-  } else {
-    throw new Error('Unknown geometry type, Only CONTOUR is supported');
-  }
-
-  const geometryLoadObject = {
-    promise: Promise.resolve(geometry),
-  };
-
-  await cache.putGeometryLoadObject(geometryId, geometryLoadObject);
-
-  return geometry;
-}
-
-// Todo: this should be moved
-function _createContourSet(
-  geometryId: string,
-  contourSetData: PublicContourSetData
-) {
-  // validate the data to make sure it is a valid contour set
-  if (!contourSetData || contourSetData.data.length === 0) {
-    throw new Error(
-      'Invalid contour set data, see publicContourSetData type for more info'
-    );
-  }
-
-  // make sure it each has id, and each has data of type Point3[]
-  if (!contourSetData.id) {
-    throw new Error(
-      'Invalid contour set data, each contour set must have an id'
-    );
-  }
-
-  if (!contourSetData.data || !Array.isArray(contourSetData.data)) {
-    throw new Error(
-      'Invalid contour set data, each contour set must have an array of contours'
-    );
-  }
-
-  contourSetData.data.forEach((contourData) => {
-    if (!contourData.points || !Array.isArray(contourData.points)) {
-      throw new Error(
-        'Invalid contour set data, each contour must have an array of points'
-      );
-    }
-
-    contourData.points.forEach((point) => {
-      if (!point || !Array.isArray(point) || point.length !== 3) {
-        throw new Error(
-          'Invalid contour set data, each point must be an array of length 3'
-        );
-      }
-    });
-  });
-
-  const contourSet = new ContourSet({
-    id: contourSetData.id,
-    data: contourSetData.data,
-    color: contourSetData.color,
-    frameOfReferenceUID: contourSetData.frameOfReferenceUID,
-    segmentIndex: contourSetData.segmentIndex,
-  });
-
-  const geometry: IGeometry = {
-    id: geometryId,
-    type: GeometryType.CONTOUR,
-    data: contourSet,
-    sizeInBytes: contourSet.getSizeInBytes(),
-  };
-
-  return geometry;
-}
-
-export { createAndCacheGeometry };

package/src/loaders/imageLoader.ts

@@ -1,298 +0,0 @@
-import cache from '../cache/cache';
-import Events from '../enums/Events';
-import eventTarget from '../eventTarget';
-import { triggerEvent } from '../utilities';
-import { IImage, ImageLoaderFn, IImageLoadObject, EventTypes } from '../types';
-import imageLoadPoolManager from '../requestPool/imageLoadPoolManager';
-
-export interface ImageLoaderOptions {
-  priority: number;
-  requestType: string;
-  additionalDetails?: Record<string, unknown>;
-}
-/**
- * This module deals with ImageLoaders, loading images and caching images
- */
-const imageLoaders = {};
-let unknownImageLoader;
-
-/**
- * Loads an image using a registered Cornerstone Image Loader.
- *
- * The image loader that is used will be
- * determined by the image loader scheme matching against the imageId.
- *
- * @param imageId - A Cornerstone Image Object's imageId
- * @param Options - to be passed to the Image Loader
- *
- * @returns - An Object which can be used to act after an image is loaded or loading fails
- */
-function loadImageFromImageLoader(
-  imageId: string,
-  options: ImageLoaderOptions
-): IImageLoadObject {
-  // Extract the image loader scheme: wadors:https://image1 => wadors
-  const colonIndex = imageId.indexOf(':');
-  const scheme = imageId.substring(0, colonIndex);
-  const loader = imageLoaders[scheme];
-  if (loader === undefined || loader === null) {
-    if (unknownImageLoader !== undefined) {
-      return unknownImageLoader(imageId);
-    }
-    throw new Error('loadImageFromImageLoader: no image loader for imageId');
-  }
-  // Load using the registered loader
-  const imageLoadObject = loader(imageId, options);
-  // Broadcast an image loaded event once the image is loaded
-  imageLoadObject.promise.then(
-    function (image) {
-      triggerEvent(eventTarget, Events.IMAGE_LOADED, { image });
-    },
-    function (error) {
-      const errorObject: EventTypes.ImageLoadedFailedEventDetail = {
-        imageId,
-        error,
-      };
-      triggerEvent(eventTarget, Events.IMAGE_LOAD_FAILED, errorObject);
-    }
-  );
-  return imageLoadObject;
-}
-
-/**
- * Gets the imageLoadObject by 1) Looking in to the cache to see if the
- * imageLoadObject has already been cached, 2) Checks inside the volume cache
- * to see if there is a volume that contains the same imageURI for the requested
- * imageID 3) Checks inside the imageCache for similar imageURI that might have
- * been stored as a result of decaching a volume 4) Finally if none were found
- * it request it from the registered imageLoaders.
- *
- * @param imageId - A Cornerstone Image Object's imageId
- * @param options - Options to be passed to the Image Loader
- *
- * @returns An Object which can be used to act after an image is loaded or loading fails
- */
-function loadImageFromCacheOrVolume(
-  imageId: string,
-  options: ImageLoaderOptions
-): IImageLoadObject {
-  // 1. Check inside the image cache for imageId
-  let imageLoadObject = cache.getImageLoadObject(imageId);
-  if (imageLoadObject !== undefined) {
-    return imageLoadObject;
-  }
-  // 2. Check if there exists a volume in the cache containing the imageId,
-  // we copy the pixelData over.
-  const cachedVolumeInfo = cache.getVolumeContainingImageId(imageId);
-  if (cachedVolumeInfo && cachedVolumeInfo.volume.loadStatus.loaded) {
-    // 2.1 Convert the volume at the specific slice to a cornerstoneImage object.
-    // this will copy the pixel data over.
-    const { volume, imageIdIndex } = cachedVolumeInfo;
-    imageLoadObject = volume.convertToCornerstoneImage(imageId, imageIdIndex);
-    return imageLoadObject;
-  }
-  // 3. If no volume found, we search inside the imageCache for the imageId
-  // that has the same URI which had been cached if the volume was converted
-  // to an image
-  const cachedImage = cache.getCachedImageBasedOnImageURI(imageId);
-  if (cachedImage) {
-    imageLoadObject = cachedImage.imageLoadObject;
-    return imageLoadObject;
-  }
-  // 4. if not in image cache nor inside the volume cache, we request the
-  // image loaders to load it
-  imageLoadObject = loadImageFromImageLoader(imageId, options);
-
-  return imageLoadObject;
-}
-
-/**
- * Loads an image given an imageId 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 imageId - A Cornerstone Image Object's imageId
- * @param options - Options to be passed to the Image Loader
- *
- * @returns An Object which can be used to act after an image is loaded or loading fails
- */
-export function loadImage(
-  imageId: string,
-  options: ImageLoaderOptions = { priority: 0, requestType: 'prefetch' }
-): Promise<IImage> {
-  if (imageId === undefined) {
-    throw new Error('loadImage: parameter imageId must not be undefined');
-  }
-
-  return loadImageFromCacheOrVolume(imageId, options).promise;
-}
-
-/**
- * Loads an image given an imageId 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 imageId -  A Cornerstone Image Object's imageId
- * @param options - Options to be passed to the Image Loader
- *
- * @returns Image Loader Object
- */
-export function loadAndCacheImage(
-  imageId: string,
-  options: ImageLoaderOptions = { priority: 0, requestType: 'prefetch' }
-): Promise<IImage> {
-  if (imageId === undefined) {
-    throw new Error(
-      'loadAndCacheImage: parameter imageId must not be undefined'
-    );
-  }
-  const imageLoadObject = loadImageFromCacheOrVolume(imageId, options);
-
-  // if not inside cache, store it
-  if (!cache.getImageLoadObject(imageId)) {
-    cache.putImageLoadObject(imageId, imageLoadObject).catch((err) => {
-      console.warn(err);
-    });
-  }
-
-  return imageLoadObject.promise;
-}
-
-/**
- * Load and cache a list of imageIds
- *
- * @param imageIds - list of imageIds
- * @param options - options for loader
- *
- */
-export function loadAndCacheImages(
-  imageIds: Array<string>,
-  options: ImageLoaderOptions = { priority: 0, requestType: 'prefetch' }
-): Promise<IImage>[] {
-  if (!imageIds || imageIds.length === 0) {
-    throw new Error(
-      'loadAndCacheImages: parameter imageIds must be list of image Ids'
-    );
-  }
-
-  const allPromises = imageIds.map((imageId) => {
-    return loadAndCacheImage(imageId, options);
-  });
-
-  return allPromises;
-}
-
-/**
- * Removes the imageId from the request pool manager and executes the `cancel`
- * function if it exists.
- *
- * @param imageId - A Cornerstone Image Object's imageId
- *
- */
-export function cancelLoadImage(imageId: string): void {
-  const filterFunction = ({ additionalDetails }) => {
-    if (additionalDetails.imageId) {
-      return additionalDetails.imageId !== imageId;
-    }
-
-    // for volumes
-    return true;
-  };
-
-  // Instruct the request pool manager to filter queued
-  // requests to ensure requests we no longer need are
-  // no longer sent.
-  imageLoadPoolManager.filterRequests(filterFunction);
-
-  // TODO: Cancel decoding and retrieval as well (somehow?)
-
-  // cancel image loading if in progress
-  const imageLoadObject = cache.getImageLoadObject(imageId);
-
-  if (imageLoadObject) {
-    imageLoadObject.cancelFn();
-  }
-}
-
-/**
- * Removes the imageIds from the request pool manager and calls the `cancel`
- * function if it exists.
- *
- * @param imageIds - Array of Cornerstone Image Object's imageIds
- *
- */
-export function cancelLoadImages(imageIds: Array<string>): void {
-  imageIds.forEach((imageId) => cancelLoadImage(imageId));
-}
-
-/**
- * Removes all the ongoing image loads by calling the `cancel` method on each
- * imageLoadObject. If no `cancel` method is available, it will be ignored.
- *
- */
-export function cancelLoadAll(): void {
-  const requestPool = imageLoadPoolManager.getRequestPool();
-
-  Object.keys(requestPool).forEach((type: string) => {
-    const requests = requestPool[type];
-
-    Object.keys(requests).forEach((priority) => {
-      const requestDetails = requests[priority].pop();
-      const { imageId, volumeId } = requestDetails.additionalDetails;
-
-      let loadObject;
-
-      if (imageId) {
-        loadObject = cache.getImageLoadObject(imageId);
-      } else if (volumeId) {
-        loadObject = cache.getVolumeLoadObject(volumeId);
-      }
-      if (loadObject) {
-        loadObject.cancel();
-      }
-    });
-    // resetting the pool types to be empty
-    imageLoadPoolManager.clearRequestStack(type);
-
-    // TODO: Clear retrieval and decoding queues as well
-  });
-}
-
-/**
- * Registers an imageLoader plugin with cornerstone for the specified scheme
- *
- * @param scheme - The scheme to use for this image loader (e.g. 'dicomweb', 'wadouri', 'http')
- * @param imageLoader - A Cornerstone Image Loader function
- */
-export function registerImageLoader(
-  scheme: string,
-  imageLoader: ImageLoaderFn
-): void {
-  imageLoaders[scheme] = imageLoader;
-}
-/**
- * Registers a new unknownImageLoader and returns the previous one
- *
- * @param imageLoader - A Cornerstone Image Loader
- *
- * @returns The previous Unknown Image Loader
- */
-export function registerUnknownImageLoader(
-  imageLoader: ImageLoaderFn
-): ImageLoaderFn {
-  const oldImageLoader = unknownImageLoader;
-  unknownImageLoader = imageLoader;
-  return oldImageLoader;
-}
-/**
- * Removes all registered and unknown image loaders. This should be called
- * when the application is unmounted to prevent memory leaks.
- *
- */
-export function unregisterAllImageLoaders(): void {
-  Object.keys(imageLoaders).forEach(
-    (imageLoader) => delete imageLoaders[imageLoader]
-  );
-  unknownImageLoader = undefined;
-}