GetWindow(int) Method

Summary

Retrieves the attributes that describe the "Window Center" and "Window Width".

Syntax

C++

Java

public DicomWindowAttributes GetWindow( 
   int index 
)

Public Overloads Function GetWindow( _ 
   ByVal index As Integer _ 
) As DicomWindowAttributes

public DicomWindowAttributes getWindow(int index)

public: 
DicomWindowAttributes^ GetWindow(  
   int index 
)

Parameters

index
The zero-based index of the window center, window width value, to retrieve. According to the DICOM standard, if multiple values are present for the window center and window width, both attributes shall have the same number of values and shall be considered as pairs.

Return Value

The window-related attributes.

Remarks

This method will retrieve the attributes that describe window center and window width. Window Center" (0028,1050) and "Window Width" (0028,1051) specify a linear conversion from stored pixel values (after any modality LUT or rescale slope and intercept specified in the IOD have been applied) to values to be displayed. Please see "VOI LUT Module Attributes" in the DICOM standard for more details.

This method will fail and throw a DicomExceptionCode.Parameter exception if the window count (number of values under the window center element) equals 0 or if index is greater or equal to the window count.

index is zero-based; if you pass 0 for example, this method will populate WindowCenter with the first value under the "Window Center" (0028,1050) element, WindowWidth with the first value under the "Window Width" (0028,1051) element, and Explanation with "Window Center and Width Explanation" (0028,1055) element if it exists.

Example

For an example, refer to GetWindowCount.

Requirements

Target Platforms