LDicomDS::GetInfoImage

#include "Ltdic.h"

L_UINT16 LDicomDS::GetInfoImage(pElement, pInfo, nIndex)

pDICOMELEMENT pElement;	/* pointer to a DICOMELEMENT structure */
pDICOMIMAGE pInfo;	/* pointer to a DICOMIMAGE structure */
L_UINT32 nIndex;	/* index value */

Retrieves information about the specified image.

Parameter	Description
pElement	Pointer to a DICOMELEMENT structure within the Data Set.
pInfo	Pointer to a DICOMIMAGE structure that contains the information about the specified image.
nIndex	Index value that indicates the position of the image. This is a zero-based index. For example, if nIndex is 0, information about the first image in the Pixel Data Element will be retrieved.

Returns

0	SUCCESS
>0	An error occurred. Refer to Return Codes.

Comments

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 retrieve information about the image at the specified index within 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 from which to get the image information.

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

See Also

Functions:	LDicomDS::GetImage, LDicomDS::GetImageList, LDicomDS::InsertImageList, LDicomDS::SetImage, LDicomDS::SetImageList
Topics:	Working with Data Sets
	How to Disable the Automatic Loading of the default DICOM IOD Table

Example

This example returns the information about an image.

L_INT LDicomDS_GetInfoImageExample()
{
   L_INT          nRet;
   LDicomDS      *pDS;
   pDICOMELEMENT  pElement;
   DICOMIMAGE     Info;
   pDS = new LDicomDS(NULL);
   nRet = pDS->LoadDS(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\image1.dic"), 0);
   if(nRet != DICOM_SUCCESS)
      return nRet;
   pElement = pDS->FindFirstElement(NULL, TAG_PIXEL_DATA, FALSE);
   if (pElement != NULL)
   {
      nRet = pDS->GetInfoImage(pElement, &Info, 0);
      if(nRet != DICOM_SUCCESS)
         return nRet;
   }
   delete pDS;
   return DICOM_SUCCESS;
}