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




element
An item in the Data Set.
index
The zero-based index of the first frame to load.
count
Value that represents the number of frames to load.
bitsPerPixel
Value that represents the resulting image pixel depth. Possible values are:
ValueMeaning
0Keep the original file's pixel depth (do not convert).
1 to 8The specified bits per pixel in the resultant image.
1212 bits per pixel in the resultant image.
1616 bits per pixel in the resultant image.
2424 bits per pixel in the resultant image.
3232 bits per pixel in the resultant image.
order
The desired color order.
flags
Flags that control the behaviour of this method.
Gets the images of a Pixel Data element.

Syntax

Visual Basic (Declaration) 
Public Function GetImages( _
   ByVal element As DicomElement, _
   ByVal index As Integer, _
   ByVal count As Integer, _
   ByVal bitsPerPixel As Integer, _
   ByVal order As RasterByteOrder, _
   ByVal flags As DicomGetImageFlags _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim element As DicomElement
Dim index As Integer
Dim count As Integer
Dim bitsPerPixel As Integer
Dim order As RasterByteOrder
Dim flags As DicomGetImageFlags
Dim value As RasterImage
 
value = instance.GetImages(element, index, count, bitsPerPixel, order, flags)
C# 
public RasterImage GetImages( 
   DicomElement element,
   int index,
   int count,
   int bitsPerPixel,
   RasterByteOrder order,
   DicomGetImageFlags flags
)
Managed Extensions for C++ 
public: RasterImage GetImages( 
   DicomElement* element,
   int index,
   int count,
   int bitsPerPixel,
   RasterByteOrder order,
   DicomGetImageFlags flags
) 
C++/CLI 
public:
RasterImage GetImages( 
   DicomElement^ element,
   int index,
   int count,
   int bitsPerPixel,
   RasterByteOrder order,
   DicomGetImageFlags flags
) 

Parameters

element
An item in the Data Set.
index
The zero-based index of the first frame to load.
count
Value that represents the number of frames to load.
bitsPerPixel
Value that represents the resulting image pixel depth. Possible values are:
ValueMeaning
0Keep the original file's pixel depth (do not convert).
1 to 8The specified bits per pixel in the resultant image.
1212 bits per pixel in the resultant image.
1616 bits per pixel in the resultant image.
2424 bits per pixel in the resultant image.
3232 bits per pixel in the resultant image.
order
The desired color order.
flags
Flags that control the behaviour of this method.

Return Value

The images of a Pixel Data element.

Example

For an example, refer to GetImage.

Remarks

As an example, if you wish to load 50 images starting with the 50th frame in the Pixel Data, call this method with index set to 49 (the 50th frame in a zero-based index) and count set to 50.

If element is null, you can retrieve all images within the Data Set. To do this you must call GetImageCount with the element parameter set to null to determine the number of images in the Data Set and set the count parameter in GetImages to this value.

If DicomGetImageFlags.AllowRangeExpansion is set in flag, consider the following example:

If the Data Set has the following attributes:

Bits allocated 16

Bits stored 12

Pixel Range 0 - +4095

Pixel Representation is unsigned (0)

Photometric Interpretation is MONOCHROME2

Rescale Slope 1

Rescale Intercept -1024

After applying the rescale slope and the intercept:

Output minimum pixel value = (0 * 1 +(-1024)) = -1024

Output maximum pixel value = (4095 * 1 + (-1024)) = 3071

The new pixel value range (–1024 to 3071) can not be represented with the current bits stored (12 bits), which can represent values in the range (–2048 to 2048). In this case the method will change the high bit inside the image object to be 12 instead of 11 (bits stored becomes 13), which can represent values in the range (–8192 to 8191).

Please note that the method will not be able to update the high bit and/or low bit if the number of bits stored was already equal to the number of bits allocated.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

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