The OVERLAYATTRIBUTES structure contains overlay attributes. Each overlay is a 1-bit image. The attributes are stored as member variable or flags inside uFlags member.
Member | Data Type | Description | |
uStructSize |
L_UINT |
The size of the structure (use sizeof (OVERLAYATTRIBUTES) ) | |
ptOrigin | POINT | Origin (top left point), in pixels, of the overlay bitmap, relative to the top left point of the displayed main bitmap. This is independent of the main bitmaps view perspective. | |
crColor | COLORREF | The color used to display those pixels in the overlay bitmap with a value of 1. | |
uFlags |
L_UINT |
One or more of the following flags: | |
OVERLAY_AUTOPAINT | [0x00000001] Paint the overlay automatically when the bitmap is painted using LPaint::PaintDC functions. | ||
OVERLAY_AUTOPROCESS | [0x00000002] Automatically adjust the overlay bitmap and position when the main bitmap is resized (zoomed in), scrolled, rotated, flipped, reversed, sheared, trimmed. | ||
OVERLAY_USEBITPLANE | [0x00000004] the overlay has a corresponding bitplane in the main bitmap. uBitPosition is the index bitplane. | ||
uBitPosition |
L_UINT16 |
Corresponding bit plane associated with an overlay. Valid only if OVERLAY_USEBITPLANE is set in uFlags. For more information about the bit position, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
uRows |
L_UINT16 |
Number of rows in the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
uColumns |
L_UINT16 |
Number of columns in the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
szType |
L_CHAR |
A null-terminated string that indicates whether this overlay represents a region of interest or other graphics. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
uBitsAllocated |
L_UINT16 |
Number of bits allocated in the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
szDescription |
L_CHAR |
NULL terminated string that contains user-defined comments about the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
szSubtype |
L_CHAR |
NULL terminated string that contains a defined term that identifies the intended purpose of the overlay type. For more information on possible values, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
szLabel |
L_CHAR |
NULL terminated string that contains user defined text, which may be used to label or name this overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
nROIArea |
L_INT32 |
Number of pixels in the Region Of Interest area. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
fROIMean |
L_DOUBLE |
Average value of the pixels in the Region Of Interest. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
fROIStandardDeviation |
L_DOUBLE |
The standard deviation of the pixel values in the Region Of Interest. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard. | |
nNumFramesInOverlay |
L_INT32 |
Number of Frames in the overlay. For more information, refer to "Multi-frame Overlay Module Attributes" in the DICOM standard. | |
uImageFrameOrigin |
L_UINT16 |
The number of the frame of a multi-frame image to which this overlay applies. For more information, refer to "Multi-frame Overlay Module Attributes" in the DICOM standard. | |
szActivationLayer |
L_CHAR |
NULL terminated string that identifies the layer in which the overlay shall be displayed. For more information, refer to "Overlay/Curve Activation Module Attributes" in the DICOM standard. |
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document