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

package/src/types/IContourSet.ts

@@ -1,59 +0,0 @@
-import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData';
-import { ContourData, IContour, Point3 } from './';
-
-/**
- * This class represents a set of contours in 3d space.
- * Usually contours are grouped together in a contour set to represent a meaningful shape.
- */
-export interface IContourSet {
-  readonly id: string;
-  readonly sizeInBytes: number;
-  readonly frameOfReferenceUID: string;
-  contours: IContour[];
-  _createEachContour(data: ContourData[]): void;
-  getSizeInBytes(): number;
-  getSegmentIndex(): number;
-  getCentroid(): Point3;
-  getColor(): any;
-  /**
-   * This function returns the contours of the image
-   * @returns The contours of the image.
-   */
-  getContours(): IContour[];
-  /**
-   * It returns an array of all the points in the glyph
-   * @returns An array of points.
-   */
-  getFlatPointsArray(): Point3[];
-  /**
-   * This function returns the number of contours in the current shape.
-   * @returns The number of contours in the glyph.
-   */
-  getNumberOfContours(): number;
-  /**
-   * It loops through each contour in the `contours` array, and adds the number of
-   * points in each contour to the `numberOfPoints` variable
-   * @returns The number of points in the contours.
-   */
-  getTotalNumberOfPoints(): number;
-  /**
-   * It returns an array of the number of points in each contour.
-   * @returns An array of numbers.
-   */
-  getNumberOfPointsArray(): number[];
-  /**
-   * It returns the points in a contour.
-   * @param contourIndex - The index of the contour you want to get the
-   * points from.
-   * @returns An array of Point3 objects.
-   */
-  getPointsInContour(contourIndex: number): Point3[];
-  /**
-   * "This function returns the number of points in a contour."
-   *
-   * @param contourIndex - The index of the contour you want to get the
-   * number of points from.
-   * @returns The number of points in the contour.
-   */
-  getNumberOfPointsInAContour(contourIndex: number): number;
-}

package/src/types/IDynamicImageVolume.ts

@@ -1,18 +0,0 @@
-import { IImageVolume, VolumeScalarData } from '../types';
-
-/**
- * Cornerstone ImageVolume interface. Todo: we should define new IVolume class
- * with appropriate typings for the other types of volume that don't have images (nrrd, nifti)
- */
-interface IDynamicImageVolume extends IImageVolume {
-  /** Returns the active time point index */
-  get timePointIndex(): number;
-  /** Set the active time point index which also updates the active scalar data */
-  set timePointIndex(newTimePointIndex: number);
-  /** Returns the number of time points */
-  get numTimePoints(): number;
-  /** return scalar data arrays (one per timepoint) */
-  getScalarDataArrays(): VolumeScalarData[];
-}
-
-export default IDynamicImageVolume;

package/src/types/IEnabledElement.ts

@@ -1,21 +0,0 @@
-import type { IRenderingEngine } from '../types';
-import type IStackViewport from './IStackViewport';
-import type IVolumeViewport from './IVolumeViewport';
-
-/**
- * Cornerstone Enabled Element interface
- */
-interface IEnabledElement {
-  /** Cornerstone Viewport instance - can be Stack or Volume Viewport as of now */
-  viewport: IStackViewport | IVolumeViewport;
-  /** Cornerstone Rendering Engine instance */
-  renderingEngine: IRenderingEngine;
-  /** Unique ID of the viewport in the renderingEngine */
-  viewportId: string;
-  /** Unique ID of the renderingEngine */
-  renderingEngineId: string;
-  /** FrameOfReference the enabledElement is rendering inside */
-  FrameOfReferenceUID: string;
-}
-
-export default IEnabledElement;

package/src/types/IGeometry.ts

@@ -1,12 +0,0 @@
-import { GeometryType } from '../enums';
-import { IContourSet } from './IContourSet';
-
-// interface IGeometry can be array of IContourSet
-interface IGeometry {
-  id: string;
-  type: GeometryType;
-  data: IContourSet; // | Array<IClosedSurface> , etc
-  sizeInBytes: number;
-}
-
-export default IGeometry;

