ImageGear .NET v25.2 - Updated
ImageGear.Formats.Dicom Assembly / ImageGear.Formats.DICOM Namespace / ImGearDICOM Class / LoadOverlay Method / LoadOverlay(ImGearPage) Method
Page from which to load overlay planes.




In This Topic
    LoadOverlay(ImGearPage) Method
    In This Topic
    Loads overlay planes from DICOM metadata of the specified page.
    Syntax
    'Declaration
     
    Public Overloads Shared Function LoadOverlay( _
       ByVal source As ImGearPage _
    ) As ImGearARTPage
    'Usage
     
    Dim source As ImGearPage
    Dim value As ImGearARTPage
     
    value = ImGearDICOM.LoadOverlay(source)
    public static ImGearARTPage LoadOverlay( 
       ImGearPage source
    )
    public: static ImGearARTPage* LoadOverlay( 
       ImGearPage* source
    ) 
    public:
    static ImGearARTPage^ LoadOverlay( 
       ImGearPage^ source
    ) 

    Parameters

    source
    Page from which to load overlay planes.

    Return Value

    New ImageGear.ART.ImGearARTPage class with annotations loaded from overlay.
    Remarks
    Loads overlay planes from DICOM metadata (DataSet), attached to the image, and creates ART marks of type ImageGear.ART.ImGearARTImageEmb class for each overlay plane. Each mark is placed in a separate ART group.

    Overlay planes do not support specifying the colors (even black or white). An overlay pixel can only be visible or invisible. All visible overlay pixels are displayed with the same color, which is specified by the application and not stored in the DICOM DataSet. By default ImageGear uses yellow color to display overlays. The application can change overlay color by going through all marks in the ImageGear.ART.ImGearARTPage class and changing palette of ImageGear.ART.ImGearARTImageEmb class marks.

    See Also