L_DicomSetImage

#include "Ltdic.h"

L_LTDIC_API L_UINT16 L_DicomSetImage(hDS, pElement, pBitmap, nCompression, nPhotometric, nBitsPerPixel, nQFactor, uFlags, pfnCallback, pUserData)

Replaces the image(s) in a Pixel Data element.

Returns

Comments

This function replaces all the images in the Pixel Data Element with the image referenced by pBitmap.

Most DICOM files will only have one Data Element of type TAG_PIXEL_DATA. Therefore, in most instances you can set pElement to NULL, since the function will automatically replace the images of the only Pixel Data Element in the file. If pElement is not NULL, it must point to the Pixel Data Element itself.

If the DICOM file is CLASS_BASIC_DIRECTORY, the file may contain more than one Pixel Data Element. In this case you must specify in pElement the Pixel Data Element in which the images will be replaced.

If you wish to replace only one image within the Pixel Data Element, you must use L_DicomDeleteImage and L_DicomInsertImage.

For a table of possible Compression, Photometric, BitsPerPixel, and Quality Factor combinations, refer to Compression Table.

For more options when using the JPEG 2000 compression, refer to L_DicomSetJ2KOptions.

This function will either insert, delete or update one or more of the following elements:

If the Shared Functional Groups Sequence element or the Per-frame Functional Groups Sequence element is added, an item child element may be added that contains either the (0028,9132) Frame VOI LUT Sequence element or the (0028,9145) Pixel Value Transformation Sequence element.

(0028,9132) Frame VOI LUT Sequence Child Elements

(0028,9145) Pixel Value Transformation Sequence child elements

This function is indifferent to the pixel data restrictions imposed by the various DICOM IOD classes, for example this function will allow the user to insert a colored image into a "Digital X-Ray Image Storage" dataset.

This function will always insert a "Number of Frames" (0028, 0008) element and set its value.

The Multi-frame Functional Groups module may have a Shared Functional Groups Sequence item, and/or a Per-frame Functional Groups Sequence item. Either of these items may have a Pixel Value Transformation Sequence (0028,9145) item, or a Frame VOI LUT Sequence (0028,9132) item.

When calling the methods L_DicomSetImage or L_DicomSetImageList, the five DICOM_SETIMAGE_MFG replace existing information in the Pixel Value Transformation Sequence or the Frame VOI LUT Sequence.

and  any existing Shared Functional Groups Sequence items, and Per-frame Functional Groups Sequence items will be removed.

• DICOM_SETIMAGE_MFG_VOI_LUT_PER_FRAME

• DICOM_SETIMAGE_MFG_VOI_LUT_SHARED

• DICOM_SETIMAGE_MFG_MODALITY_LUT_PER_FRAME

• DICOM_SETIMAGE_MFG_MODALITY_LUT_SHARED

• DICOM_SETIMAGE_MFG_VOI_LUT_PER_FRAME

• DICOM_SETIMAGE_MFG_VOI_LUT_SHARED

• DICOM_SETIMAGE_MFG_MODALITY_LUT_PER_FRAME

• DICOM_SETIMAGE_MFG_MODALITY_LUT_SHARED

Any new sequences are placed in the sequence indicated by the flag (Per-frame Functional Groups Sequence or Shared Functional Groups Sequence).

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.

Note:

DICOM_SETIMAGE_MFG_VOI_LUT_PER_FRAME cannot be combined with DICOM_SETIMAGE_MFG_VOI_LUT_SHARED.

DICOM_SETIMAGE_MFG_MODALITY_LUT_PER_FRAME cannot be combined with DICOM_SETIMAGE_MFG_MODALITY_LUT_SHARED.

Note that the only valid values are for nPhotometric are:

• IMAGE_PHOTOMETRIC_MONOCHROME2 (gray)

• IMAGE_PHOTOMETRIC_PALETTE_COLOR (palletized)

• IMAGE_PHOTOMETRIC_RGB (Color)

All other values are ignored.

The nPhotometric  parameter is used as an indicator as how the data image data will be saved: gray, color, or palletized. The nPhotometric parameter is NOT necessarily going to be the final value of the Photometric Interpretation that is stored in the resulting DICOM dataset.  The resulting Photometric Interpretation in the DICOM dataset is set automatically, based on the compression type, flags, and QFactor.  The table below gives examples of the resulting DICOM dataset Photometric Interpretation, based on various input parameters:

Note: There is no high level function to embed MPEG2 into a DICOM dataset. The Multimedia toolkit (DICOM writer) can create DICOM files with MPEG2 compression.

Note: This function cannot be used to encode DICOM transfer syntaxes (e.g. video compression support) that are not part of the main medical SDK and it is supported only via the LEADTOOLS Medical Multimedia Module.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_INT DicomSetImageExample(pBITMAPHANDLE pBitmap) 
{ 
   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) 
   { 
      L_DicomFreeDS(hDS); 
      return nRet; 
   } 
   pElement = L_DicomFindFirstElement(hDS, NULL, TAG_PIXEL_DATA, FALSE); 
   if (pElement != NULL) 
   { 
      nRet = L_DicomSetImage(hDS, pElement, pBitmap, IMAGE_COMPRESSION_NONE, 
      IMAGE_PHOTOMETRIC_MONOCHROME1, 0, 0, DICOM_SETIMAGE_AUTO_SET_VOI_LUT, NULL, NULL); 
      if (nRet != DICOM_SUCCESS) 
      { 
         L_DicomFreeDS(hDS); 
         return nRet; 
      } 
   } 
   L_DicomFreeDS(hDS); 
   return DICOM_SUCCESS; 
}