package/src/types/IImage.ts

@@ -1,116 +0,0 @@
-import CPUFallbackLUT from './CPUFallbackLUT';
-import CPUFallbackColormap from './CPUFallbackColormap';
-import CPUFallbackEnabledElement from './CPUFallbackEnabledElement';
-import { PixelDataTypedArray } from './PixelDataTypedArray';
-
-/**
- * Cornerstone Image interface, it is used for both CPU and GPU rendering
- */
-interface IImage {
-  /** Image Id */
-  imageId: string;
-  sharedCacheKey?: string;
-  /** Whether the image is Pre-scaled during loading */
-  isPreScaled?: boolean;
-  /** preScale object */
-  preScale?: {
-    /** boolean flag to indicate whether the image has been scaled */
-    scaled?: boolean;
-    /** scaling parameters */
-    scalingParameters?: {
-      /** modality of the image */
-      modality?: string;
-      /** rescale slop */
-      rescaleSlope?: number;
-      /** rescale intercept */
-      rescaleIntercept?: number;
-      /** PT suvbw */
-      suvbw?: number;
-    };
-  };
-  /** minimum pixel value of the image */
-  minPixelValue: number;
-  /* maximum pixel value of the image */
-  maxPixelValue: number;
-  /** slope from metadata for scaling */
-  slope: number;
-  /** intercept from metadata for scaling */
-  intercept: number;
-  /** windowCenter from metadata */
-  windowCenter: number[] | number;
-  /** windowWidth from metadata */
-  windowWidth: number[] | number;
-  /** voiLUTFunction from metadata */
-  voiLUTFunction: string;
-  /** function that returns the pixelData as an array */
-  getPixelData: () => PixelDataTypedArray;
-  getCanvas: () => HTMLCanvasElement;
-  /** image number of rows */
-  rows: number;
-  /** image number of columns */
-  columns: number;
-  /** image height */
-  height: number;
-  /** image width */
-  width: number;
-  /** is image a color image */
-  color: boolean;
-  /** is image rgb and alpha */
-  rgba: boolean;
-  /** number of components in the image */
-  numComps: number;
-  /** CPU: custom render method for the image */
-  render?: (
-    enabledElement: CPUFallbackEnabledElement,
-    invalidated: boolean
-  ) => unknown;
-  /** column pixel spacing */
-  columnPixelSpacing: number;
-  /** row pixel spacing */
-  rowPixelSpacing: number;
-  /** slice thickness */
-  sliceThickness?: number;
-  /** whether image pixels are inverted in color */
-  invert: boolean;
-  /** image photometric interpretation */
-  photometricInterpretation?: string;
-  /** image size in number of bytes */
-  sizeInBytes: number;
-  /** CPU: custom modality LUT for image  */
-  modalityLUT?: CPUFallbackLUT;
-  /** CPU: custom VOI LUT for image  */
-  voiLUT?: CPUFallbackLUT;
-  /** CPU: custom color map for image  */
-  colormap?: CPUFallbackColormap;
-  /** image scaling metadata - including PT suv values */
-  scaling?: {
-    PT?: {
-      // @TODO: Do these values exist?
-      SUVlbmFactor?: number;
-      SUVbsaFactor?: number;
-      // accessed in ProbeTool
-      suvbwToSuvlbm?: number;
-      suvbwToSuvbsa?: number;
-    };
-  };
-  /** CPU: image statistics for rendering */
-  stats?: {
-    lastStoredPixelDataToCanvasImageDataTime?: number;
-    lastGetPixelDataTime?: number;
-    lastPutImageDataTime?: number;
-    lastLutGenerateTime?: number;
-    lastRenderedViewport?: unknown;
-    lastRenderTime?: number;
-  };
-  /** CPU: image cached LUT */
-  cachedLut?: {
-    windowWidth?: number | number[];
-    windowCenter?: number | number[];
-    invert?: boolean;
-    lutArray?: Uint8ClampedArray;
-    modalityLUT?: unknown;
-    voiLUT?: CPUFallbackLUT;
-  };
-}
-
-export default IImage;

