@cornerstonejs/core 2.0.0-beta.8 → 2.0.0

package/src/utilities/imageIdToURI.ts

@@ -1,10 +0,0 @@
-/**
- * Removes the data loader scheme from the imageId
- *
- * @param imageId - Image ID
- * @returns imageId without the data loader scheme
- */
-export default function imageIdToURI(imageId: string): string {
-  const colonIndex = imageId.indexOf(':');
-  return imageId.substring(colonIndex + 1);
-}

package/src/utilities/imageRetrieveMetadataProvider.ts

@@ -1,36 +0,0 @@
-import { addProvider } from '../metaData';
-
-const retrieveConfigurationState = new Map<string, any>();
-
-const IMAGE_RETRIEVE_CONFIGURATION = 'imageRetrieveConfiguration';
-
-/**
- * Simple metadataProvider object to store metadata for the image retrieval.
- */
-const imageRetrieveMetadataProvider = {
-  IMAGE_RETRIEVE_CONFIGURATION,
-
-  /** Empty the metadata state */
-  clear: () => {
-    retrieveConfigurationState.clear();
-  },
-
-  /* Adding a new entry to the state object. */
-  add: (key: string, payload): void => {
-    retrieveConfigurationState.set(key, payload);
-  },
-
-  get: (type: string, ...queries: string[]) => {
-    if (type === IMAGE_RETRIEVE_CONFIGURATION) {
-      return queries
-        .map((query) => retrieveConfigurationState.get(query))
-        .find((it) => it !== undefined);
-    }
-  },
-};
-
-addProvider(
-  imageRetrieveMetadataProvider.get.bind(imageRetrieveMetadataProvider)
-);
-
-export default imageRetrieveMetadataProvider;

package/src/utilities/imageToWorldCoords.ts

@@ -1,57 +0,0 @@
-import { vec3 } from 'gl-matrix';
-import { metaData } from '..';
-import { Point2, Point3 } from '../types';
-
-/**
- * Given the imageId and a 2d coordinates on the image space with [0,0] being the top left corner
- * of the top left pixel, and options which includes the imageId, it returns the
- * 3d coordinates on the world space.
- * @param imageId - The image id
- * @param imageCoords - The 2d coordinates on the image
- * @returns The 3d coordinates on the world.
- *
- */
-export default function imageToWorldCoords(
-  imageId: string,
-  imageCoords: Point2
-): Point3 | undefined {
-  const imagePlaneModule = metaData.get('imagePlaneModule', imageId);
-
-  if (!imagePlaneModule) {
-    throw new Error(`No imagePlaneModule found for imageId: ${imageId}`);
-  }
-
-  const {
-    columnCosines,
-    rowCosines,
-    imagePositionPatient: origin,
-  } = imagePlaneModule;
-
-  let { columnPixelSpacing, rowPixelSpacing } = imagePlaneModule;
-  // Use ||= to convert null and 0 as well as undefined to 1
-  columnPixelSpacing ||= 1;
-  rowPixelSpacing ||= 1;
-
-  // calculate the image coordinates in the world space
-  const imageCoordsInWorld = vec3.create();
-
-  // move from origin in the direction of the row cosines with the amount of
-  // row pixel spacing times the first element of the image coordinates vector
-  vec3.scaleAndAdd(
-    imageCoordsInWorld,
-    origin,
-    rowCosines,
-    // to accommodate the [0,0] being on the top left corner of the top left pixel
-    // but the origin is at the center of the top left pixel
-    rowPixelSpacing * (imageCoords[0] - 0.5)
-  );
-
-  vec3.scaleAndAdd(
-    imageCoordsInWorld,
-    imageCoordsInWorld,
-    columnCosines,
-    columnPixelSpacing * (imageCoords[1] - 0.5)
-  );
-
-  return Array.from(imageCoordsInWorld) as Point3;
-}

package/src/utilities/index.ts

