@cornerstonejs/core 2.0.0-beta.13 → 2.0.0-beta.15

package/src/types/IVolumeViewport.ts

@@ -1,183 +0,0 @@
-import Point2 from './Point2';
-import Point3 from './Point3';
-import { IViewport } from './IViewport';
-import { IVolumeInput } from './IVolumeInput';
-import FlipDirection from './FlipDirection';
-import IImageData from './IImageData';
-import { BlendModes, OrientationAxis } from '../enums';
-import { VolumeViewportProperties } from '.';
-
-/**
- * Interface for the Volume Viewport
- */
-export default interface IVolumeViewport extends IViewport {
-  useCPURendering: boolean;
-  getFrameOfReferenceUID: () => string;
-
-  /**
-   * Retrieve the viewport default properties
-   * If volumeId is given, we retrieve the default properties of a volumeId if it exists
-   * If not given,we return the global properties of the viewport
-   * default viewport properties including voi, invert, interpolation type, colormap
-   */
-  getDefaultProperties: (volumeId?: string) => VolumeViewportProperties;
-  /**
-   * Retrieve the viewport properties
-   */
-  getProperties: (volumeId?: string) => VolumeViewportProperties;
-  /**
-   * canvasToWorld Returns the world coordinates of the given `canvasPos`
-   * projected onto the plane defined by the `Viewport`'s `vtkCamera`'s focal point
-   * and the direction of projection.
-   */
-  canvasToWorld: (canvasPos: Point2) => Point3;
-  /**
-   * Returns the canvas coordinates of the given `worldPos`
-   * projected onto the `Viewport`'s `canvas`.
-   */
-  worldToCanvas: (worldPos: Point3) => Point2;
-  /**
-   * Returns the list of image Ids for the current viewport
-   */
-  getImageIds: (volumeId?: string) => string[];
-  /**
-   * Uses viewport camera and volume actor to decide if the viewport
-   * is looking at the volume in the direction of acquisition (imageIds).
-   * If so, it uses the origin and focalPoint to calculate the slice index.
-   */
-  getCurrentImageIdIndex: () => number;
-
-  /**
-   * Checks if the viewport has a volume actor with the given volumeId
-   */
-  hasVolumeId: (volumeId: string) => boolean;
-
-  /**
-   * if the volume viewport has imageURI (no loader schema)
-   * in one of its volume actors
-   */
-  hasImageURI: (imageURI: string) => boolean;
-
-  /**
-   * Uses viewport camera and volume actor to decide if the viewport
-   * is looking at the volume in the direction of acquisition (imageIds).
-   * If so, it uses the origin and focalPoint to find which imageId is
-   * currently being viewed.
-   */
-  getCurrentImageId: () => string;
-  /**
-   * Sets the default properties for the viewport. If no volumeId is provided
-   * it applies the properties to the default volume actor (first volume)
-   */
-  setDefaultProperties(
-    ViewportProperties: VolumeViewportProperties,
-    volumeId?: string
-  ): void;
-  /**
-   * Remove the global default properties of the viewport or remove default properties for a volumeId if specified
-   * If volumeId is given, we remove the default properties only for this volumeId, if not
-   * the global default properties will be removed
-   */
-  clearDefaultProperties(volumeId?: string): void;
-  /**
-   * Sets the properties for the viewport. If no volumeId is provided
-   * it applies the properties to the default volume actor (first volume)
-   */
-  setProperties(
-    { voiRange }: VolumeViewportProperties,
-    volumeId?: string,
-    suppressEvents?: boolean
-  ): void;
-  /**
-   * Reset the viewport properties to the default values
-   */
-  resetProperties(volumeId: string): void;
-  /**
-   * Creates volume actors for all volumes defined in the `volumeInputArray`.
-   * For each entry, if a `callback` is supplied, it will be called with the new volume actor as input.
-   * For each entry, if a `blendMode` and/or `slabThickness` is defined, this will be set on the actor's
-   * `VolumeMapper`.
-   */
-  setVolumes(
-    volumeInputArray: Array<IVolumeInput>,
-    immediate?: boolean,
-    suppressEvents?: boolean
-  ): Promise<void>;
-  /**
-   * Creates and adds volume actors for all volumes defined in the `volumeInputArray`.
-   * For each entry, if a `callback` is supplied, it will be called with the new volume actor as input.
-   */
-  addVolumes(
-    volumeInputArray: Array<IVolumeInput>,
-    immediate?: boolean,
-    suppressEvents?: boolean
-  ): Promise<void>;
-  /**
-   * It removes the volume actor from the Viewport. If the volume actor is not in
-   * the viewport, it does nothing.
-   */
-  removeVolumeActors(actorUIDs: Array<string>, immediate?: boolean): void;
-
-  /**
-   * Given a point in world coordinates, return the intensity at that point
-   */
-  getIntensityFromWorld(point: Point3): number;
-  /**
-   * getBounds gets the visible bounds of the viewport
-   */
-  getBounds(): any;
-  /**
-   * Flip the viewport along the desired axis
-   */
-  flip(flipDirection: FlipDirection): void;
-  /**
-   * Reset the camera for the volume viewport
-   */
-  resetCamera({
-    resetPan,
-    resetZoom,
-    resetToCenter,
-    resetRotation,
-    suppressEvents,
-  }?: {
-    resetPan?: boolean;
-    resetZoom?: boolean;
-    resetToCenter?: boolean;
-    resetRotation?: boolean;
-    suppressEvents?: boolean;
-  }): boolean;
-  /**
-   * Reset the slab thickness for actors of the viewport.
-   */
-  resetSlabThickness(): void;
-  /**
-   * Sets the blendMode for actors of the viewport.
-   */
-  setBlendMode(
-    blendMode: BlendModes,
-    filterActorUIDs?: Array<string>,
-    immediate?: boolean
-  ): void;
-  /**
-   * Sets the slab thickness for actors of the viewport.
-   */
-  setSlabThickness(
-    slabThickness: number,
-    filterActorUIDs?: Array<string>
-  ): void;
-  /**
-   * Gets the slab thickness option in the `Viewport`'s `options`.
-   */
-  getSlabThickness(): number;
-  /**
-   * Returns the image and its properties that is being shown inside the
-   * stack viewport. It returns, the image dimensions, image direction,
-   * image scalar data, vtkImageData object, metadata, and scaling (e.g., PET suvbw)
-   * Note: since the volume viewport supports fusion, to get the
-   * image data for a specific volume, use the optional volumeId
-   * argument.
-   */
-  getImageData(volumeId?: string): IImageData | undefined;
-
-  setOrientation(orientation: OrientationAxis): void;
-}

