Class SeriesDataContext

The SeriesDataContext directly corresponds to a native-level SDC and contains the DICOM tags for a specific DICOM Series. A SeriesDataContext may contain the complete DICOM Series, or a subseries if the series consists of multiple, separable 3D-able sequences, depending which sdc was referenced from the ScanDirSeriesResults .

Hierarchy

Index

Constructors

constructor

  • Constructs a new object. This constructor should only called internal to the API.

    Parameters

    • patientInfo: DICOMDirEntry

      patient record with patient specific DICOM tags

    • dicomStudy: DICOMStudy

      study record with study specific DICOM tags

    • dicomSeries: DICOMImageSeries

      series record with study series DICOM tags

    • Default value subSeriesID: number = 0

      subSeries ID (0 for full series, >0 for which specific subSeries)

    Returns SeriesDataContext

    This is a synchronous method that returns the newly SeriesDataContext

Properties

attendingPhysicanName

attendingPhysicanName: string

cadFindingsInfo

cadFindingsInfo: Array<CADFindingsInfo> = []

cadMarkerSummary

cadMarkerSummary: ConceptSummary = null

imageCount

imageCount: number

imageHeight

imageHeight: number

imageTags

imageTags: Array<DICOMImageTags>

imageWidth

imageWidth: number

institutionName

institutionName: string

is3DableSeries

is3DableSeries: boolean

keyImages

keyImages: Array<number> = []

manufacturer

manufacturer: string

modality

modality: string

patientAge

patientAge: string

patientBirthDate

patientBirthDate: string

patientID

patientID: string

patientName

patientName: string

patientSex

patientSex: string

referringPhysicianName

referringPhysicianName: string

seriesDate

seriesDate: string

seriesDescription

seriesDescription: string

seriesFolderPath

seriesFolderPath: string

seriesInstanceUID

seriesInstanceUID: string

seriesNumber

seriesNumber: number

seriesTime

seriesTime: string

studyAccessionNumber

studyAccessionNumber: string

studyDate

studyDate: string

studyDescription

studyDescription: string

studyInstanceUID

studyInstanceUID: string

studyTime

studyTime: string

subSeriesID

subSeriesID: number

totalClusterFindings

totalClusterFindings: number = 0

totalDensityFindings

totalDensityFindings: number = 0

Methods

IsInstanceExists

  • IsInstanceExists(sopInstanceUid: string, frameNumber?: number): boolean
  • description

    Check whether the sopinstanceuid available in series

    Parameters

    • sopInstanceUid: string

      sopInstanceUid

    • Default value frameNumber: number = 1

    Returns boolean

clearCadFindigInfo

  • clearCadFindigInfo(): void
  • description

    Clear the cad findings related information

    Returns void

getDICOMTags

  • getDICOMTags(imageIndex: number, callbackFunc?: any): any
  • getDICOMTags(sopInstanceUID: string, callbackFunc?: any): any
  • Returns the complete list of DICOM tags for the image based on either the selected image index or sopInstanceUID. (if both specified, it will use the sopInstanceUID). The return value is an array of entries with element/group, tagName and tagValue

    Parameters

    • imageIndex: number

      0-based index of the image to retrieve the DICOM tags

    • Optional callbackFunc: any

    Returns any

    This is an asynchronous method that returns a Promise as follows:

    Promise .then(dicomTagArray) .catch (err: ReturnCode )

    callbackFunc(err: ReturnCode , dicomTagArray)

  • Parameters

    • sopInstanceUID: string
    • Optional callbackFunc: any

    Returns any

getDicomTagByIndex

  • description

    Get the DicomTag from this series for the given index

    Parameters

    • index: number

      Index

    Returns DICOMImageTags

getDicomTagBySopInstanceUid

  • getDicomTagBySopInstanceUid(sopInstanceUID: string, frameNumber: number): DICOMImageTags
  • description

    Get DICOMImageTags data for the given SOP Instance and frame number from list of image tags

    Parameters

    • sopInstanceUID: string

      SOP Instance UID

    • frameNumber: number

      Frame number

    Returns DICOMImageTags

getFinding

  • Check whether the given finding already exists or not using sop instance uid key

    Parameters

    Returns CADFindingsInfo

    Corresponding finding will be returned in sucess case, null on failure case

getMarkerSummary

  • description

    Get the cad marker summary for this series

    Returns ConceptSummary

    Returns the summary on success case, null on failure case

getNumImages

  • getNumImages(): number
  • Returns the number of images in this series.

    Returns number

    This is an synchronous method that returns the number of images in the series.

getPatientData

getPrivateTagValue

  • getPrivateTagValue(sopInstanceUID: string, privateCreator: string, groupNumber: number, elementNumber: number, callbackFunc?: any): any
  • Parameters

    • sopInstanceUID: string
    • privateCreator: string
    • groupNumber: number
    • elementNumber: number
    • Optional callbackFunc: any

    Returns any

getStudyData

getTagValue

  • getTagValue(sopInstanceUID: string, groupNumber: number, elementNumber: number, callbackFunc?: any): any
  • Parameters

    • sopInstanceUID: string
    • groupNumber: number
    • elementNumber: number
    • Optional callbackFunc: any

    Returns any

updateCADFindingsInfo

  • description

    Set total density and cluster finding information to this series data

    Parameters

    Returns void