Collapse All Expand All

L_DicomGetVOILUT

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomGetVOILUT(hDS, uVOILUTIndex, pVOILUTAttributes, uStructSize, uFlags)

HDICOMDS hDS;	/* a DICOM handle */
L_UINT uVOILUTIndex;	/* the VOI LUT index*/
pDICOMVOILUTATTRIBS pVOILUTAttributes;	/* pointer to a VOI LUT attributes structure */
L_UINTuStructSize;	/* the size of the DICOMVOILUTATTRIBS structure */
L_UINT uFlags;	/* reserved for future use */

Retrieves the attributes that describe the VOI LUT.

Parameter	Description
hDS	A DICOM handle.
uVOILUTIndex	Index to the VOI LUT to be retrieved. According to the DICOM standard one or more items could exist under one VOI LUT Sequence (0028,3010), use this index to specify which item to use in order to populate the pVOILUTAttributes structure. This index is zero-based.
pVOILUTAttributes	Pointer to a structure to be updated with the VOI LUT attributes.
uStructSize	Size of the DICOMVOILUTATTRIBS structure. Pass sizeof(DICOMVOILUTATTRIBS).
uFlags	Reserved for future use. Pass 0.

Returns

DICOM_SUCCESS	The function was successful.
>0	An error occurred. Refer to Return Codes.

Comments

This function will retrieve the attributes that describe a VOI LUT and store their values in the structure pointed to by pVOILUTAttributes.

pVOILUTAttributes->uStructSize will be set to the value of the parameter uStructSize.

Before calling this function call L_DicomGetVOILUTCount to see if a VOI LUT Sequence (0028,3010) exists in the DICOM dataset and to retrieve the number of items under that sequence.

uVOILUTIndex is zero-based. If you pass 0, this function will populate pVOILUTAttributes->LUTDescriptor with the values of the "LUT Descriptor"(0028,3002) under the first item in the "VOI LUT Sequence" and pVOILUTAttributes->pszLUTExplanation with the value of "LUT Explanation" (0028,3003) element, if it exists.

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.

See Also

Functions:	L_DicomGetWindowCount, L_DicomGetVOILUTCount, L_DicomGetWindow, L_DicomSetWindow, L_DicomDeleteWindow, L_DicomSetVOILUT, L_DicomGetVOILUTData, L_DicomDeleteVOILUT, L_ApplyVOILUT
Topics:	LUT Encoding Overview
	LUT Encoding: VOI LUT

Example

For an example, refer to L_DicomSetVOILUT.