GetImage Method (IDICOMObjectRetrieve)

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

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

'Usage
 
Dim instance As IDICOMObjectRetrieve
Dim sopInstanceUID As String
Dim frameNumber As Integer
Dim imageWidth As Integer
Dim imageHeight As Integer
Dim mimeType As String
Dim bitsPerPixel As Integer
Dim qualityFactor As Integer
Dim extraData As String
Dim value() As Byte
 
value = instance.GetImage(sopInstanceUID, frameNumber, imageWidth, imageHeight, mimeType, bitsPerPixel, qualityFactor, extraData)

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 to be retrieved. Pass 0 to get a representative frame and -1 to get the entire image with all frames.

imageWidth

The width, in pixels, of the image. The returned image may have a different width to preserve scale ratio.

imageHeight

The Height, in pixels, of the image. The returned image may have a different height to preserve scale ratio.

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

Target Platforms

Reference

IDICOMObjectRetrieve Interface
IDICOMObjectRetrieve Members