OVERLAYATTRIBUTES

The OVERLAYATTRIBUTES structure contains the overlay attributes. The attributes are stored as member variables or as flags inside the uFlags member.

Members

L_UINT uStructSize

The size of the structure (use sizeof (OVERLAYATTRIBUTES))

L_POINT ptOrigin

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 bitmap's view perspective.

L_COLORREF crColor

The color used to display those pixels in the overlay bitmap with a value of 1.

L_UINT uFlags

One or more of the following flags:

Value Meaning
OVERLAY_AUTOPAINT [0x00000001] Paint the overlay automatically when the bitmap is painted using the L_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.

L_UINT16 uBitPosition

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.

L_UINT16 uRows

Number of rows in the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard.

L_UINT16 uColumns

Number of columns in the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard.

L_TCHAR szType

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.

L_UINT16 uBitsAllocated

Number of bits allocated in the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard.

L_TCHAR szDescription

NULL terminated string that contains user-defined comments about the overlay. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard.

L_TCHAR szSubtype

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.

L_TCHAR szLabel

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.

L_INT32 nROIArea

Number of pixels in the Region Of Interest area. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard.

L_DOUBLE fROIMean

Average value of the pixels in the Region Of Interest. For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard.

L_DOUBLE fROIStandardDeviation

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.

L_INT32 nNumFramesInOverlay

Number of Frames in the overlay. For more information, refer to "Multi-frame Overlay Module Attributes" in the DICOM standard.

L_UINT16 uImageFrameOrigin

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.

L_TCHAR szActivationLayer

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.

Usage

Help Version 22.0.2023.7.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.