In This Topic ▼

L_DicomGetVOILUT

Summary

Retrieves the attributes that describe the VOI LUT.

Syntax

#include "ltdic.h"

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

Parameters

HDICOMDS hDS

A DICOM handle.

L_UINT 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.

pDICOMVOILUTATTRIBS pVOILUTAttributes

Pointer to a structure to be updated with the VOI LUT attributes.

L_UINT uStructSize

Size of the DICOMVOILUTATTRIBS structure. Pass sizeof(DICOMVOILUTATTRIBS).

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Value	Meaning
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.