GetModalityLutAttributes(Int32) Method

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public DicomModalityLutAttributes GetModalityLutAttributes( 
   int frameIndex
)

'Declaration
 
Public Overloads Function GetModalityLutAttributes( _
   ByVal frameIndex As Integer _
) As DicomModalityLutAttributes

'Usage
 
Dim instance As DicomDataSet
Dim frameIndex As Integer
Dim value As DicomModalityLutAttributes
 
value = instance.GetModalityLutAttributes(frameIndex)

public DicomModalityLutAttributes GetModalityLutAttributes( 
   int frameIndex
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.GetModalityLutAttributes(Int32)( 
   frameIndex 
)

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.

If the method does not find any of the attributes of the "Modality LUT Module" it will set both IsModalityLutSequence and 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 IsRescaleSlopeIntercept to true and populate RescaleIntercept, DicomModalityLutAttributes.RescaleSlope, and RescaleType with the values retrieved from the DICOM Data Set.

If the method finds "Modality LUT Sequence" (0028,3000), it will set IsModalityLutSequence to true and populate FirstStoredPixelValueMapped, NumberOfEntries, EntryBits, LutExplanation, and 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

Tag	Name
(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.

For an example, refer to SetModalityLut(DicomModalityLutAttributes,Int32[]).

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomDataSet Class
DicomDataSet Members
Overload List
GetModalityLutData Method
SetModalityLut(DicomModalityLutAttributes,Int32[]) Method
DeleteModalityLut Method