←Select platform

GetSeriesImages Method

Summary

Retrieves all the DICOM images in a series with the preferred compression options.

Syntax

C++

public byte[] GetSeriesImages( 
   string studyInstanceUID, 
   string seriesInstanceUID, 
   int width, 
   int height, 
   string mimeType, 
   int bitsPerPixel, 
   int qualityFactor, 
   string extraData 
)

  
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()

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 can have a different width(to preserve scale ratio). Pass 0 to keep the original width.

height
The height, in pixels, of the image. The returned image can have a 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 closest 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

Reference

DICOMService Class

DICOMService Members

Help Version 19.0.2017.10.27