←Select platform

DoGetSeriesImages Method

Summary

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

Syntax

C++

protected override byte[] DoGetSeriesImages( 
   string[] dicomFiles, 
   string[] sopInstsanceUIDs, 
   int width, 
   int height, 
   string mimeType, 
   int bitsPerPixel, 
   int qualityFactor, 
   string extraData 
)

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

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 UIDs 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 can have a different width (to preserve scale ratio).

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. Valid values range 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 supports multi pages if there is more than 1 DICOM object in the series.

Only the TIFF file format supports multi pages. Specifically, you can use the following formats 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. Wsing the Tag ID 0X9C40 (40000) to retrieve the private Tag from each frame as a 1-based value using ASCII string encoding

Requirements

Target Platforms

Reference

MedicalWebViewerObjectRetrieve Class

MedicalWebViewerObjectRetrieve Members

Help Version 19.0.2017.10.27

Leadtools.MedicalWebViewer.DicomObjectRetrieve Assembly

Introduction

Getting Started

Namespaces

Leadtools.MedicalWebViewer.DicomObjectRetrieve Namespace

Assemblies