package/src/types/ImageLoadListener.ts

@@ -1,20 +0,0 @@
-export type ImageLoadListener = {
-  /**
-   * Called when an image is loaded.  May be called multiple times with increasing
-   * status values.
-   */
-  successCallback: (imageId, image) => void;
-  /**
-   * Called when an image fails to load.  A failure is permanent if no more attempts
-   * will be made.
-   */
-  errorCallback: (imageId, permanent, reason) => void;
-
-  /**
-   * Gets the target options for loading a given image, used by the image loader.
-   * @returns Loader image options to use when loading the image.  Note this
-   *          is often a DICOMLoaderImageOptions, but doesn't have to be.
-   * @throws exception to prevent further loading of this image
-   */
-  getLoaderImageOptions?: (imageId) => Record<string, unknown>;
-};

package/src/types/ImageLoaderFn.ts

@@ -1,16 +0,0 @@
-/**
- * Any imageLoader function should implement a loading given the imageId
- * and returns a mandatory promise which will resolve to the loaded image object.
- * Additional `cancelFn` and `decache` can be implemented.
- */
-type ImageLoaderFn = (
-  imageId: string,
-  options?: Record<string, any>
-) => {
-  /** Promise that resolves to the image object */
-  promise: Promise<Record<string, any>>;
-  cancelFn?: () => void | undefined;
-  decache?: () => void | undefined;
-};
-
-export default ImageLoaderFn;

package/src/types/ImagePixelModule.ts

@@ -1,14 +0,0 @@
-import { VOILUTFunctionType } from '../enums';
-
-export interface ImagePixelModule {
-  bitsAllocated: number;
-  bitsStored: number;
-  samplesPerPixel: number;
-  highBit: number;
-  photometricInterpretation: string;
-  pixelRepresentation: string;
-  windowWidth: number | number[];
-  windowCenter: number | number[];
-  voiLUTFunction: VOILUTFunctionType;
-  modality: string;
-}

