LEADTOOLS Medical (Leadtools.MedicalWebViewer.DICOMObjectRetrieve assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.25
DoGetSeriesImages Method
See Also 
Leadtools.Dicom.Services.MedicalWebViewer Namespace > MedicalWebViewerObjectRetrieve Class : DoGetSeriesImages Method



dicomFiles
An array of the physical DICOM files paths to be retrieved.
sopInstsanceUIDs
An array of SOP Instance UID for each DICOM object. The array length should be equal to the number of DICOM files specified by dicomFiles
width
The width, in pixels, of the image. The returned image might have different width to preserve scale ratio.
height
The Height, in pixels, of the image. The returned image might have different height to preserve scale ratio.
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.

The DoGetSeriesImages Method is available as an add-on to the LEADTOOLS Medical Imaging toolkits.

dicomFiles
An array of the physical DICOM files paths to be retrieved.
sopInstsanceUIDs
An array of SOP Instance UID for each DICOM object. The array length should be equal to the number of DICOM files specified by dicomFiles
width
The width, in pixels, of the image. The returned image might have different width to preserve scale ratio.
height
The Height, in pixels, of the image. The returned image might have different height to preserve scale ratio.
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) 
Overrides Protected Function DoGetSeriesImages( _
   ByVal dicomFiles() As String, _
   ByVal sopInstsanceUIDs() 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 MedicalWebViewerObjectRetrieve
Dim dicomFiles() As String
Dim sopInstsanceUIDs() 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.DoGetSeriesImages(dicomFiles, sopInstsanceUIDs, width, height, mimeType, bitsPerPixel, qualityFactor, extraData)
C# 
protected override byte[] DoGetSeriesImages( 
   string[] dicomFiles,
   string[] sopInstsanceUIDs,
   int width,
   int height,
   string mimeType,
   int bitsPerPixel,
   int qualityFactor,
   string extraData
)
C++/CLI 
protected:
array<byte>^ DoGetSeriesImages( 
   array<String^>^ dicomFiles,
   array<String^>^ sopInstsanceUIDs,
   int width,
   int height,
   String^ mimeType,
   int bitsPerPixel,
   int qualityFactor,
   String^ extraData
) override 

Parameters

dicomFiles
An array of the physical DICOM files paths to be retrieved.
sopInstsanceUIDs
An array of SOP Instance UID for each DICOM object. The array length should be equal to the number of DICOM files specified by dicomFiles
width
The width, in pixels, of the image. The returned image might have different width to preserve scale ratio.
height
The Height, in pixels, of the image. The returned image might have different height to preserve scale ratio.
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 Leadtools.RasterImage where each page is an image in the series.

Remarks

You should use a file format which support multi pages if you there are more than 1 DICOM object in the series.

Only the TIFF file format support multi pages so you can use SupportedImageFormat.Tiff, SupportedImageFormat.TiffJ2k or SupportedImageFormat.TiffJpeg in the mimeType.

The SOP Instance UID value of the retrieved DICOM object(s) will be stored as a private Tag in each image frame when using any of the TIFF file formats. You can retrieve the private Tag from each frame as a 1 based value and ASCII string encoding using the Tag ID 0X9C40 (40000)

Requirements

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

See Also