@@ -1,171 +0,0 @@
-import * as eventListener from './eventListener';
-import csUtils from './invertRgbTransferFunction';
-import createSigmoidRGBTransferFunction from './createSigmoidRGBTransferFunction';
-import getVoiFromSigmoidRGBTransferFunction from './getVoiFromSigmoidRGBTransferFunction';
-import createLinearRGBTransferFunction from './createLinearRGBTransferFunction';
-import scaleRgbTransferFunction from './scaleRgbTransferFunction';
-import triggerEvent from './triggerEvent';
-import uuidv4 from './uuidv4';
-import getMinMax from './getMinMax';
-import getRuntimeId from './getRuntimeId';
-import imageIdToURI from './imageIdToURI';
-import calibratedPixelSpacingMetadataProvider from './calibratedPixelSpacingMetadataProvider';
-import clamp from './clamp';
-import { isEqual, isEqualAbs, isEqualNegative } from './isEqual';
-import isOpposite from './isOpposite';
-import createUint8SharedArray from './createUint8SharedArray';
-import createFloat32SharedArray from './createFloat32SharedArray';
-import createUint16SharedArray from './createUInt16SharedArray';
-import createInt16SharedArray from './createInt16SharedArray';
-import getViewportModality from './getViewportModality';
-import getClosestImageId from './getClosestImageId';
-import getSpacingInNormalDirection from './getSpacingInNormalDirection';
-import getTargetVolumeAndSpacingInNormalDir from './getTargetVolumeAndSpacingInNormalDir';
-import getVolumeActorCorners from './getVolumeActorCorners';
-import indexWithinDimensions from './indexWithinDimensions';
-import getVolumeViewportsContainingSameVolumes from './getVolumeViewportsContainingSameVolumes';
-import getViewportsWithVolumeId from './getViewportsWithVolumeId';
-import transformWorldToIndex from './transformWorldToIndex';
-import transformIndexToWorld from './transformIndexToWorld';
-import loadImageToCanvas from './loadImageToCanvas';
-import renderToCanvasCPU from './renderToCanvasCPU';
-import renderToCanvasGPU from './renderToCanvasGPU';
-import worldToImageCoords from './worldToImageCoords';
-import imageToWorldCoords from './imageToWorldCoords';
-import getVolumeSliceRangeInfo from './getVolumeSliceRangeInfo';
-import getVolumeViewportScrollInfo from './getVolumeViewportScrollInfo';
-import getSliceRange from './getSliceRange';
-import snapFocalPointToSlice from './snapFocalPointToSlice';
-import getImageSliceDataForVolumeViewport from './getImageSliceDataForVolumeViewport';
-import { isImageActor, actorIsA } from './actorCheck';
-import getViewportsWithImageURI from './getViewportsWithImageURI';
-import getClosestStackImageIndexForPoint from './getClosestStackImageIndexForPoint';
-import getCurrentVolumeViewportSlice from './getCurrentVolumeViewportSlice';
-import calculateViewportsSpatialRegistration from './calculateViewportsSpatialRegistration';
-import spatialRegistrationMetadataProvider from './spatialRegistrationMetadataProvider';
-import getViewportImageCornersInWorld from './getViewportImageCornersInWorld';
-import hasNaNValues from './hasNaNValues';
-import applyPreset from './applyPreset';
-import PointsManager from './PointsManager';
-import deepMerge from './deepMerge';
-import getScalingParameters from './getScalingParameters';
-import getScalarDataType from './getScalarDataType';
-import isPTPrescaledWithSUV from './isPTPrescaledWithSUV';
-import getImageLegacy from './getImageLegacy';
-import sortImageIdsAndGetSpacing from './sortImageIdsAndGetSpacing';
-import makeVolumeMetadata from './makeVolumeMetadata';
-import genericMetadataProvider from './genericMetadataProvider';
-import { isValidVolume } from './isValidVolume';
-import { updateVTKImageDataWithCornerstoneImage } from './updateVTKImageDataWithCornerstoneImage';
-import ProgressiveIterator from './ProgressiveIterator';
-import decimate from './decimate';
-import imageRetrieveMetadataProvider from './imageRetrieveMetadataProvider';
-import isVideoTransferSyntax from './isVideoTransferSyntax';
-import { getBufferConfiguration } from './getBufferConfiguration';
-import { generateVolumePropsFromImageIds } from './generateVolumePropsFromImageIds';
-import { convertStackToVolumeViewport } from './convertStackToVolumeViewport';
-import { convertVolumeToStackViewport } from './convertVolumeToStackViewport';
-import VoxelManager from './VoxelManager';
-import RLEVoxelMap from './RLEVoxelMap';
-import roundNumber, { roundToPrecision } from './roundNumber';
-import convertToGrayscale from './convertToGrayscale';
-import getViewportImageIds from './getViewportImageIds';
-import { getRandomSampleFromArray } from './getRandomSampleFromArray';
-import { getVolumeId } from './getVolumeId';
-import { hasFloatScalingParameters } from './hasFloatScalingParameters';
-
-// name spaces
-import * as planar from './planar';
-import * as windowLevel from './windowLevel';
-import * as colormap from './colormap';
-import * as transferFunctionUtils from './transferFunctionUtils';
-import * as cacheUtils from './cacheUtils';
-import * as color from './color';
-
-export {
-  eventListener,
-  csUtils as invertRgbTransferFunction,
-  createSigmoidRGBTransferFunction,
-  getVoiFromSigmoidRGBTransferFunction,
-  createLinearRGBTransferFunction,
-  scaleRgbTransferFunction,
-  triggerEvent,
-  imageIdToURI,
-  calibratedPixelSpacingMetadataProvider,
-  clamp,
-  uuidv4,
-  planar,
-  getMinMax,
-  getRuntimeId,
-  isEqual,
-  isEqualAbs,
-  isEqualNegative,
-  isOpposite,
-  createFloat32SharedArray,
-  createUint8SharedArray,
-  createUint16SharedArray,
-  createInt16SharedArray,
-  getViewportModality,
-  windowLevel,
-  convertToGrayscale,
-  getClosestImageId,
-  getSpacingInNormalDirection,
-  getTargetVolumeAndSpacingInNormalDir,
-  getVolumeActorCorners,
-  indexWithinDimensions,
-  getVolumeViewportsContainingSameVolumes,
-  getViewportsWithVolumeId,
-  transformWorldToIndex,
-  transformIndexToWorld,
-  loadImageToCanvas,
-  renderToCanvasCPU,
-  renderToCanvasGPU,
-  worldToImageCoords,
-  imageToWorldCoords,
-  getVolumeSliceRangeInfo,
-  getVolumeViewportScrollInfo,
-  getSliceRange,
-  snapFocalPointToSlice,
-  getImageSliceDataForVolumeViewport,
-  isImageActor,
-  isPTPrescaledWithSUV,
-  actorIsA,
-  getViewportsWithImageURI,
-  getClosestStackImageIndexForPoint,
-  getCurrentVolumeViewportSlice,
-  calculateViewportsSpatialRegistration,
-  spatialRegistrationMetadataProvider,
-  getViewportImageCornersInWorld,
-  hasNaNValues,
-  applyPreset,
-  deepMerge,
-  PointsManager,
-  getScalingParameters,
-  getScalarDataType,
-  colormap,
-  getImageLegacy,
-  ProgressiveIterator,
-  decimate,
-  imageRetrieveMetadataProvider,
-  transferFunctionUtils,
-  updateVTKImageDataWithCornerstoneImage,
-  sortImageIdsAndGetSpacing,
-  makeVolumeMetadata,
-  isValidVolume,
-  genericMetadataProvider,
-  isVideoTransferSyntax,
-  generateVolumePropsFromImageIds,
-  getBufferConfiguration,
-  VoxelManager,
-  RLEVoxelMap,
-  convertStackToVolumeViewport,
-  convertVolumeToStackViewport,
-  cacheUtils,
-  roundNumber,
-  roundToPrecision,
-  getViewportImageIds,
-  getRandomSampleFromArray,
-  getVolumeId,
-  color,
-  hasFloatScalingParameters,
-};