package/src/types/IImageCalibration.ts

@@ -1,41 +0,0 @@
-import CalibrationTypes from '../enums/CalibrationTypes';
-
-/**
- * IImageCalibration is an object that stores information about the type
- * of image calibration.
- */
-export interface IImageCalibration {
-  /**
-   * The pixel spacing for the image, in mm between pixel centers
-   * These are not required, and are deprecated in favour of getting the original
-   * image spacing and then applying the transforms.  The values here should
-   * be identical to original spacing.
-   */
-  rowPixelSpacing?: number;
-  columnPixelSpacing?: number;
-  /** The scaling of measurement values relative to the base pixel spacing (1 if not specified) */
-  scale?: number;
-  /**
-   * The calibration aspect ratio for non-square calibrations.
-   * This is the aspect ratio similar to the scale above that applies when
-   * the viewport is displaying non-square image pixels as square screen pixels.
-   *
-   * Defaults to 1 if not specified, and is also 1 if the Viewport has squared
-   * up the image pixels so that they are displayed as a square.
-   * Not well handled currently as this needs to be incorporated into
-   * tools when doing calculations.
-   */
-  aspect?: number;
-  /** The type of the pixel spacing, distinguishing between various
-   * types projection (CR/DX/MG) spacing and volumetric spacing (the type is
-   * an empty string as it doesn't get a suffix, but this distinguishes it
-   * from other types)
-   */
-  type: CalibrationTypes;
-  /** A tooltip which can be used to explain the calibration information */
-  tooltip?: string;
-  /** The DICOM defined ultrasound regions.  Used for non-distance spacing units. */
-  sequenceOfUltrasoundRegions?: Record<string, unknown>[];
-}
-
-export default IImageCalibration;

package/src/types/IImageData.ts

@@ -1,49 +0,0 @@
-import type { vtkImageData } from '@kitware/vtk.js/Common/DataModel/ImageData';
-import { Point3, Scaling, Mat3 } from '../types';
-import IImageCalibration from './IImageCalibration';
-
-/**
- * IImageData of an image, which stores actual scalarData and metaData about the image.
- * IImageData is different from vtkImageData.
- */
-interface IImageData {
-  /** image dimensions */
-  dimensions: Point3;
-  /** image direction */
-  direction: Mat3;
-  /** image spacing */
-  spacing: Point3;
-  /** image origin */
-  origin: Point3;
-  /** image scalarData which stores the array of pixelData */
-  scalarData: Float32Array | Uint16Array | Uint8Array | Int16Array;
-  /** vtkImageData object */
-  imageData: vtkImageData;
-  /** image metadata - currently only modality */
-  metadata: { Modality: string };
-  /** image scaling for scaling pixelArray */
-  scaling?: Scaling;
-  /** whether the image has pixel spacing and it is not undefined */
-  hasPixelSpacing?: boolean;
-
-  calibration?: IImageCalibration;
-
-  /** preScale object */
-  preScale?: {
-    /** boolean flag to indicate whether the image has been scaled */
-    scaled?: boolean;
-    /** scaling parameters */
-    scalingParameters?: {
-      /** modality of the image */
-      modality?: string;
-      /** rescale slop */
-      rescaleSlope?: number;
-      /** rescale intercept */
-      rescaleIntercept?: number;
-      /** PT suvbw */
-      suvbw?: number;
-    };
-  };
-}
-
-export default IImageData;

package/src/types/IImageVolume.ts

