DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomImage Class / OverlayVisible Property






In This Topic
    OverlayVisible Property
    In This Topic
    Controls whether overlays embedded in the image are displayed
    Syntax
    'Declaration
     
    
    Public ReadOnly Property OverlayVisible As System.Boolean()
    'Usage
     
    
    Dim instance As DicomImage
    Dim value() As System.Boolean
     
    value = instance.OverlayVisible
    public System.bool[] OverlayVisible {get;}
    public read-only property OverlayVisible: System.array of Boolean; 
    public function get OverlayVisible : System.boolean[]
    public: __property System.bool[]* get_OverlayVisible();
    public:
    property System.array<bool>^ OverlayVisible {
       System.array<bool>^ get();
    }

    Property Value

    Array of 16 elements, 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 1 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 4.8 or higher

    See Also