L_DicomGetImageList

#include "Ltdic.h"

L_LTDIC_API L_UINT16 L_DicomGetImageList(hDS, pElement, hList, nIndex, nCount, nBitsPerPixel, uFlags)

Loads the image list with frames from a Pixel Data element.

Parameters

HDICOMDS hDS

A DICOM handle.

pDICOMELEMENT pElement

Pointer to a DICOMELEMENT structure within the Data Set.

HBITMAPLIST hList

Handle to the list of images.

L_UINT32 nIndex

Position of the first frame to get. Use zero-based indexing. For example, if there are 10 images in a list, the index of the last one is 9. To get the last image in the Pixel Data element, use ELEMENT_INDEX_MAX.

L_UINT32 nCount

Number of frames to load into the image list.

L_INT32 nBitsPerPixel

Resulting image pixel depth. Possible values are:

L_UINT uFlags

Flags which control the behavior of this function. Possible values are:

Returns

Comments

If you need to use a callback function, use the L_DicomGetImageListEx function.

As an example, if you wish to load 50 images starting with the 50th frame in the Pixel Data, call this function with nIndex set to 49 (the 50th frame in a zero-based index) and nCount set to 50.

If pElement is NULL, you can retrieve a image list of all images within the Data Set. To do this you must call L_DicomGetCountImage with pElement set to NULL to determine the number of images in the Data Set and set the nCount parameter in L_DicomGetImageList to this value.

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

If the dataset has the following attributes:

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) cant be represented with the current bits stored (12 bits), which can represent values in the range (2048 to 2048). In this case the function will change the high bit inside the image handle to be 12 instead of 11 (bits stored becomes 13), which can represent values in the range (8192 to 8191).

Please note that the function wont 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:

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

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

Platforms

Win32, x64, Linux.

L_INT DicomGetImageListExample(L_VOID) 
{ 
   HDICOMDS    hDS; 
   HBITMAPLIST hList; 
   L_UINT16 nRet; 
 
   hDS = L_DicomCreateDS(NULL); 
 
   nRet = L_DicomLoadDS(hDS, MAKE_IMAGE_PATH(TEXT("Image1.dcm")), 0); 
   if (nRet != DICOM_SUCCESS) 
   { 
      L_DicomFreeDS(hDS); 
      return nRet; 
   } 
 
   nRet = (L_UINT16) L_CreateBitmapList(&hList); 
   if (nRet != SUCCESS) 
   { 
      L_DicomFreeDS(hDS); 
      return nRet; 
   } 
 
   nRet = L_DicomGetImageList(hDS, NULL, hList, 0, ELEMENT_INDEX_MAX, 0, 0); 
   if (nRet != DICOM_SUCCESS) 
   { 
      L_DicomFreeDS(hDS); 
      return nRet; 
   } 
 
   nRet = (L_UINT16) L_DestroyBitmapList(hList); 
   if (nRet != SUCCESS) 
   { 
      L_DicomFreeDS(hDS); 
      return nRet; 
   } 
 
   L_DicomFreeDS(hDS); 
   return DICOM_SUCCESS; 
}