ImageGear for C and C++ on Windows v19.0
MED_overlay_extract
| API Reference Guide > MD Component API Reference > MD Component Functions Reference > Overlay Functions > MED_overlay_extract |
Saves ART marks into DICOM dataset as overlay planes.
|
Copy Code
|
|
|---|---|
AT_ERRCOUNT ACCUAPI MED_overlay_extract(HIGEAR hIGear); |
|
| Name | Type | Description |
|---|---|---|
| hIGear | HIGEAR | Page for which to save annotations into DataSet as overlay planes. |
Returns the number of ImageGear errors that occurred during the function call.
This function does not process image pixels.
 |
The image must have a DICOM DataSet attached to it. Use MED_DCM_DS_exists to check whether the image contains a DataSet. |
Each ART group is saved into a separate overlay plane.
Since overlay planes do not support any types of graphic objects other than bi-tonal bitmaps, all ART marks from a group are converted into a bitmap before saving into an overlay.
Overlay planes do not support specifying the colors (even black or white). An overlay pixel can only be visible or invisible. All visible overlay pixels are displayed with the same color, which is specified by the application and not stored in the DICOM DataSet.
This function requires the ImageGear ART Component to be attached to ImageGear. See Attaching Components.
ART Component API Function Reference