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

package/src/types/IViewport.ts

@@ -1,164 +0,0 @@
-import ICamera from './ICamera';
-import Point2 from './Point2';
-import Point3 from './Point3';
-import ViewportInputOptions from './ViewportInputOptions';
-import { ActorEntry } from './IActor';
-import ViewportType from '../enums/ViewportType';
-import ViewportStatus from '../enums/ViewportStatus';
-import DisplayArea from './displayArea';
-
-/**
- * Viewport interface for cornerstone viewports
- */
-interface IViewport {
-  /** unique identifier of the viewport */
-  id: string;
-  /** renderingEngineId the viewport belongs to */
-  renderingEngineId: string;
-  /** viewport type, can be ORTHOGRAPHIC or STACK for now */
-  type: ViewportType;
-  /** canvas associated to the viewport */
-  canvas: HTMLCanvasElement;
-  /** public DOM element associated to the viewport */
-  element: HTMLDivElement;
-  /** sx of the viewport on the offscreen canvas (if rendering using GPU) */
-  sx: number;
-  /** sy of the viewport on the offscreen canvas (if rendering using GPU) */
-  sy: number;
-  /** width of the viewport on the offscreen canvas (if rendering using GPU) */
-  sWidth: number;
-  /** height of the viewport on the offscreen canvas (if rendering using GPU) */
-  sHeight: number;
-  /** actors rendered in the viewport*/
-  _actors: Map<string, any>;
-  /** viewport default options including the axis, and background color  */
-  defaultOptions: any;
-  /** viewport options */
-  options: ViewportInputOptions;
-  /** Suppress events */
-  suppressEvents: boolean;
-  /** if the viewport has been disabled */
-  isDisabled: boolean;
-  /** The rendering state of this viewport */
-  viewportStatus: ViewportStatus;
-  /** the rotation applied to the view */
-  getRotation: () => number;
-  /** frameOfReferenceUID the viewport's default actor is rendering */
-  getFrameOfReferenceUID: () => string;
-  /** method to convert canvas to world coordinates */
-  canvasToWorld: (canvasPos: Point2) => Point3;
-  /** method to convert world to canvas coordinates */
-  worldToCanvas: (worldPos: Point3) => Point2;
-  /** get the first actor */
-  getDefaultActor(): ActorEntry;
-  /** returns all the actor entires for a viewport which is an object containing actor and its uid */
-  getActors(): Array<ActorEntry>;
-  /** returns specific actor by its uid */
-  getActor(actorUID: string): ActorEntry;
-  /** returns specific actor uid by array index */
-  getActorUIDByIndex(index: number): string;
-  /** returns specific actor by array index */
-  getActorByIndex(index: number): ActorEntry;
-  /** set and overwrite actors in a viewport */
-  setActors(actors: Array<ActorEntry>): void;
-  /** add actors to the list of actors */
-  addActors(actors: Array<ActorEntry>): void;
-  /** add one actor */
-  addActor(actorEntry: ActorEntry): void;
-  /** remove all actors from the viewport */
-  removeAllActors(): void;
-  /** remove array of uids */
-  removeActors(actorUIDs: Array<string>): void;
-  /** returns the renderingEngine instance the viewport belongs to */
-  getRenderingEngine(): any;
-  /** returns the vtkRenderer (for GPU rendering) of the viewport */
-  getRenderer(): void;
-  /** triggers render for all actors in the viewport */
-  render(): void;
-  /** set options for the viewport */
-  setOptions(options: ViewportInputOptions, immediate: boolean): void;
-  /** set displayArea for the viewport */
-  setDisplayArea(
-    displayArea: DisplayArea,
-    callResetCamera?: boolean,
-    suppressEvents?: boolean
-  );
-  /** returns the displayArea */
-  getDisplayArea(): DisplayArea | undefined;
-  /** reset camera and options*/
-  reset(immediate: boolean): void;
-  /** returns the canvas */
-  getCanvas(): HTMLCanvasElement;
-  /** returns camera object */
-  getCamera(): ICamera;
-  /** Sets the rendered state to rendered if the render actually showed image data */
-  setRendered(): void;
-  /** returns the parallel zoom relative to the default (eg returns 1 after reset) */
-  getZoom(): number;
-  /** Sets the relative zoom - set to 1 to reset it */
-  setZoom(zoom: number, storeAsInitialCamera?: boolean);
-  /** Gets the canvas pan value */
-  getPan(): Point2;
-  /** Sets the canvas pan value */
-  setPan(pan: Point2, storeAsInitialCamera?: boolean);
-  /** sets the camera */
-  setCamera(cameraInterface: ICamera, storeAsInitialCamera?: boolean): void;
-  /** whether the viewport has custom rendering */
-  customRenderViewportToCanvas: () => unknown;
-  _getCorners(bounds: Array<number>): Array<number>[];
-  updateRenderingPipeline: () => void;
-}
-
-/**
- * Public Interface for viewport input to get enabled/disabled or set
- */
-type PublicViewportInput = {
-  /** HTML element in the DOM */
-  element: HTMLDivElement;
-  /** unique id for the viewport in the renderingEngine */
-  viewportId: string;
-  /** type of the viewport */
-  type: ViewportType;
-  /** options for the viewport */
-  defaultOptions?: ViewportInputOptions;
-};
-
-type NormalizedViewportInput = {
-  /** HTML element in the DOM */
-  element: HTMLDivElement;
-  /** unique id for the viewport in the renderingEngine */
-  viewportId: string;
-  /** type of the viewport */
-  type: ViewportType;
-  /** options for the viewport */
-  defaultOptions: ViewportInputOptions;
-};
-
-type InternalViewportInput = {
-  element: HTMLDivElement;
-  canvas: HTMLCanvasElement;
-  viewportId: string;
-  type: ViewportType;
-  defaultOptions: ViewportInputOptions;
-};
-
-type ViewportInput = {
-  id: string;
-  element: HTMLDivElement;
-  canvas: HTMLCanvasElement;
-  renderingEngineId: string;
-  type: ViewportType;
-  sx: number;
-  sy: number;
-  sWidth: number;
-  sHeight: number;
-  defaultOptions: ViewportInputOptions;
-};
-
-export type {
-  IViewport,
-  ViewportInput,
-  PublicViewportInput,
-  InternalViewportInput,
-  NormalizedViewportInput,
-};

