ImageGear .NET v25.2 - Updated
ImageGear.Formats.Dicom Assembly / ImageGear.Formats.DICOM Namespace / ImGearDICOM Class / LoadOverlay Method / LoadOverlay(ImGearPage,Boolean) Method
Page from which to load overlay planes.
Specifies whether to create overlays using legacy ImageGear.ART.ImGearARTImageEmb or new ImageGear.ART.ImGearARTImage mark. As far as in ImageGear for Silverlight ImageGear.ART.ImGearARTImageEmb mark is not available, this parameter in case of Silverlight framework must be false, otherwise ImageGear.Core.ImGearException will be thrown, indicating wrong usage.




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

    Parameters

    source
    Page from which to load overlay planes.
    useLegacyMarks
    Specifies whether to create overlays using legacy ImageGear.ART.ImGearARTImageEmb or new ImageGear.ART.ImGearARTImage mark. As far as in ImageGear for Silverlight ImageGear.ART.ImGearARTImageEmb mark is not available, this parameter in case of Silverlight framework must be false, otherwise ImageGear.Core.ImGearException will be thrown, indicating wrong usage.

    Return Value

    New ImageGear.ART.ImGearARTPage class with annotations loaded from overlay data.
    Remarks
    Loads overlay planes from DICOM metadata (DataSet), attached to the image, and creates ART marks of type either ImageGear.ART.ImGearARTImage or 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 either ImageGear.ART.ImGearARTImage or ImageGear.ART.ImGearARTImageEmb class marks.

    See Also