package/src/utilities/indexWithinDimensions.ts

@@ -1,27 +0,0 @@
-import { Point3 } from '../types';
-
-/**
- * Returns true if the specified index is within the given dimensions.
- *
- * @param index - The index to check.
- * @param dimensions - The dimensions to check against.
- *
- * @returns True if the index is in-bounds.
- */
-export default function indexWithinDimensions(
-  index: Point3,
-  dimensions: Point3
-): boolean {
-  if (
-    index[0] < 0 ||
-    index[0] >= dimensions[0] ||
-    index[1] < 0 ||
-    index[1] >= dimensions[1] ||
-    index[2] < 0 ||
-    index[2] >= dimensions[2]
-  ) {
-    return false;
-  }
-
-  return true;
-}

package/src/utilities/invertRgbTransferFunction.ts

@@ -1,41 +0,0 @@
-/**
- * A utility that can be used to invert (in place) an RgbTransferFunction.
- *
- * @example
- * Grabbing a reference to the RGB Transfer function from the viewport:
- * ```
- * const rgbTransferFunction = viewport
- *   .getActor()
- *   .getProperty()
- *   .getRGBTransferFunction(0);
- *
- * rgbTransferFunction.setRange(0, 5);
- *
- * invertRgbTransferFunction(rgbTransferFunction);
- * ```
- *
- * @see {@link https://kitware.github.io/vtk-js/api/Rendering_Core_ColorTransferFunction.html|VTK.js: ColorTransferFunction}
- * @param rgbTransferFunction
- */
-export default function invertRgbTransferFunction(
-  rgbTransferFunction: any
-): void {
-  // cut in case there is no function at all
-  if (!rgbTransferFunction) {
-    return;
-  }
-
-  const size = rgbTransferFunction.getSize();
-
-  for (let index = 0; index < size; index++) {
-    const nodeValue1 = [];
-
-    rgbTransferFunction.getNodeValue(index, nodeValue1);
-
-    nodeValue1[1] = 1 - nodeValue1[1];
-    nodeValue1[2] = 1 - nodeValue1[2];
-    nodeValue1[3] = 1 - nodeValue1[3];
-
-    rgbTransferFunction.setNodeValue(index, nodeValue1);
-  }
-}

