DicomObjects.NET.V8
DicomObjects Namespace / DicomImage Class / OverlayColour Property



In This Topic
    OverlayColour Property
    In This Topic
    Controls how overlays embedded in the image are displayed
    Syntax
    'Declaration
     
    Public ReadOnly Property OverlayColour As Color()
    'Usage
     
    Dim instance As DicomImage
    Dim value() As Color
     
    value = instance.OverlayColour
    public Color[] OverlayColour {get;}
    public:
    property array<Color>^ OverlayColour {
       array<Color>^ get();
    }

    Property Value

    Array of 16 System.Drawing.Colorelements, one for each possible overlay plane
    Remarks

    DICOM defines up to 16 overlay planes embedded in an image, using group number 6000, 6002, 6004�601E, and these properties allow the developer to choose which to display. Each is a simple single bit mask, and is displayed if the appropriate OverlayVisible property is true, using the associated OverlayColour.

    The source of the data for such overlays can be either unused bits in the pixel data, or separate elements, but this is handled internally by DicomObjects, and all such overlays are handled identically.

    The OverlayIDs are numbered from 0 to 15, and so are related to the group numbers as follows:

    OverlayID=(group number � 0x6000) / 2

    Or put another way

    Group number=OverlayID * 2 + 0x6000

    Requirements

    Target Platforms: .NET CLR 3.5 or higher

    See Also