package/src/types/ImagePlaneModule.ts

@@ -1,17 +0,0 @@
-import Point2 from './Point2';
-import Point3 from './Point3';
-
-export interface ImagePlaneModule {
-  columnCosines?: Point3;
-  columnPixelSpacing?: number;
-  imageOrientationPatient?: Float32Array;
-  imagePositionPatient?: Point3;
-  pixelSpacing?: Point2;
-  rowCosines?: Point3;
-  rowPixelSpacing?: number;
-  sliceLocation?: number;
-  sliceThickness?: number;
-  frameOfReferenceUID: string;
-  columns: number;
-  rows: number;
-}

package/src/types/ImageSliceData.ts

@@ -1,6 +0,0 @@
-type ImageSliceData = {
-  numberOfSlices: number;
-  imageIndex: number;
-};
-
-export default ImageSliceData;

package/src/types/ImageVolumeProps.ts

@@ -1,15 +0,0 @@
-import { VolumeProps } from '.';
-
-/**
- * ImageVolume which is considered a special case of a Volume, which is
- * constructed out of set of images (imageIds). Unlike Volume which can be
- * constructed from any type of volumetric data, such as nifti or nrrd,
- */
-interface ImageVolumeProps extends VolumeProps {
-  /** imageIds of the volume (if it is built of separate imageIds) */
-  imageIds: Array<string>;
-  /** if the volume is created from a stack, the imageIds of the stack */
-  referencedImageIds?: Array<string>;
-}
-
-export { ImageVolumeProps };

package/src/types/Mat3.ts

@@ -1,8 +0,0 @@
-/**
- * This represents a 3x3 matrix of numbers
- */
-type Mat3 =
-  | [number, number, number, number, number, number, number, number, number]
-  | Float32Array;
-
-export default Mat3;

package/src/types/Metadata.ts

@@ -1,39 +0,0 @@
-import type { VOI } from './voi';
-
-/**
- * Metadata for images, More information can be found in the
- * {@link https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.6.3.html#table_C.7-11c}
- */
-type Metadata = {
-  /** Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated */
-  BitsAllocated: number;
-  /** Number of bits stored for each pixel sample */
-  BitsStored: number;
-  SamplesPerPixel: number;
-  /** Most significant bit for pixel sample data */
-  HighBit: number;
-  /** Specifies the intended interpretation of the pixel data */
-  PhotometricInterpretation: string;
-  /** Data representation of the pixel samples. */
-  PixelRepresentation: number;
-  /** Image Modality */
-  Modality: string;
-  /** SeriesInstanceUID of the volume */
-  SeriesInstanceUID?: string;
-  /** The direction cosines of the first row and the first column with respect to the patient */
-  ImageOrientationPatient: Array<number>;
-  /** Physical distance in the patient between the center of each pixel */
-  PixelSpacing: Array<number>;
-  /** Uniquely identifies the Frame of Reference for a Series */
-  FrameOfReferenceUID: string;
-  /** Number of columns in the image. */
-  Columns: number;
-  /** Number of rows in the image. */
-  Rows: number;
-  /** Window Level/Center for the image */
-  voiLut: Array<VOI>;
-  /** VOILUTFunction for the image which is LINEAR or SAMPLED_SIGMOID */
-  VOILUTFunction: string;
-};
-
-export default Metadata;

package/src/types/OrientationVectors.ts

@@ -1,36 +0,0 @@
-import { Point3 } from '../types';
-
-/**
- * - `viewUp` - An array of three floating point numbers describing a vector
- *  that represents the up direction for the view.
- * - `viewPlaneNormal` - The direction of the projection
- *
- * see [Axial vs Sagittal vs Coronal](https://faculty.washington.edu/chudler/slice.html)
- * see {@link https://kitware.github.io/vtk-js/api/Rendering_Core_Camera.html | VTK.js: Rendering_Core_Camera}
- *
- * @example
- *
- * ```javascript
- * renderingEngine.setViewports([
- *  {
- *    viewportId: 'a-viewport-uid',
- *    type: ViewportType.ORTHOGRAPHIC,
- *    element: document.querySelector('div'),
- *    defaultOptions: {
- *      orientation: {
- *       viewUp: [0, 0, 1],
- *      viewPlaneNormal: [1, 0, 0],
- *     },
- *      background: [1, 0, 0],
- *    },
- *  }]);
- * ```
- */
-type OrientationVectors = {
-  /** Slice Normal for the viewport - the normal that points in the opposite direction of the slice normal out of screen and is negative of direction of projection */
-  viewPlaneNormal: Point3;
-  /** viewUp direction for the viewport - the vector that points from bottom to top of the viewport */
-  viewUp: Point3;
-};
-
-export default OrientationVectors;