package/src/utilities/isEqual.ts

@@ -1,92 +0,0 @@
-function areNumbersEqualWithTolerance(
-  num1: number,
-  num2: number,
-  tolerance: number
-): boolean {
-  return Math.abs(num1 - num2) <= tolerance;
-}
-
-function areArraysEqual(
-  arr1: ArrayLike<number>,
-  arr2: ArrayLike<number>,
-  tolerance = 1e-5
-): boolean {
-  if (arr1.length !== arr2.length) {
-    return false;
-  }
-
-  for (let i = 0; i < arr1.length; i++) {
-    if (!areNumbersEqualWithTolerance(arr1[i], arr2[i], tolerance)) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-function isNumberType(value: any): value is number {
-  return typeof value === 'number';
-}
-
-function isNumberArrayLike(value: any): value is ArrayLike<number> {
-  return 'length' in value && typeof value[0] === 'number';
-}
-
-/**
- * Returns whether two values are equal or not, based on epsilon comparison.
- * For array comparison, it does NOT strictly compare them but only compare its values.
- * It can compare array of numbers and also typed array. Otherwise it will just return false.
- *
- * @param v1 - The first value to compare
- * @param v2 - The second value to compare
- * @param tolerance - The acceptable tolerance, the default is 0.00001
- *
- * @returns True if the two values are within the tolerance levels.
- */
-export default function isEqual<ValueType>(
-  v1: ValueType,
-  v2: ValueType,
-  tolerance = 1e-5
-): boolean {
-  // values must be the same type or not null
-  if (typeof v1 !== typeof v2 || v1 === null || v2 === null) {
-    return false;
-  }
-
-  if (isNumberType(v1) && isNumberType(v2)) {
-    return areNumbersEqualWithTolerance(v1, v2, tolerance);
-  }
-
-  if (isNumberArrayLike(v1) && isNumberArrayLike(v2)) {
-    return areArraysEqual(v1, v2, tolerance);
-  }
-
-  return false;
-}
-
-const negative = (v) =>
-  typeof v === 'number' ? -v : v?.map ? v.map(negative) : !v;
-
-const abs = (v) =>
-  typeof v === 'number' ? Math.abs(v) : v?.map ? v.map(abs) : v;
-
-/**
- *  Compare negative values of both single numbers and vectors
- */
-const isEqualNegative = <ValueType>(
-  v1: ValueType,
-  v2: ValueType,
-  tolerance = undefined
-) => isEqual(v1, negative(v2) as unknown as ValueType, tolerance);
-
-/**
- * Compare absolute values for single numbers and vectors.
- * Not recommended for large vectors as this creates a copy
- */
-const isEqualAbs = <ValueType>(
-  v1: ValueType,
-  v2: ValueType,
-  tolerance = undefined
-) => isEqual(abs(v1), abs(v2) as unknown as ValueType, tolerance);
-
-export { isEqualNegative, isEqual, isEqualAbs };

package/src/utilities/isOpposite.ts

@@ -1,23 +0,0 @@
-import type Point3 from '../types/Point3';
-
-/**
- * returns equal if the two vec3s are opposite within the
- * given tolerance in each dimension.
- *
- * @param v1 - The first 3 vector
- * @param v2 - The second 3 vector.
- * @param tolerance - The acceptable tolerance.
- *
- * @returns True if the two values are within the tolerance levels.
- */
-export default function isOpposite(
-  v1: Point3,
-  v2: Point3,
-  tolerance = 1e-5
-): boolean {
-  return (
-    Math.abs(v1[0] + v2[0]) < tolerance &&
-    Math.abs(v1[1] + v2[1]) < tolerance &&
-    Math.abs(v1[2] + v2[2]) < tolerance
-  );
-}

package/src/utilities/isPTPrescaledWithSUV.ts

@@ -1,7 +0,0 @@
-import { IImage } from '../types';
-
-const isPTPrescaledWithSUV = (image: IImage) => {
-  return image.preScale?.scaled && image.preScale.scalingParameters?.suvbw;
-};
-
-export default isPTPrescaledWithSUV;

package/src/utilities/isTypedArray.ts

@@ -1,20 +0,0 @@
-/**
- * checks if an object is an instance of a TypedArray
- *
- * @param obj - Object to check
- *
- * @returns True if the object is a TypedArray.
- */
-export default function isTypedArray(obj: any): boolean {
-  return (
-    obj instanceof Int8Array ||
-    obj instanceof Uint8Array ||
-    obj instanceof Uint8ClampedArray ||
-    obj instanceof Int16Array ||
-    obj instanceof Uint16Array ||
-    obj instanceof Int32Array ||
-    obj instanceof Uint32Array ||
-    obj instanceof Float32Array ||
-    obj instanceof Float64Array
-  );
-}

package/src/utilities/isValidVolume.ts

@@ -1,59 +0,0 @@
-import { metaData } from '..';
-import isEqual from './isEqual';
-
-/**
- * Checks if the given imageIds form a valid volume. A volume is considered valid if all imageIds
- * have the same series instance UID, modality, columns, rows, image orientation patient, and pixel
- * spacing.
- *
- * @param imageIds - The imageIds to check.
- * @returns true if the imageIds form a valid volume, false otherwise.
- */
-function isValidVolume(imageIds: string[]): boolean {
-  const imageId0 = imageIds[0];
-
-  const { modality, seriesInstanceUID } = metaData.get(
-    'generalSeriesModule',
-    imageId0
-  );
-
-  const {
-    imageOrientationPatient,
-    pixelSpacing,
-    frameOfReferenceUID,
-    columns,
-    rows,
-  } = metaData.get('imagePlaneModule', imageId0);
-
-  const baseMetadata = {
-    modality,
-    imageOrientationPatient,
-    pixelSpacing,
-    frameOfReferenceUID,
-    columns,
-    rows,
-    seriesInstanceUID,
-  };
-
-  const validVolume = imageIds.every((imageId) => {
-    const { modality, seriesInstanceUID } = metaData.get(
-      'generalSeriesModule',
-      imageId
-    );
-    const { imageOrientationPatient, pixelSpacing, columns, rows } =
-      metaData.get('imagePlaneModule', imageId);
-
-    return (
-      seriesInstanceUID === baseMetadata.seriesInstanceUID &&
-      modality === baseMetadata.modality &&
-      columns === baseMetadata.columns &&
-      rows === baseMetadata.rows &&
-      isEqual(imageOrientationPatient, baseMetadata.imageOrientationPatient) &&
-      isEqual(pixelSpacing, baseMetadata.pixelSpacing)
-    );
-  });
-
-  return validVolume;
-}
-
-export { isValidVolume };

package/src/utilities/isVideoTransferSyntax.ts

@@ -1,26 +0,0 @@
-export const videoUIDs = new Set<string>([
-  '1.2.840.10008.1.2.4.100',
-  '1.2.840.10008.1.2.4.100.1',
-  '1.2.840.10008.1.2.4.101',
-  '1.2.840.10008.1.2.4.101.1',
-  '1.2.840.10008.1.2.4.102',
-  '1.2.840.10008.1.2.4.102.1',
-  '1.2.840.10008.1.2.4.103',
-  '1.2.840.10008.1.2.4.103.1',
-  '1.2.840.10008.1.2.4.104',
-  '1.2.840.10008.1.2.4.104.1',
-  '1.2.840.10008.1.2.4.105',
-  '1.2.840.10008.1.2.4.105.1',
-  '1.2.840.10008.1.2.4.106',
-  '1.2.840.10008.1.2.4.106.1',
-  '1.2.840.10008.1.2.4.107',
-  '1.2.840.10008.1.2.4.108',
-]);
-
-export default function isVideoTransferSyntax(uidOrUids: string | string[]) {
-  if (!uidOrUids) {
-    return false;
-  }
-  const uids = Array.isArray(uidOrUids) ? uidOrUids : [uidOrUids];
-  return uids.find((uid) => videoUIDs.has(uid));
-}