GetImageInformation Method

Summary

Retrieves information about the specified image.

Syntax

C++

Java

public DicomImageInformation GetImageInformation( 
   DicomElement element, 
   int index 
)

Public Function GetImageInformation( _ 
   ByVal element As DicomElement, _ 
   ByVal index As Integer _ 
) As DicomImageInformation

public DicomImageInformation getImageInformation(DicomElement element, int index)

public: 
DicomImageInformation^ GetImageInformation(  
   DicomElement^ element, 
   int index 
)

Parameters

element
An item in the Data Set.

index
The zero-based index of the frame whose information is required.

Return Value

The information about the specified image.

Remarks

Most DICOM files will only have one Data Element of type DicomTag.PixelData. Therefore, in most instances you can set the element to null, since the method will automatically retrieve information about the image at the specified index within the only Pixel Data Element in the file. If the element is not null, it must point to the Pixel Data Element itself. If the DICOM file is DicomClassType.BasicDirectory , the file may contain more than one Pixel Data Element. In this case you must specify in the element parameter the Pixel Data Element from which to get the image information.

Example

For an example, refer to GetImage.

Requirements

Target Platforms