DicomObjects.NET8 Documentation
DicomObjects Namespace / DicomImage Class / Export Method / Export(String,String,Object) Method

The name of the file to export

The type of export operation to perform

The quality factor to be used. This is a generic compression quality depending on the Transfer Syntax used. This value for JPEG Baseline and JPEG Extended compression represents an integer between 0 – 100. This tells DicomObjects to set up the compressor to try to achieve the quality in percentage (higher quality value towards 100 means better quality and lower compression ratio). And for JPEG-LS Lossy and JPEG2000 Lossy compression this value is actually the desired compression ratio, i.e. if you set the quality value to 10, it tells DicomObjects to try to achieve compression ratio of 10. The actual compression ratio achieved will not be exactly the same as specified by quality value but close enough. The actual compression ratio is calculated based on the original data size and the compressed data size before it is added to “Lossy Image Compression Ratio” tag of the image. For Video compression, this value directly corresponds to the BitsPerSecond of the compressed video.




In This Topic
    Export(String,String,Object) Method
    In This Topic
    Export DicomImage to supported Format
    Syntax
    'Declaration
     
    
    Public Overloads Sub Export( _
       ByVal fileName As String, _
       Optional ByVal format As String, _
       Optional ByVal quality As Object _
    ) 
    'Usage
     
    
    Dim instance As DicomImage
    Dim fileName As String
    Dim format As String
    Dim quality As Object
     
    instance.Export(fileName, format, quality)
    public void Export( 
       string fileName,
       string format,
       object quality
    )
    public:
    void Export( 
       String^ fileName,
       String^ format,
       Object^ quality
    ) 

    Parameters

    fileName

    The name of the file to export

    format

    The type of export operation to perform

    quality

    The quality factor to be used. This is a generic compression quality depending on the Transfer Syntax used. This value for JPEG Baseline and JPEG Extended compression represents an integer between 0 – 100. This tells DicomObjects to set up the compressor to try to achieve the quality in percentage (higher quality value towards 100 means better quality and lower compression ratio). And for JPEG-LS Lossy and JPEG2000 Lossy compression this value is actually the desired compression ratio, i.e. if you set the quality value to 10, it tells DicomObjects to try to achieve compression ratio of 10. The actual compression ratio achieved will not be exactly the same as specified by quality value but close enough. The actual compression ratio is calculated based on the original data size and the compressed data size before it is added to “Lossy Image Compression Ratio” tag of the image. For Video compression, this value directly corresponds to the BitsPerSecond of the compressed video.

    Remarks

    Any of the formats supported via SkiaSharp.SKEncodedImageFormat or via internal codecs are supported

    See for details of how to write and configure your own codecs.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also