#include "Ltdic.h"

L_LTDIC_API L_UINT16 L_DicomGetImage(hDS, pElement, pBitmap, uStructSize, nIndex, nBitsPerPixel, uFlags, pfnCallback, pUserData)


a DICOM handle


pointer to a DICOMELEMENT structure


pointer to the bitmap handle  

L_UINT uStructSize;

size in bytes, of the structure pointed to by pBitmap

L_UINT32 nIndex;

index value

L_INT32 nBitsPerPixel;

resulting bitmap pixel depth

L_UINT uFlags;



optional callback function

L_VOID *pUserData;

pointer to more parameters for the callback

Loads the bitmap of a Pixel Data element into a BITMAPHANDLE.

Parameter Description
hDS A DICOM handle.
pElement Pointer to a DICOMELEMENT structure within the Data Set.
pBitmap Pointer to the bitmap handle that references the loaded bitmap.
uStructSize Size in bytes, of the structure pointed to by pBitmap, for versioning. Use sizeof(BITMAPHANDLE).
nIndex Index value that indicates which frame in a Pixel Data element to get. To get the last image in the Pixel Data element, use ELEMENT_INDEX_MAX
nBitsPerPixel Resulting bitmap pixel depth. Possible values are:
  Value Meaning
  0 Keep the original file's pixel depth (Do not convert).
  1 to 8 The specified bits per pixel in the resultant bitmap
  12 12 bits per pixel in the resultant bitmap.
  16 16 bits per pixel in the resultant bitmap
  24 24 bits per pixel in the resultant bitmap
  32 32 bits per pixel in the resultant bitmap
uFlags Flags which control the behaviour of this function. Possible values are:
  Value Meaning
  DICOM_GETIMAGE_AUTO_LOAD_OVERLAYS [0x0001] If set, the function will automatically extract the overlays included in the dataset and add them to the loaded bitmap.
  DICOM_GETIMAGE_AUTO_APPLY_MODALITY_LUT [0x0002] If set, the function will automatically apply the "Modality LUT" when loading the bitmap.
  DICOM_GETIMAGE_AUTO_APPLY_VOI_LUT [0x0004] If set, the function will automatically apply the "VOI LUT" when loading the bitmap.
  DICOM_GETIMAGE_ALLOW_RANGE_EXPANSION [0x0008] If set, the function will adjust the high bit and/or low bit (if possible) inside the bitmap handle in order to hold the range of pixel values after applying the modality LUT.
  DICOM_GETIMAGE_AUTO_SCALE_MODALITY_LUT [0x0010] If set, the function will scale the resulting pixel data to fit within the range of 0 to 2^BitsPerPixel-1 if any of the values would exceed that range.
  DICOM_GETIMAGE_AUTO_SCALE_VOI_LUT [0x0020] Only used in conjuction with DICOM_GETIMAGE_AUTO_SCALE_MODALITY_LUT. If set, the function will rescale the VOI LUT to match the rescale that was performed by DICOM_GETIMAGE_AUTO_SCALE_MODALITY_LUT.
DICOM_GETIMAGE_AUTODETECT_INVALID_RLE_COMPRESSION [0x0040] For RLE compressed, automatically detects if the MSB and LSB segments are written in the incorrect order.
DICOM_GETIMAGE_LOADCORRUPTED [0x0100] Allow loading of corrupt JPEG.
DICOM_GETIMAGE_FROM_FLTLOAD [0x8000] Internal Use Only.
pfnCallback Optional callback function for additional processing.
  • If you do not provide a callback function, use NULL as the value of this parameter.

  • If you do provide a callback function, use the function pointer as the value of this parameter.

  The callback function must adhere to the function prototype described in FILEREADCALLBACK Function.
pUserData Void pointer that you can use to pass one or more additional parameters that the callback function needs.
  To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID  *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure.
  If the additional parameters are not needed, you can pass NULL in this parameter.



The function was successful.


An error occurred. Refer to Return Codes.


L_DicomGetImage will only update the BITMAPHANDLE structure with data pertaining to the image.  Therefore, some fields, such as XResolution and YResolution, will not be updated or will be updated with default values

If pElement is NULL, this function will load any image within the file, based on the nIndex parameter.

If DICOM_GETIMAGE_ALLOW_RANGE_EXPANSION is set in uFlags, note the following example:

For the following attributes:

Bits allocated


Bits stored


Pixel Range

0 - +4095

Pixel Representation is unsigned (0)


Photometric Interpretation is MONOCHROME2


Rescale Slope


Rescale Intercept


After applying the rescale slope and the intercept:

Output minimum pixel value = (0 * 1 +(-1024)) = -1024

Output maximum pixel value = (4095 * 1 + (-1024)) = 3071

The new pixel value range (1024 to 3071) cannot be represented with the current bits stored (12 bits), which can only represent values in the range (2048 to 2048). In this case the function will change the high bit inside the bitmap handle to be 12 instead of 11 (bits stored becomes 13), which can represent values in the range (8192 to 8191).

L_DicomGetImage will not be able to update the high bit and/or low bit if the number of bits stored was already equal to the number of bits allocated.

If the DICOM dataset has a Multi-frame Functional Groups module, some VOI LUT information will be read from the correspondingFrame VOI LUT Sequence, and some Modality LUT information will be read from the corresponding Pixel Value Transformation Sequence.

The specific elements that are read is shown below:

(0028,9132) Frame VOI LUT Sequence Child Elements




Window Center


Window Width


Window Center & Width Explanation

(0028,9145) Pixel Value Transformation Sequence child elements




Rescale Intercept


Rescale Slope


Rescale Type

For a detailed discussion on Multi-frame Functional Groups and how the DICOM_SET_IMAGE_MFG flags are used, see the topic Multi-frame Functional Groups.

Required DLLs and Libraries


For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application


Win32, x64, Linux.

See Also


L_DicomGetCountImage, L_DicomGetImageList


Working with Data Sets


This example fills a bitmap with an image from the Data Set

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_INT DicomGetImageExample(L_VOID) 
   HDICOMDS      hDS; 
   pDICOMELEMENT pElement; 
   L_UINT16 nRet; 
   hDS = L_DicomCreateDS(NULL); 
   nRet = L_DicomLoadDS(hDS, MAKE_IMAGE_PATH(TEXT("Image1.dcm")), 0); 
   if (nRet != DICOM_SUCCESS) 
      return nRet; 
   pElement = L_DicomFindFirstElement(hDS, NULL, TAG_PIXEL_DATA, FALSE); 
   if (pElement != NULL) 
      nRet = L_DicomGetImage(hDS, 
      if (nRet != DICOM_SUCCESS) 
         return nRet; 
   return DICOM_SUCCESS; 

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.