@@ -1,78 +0,0 @@
-import type { vtkImageData } from '@kitware/vtk.js/Common/DataModel/ImageData';
-import {
-  Metadata,
-  VolumeScalarData,
-  Point3,
-  IImageLoadObject,
-  Mat3,
-} from '../types';
-
-/**
- * Cornerstone ImageVolume interface. Todo: we should define new IVolume class
- * with appropriate typings for the other types of volume that don't have images (nrrd, nifti)
- */
-interface IImageVolume {
-  /** unique identifier of the volume in the cache */
-  readonly volumeId: string;
-  /** volume dimensions */
-  dimensions: Point3;
-  /** volume direction */
-  direction: Mat3;
-  /** volume metadata */
-  metadata: Metadata;
-  /** volume origin - set to the imagePositionPatient of the last image in the volume */
-  origin: Point3;
-  /** Whether preScaling has been performed on the volume */
-  isPreScaled: boolean;
-  /** volume scaling metadata */
-  scaling?: {
-    PT?: {
-      SUVlbmFactor?: number;
-      SUVbsaFactor?: number;
-      suvbwToSuvlbm?: number;
-      suvbwToSuvbsa?: number;
-    };
-  };
-  /** volume size in bytes */
-  sizeInBytes?: number;
-  /** volume spacing */
-  spacing: Point3;
-  /** number of voxels in the volume */
-  numVoxels: number;
-  /** volume image data as vtkImageData */
-  imageData?: vtkImageData;
-  /** openGL texture for the volume */
-  vtkOpenGLTexture: any;
-  /** loading status object for the volume containing loaded/loading statuses */
-  loadStatus?: Record<string, any>;
-  /** imageIds of the volume (if it is built of separate imageIds) */
-  imageIds: Array<string>;
-  /** volume referencedVolumeId (if it is derived from another volume) */
-  referencedVolumeId?: string; // if volume is derived from another volume
-  /** whether the metadata for the pixel spacing is not undefined  */
-  hasPixelSpacing: boolean;
-  /** return true if it is a 4D volume or false if it is 3D volume */
-  isDynamicVolume(): boolean;
-  /** method to convert the volume data in the volume cache, to separate images in the image cache */
-  convertToCornerstoneImage?: (
-    imageId: string,
-    imageIdIndex: number
-  ) => IImageLoadObject;
-
-  //cancel load
-  cancelLoading?: () => void;
-
-  /** return the volume scalar data */
-  getScalarData(): VolumeScalarData;
-
-  /** return the index of a given imageId */
-  getImageIdIndex(imageId: string): number;
-
-  /** return the index of a given imageURI */
-  getImageURIIndex(imageURI: string): number;
-
-  /** destroy the volume and make it unusable */
-  destroy(): void;
-}
-
-export default IImageVolume;

package/src/types/ILoadObject.ts

@@ -1,36 +0,0 @@
-import { ImageVolume } from './../cache/classes/ImageVolume';
-import IGeometry from './IGeometry';
-import IImage from './IImage';
-
-/**
- * ImageLoadObject interface which any imageLoader should return
- */
-export interface IImageLoadObject {
-  /** promise that resolves to an image */
-  promise: Promise<IImage>;
-  /** optional cancel function for loading*/
-  cancelFn?: () => void;
-  /** optional decache function */
-  decache?: () => void;
-}
-
-/**
- * VolumeLoadObject interface which any volumeLoader should return
- */
-export interface IVolumeLoadObject {
-  /** promise that resolves to an ImageVolume */
-  promise: Promise<ImageVolume>;
-  /** optional cancel function for loading*/
-  cancelFn?: () => void;
-  /** optional decache function */
-  decache?: () => void;
-}
-
-export interface IGeometryLoadObject {
-  /** promise that resolves to an ImageVolume */
-  promise: Promise<IGeometry>;
-  /** optional cancel function for loading*/
-  cancelFn?: () => void;
-  /** optional decache function */
-  decache?: () => void;
-}

package/src/types/IRegisterImageLoader.ts