package/src/types/IViewportId.ts

@@ -1,9 +0,0 @@
-/**
- * Interface to uniquely define a viewport in cornerstone. Note: viewportIds
- * can be shared between different rendering engines, but having a renderingEngineId
- * and a viewportId is required to uniquely define a viewport.
- */
-export default interface IViewportId {
-  renderingEngineId: string;
-  viewportId: string;
-}

package/src/types/IVolume.ts

@@ -1,45 +0,0 @@
-import type { vtkImageData } from '@kitware/vtk.js/Common/DataModel/ImageData';
-import type Point3 from './Point3';
-import type Metadata from './Metadata';
-import Mat3 from './Mat3';
-
-type VolumeScalarData = Float32Array | Uint8Array | Uint16Array | Int16Array;
-
-/**
- * Cornerstone ImageVolume interface.
- */
-interface IVolume {
-  /** unique identifier for the volume in the cache */
-  volumeId: string;
-  /** volume metadata */
-  metadata: Metadata;
-  /** volume dimensions */
-  dimensions: Point3;
-  /** volume spacing */
-  spacing: Point3;
-  /** volume origin */
-  origin: Point3;
-  /** volume direction */
-  direction: Mat3;
-  /** volume scalarData */
-  scalarData: VolumeScalarData | Array<VolumeScalarData>;
-  /** volume size in bytes */
-  sizeInBytes?: number;
-  /** volume image data as vtkImageData */
-  imageData?: vtkImageData;
-  /** referencedVolumeId if volume is derived from another volume */
-  referencedVolumeId?: string;
-  /** volume scaling metadata */
-  scaling?: {
-    PT?: {
-      // @TODO: Do these values exist?
-      SUVlbmFactor?: number;
-      SUVbsaFactor?: number;
-      // accessed in ProbeTool
-      suvbwToSuvlbm?: number;
-      suvbwToSuvbsa?: number;
-    };
-  };
-}
-
-export { IVolume as default, IVolume, VolumeScalarData };

package/src/types/IVolumeInput.ts

@@ -1,36 +0,0 @@
-import { VolumeActor } from './IActor';
-import BlendModes from '../enums/BlendModes';
-
-/**
- * Volume input callback type, used to perform operations on the volume data
- * after it has been loaded.
- */
-type VolumeInputCallback = (params: {
-  /** vtk volume actor */
-  volumeActor: VolumeActor;
-  /** unique volume Id in the cache */
-  volumeId: string;
-}) => unknown;
-
-/**
- * VolumeInput that can be used to add a volume to a viewport. It includes
- * mandatory `volumeId` but other options such as `visibility`, `blendMode`,
- * `slabThickness` and `callback` can also be provided
- */
-interface IVolumeInput {
-  /** Volume ID of the volume in the cache */
-  volumeId: string;
-  // actorUID for segmentations, since two segmentations with the same volumeId
-  // can have different representations
-  actorUID?: string;
-  /** Visibility of the volume - by default it is true */
-  visibility?: boolean;
-  /** Callback to be called when the volume is added to the viewport */
-  callback?: VolumeInputCallback;
-  /** Blend mode of the volume - by default it is `additive` */
-  blendMode?: BlendModes;
-  /** Slab thickness of the volume - by default it is 0.05*/
-  slabThickness?: number;
-}
-
-export type { IVolumeInput, VolumeInputCallback };

package/src/types/IVolumeViewport.ts

@@ -1,149 +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 properties
-   */
-  getProperties: () => 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 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;
-  /**
-   * 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?: boolean,
-    resetZoom?: boolean,
-    resetToCenter?: boolean
-  ): boolean;
-  /**
-   * 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;
-  /**
-   * Reset the viewport properties to the default values
-   */
-  resetProperties(volumeId?: string): void;
-}

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/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,7 +0,0 @@
-export type PixelDataTypedArray =
-  | 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,6 +0,0 @@
-/**
- * This duplicates the typing established in gl-matrix for a vec3
- */
-type Point3 = [number, number, 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,18 +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;
-  /** image rotation */
-  rotation?: number;
-  /** suppress events (optional) */
-  suppressEvents?: boolean;
-  /** Indicates if the voi is a computed VOI (not user set) */
-  isComputedVOI?: boolean;
-};
-
-export default StackViewportProperties;

package/src/types/TransformMatrix2D.ts

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