GetVoiLut Method

Summary

Retrieves the attributes that describe the VOI LUT.

Syntax

Java

C++

public DicomVoiLutAttributes GetVoiLut( 
   int index 
)

Public Function GetVoiLut( _ 
   ByVal index As Integer _ 
) As DicomVoiLutAttributes

public DicomVoiLutAttributes getVoiLut(int index)

public: 
DicomVoiLutAttributes^ GetVoiLut(  
   int index 
)

Parameters

index
The zero-based index of the VOI LUT to retrieve. According to the DICOM standard, one or more items could exist under one VOI LUT Sequence (0028,3010); use this index to specify the item from which to retrieve the attributes.

Return Value

The VOI LUT attributes.

Remarks

Before calling this method, access VoiLutCount to see if a VOI LUT Sequence (0028,3010) exists in the DICOM Data Set and to obtain the number of items under that sequence. index is zero-based. If you pass 0, this method will populate DicomVoiLutAttributes with the values of the "LUT Descriptor"(0028,3002) under the first item in the "VOI LUT Sequence" and LutExplanation with the value of the "LUT Explanation" (0028,3003) element, if it exists.

Example

For an example, refer to VoiLutCount.

Requirements

Target Platforms