@@ -1,10 +0,0 @@
-import ImageLoaderFn from './ImageLoaderFn';
-
-/**
- * Register image loader interface
- */
-interface IRegisterImageLoader {
-  registerImageLoader: (scheme: string, imageLoader: ImageLoaderFn) => void;
-}
-
-export default IRegisterImageLoader;

package/src/types/IRenderingEngine.ts

@@ -1,28 +0,0 @@
-import IStackViewport from './IStackViewport';
-import { PublicViewportInput } from './IViewport';
-import IVolumeViewport from './IVolumeViewport';
-
-export default interface IRenderingEngine {
-  id: string;
-  hasBeenDestroyed: boolean;
-  offscreenMultiRenderWindow: any;
-  offScreenCanvasContainer: any;
-  setViewports(viewports: Array<PublicViewportInput>): void;
-  resize(immediate?: boolean, keepCamera?: boolean): void;
-  getViewport(id: string): IStackViewport | IVolumeViewport;
-  getViewports(): Array<IStackViewport | IVolumeViewport>;
-  render(): void;
-  renderViewports(viewportIds: Array<string>): void;
-  renderViewport(viewportId: string): void;
-  renderFrameOfReference(FrameOfReferenceUID: string): void;
-  fillCanvasWithBackgroundColor(
-    canvas: HTMLCanvasElement,
-    backgroundColor: [number, number, number]
-  ): void;
-  enableElement(viewportInputEntry: PublicViewportInput): void;
-  disableElement(viewportId: string): void;
-  getStackViewports(): Array<IStackViewport>;
-  getVolumeViewports(): Array<IVolumeViewport>;
-  destroy(): void;
-  _debugRender(): void;
-}

package/src/types/IStackViewport.ts

