GetImageInformation Method

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

public DicomImageInformation GetImageInformation( 
   DicomElement element,
   int index
)

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

'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim index As Integer
Dim value As DicomImageInformation
 
value = instance.GetImageInformation(element, index)

public DicomImageInformation GetImageInformation( 
   DicomElement element,
   int index
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.GetImageInformation( 
   element ,
   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.

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.

For an example, refer to GetImage(DicomElement,Int32,Int32,RasterByteOrder,DicomGetImageFlags).

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
GetImage(DicomElement,Int32,Int32,RasterByteOrder,DicomGetImageFlags) Method
GetImages(DicomElement,Int32,Int32,Int32,RasterByteOrder,DicomGetImageFlags) Method
InsertImage Method
InsertImages Method
SetImage Method
SetImages Method