Class ScanDirResults

ScanDirResults is returned by scanDICOMDir and contains the complete DICOM study hierarchy as a result of the scan.

Hierarchy

  • ScanDirResults

Index

Constructors

constructor

  • Constructs a new object based on the results from the scanDICOMDir. This constructor should only called internal to the API.

    Parameters

    Returns ScanDirResults

    This is an synchronous method that returns the newly constructed ScanDirResults

Properties

Private directoryList

directoryList: Array<DICOMDirEntry> = []

Private directoryPath

directoryPath: string

Methods

findSeries

  • Synchronous method that returns the SeriesDataContext that matches the seriesInstanceUID, and optional subSeriesID

    Parameters

    • seriesInstanceUID: any

      UID of the series to search for

    • Default value subSeriesID: number = 0

      0 indicates the original DICOM series, or > 0 for the ID of the subseries if sries contains of multiple, separable 3D-able seequences

    Returns SeriesDataContext

    SeriesDataContext if the series is found, or null otherwise

findStudy

getNumStudies

  • getNumStudies(): number
  • Synchronous method to return the number of studies located. Each study can be accessed by calling findStudy with index 0 thorugh getNumStudies() - 1

    Returns number

getPatients

  • Synchronous method to return an array of DICOMDirEntry object

    Returns Array<DICOMDirEntry>

getStudies

  • getStudies(): Array<string>
  • Synchronous method to return an array of study instance UIDs which can be used in findStudy() method by study instance UID.

    Returns Array<string>