@@ -1,144 +0,0 @@
-import CPUFallbackColormapData from './CPUFallbackColormapData';
-import CPUIImageData from './CPUIImageData';
-import ICamera from './ICamera';
-import IImageData from './IImageData';
-import { IViewport } from './IViewport';
-import Point2 from './Point2';
-import Point3 from './Point3';
-import { Scaling } from './ScalingParameters';
-import StackViewportProperties from './StackViewportProperties';
-import { ColormapRegistration } from './Colormap';
-import IImage from './IImage';
-
-/**
- * Interface for Stack Viewport
- */
-export default interface IStackViewport extends IViewport {
-  modality: string;
-  /** Scaling parameters */
-  scaling: Scaling;
-  /**
-   * Resizes the viewport - only used in CPU fallback for StackViewport. The
-   * GPU resizing happens inside the RenderingEngine.
-   */
-  resize: () => void;
-  /**
-   * Returns the frame of reference UID, if the image doesn't have imagePlaneModule
-   * metadata, it returns undefined, otherwise, frameOfReferenceUID is returned.
-   */
-  getFrameOfReferenceUID: () => string;
-  /**
-   * Sets the properties for the viewport on the default actor. Properties include
-   * setting the VOI, inverting the colors and setting the interpolation type, rotation
-   */
-  setProperties(
-    { voiRange, invert, interpolationType, rotation }: StackViewportProperties,
-    suppressEvents?: boolean
-  ): void;
-  /**
-   * Retrieve the viewport properties
-   */
-  getProperties: () => StackViewportProperties;
-  /**
-   * canvasToWorld Returns the world coordinates of the given `canvasPos`
-   * projected onto the plane defined by the `Viewport`'s camera.
-   */
-  canvasToWorld: (canvasPos: Point2) => Point3;
-  /**
-   * Returns the canvas coordinates of the given `worldPos`
-   * projected onto the `Viewport`'s `canvas`.
-   */
-  worldToCanvas: (worldPos: Point3) => Point2;
-  /**
-   * Returns the index of the imageId being renderer
-   */
-  getCurrentImageIdIndex: () => number;
-  /**
-   * Returns the list of image Ids for the current viewport
-   */
-  getImageIds: () => string[];
-  /**
-   * Returns true if the viewport contains the imageId
-   */
-  hasImageId: (imageId: string) => boolean;
-  /**
-   * Returns true if the viewport contains the imageURI
-   */
-  hasImageURI: (imageURI: string) => boolean;
-  /**
-   * Returns the currently rendered imageId
-   */
-  getCurrentImageId: () => string;
-
-  /**
-   * Custom rendering pipeline for the rendering for the CPU fallback
-   */
-  customRenderViewportToCanvas: () => {
-    canvas: HTMLCanvasElement;
-    element: HTMLDivElement;
-    viewportId: string;
-    renderingEngineId: string;
-  };
-  /**
-   * 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)
-   */
-  getImageData(): IImageData | CPUIImageData;
-  /**
-   * Returns the raw/loaded image being shown inside the stack viewport.
-   */
-  getCornerstoneImage: () => IImage;
-  /**
-   * Reset the viewport properties to the default values
-   */
-  resetProperties(): void;
-  /**
-   * If the user has selected CPU rendering, return the CPU camera, otherwise
-   * return the default camera
-   */
-  getCamera(): ICamera;
-  /**
-   * Set the camera based on the provided camera object.
-   */
-  setCamera(cameraInterface: ICamera): void;
-  /**
-   * Sets the imageIds to be visualized inside the stack viewport. It accepts
-   * list of imageIds, the index of the first imageId to be viewed. It is a
-   * asynchronous function that returns a promise resolving to imageId being
-   * displayed in the stack viewport.
-   */
-  setStack(
-    imageIds: Array<string>,
-    currentImageIdIndex?: number
-  ): Promise<string>;
-  /**
-   * Centers Pan and resets the zoom for stack viewport.
-   */
-  resetCamera(resetPan?: boolean, resetZoom?: boolean): boolean;
-  /**
-   * Loads the image based on the provided imageIdIndex. It is an Async function which
-   * returns a promise that resolves to the imageId.
-   */
-  setImageIdIndex(imageIdIndex: number): Promise<string>;
-  /**
-   * Calibrates the image with new metadata that has been added for imageId. To calibrate
-   * a viewport, you should add your calibration data manually to
-   * calibratedPixelSpacingMetadataProvider and call viewport.calibrateSpacing
-   * for it get applied.
-   */
-  calibrateSpacing(imageId: string): void;
-  /**
-   * If the renderer is CPU based, throw an error. Otherwise, returns the `vtkRenderer` responsible for rendering the `Viewport`.
-   */
-  getRenderer(): any;
-  /**
-   * Sets the colormap for the current viewport.
-   * @param colormap - The colormap data to use.
-   */
-  setColormap(colormap: CPUFallbackColormapData | ColormapRegistration): void;
-  /**
-   * It sets the colormap to the default colormap.
-   */
-  unsetColormap(): void;
-}

package/src/types/IStreamingImageVolume.ts

@@ -1,13 +0,0 @@
-import { ImageVolume } from './../cache/classes/ImageVolume';
-
-/**
- * Cornerstone StreamingImageVolume which extends ImageVolume
- */
-export default interface IStreamingImageVolume extends ImageVolume {
-  /** method to load all the loading requests */
-  clearLoadCallbacks(): void;
-  /** method to convert the volume data in the volume cache, to separate images in the image cache */
-  convertToCornerstoneImage(imageId: string, imageIdIndex: number): any;
-  /** method to decache the volume from cache */
-  decache(completelyRemove: boolean): void;
-}

package/src/types/IStreamingVolumeProperties.ts

@@ -1,15 +0,0 @@
-interface IStreamingVolumeProperties {
-  /** imageIds of the volume  */
-  imageIds: Array<string>;
-
-  /** loading status object for the volume containing loaded/loading statuses */
-  loadStatus: {
-    loaded: boolean;
-    loading: boolean;
-    cancelled: boolean;
-    cachedFrames: Array<boolean>;
-    callbacks: Array<() => void>;
-  };
-}
-
-export default IStreamingVolumeProperties;