package/src/types/PixelDataTypedArray.ts

@@ -1,15 +0,0 @@
-export type PixelDataTypedArray =
-  | Float32Array
-  | Int16Array
-  | Uint16Array
-  | Uint8Array
-  | Int8Array
-  | Uint8ClampedArray;
-
-export type PixelDataTypedArrayString =
-  | 'Float32Array'
-  | 'Int16Array'
-  | 'Uint16Array'
-  | 'Uint8Array'
-  | 'Int8Array'
-  | 'Uint8ClampedArray';

package/src/types/Plane.ts

@@ -1,6 +0,0 @@
-/**
- * Plane equation Ax+By+Cz=D, plane is defined by [A, B, C, D]
- */
-type Plane = [number, number, number, number];
-
-export default Plane;

package/src/types/Point2.ts

@@ -1,6 +0,0 @@
-/**
- * This duplicates the typing established in gl-matrix for a vec2
- */
-type Point2 = [number, number];
-
-export default Point2;

package/src/types/Point3.ts

@@ -1,15 +0,0 @@
-/**
- * This duplicates the typing established in gl-matrix for a vec3
- */
-export type Point3 = [number, number, number];
-
-/**
- * Some algorithms use separated values
- */
-export type PointsXYZ = {
-  x: number[];
-  y: number[];
-  z: number[];
-};
-
-export default Point3;

package/src/types/Point4.ts

@@ -1,6 +0,0 @@
-/**
- * This represents a 4-vector or RGBA value.
- */
-type Point4 = [number, number, number, number];
-
-export default Point4;

package/src/types/RGB.ts

@@ -1,6 +0,0 @@
-/**
- * RGB color type.
- */
-type RGB = [number, number, number];
-
-export default RGB;

package/src/types/ScalingParameters.ts

@@ -1,33 +0,0 @@
-type ScalingParameters = {
-  /** m in m*p+b which specifies the linear transformation from stored pixels to memory value  */
-  rescaleSlope: number;
-  /** b in m*p+b which specifies the offset of the transformation */
-  rescaleIntercept: number;
-  /** modality */
-  modality: string;
-  /** SUV body weight */
-  suvbw?: number;
-  /** SUV lean body mass */
-  suvlbm?: number;
-  /** SUV body surface area */
-  suvbsa?: number;
-};
-
-type PTScaling = {
-  /** suv body weight to suv lean body mass */
-  suvbwToSuvlbm?: number;
-  /** suv body weight to suv body surface area */
-  suvbwToSuvbsa?: number;
-  /** SUV body weight */
-  suvbw?: number;
-  /** SUV lean body mass */
-  suvlbm?: number;
-  /** SUV body surface area */
-  suvbsa?: number;
-};
-
-type Scaling = {
-  PT?: PTScaling;
-};
-
-export { PTScaling, Scaling, ScalingParameters };

package/src/types/StackViewportProperties.ts

@@ -1,16 +0,0 @@
-import InterpolationType from '../enums/InterpolationType';
-import { ViewportProperties } from './ViewportProperties';
-
-/**
- * Stack Viewport Properties
- */
-type StackViewportProperties = ViewportProperties & {
-  /** interpolation type - linear or nearest neighbor */
-  interpolationType?: InterpolationType;
-  /** suppress events (optional) */
-  suppressEvents?: boolean;
-  /** Indicates if the voi is a computed VOI (not user set) */
-  isComputedVOI?: boolean;
-};
-
-export default StackViewportProperties;

package/src/types/SurfaceData.ts

@@ -1,15 +0,0 @@
-import Point3 from './Point3';
-
-type PublicSurfaceData = {
-  id: string;
-  data: SurfaceData;
-  frameOfReferenceUID: string;
-  color?: Point3;
-};
-
-type SurfaceData = {
-  points: number[];
-  polys: number[];
-};
-
-export type { PublicSurfaceData, SurfaceData };

package/src/types/TransformMatrix2D.ts

