@dcm/nifti-image-loader/index.d.ts

Neuroimaging Informatics Technology Initiative (NIfTI) Image Loader for the Cornerstone library.

import type { Cornerstone, ImageLoadObject } from '@dcm/cornerstone-core';

/** Compound metadata */
export interface CompoundMetaData extends Record<string, any> {}

/** Loader configure options */
export interface LoaderConfigureOptions {
  beforeSend?: (
    xhr: XMLHttpRequest,
    imageId?: string,
    headers?: Record<string, any>,
    params?: Record<string, any>,
  ) => void;
}

/** Slice shape */
interface SliceShape {
  dimension?: 'x' | 'y' | 'z';
  index?: number;
}

/** ImageId class */
export interface ImageId {
  filePath: string;
  slice: SliceShape;
  timePoint?: number;
  new (filePath: string, slice: SliceShape, timePoint?: number): ImageId;
  url(): string;
  static fromURL(url: string): ImageId;
}

export interface CornerstoneNIFTIImageLoader {
  nifti: {
    loadImage(imageId: string): Promis<ImageLoadObject>;
    loadVolumeTimepoint(imageId: string): Promise<ImageLoadObject>;
    loadHeader(imageId: string, isRangeRead?: boolean = true): Promise<CompoundMetaData>;
    ImageId: ImageId;
    streamingMode: boolean;
    register(cornerstone: Cornerstone): void;
    configure(loaderOptions: LoaderConfigureOptions): void;
  };

  /** External libraries */
  external: {
    cornerstone: Cornerstone;
    niftiReaderJs: Record<string, any>;
  };
}

declare const cornerstoneNIFTIImageLoader: CornerstoneNIFTIImageLoader;

declare module '@dcm/nifti-image-loader' {
  export = cornerstoneNIFTIImageLoader;
}