Leadtools.Dicom.Services Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.25
GetSeriesImages Method
See Also 
Leadtools.Dicom.Services Namespace > DICOMObjectRetrieve Class : GetSeriesImages Method



studyInstanceUID
A System.String representing the Study Instance UID to match the DICOM object.
seriesInstanceUID
A System.String representing the Series Instance UID to match the DICOM object.
width
The width, in pixels, of the image. The returned image might have different width to preserve scale ratio. Pass 0 to keep the original width.
height
The Height, in pixels, of the image. The returned image might have different height to preserve scale ratio. Pass 0 to keep the original height.
mimeType
A System.String representing the file format and compression of the image.
bitsPerPixel
Resulting image's pixel depth. Note that not all bits per pixel are available to all image formats. If bitsPerPixel is 0, the image will be stored using the original or closet bits/pixel value supported by that format.
qualityFactor
The quality factor (Q factor) is a number that determines the degree of loss in the compression process. Use 0 for Lossless compression or you can set a value from 2 to 255, where 2 is the highest quality and 255 is the most compression.
extraData
User custom data.
studyInstanceUID
A System.String representing the Study Instance UID to match the DICOM object.
seriesInstanceUID
A System.String representing the Series Instance UID to match the DICOM object.
width
The width, in pixels, of the image. The returned image might have different width to preserve scale ratio. Pass 0 to keep the original width.
height
The Height, in pixels, of the image. The returned image might have different height to preserve scale ratio. Pass 0 to keep the original height.
mimeType
A System.String representing the file format and compression of the image.
bitsPerPixel
Resulting image's pixel depth. Note that not all bits per pixel are available to all image formats. If bitsPerPixel is 0, the image will be stored using the original or closet bits/pixel value supported by that format.
qualityFactor
The quality factor (Q factor) is a number that determines the degree of loss in the compression process. Use 0 for Lossless compression or you can set a value from 2 to 255, where 2 is the highest quality and 255 is the most compression.
extraData
User custom data.
Retrieves all the DICOM images in a series with the preferred compression options.

Syntax

Visual Basic (Declaration) 
Public Function GetSeriesImages( _
   ByVal studyInstanceUID As String, _
   ByVal seriesInstanceUID As String, _
   ByVal width As Integer, _
   ByVal height As Integer, _
   ByVal mimeType As String, _
   ByVal bitsPerPixel As Integer, _
   ByVal qualityFactor As Integer, _
   ByVal extraData As String _
) As Byte()
Visual Basic (Usage)Copy Code
Dim instance As DICOMObjectRetrieve
Dim studyInstanceUID As String
Dim seriesInstanceUID As String
Dim width As Integer
Dim height As Integer
Dim mimeType As String
Dim bitsPerPixel As Integer
Dim qualityFactor As Integer
Dim extraData As String
Dim value() As Byte
 
value = instance.GetSeriesImages(studyInstanceUID, seriesInstanceUID, width, height, mimeType, bitsPerPixel, qualityFactor, extraData)
C# 
public byte[] GetSeriesImages( 
   string studyInstanceUID,
   string seriesInstanceUID,
   int width,
   int height,
   string mimeType,
   int bitsPerPixel,
   int qualityFactor,
   string extraData
)
C++/CLI 
public:
array<byte>^ GetSeriesImages( 
   String^ studyInstanceUID,
   String^ seriesInstanceUID,
   int width,
   int height,
   String^ mimeType,
   int bitsPerPixel,
   int qualityFactor,
   String^ extraData
) 

Parameters

studyInstanceUID
A System.String representing the Study Instance UID to match the DICOM object.
seriesInstanceUID
A System.String representing the Series Instance UID to match the DICOM object.
width
The width, in pixels, of the image. The returned image might have different width to preserve scale ratio. Pass 0 to keep the original width.
height
The Height, in pixels, of the image. The returned image might have different height to preserve scale ratio. Pass 0 to keep the original height.
mimeType
A System.String representing the file format and compression of the image.
bitsPerPixel
Resulting image's pixel depth. Note that not all bits per pixel are available to all image formats. If bitsPerPixel is 0, the image will be stored using the original or closet bits/pixel value supported by that format.
qualityFactor
The quality factor (Q factor) is a number that determines the degree of loss in the compression process. Use 0 for Lossless compression or you can set a value from 2 to 255, where 2 is the highest quality and 255 is the most compression.
extraData
User custom data.

Return Value

A buffer containing a multi page RasterImage where each page is an image in the series.

Requirements

Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also