@@ -1,4 +0,0 @@
-/** used for CPU rendering */
-type TransformMatrix2D = [number, number, number, number, number, number];
-
-export default TransformMatrix2D;

package/src/types/VideoViewportProperties.ts

@@ -1,15 +0,0 @@
-import { ViewportProperties } from './ViewportProperties';
-import Point2 from './Point2';
-
-/**
- * Stack Viewport Properties
- */
-type VideoViewportProperties = ViewportProperties & {
-  loop?: boolean;
-  muted?: boolean;
-  pan?: Point2;
-  playbackRate?: number;
-  scrollSpeed?: number;
-};
-
-export default VideoViewportProperties;

package/src/types/VideoViewportTypes.ts

@@ -1,20 +0,0 @@
-import { ViewportType } from '../enums';
-import Point2 from './Point2';
-
-export type InternalVideoCamera = {
-  panWorld?: Point2;
-  parallelScale?: number;
-};
-
-export type VideoViewportInput = {
-  id: string;
-  renderingEngineId: string;
-  type: ViewportType;
-  element: HTMLDivElement;
-  sx: number;
-  sy: number;
-  sWidth: number;
-  sHeight: number;
-  defaultOptions: any;
-  canvas: HTMLCanvasElement;
-};

package/src/types/ViewportInputOptions.ts

@@ -1,25 +0,0 @@
-import { OrientationAxis } from '../enums';
-import OrientationVectors from './OrientationVectors';
-import DisplayArea from './displayArea';
-import RGB from './RGB';
-
-/**
- * This type defines the shape of viewport input options, so we can throw when it is incorrect.
- */
-type ViewportInputOptions = {
-  /** background color */
-  background?: RGB;
-  /** orientation of the viewport which can be either an Enum for axis Enums.OrientationAxis.[AXIAL|SAGITTAL|CORONAL|DEFAULT] or an object with viewPlaneNormal and viewUp */
-  orientation?: OrientationAxis | OrientationVectors;
-  /** displayArea of interest */
-  displayArea?: DisplayArea;
-  /** whether the events should be suppressed and not fired*/
-  suppressEvents?: boolean;
-  /**
-   * parallel projection settings, Note that this will only be used for VOLUME_3D viewport. You can't modify the
-   * parallel projection of a stack viewport or volume viewport using viewport input options.
-   */
-  parallelProjection?: boolean;
-};
-
-export default ViewportInputOptions;

package/src/types/ViewportPreset.ts

@@ -1,14 +0,0 @@
-interface ViewportPreset {
-  name: string;
-  gradientOpacity: string;
-  specularPower: string;
-  scalarOpacity: string;
-  specular: string;
-  shade: string;
-  ambient: string;
-  colorTransfer: string;
-  diffuse: string;
-  interpolation: string;
-}
-
-export default ViewportPreset;

package/src/types/ViewportProperties.ts

@@ -1,19 +0,0 @@
-import { InterpolationType, VOILUTFunctionType } from '../enums';
-import { VOIRange } from './voi';
-import { ColormapPublic } from './Colormap';
-
-/**
- * Shared Viewport Properties between Stack and Volume Viewports
- */
-export type ViewportProperties = {
-  /** voi range (upper, lower) for the viewport */
-  voiRange?: VOIRange;
-  /** VOILUTFunction type which is LINEAR or SAMPLED_SIGMOID */
-  VOILUTFunction?: VOILUTFunctionType;
-  /** invert flag - whether the image is inverted */
-  invert?: boolean;
-  /** Colormap applied to the viewport*/
-  colormap?: ColormapPublic;
-  /** interpolation type */
-  interpolationType?: InterpolationType;
-};

package/src/types/VolumeLoaderFn.ts

@@ -1,18 +0,0 @@
-/**
- * Any volumeLoader function should implement a loading given the volumeId
- * and returns a mandatory promise which will resolve to the loaded volume object.
- * Additional `cancelFn` and `decache` can be implemented.
- */
-type VolumeLoaderFn = (
-  volumeId: string,
-  options?: Record<string, any>
-) => {
-  /** promise that resolves to the volume object */
-  promise: Promise<Record<string, any>>;
-  /** cancel function */
-  cancelFn?: () => void | undefined;
-  /** decache function */
-  decache?: () => void | undefined;
-};
-
-export default VolumeLoaderFn;