Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetModalityLutAttributes(Int32) Method
See Also 
Leadtools.Dicom Namespace > DicomDataSet Class > GetModalityLutAttributes Method : GetModalityLutAttributes(Int32) Method



frameIndex
A zero-based index that identifies the frame number in the dataset. If the dataset does not support Multi-frames, this parameter is ignored.
frameIndex
A zero-based index that identifies the frame number in the dataset. If the dataset does not support Multi-frames, this parameter is ignored.
Retrieves the attributes that describe the Modality LUT.

Syntax

Visual Basic (Declaration) 
Overloads Public Function GetModalityLutAttributes( _
   ByVal frameIndex As Integer _
) As DicomModalityLutAttributes
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim frameIndex As Integer
Dim value As DicomModalityLutAttributes
 
value = instance.GetModalityLutAttributes(frameIndex)
C# 
public DicomModalityLutAttributes GetModalityLutAttributes( 
   int frameIndex
)
C++/CLI 
public:
DicomModalityLutAttributes^ GetModalityLutAttributes( 
   int frameIndex
) 

Parameters

frameIndex
A zero-based index that identifies the frame number in the dataset. If the dataset does not support Multi-frames, this parameter is ignored.

Return Value

Modality LUT attributes.

Example

Remarks

If the method does not find any of the attributes of the "Modality LUT Module" it will set both DicomModalityLutAttributes.IsModalityLutSequence and DicomModalityLutAttributes.IsRescaleSlopeIntercept to false. In this case, the rest of the members of the DicomModalityLutAttributes class are undefined.

If the method finds the "Rescale Intercept" (0028,1052) and "Rescale Slope" (0028,1053) elements, it will set DicomModalityLutAttributes.IsRescaleSlopeIntercept to true and populate DicomModalityLutAttributes.RescaleIntercept, DicomModalityLutAttributes.RescaleSlope, and DicomModalityLutAttributes.RescaleType with the values retrieved from the DICOM Data Set.

If the method finds "Modality LUT Sequence" (0028,3000), it will set DicomModalityLutAttributes.IsModalityLutSequence to true and populate DicomModalityLutAttributes.FirstStoredPixelValueMapped, DicomModalityLutAttributes.NumberOfEntries, DicomModalityLutAttributes.EntryBits, DicomModalityLutAttributes.LutExplanation, and DicomModalityLutAttributes.LutType with the values retrieved from the DICOM Data Set.

It is prohibited by the DICOM standard for both "Rescale Intercept" and "Modality LUT Sequence" to exist in the same DICOM Data Set. However, if this method encounters such a Data Set, it will ignore "Modality LUT Sequence" and assume that only "Rescale Intercept" exists.


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. If the following elements are not found at the top level in the dataset, this method looks in the Shared Functional Groups Sequence item and the Per-frame Functional Groups Sequence

TagName
(0028,1052)Rescale Intercept
(0028,1053)Rescale Slope
(0028,1054)Rescale Type


For a detailed discussion on Multi-frame Functional Groups see the topic Multi-frame Functional Groups.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features