Leadtools.Dicom.Web Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetImage Method
See Also 
Leadtools.Dicom.Web Namespace > DicomWCFStreamer Class : GetImage Method



sopInstanceUID
The SOP Instance UID for the DICOM object requested.
frameNumber
A 1 based number which specify the frame requested from the DICOM image.
imageSize
The Size of the image. Pass 0 for the width or height to keep their original values.
mimeType
A String representing the file format and compression of the image. Check the SupportedImageFormat class for supported file formats and compression.
bitsPerPixel
Requested 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.
imageData
A user buffer which receives the requested image as an array of Bytes.
Retrieve a DICOM image with the user specified compression options.

Syntax

Visual Basic (Declaration) 
Public Function GetImage( _
   ByVal sopInstanceUID As String, _
   ByVal frameNumber As Integer, _
   ByVal imageSize As Size, _
   ByVal mimeType As String, _
   ByVal bitsPerPixel As Integer, _
   ByVal qualityFactor As Integer, _
   ByVal extraData As String, _
   ByRef imageData As Byte _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As DicomWCFStreamer
Dim sopInstanceUID As String
Dim frameNumber As Integer
Dim imageSize As Size
Dim mimeType As String
Dim bitsPerPixel As Integer
Dim qualityFactor As Integer
Dim extraData As String
Dim imageData As Byte
Dim value As RasterImage
 
value = instance.GetImage(sopInstanceUID, frameNumber, imageSize, mimeType, bitsPerPixel, qualityFactor, extraData, imageData)
C# 
public RasterImage GetImage( 
   string sopInstanceUID,
   int frameNumber,
   Size imageSize,
   string mimeType,
   int bitsPerPixel,
   int qualityFactor,
   string extraData,
   out byte imageData
)
C++/CLI 
public:
RasterImage GetImage( 
   String^ sopInstanceUID,
   int frameNumber,
   Size imageSize,
   String^ mimeType,
   int bitsPerPixel,
   int qualityFactor,
   String^ extraData,
   [Out] byte imageData
) 

Parameters

sopInstanceUID
The SOP Instance UID for the DICOM object requested.
frameNumber
A 1 based number which specify the frame requested from the DICOM image.
imageSize
The Size of the image. Pass 0 for the width or height to keep their original values.
mimeType
A String representing the file format and compression of the image. Check the SupportedImageFormat class for supported file formats and compression.
bitsPerPixel
Requested 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.
imageData
A user buffer which receives the requested image as an array of Bytes.

Return Value

The requested image as a RasterImage.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

GetImage requires a Web Viewer Framework Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features