The DoGetImage Method is available as an add-on to the LEADTOOLS Medical Imaging toolkits.
- dicomFileName
- The physical path of the DICOM file to extract the image from.
- 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. 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 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.
Visual Basic (Declaration) | |
---|---|
Overrides Protected Function DoGetImage( _ 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 extraData As String _ ) As Byte() |
Visual Basic (Usage) | Copy Code |
---|---|
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 extraData As String Dim value() As Byte value = instance.DoGetImage(dicomFileName, sopInstanceUID, frameNumber, imageWidth, imageHeight, mimeType, bitsPerPixel, qualityFactor, extraData) |
C# | |
---|---|
protected override byte[] DoGetImage( string dicomFileName, string sopInstanceUID, int frameNumber, int imageWidth, int imageHeight, string mimeType, int bitsPerPixel, int qualityFactor, string extraData ) |
C++/CLI | |
---|---|
protected: array<byte>^ DoGetImage( String^ dicomFileName, String^ sopInstanceUID, int frameNumber, int imageWidth, int imageHeight, String^ mimeType, int bitsPerPixel, int qualityFactor, String^ extraData ) override |
Parameters
- dicomFileName
- The physical path of the DICOM file to extract the image from.
- 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. 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 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, TIFF).You should use a file format which support multi pages if you set the frameNumber value to -1.
Only the TIFF file format support multi pages so you can use SupportedImageFormat.Tiff, SupportedImageFormat.TiffJ2k or SupportedImageFormat.TiffJpeg in the mimeType.
The SOP Instance UID value of the retrieved DICOM object will be stored as a private Tag in the first image frame when using any of the TIFF file formats. You can retrieve the private Tag from the first frame as ASCII string using the Tag ID 0X9C40 (40000)
Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family