- 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 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 String representing the file format and compression of the image. Check the 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.
- codec
- An initialized RasterCodecs object to be used for loading the pre-compressed image or retrieving its information.
Visual Basic (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 RasterCodecs _ ) As Byte() |
Visual Basic (Usage) | Copy Code |
---|---|
|
C# | |
---|---|
protected virtual byte[] GetPreCompressedImage( string dicomFileName, string sopInstanceUID, int frameNumber, int imageWidth, int imageHeight, string mimeType, int bitsPerPixel, int qualityFactor, RasterCodecs codec ) |
C++/CLI | |
---|---|
protected: virtual array<byte>^ GetPreCompressedImage( String^ dicomFileName, String^ sopInstanceUID, int frameNumber, int imageWidth, int imageHeight, String^ mimeType, int bitsPerPixel, int qualityFactor, 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 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 String representing the file format and compression of the image. Check the 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.
- codec
- An initialized RasterCodecs object to be used for loading the pre-compressed image or retrieving its information.
Return Value
A buffer containing the pre-compressed RasterImage. If no pre-compressed image is available null value will be returned.
Note to developers: override this method to provide your own method of retrieving the pre-compressed images.
Also this method will be called before loading any image from the DoGetSeriesImages and DoGetImage methods to check if there exists a pre-compressed image.
Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family