Class PresentationDataContext

PresentationDataContext contains dicom viewing attributes and graphic annotation sequence

Hierarchy

  • PresentationDataContext

Index

Constructors

Properties

Methods

Constructors

constructor

  • description

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

    Parameters

    • Default value renderEngineID: any = null

    Returns PresentationDataContext

    This is a synchronous method that returns the newly PresentationDataContext

Properties

contentCreatorName

contentCreatorName: string

contentDescription

contentDescription: string

contentLabel

contentLabel: string

displayAreaSequence

displayAreaSequence: Array<DisplayArea> = []

graphicAnnotationContext

graphicAnnotationContext: GraphicAnnotationContext = null

graphicLayerSequence

graphicLayerSequence: Array<GraphicLayer> = []

instanceNumber

instanceNumber: number

isEnabled

isEnabled: boolean = false

manufacturer

manufacturer: string

Private name

name: string = "PresentationDataContext"

Private orgRoot

orgRoot: string = ""

orgRootUpdated

orgRootUpdated: boolean = false

path

path: string

Private patientInfo

patientInfo: DICOMDirEntry = null

presentationCreationDate

presentationCreationDate: string

presentationCreationTime

presentationCreationTime: string

referencedSeriesSequence

referencedSeriesSequence: Array<ReferencedSeries> = []

renderEngineID

renderEngineID: any = null

sopInstanceUid

sopInstanceUid: string

Private source

source: string

Private studyInfo

studyInfo: DICOMStudy = null

viewingAttribute

viewingAttribute: ViewingAttribute

viewingAttributesUpdated

viewingAttributesUpdated: boolean = false

Methods

addDisplayAreaSequence

  • addDisplayAreaSequence(referencedImage: ReferencedImage, pixelSpacing: string, topLeftHandCorner: Point, bottomRightHandCorner: Point, presentationSizeMode?: string): void
  • description

    Add display area sequence for the given refernced image

    Parameters

    • referencedImage: ReferencedImage

      value for dicom tag Referenced Image Sequence (0008,1140)

    • pixelSpacing: string

      value for dicom tag Presentation pixel spacing (0070,0101)

    • topLeftHandCorner: Point

      value for dicom tag Displayed area Top Left Corner (0070,0052)

    • bottomRightHandCorner: Point

      value for dicom tag Displayed area Bottom Right Corner (0070,0053)

    • Default value presentationSizeMode: string = null

      value for dicom tag Presentation size mode (0070,0100)

    Returns void

addGraphicLayerSequence

  • addGraphicLayerSequence(layer: string, color: Color): void
  • description

    Add a new graphic layer if not found

    Parameters

    • layer: string

      graphic layer name

    • color: Color

      Fovia.Util.Color CIELab color values

    Returns void

addReferencedImage

  • addReferencedImage(referencedSeriesInstanceUID: string, referencedImage: ReferencedImage): void
  • description

    Add referenced image to referenced series sequence

    Parameters

    • referencedSeriesInstanceUID: string

      Value for dicom tag (0020,000E)

    • referencedImage: ReferencedImage

      Value for dicom tag (0008,1140)

    Returns void

addReferencedSeries

  • addReferencedSeries(referencedSeries: ReferencedSeries, isMultiFrame: boolean): void

  • Add referencedSeries to this object's referneced series sequence. If the series already exists, merges the referenced image sequence

    Parameters

    • referencedSeries: ReferencedSeries

      Fovia.ReferencedSeries object to be added to the sequence

    • isMultiFrame: boolean

      States whether the series is multi-frame

    Returns void

getLutExplanation

  • getLutExplanation(seriesInstanceUID: string): string
  • description

    Get lut explanation from softcopy VOILUT data for the given instance

    Parameters

    • seriesInstanceUID: string

      Referenced series Instance uid

    Returns string

    lut explation value if found otherwise null

Protected getReferencedSeries

  • Get referenced series by given referenced series instance UID

    Parameters

    • referencedSeriesInstanceUid: string

      referenced series instance uid

    Returns ReferencedSeries

    Fovia.ReferencedSeries object

hasPresentationStates

  • hasPresentationStates(sopInstanceUID: string): boolean
  • description

    Check if presentation data available for given instance

    Parameters

    • sopInstanceUID: string

      referenced image SOP Instance UID

    Returns boolean

    boolean true if given referenced image exists otherwise false

isDisplayAreaExists

  • isDisplayAreaExists(sopInstanceUID: string, frameNumber: number): boolean
  • description

    Check if display area exists for given sop instance

    Parameters

    • sopInstanceUID: string

      SOP Instance Uid and frame number

    • frameNumber: number

      frame number

    Returns boolean

    boolean stating whether display area exists

isGraphicLayerExists

  • isGraphicLayerExists(layer: string): boolean

  • Check if given graphic layer already exists

    Parameters

    • layer: string

      Graphic layer to be checked

    Returns boolean

    boolean stating whether graphic layer area exists

isReferencedSeriesExists

  • isReferencedSeriesExists(referencedSeriesInstanceUid: string): boolean
  • description

    Check if given referenced series exists

    Parameters

    • referencedSeriesInstanceUid: string

      Referenced series instance uid to check

    Returns boolean

    Returns true on success case, false on failure case

merge

mergeDisplayAreaSequence

  • mergeDisplayAreaSequence(displayAreaSequence: Array<DisplayArea>): void
  • description

    Merge given display area sequence data to this display area sequence.

    Parameters

    • displayAreaSequence: Array<DisplayArea>

      Array of Fovia.DisplayArea data

    Returns void

mergeGraphicLayerSequence

  • mergeGraphicLayerSequence(graphicLayerSequence: Array<GraphicLayer>): void
  • description

    Merge given graphic layer sequence data to this graphic layer sequence.

    Parameters

    • graphicLayerSequence: Array<GraphicLayer>

      Array of Fovia.GraphicLayer data

    Returns void

mergePresentaitonInfo

mergePresentationInfo

  • description

    Merge presentation data details to this object's data from given Non-Image data

    Parameters

    • nonImageData: NonImageData

      Fovia.NonImageData having presentation data information

    Returns void

mergeReferencedSeries

  • mergeReferencedSeries(referencedSeriesSequence: Array<ReferencedSeries>): void
  • description

    Merge given referenced series with this referenced series

    Parameters

    • referencedSeriesSequence: Array<ReferencedSeries>

      An array of referenced series data

    Returns void

setOrgRoot

  • setOrgRoot(value: string): void
  • description

    Set organization root value which is used to generate sop class uid for presentation

    Parameters

    • value: string

      organizational root value

    Returns void

setPatient

setStudy

toJSON

  • toJSON(): any
  • description

    Convert presentation data to key value pair to be sent to server to save

    Returns any

    Object with key value pair of presentation data

updateViewingAttribute

  • description

    Update viewing attributes(rotate/flip/inverse) this presentation when modified

    Parameters

    • renderParams: RenderParams2D

      Fovia.RenderParams2D object having updated viewing attributes

    Returns void

updateWindowLevel

  • description

    Update softcopy VOI lut data for the given referenced image

    Parameters

    • renderParams: RenderParams2D

      Fovia.RenderParams2D object having updated W/L values

    • referencedImage: ReferencedImage

      Fovia.ReferencedImage object to be added

    • rescaleSlope: number
    • rescaleIntercept: number

    Returns void