LDicomDS::DeleteOverlay

Summary

Deletes all the elements that describe an overlay.

Syntax

#include "ltdic.h"

L_UINT16 LDicomDS::DeleteOverlay(uOverlayIndex, uFlags)

Parameters

L_UINT uOverlayIndex

The index of the overlay being deleted. This index is zero-based.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Value Meaning
0 The function was successful.
> 0 An error occurred. Refer to Return Codes.

Comments

This function will delete the following elements:

Element Value
"Overlay Rows" (60xx, 0010)
"Overlay Columns" (60xx, 0011)
"Overlay Planes" (60xx, 0012)
"Number of Frames in Overlay" (60xx, 0015)
"Overlay Description" (60xx, 0022)
"Overlay Type" (60xx, 0040)
"Overlay Subtype" (60xx, 0045)
"Overlay Origin" (60xx, 0050)
"Image Frame Origin" (60xx, 0051)
"Overlay Plane Origin" (60xx, 0052)
"Overlay Bits Allocated" (60xx, 0100)
"Overlay Bit Position" (60xx, 0102)
"Overlay Activation Layer" (60xx, 1001)
"ROI Area" (60xx, 1301)
"ROI Mean" (60xx, 1302)
"ROI Standard Deviation" (60xx, 1303)
"Overlay Label" (60xx, 1500)
"Overlay Data" (60xx, 3000)

Required DLLs and Libraries

Platforms

Win32, x64

See Also

Functions

Topics

Example

For an example, refer to LDicomDS::SetOverlayAttributes.

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

LEADTOOLS DICOM C++ Class Library Help

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