Class ReferencedImage

This class is the container to hold referenced image information and have functionalities to manage them, fetched from Referenced Image Sequence Attribute Attribute (0008,1140)

Hierarchy

  • ReferencedImage

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ReferencedImage(sopClassUid?: string, sopInstanceUid: string, isMultiFrame?: boolean, ...frameNumbers: any[]): ReferencedImage
  • description

    constructs the ReferencedImage object from given value

    Parameters

    • Default value sopClassUid: string = ""

      Referenced SOP Class UID, default to empty.

    • sopInstanceUid: string

      Referenced SOP Instance UID.

    • Default value isMultiFrame: boolean = false

      Flag to state whether mutliframe, defaults to false

    • Rest ...frameNumbers: any[]

      // An array of number

    Returns ReferencedImage

    This is a synchronous method that returns the newly ReferencedImage

Properties

isMultiFrame

isMultiFrame: boolean = false

referencedFrameNumbers

referencedFrameNumbers: Array<number> = []

referencedSopClassUid

referencedSopClassUid: string

referencedSopInstanceUid

referencedSopInstanceUid: string

Methods

equals

  • equals(sopInstanceUid: string, frameNumber: number): boolean
  • description

    Check if referenced sopinstance uid equal for given referenced SopInstanceUid and frameNumber

    Parameters

    • sopInstanceUid: string
    • frameNumber: number

    Returns boolean

    boolean stating whether referenced sopinstance uid equal or not