←Select platform

GetImage Method

Summary

Gets an image from a DICOM object with the preferred compression options.

Syntax

C++

public virtual byte[] GetImage( 
   string sopInstanceUID, 
   int frameNumber, 
   int imageWidth, 
   int imageHeight, 
   string mimeType, 
   int bitsPerPixel, 
   int qualityFactor, 
   string extraData 
)

  
Public Overridable Function GetImage( _ 
   ByVal sopInstanceUID As String, _ 
   ByVal frameNumber As Integer, _ 
   ByVal imageWidth As Integer, _ 
   ByVal imageHeight As Integer, _ 
   ByVal mimeType As String, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal qualityFactor As Integer, _ 
   ByVal extraData As String _ 
) As Byte()

public: 
virtual array<byte>^ GetImage(  
   String^ sopInstanceUID, 
   int frameNumber, 
   int imageWidth, 
   int imageHeight, 
   String^ mimeType, 
   int bitsPerPixel, 
   int qualityFactor, 
   String^ extraData 
)

Parameters

sopInstanceUID
The SOP Instance UID of the DICOM object.

frameNumber
The 1-based number of the frame you want to retrieve from the image. Pass 0 to get a representative frame and -1 to get the full image with all frames.

imageWidth
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.

imageHeight
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. Check the Leadtools.Dicom.Services.DataTypes.SupportedImageFormat class for supported file formats and compression.

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 the image file (e.g. JPEG and TIFF).

Requirements

Target Platforms

Reference

DICOMObjectRetrieve Class

DICOMObjectRetrieve Members

Help Version 19.0.2017.10.27

Leadtools.Dicom.Services Assembly

Introduction

Getting Started

Namespaces

Leadtools.Dicom.Services Namespace

Leadtools.Dicom.Services.DataTypes Namespace

Assemblies