References ▼
#include "ltdic.h"
L_UINT16 LDicomDS::GetOverlayBitmap(uOverlayIndex,pBitmap,uStructSize,uFlags)
Retrieves the "Overlay Data" (60xx,3000) for the specified overlay index.
The index of the overlay for which to get the bitmap. This index is zero-based.
Pointer to a bitmap handle which will be filled with the overlay data. Cannot be NULL.
Size of the BITMAPHANDLE structure. Pass sizeof(BITMAPHANDLE).
Reserved for future use. Pass 0.
| Value | Meaning |
|---|---|
| 0 | The function was successful. |
| > 0 | An error occurred. Refer to Return Codes. |
This function will extract the "Overlay Data" (60xx,3000) for an overlay, initialize and allocate pBitmap based on the "Overlay Columns" (60xx,0011) and "Overlay Rows"(60xx,0010), and then fill pBitmap with the stream of bytes under the "Overlay Data" (60xx,3000) element.
NOTE: pBitmap is assumed to be unallocated and uninitiated. It will be filled without freeing the existing data.
If the function does not find the "Overlay Data" element inside the dataset it will return DICOM_ERROR_OVERLAY_DATA_MISSING.
Before calling this function you must call LDicomDS::GetOverlayAttributes to determine if the overlay pixel data is embedded in the "Image Pixel Data" (7FE0,0010) element or is under "Overlay Data" (60xx,3000) element. If the overlay data is embedded in the "Image Pixel Data", the flag OVERLAY_USEBITPLANE will be set inside pOverlayAttributes->uFlags (pOverlayAttributes is the OVERLAYATTRIBUTES structure returned by the LDicomDS::GetOverlayAttributes function).
If the overlay pixel data is embedded in the "Image Pixel Data" (7FE0, 0010), follow these steps to get the overlay data as a bitmap handle:
pOverlayAttributes.Now we need to add our overlay as one of the overlays associated with pMainBitmap. To do that we need to call:
LBitmap::SetOverlayAttributes(pMainBitmap,0,pOverlayAttributes, OVERLAYATTRIBUTES_FLAGS | OVERLAYATTRIBUTES_BITINDEX |OVERLAYATTRIBUTES_ORIGIN |OVERLAYATTRIBUTES_DICOM | OVERLAYATTRIBUTES_COLOR); Now we need to extract the overlay data from the main image data:
LBitmap::UpdateOverlayBits(pMainBitmap,0, SETOVERLAYBITS_FROMBITMAP); Now call LBitmap::GetOverlay to get the overlay data itself as a bitmap handle.
Required DLLs and Libraries
Win32, x64
This example will extract the overlays from a
DICOM dataset and associate them with a bitmap,
the bitmap is assumed to be extracted from the
same DICOM dataset.
L_INT LDicomDS_GetOverlayBitmapExample(LDicomDS &InDS ,// Input datasetpBITMAPHANDLE pBitmap // Bitmap which will be associated with// the overlays, note this should be a// valid bitmap loaded from the same DICOM// dataset where the overlays exist.){L_INT nRet;L_UINT uOverlayCount;L_UINT uOverlayIndex;OVERLAYATTRIBUTES OverlayAttributes = {0};L_INT GroupNumber=0;L_BOOL IsOverlayInDataset = FALSE;L_INT nLEADRet;L_UINT uLEADOverlayIndex;BITMAPHANDLE OverlayBitmap = {0};//(1)Sanity Check !if(NULL == pBitmap){return DICOM_ERROR_NULL_PTR;}uOverlayCount =0;//(2)Do we have any overlays at allnRet = InDS.GetOverlayCount (&uOverlayCount);if( (DICOM_SUCCESS != nRet) || (0 == uOverlayCount) ){return DICOM_SUCCESS;}//(3)Go through the overlays one by oneuOverlayIndex = 0;uLEADOverlayIndex = 0;while(uOverlayIndex < uOverlayCount){// Reset the overlay attributes structurememset(&OverlayAttributes,0,sizeof(OverlayAttributes));GroupNumber = 0;IsOverlayInDataset = FALSE;// Reset the overlay bitmapL_InitBitmap( &OverlayBitmap,sizeof(OverlayBitmap),1,1,1);// Get the attributes of this overlaynRet = InDS.GetOverlayAttributes ( uOverlayIndex,&OverlayAttributes,sizeof(OverlayAttributes),&GroupNumber,&IsOverlayInDataset,0);if(DICOM_SUCCESS != nRet){return nRet;}if(!IsOverlayInDataset){uOverlayIndex++;continue;}// Auto paint and process overlaysOverlayAttributes.uFlags |= OVERLAY_AUTOPAINT |OVERLAY_AUTOPROCESS ;OverlayAttributes.crColor = RGB(0xFF,0xFF,0xFF);// Is the overlay embedded inside the image data ?if(OverlayAttributes.uFlags & OVERLAY_USEBITPLANE){// Add this overlay to the list of overlays// in the bitmap handlenLEADRet = L_SetOverlayAttributes( pBitmap,uLEADOverlayIndex,&OverlayAttributes,OVERLAYATTRIBUTES_FLAGS |OVERLAYATTRIBUTES_BITINDEX |OVERLAYATTRIBUTES_ORIGIN |OVERLAYATTRIBUTES_DICOM |OVERLAYATTRIBUTES_COLOR);if(SUCCESS != nLEADRet){return DICOM_ERROR_MEMORY;}// Make sure to extract the overlay data from the image datanLEADRet = L_UpdateBitmapOverlayBits( pBitmap,uLEADOverlayIndex,SETOVERLAYBITS_FROMBITMAP);if(SUCCESS != nLEADRet){return DICOM_ERROR_MEMORY;}}// The overlay is inside overlay dataelse{// Add this overlay to the list of overlays// in the bitmap handlenLEADRet = L_SetOverlayAttributes( pBitmap,uLEADOverlayIndex,&OverlayAttributes,OVERLAYATTRIBUTES_FLAGS |OVERLAYATTRIBUTES_ORIGIN |OVERLAYATTRIBUTES_DICOM |OVERLAYATTRIBUTES_COLOR);if(SUCCESS != nLEADRet){return DICOM_ERROR_MEMORY;}// Get the overlay bitmap from the overlay datanRet = InDS.GetOverlayBitmap (uOverlayIndex,&OverlayBitmap,sizeof(OverlayBitmap),0);if(DICOM_SUCCESS != nRet){return nRet;}// Set the bitmap for this overlay inside the// list of overlays we have in the bitmap handlenLEADRet = L_SetOverlayBitmap(pBitmap,uLEADOverlayIndex,&OverlayBitmap,OVERLAY_MOVE);if(SUCCESS != nLEADRet){if(OverlayBitmap.Flags.Allocated){L_FreeBitmap(&OverlayBitmap);memset(&OverlayBitmap,0,sizeof(OverlayBitmap));}return DICOM_ERROR_MEMORY;}memset(&OverlayBitmap,0,sizeof(OverlayBitmap));}uOverlayIndex++;uLEADOverlayIndex++;}return DICOM_SUCCESS;}