GetPreCompressedImage Method

'Declaration
 
Protected Overridable Function GetPreCompressedImage( _
   ByVal dicomFileName As String, _
   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 codec As Leadtools.Codecs.RasterCodecs _
) As Byte()

'Usage
 
Dim instance As MedicalWebViewerObjectRetrieve
Dim dicomFileName As String
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 codec As Leadtools.Codecs.RasterCodecs
Dim value() As Byte
 
value = instance.GetPreCompressedImage(dicomFileName, sopInstanceUID, frameNumber, imageWidth, imageHeight, mimeType, bitsPerPixel, qualityFactor, codec)

protected virtual byte[] GetPreCompressedImage( 
   string dicomFileName,
   string sopInstanceUID,
   int frameNumber,
   int imageWidth,
   int imageHeight,
   string mimeType,
   int bitsPerPixel,
   int qualityFactor,
   Leadtools.Codecs.RasterCodecs codec
)

protected:
virtual array<byte>^ GetPreCompressedImage( 
   String^ dicomFileName,
   String^ sopInstanceUID,
   int frameNumber,
   int imageWidth,
   int imageHeight,
   String^ mimeType,
   int bitsPerPixel,
   int qualityFactor,
   Leadtools.Codecs.RasterCodecs^ codec
) 

Parameters

dicomFileName

The physical path of the DICOM file containing the image.

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 complete image with all frames.

imageWidth

The width, in pixels, of the image. The returned image can have a different width (to preserve scale ratio). Pass 0 to keep the original width.

imageHeight

The height, in pixels, of the image. The returned image can have a 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 in 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.

codec

An initialized Leadtools.Codecs.RasterCodecs object to be used for loading the pre-compressed image or retrieving its information.

Return Value

Target Platforms

Reference

MedicalWebViewerObjectRetrieve Class
MedicalWebViewerObjectRetrieve Members