GetImages(DicomElement,Int32,Int32,Int32,DicomGetImageFlags) Method

public RasterImage GetImages( 
   DicomElement element,
   int index,
   int count,
   int bitsPerPixel,
   DicomGetImageFlags flags
)

'Declaration
 
Public Overloads Function GetImages( _
   ByVal element As DicomElement, _
   ByVal index As Integer, _
   ByVal count As Integer, _
   ByVal bitsPerPixel As Integer, _
   ByVal flags As DicomGetImageFlags _
) As RasterImage

'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim index As Integer
Dim count As Integer
Dim bitsPerPixel As Integer
Dim flags As DicomGetImageFlags
Dim value As RasterImage
 
value = instance.GetImages(element, index, count, bitsPerPixel, flags)

public RasterImage GetImages( 
   DicomElement element,
   int index,
   int count,
   int bitsPerPixel,
   DicomGetImageFlags flags
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.GetImages(DicomElement,Int32,Int32,Int32,DicomGetImageFlags)( 
   element ,
   index ,
   count ,
   bitsPerPixel ,
   flags 
)

public:
RasterImage^ GetImages( 
   DicomElement^ element,
   int index,
   int count,
   int bitsPerPixel,
   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:

Value	Meaning
0	Keep the original file's pixel depth (do not convert).
1 to 8	Use the specified bits per pixel in the resulting image.
12	Use 12 bits per pixel in the resulting image.
16	Use 16 bits per pixel in the resulting image.
24	Use 24 bits per pixel in the resulting image.
32	Use 32 bits per pixel in the resulting image.

flags

Flags that control the behavior of this method.

Return Value

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 then set the count parameter in GetImages(DicomElement,Int32,Int32,Int32,RasterByteOrder,DicomGetImageFlags) to this value.

If DicomGetImageFlags.AllowRangeExpansion is set in flags, 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) cannot 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.

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
GetImageCount Method
GetImage(DicomElement,Int32,Int32,RasterByteOrder,DicomGetImageFlags) Method