Leadtools.Dicom.Services Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.25
GetImage Method
See Also 
Leadtools.Dicom.Services Namespace > IDICOMObjectRetrieve Interface : GetImage Method



sopInstanceUID
The SOP Instance UID of the DICOM object.
frameNumber
A 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.
imageHeight
The Height, in pixels, of the image. The returned image might have 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 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.
sopInstanceUID
The SOP Instance UID of the DICOM object.
frameNumber
A 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.
imageHeight
The Height, in pixels, of the image. The returned image might have 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 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.
Gets an image from a DICOM object with the preferred compression options.

Syntax

Visual Basic (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()
Visual Basic (Usage)Copy Code
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)
C# 
byte[] GetImage( 
   string sopInstanceUID,
   int frameNumber,
   int imageWidth,
   int imageHeight,
   string mimeType,
   int bitsPerPixel,
   int qualityFactor,
   string extraData
)
C++/CLI 
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
A 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.
imageHeight
The Height, in pixels, of the image. The returned image might have 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 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.

Return Value

A buffer containing the image file (e.g. JPEG and TIFF).

Requirements

Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also