DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomImage Class / Export Method / Export(Stream,String,Object) Method

The stream into which the image is written

The file format you would like to export image to

The quality factor to be used. This is a generic compression quality depending on the Transfer Syntax used. This can be an integer that specifies the value stored in the System.Drawing.Imaging.EncoderParameter object for Bitmap export. 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(Stream,String,Object) Method
    In This Topic
    Export DicomImage to supported Image Format
    Syntax
    'Declaration
     
    
    Public Overloads Sub Export( _
       ByVal Stream As System.IO.Stream, _
       ByVal Format As System.String, _
       ByVal Quality As System.Object _
    ) 
    'Usage
     
    
    Dim instance As DicomImage
    Dim Stream As System.IO.Stream
    Dim Format As System.String
    Dim Quality As System.Object
     
    instance.Export(Stream, Format, Quality)
    public void Export( 
       System.IO.Stream Stream,
       System.string Format,
       System.object Quality
    )
    public procedure Export( 
        Stream: System.IO.Stream;
        Format: System.String;
        Quality: System.TObject
    ); 
    public function Export( 
       Stream : System.IO.Stream,
       Format : System.String,
       Quality : System.Object
    );
    public: void Export( 
       System.IO.Stream* Stream,
       System.string* Format,
       System.Object* Quality
    ) 
    public:
    void Export( 
       System.IO.Stream^ Stream,
       System.String^ Format,
       System.Object^ Quality
    ) 

    Parameters

    Stream

    The stream into which the image is written

    Format

    The file format you would like to export image to

    Quality

    The quality factor to be used. This is a generic compression quality depending on the Transfer Syntax used. This can be an integer that specifies the value stored in the System.Drawing.Imaging.EncoderParameter object for Bitmap export. 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
    This method uses the internal DicomObjects export methods, including the ability to export multi-frame GIF etc.
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also