Save(RasterImage,Stream,Int64,RasterImageFormat,Int32) Method

Saves the specified image to a stream using an offset within to begin saving.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public long Save( 
   RasterImage image,
   Stream stream,
   long offset,
   RasterImageFormat format,
   int bitsPerPixel
)

'Declaration
 
Public Overloads Function Save( _
   ByVal image As RasterImage, _
   ByVal stream As Stream, _
   ByVal offset As Long, _
   ByVal format As RasterImageFormat, _
   ByVal bitsPerPixel As Integer _
) As Long

'Usage
 
Dim instance As RasterCodecs
Dim image As RasterImage
Dim stream As Stream
Dim offset As Long
Dim format As RasterImageFormat
Dim bitsPerPixel As Integer
Dim value As Long
 
value = instance.Save(image, stream, offset, format, bitsPerPixel)

public long Save( 
   RasterImage image,
   Stream stream,
   long offset,
   RasterImageFormat format,
   int bitsPerPixel
)

 function Leadtools.Codecs.RasterCodecs.Save(RasterImage,Stream,Int64,RasterImageFormat,Int32)( 
   image ,
   stream ,
   offset ,
   format ,
   bitsPerPixel 
)

public:
int64 Save( 
   RasterImage^ image,
   Stream^ stream,
   int64 offset,
   RasterImageFormat format,
   int bitsPerPixel
)

Parameters

image: The Leadtools.RasterImage object that holds the image data.
stream: A System.IO.Stream where the image data will be saved.
offset: The offset within the specified stream to embed the saved image file. For example, if you specify 5, then 5 bytes of other data will precede the embedded file.
format: The output file format. For valid values, Summary of All Supported Image File Formats.
bitsPerPixel: Resulting file's pixel depth. Note that not all bits per pixel are available to all file formats. For valid values, refer to Summary of All Supported Image File Formats. If bitsPerPixel is 0, the image will be stored using the closet bits/pixel value supported by that format. For example, if a file format supports 1, 4, and 24 bits/pixel, and RasterImage.BitsPerPixel is 5, the file will be stored as 24 bit. Likewise, if RasterImage.BitsPerPixel is 2, the file will be stored as 4 bit.

Return Value

The size of the embedded image file in bytes.

Remarks

You can use this method to embed an image file in another file.

If the output file format supports multipage and then all the pages in image will be saved to the file.

If the image is 8 bits per pixel or greater, use the LEAD CMP format or one of the JPEG (JTIF or JFIF) formats to save disk space.

If the image is 1-bit per pixel, use the LEAD 1-bit format or a CCITT Group 3 or 4 format to save disk space.

If the image has a region, the region stored in the image will be saved, if the image is saved as one of the TIFF file formats. Note, however, that the ability to save a region inside a TIFF file must be unlocked. This requires a Document Imaging or Medical Imaging toolkit. For more information, refer to Saving A Region.

Only TIFF and DICOM file formats are capable of saving images that have been window-leveled. Images can be window-leveled by calling RasterImage.WindowLevel and specifying RasterWindowLevelMode.PaintAndProcessing, by using the Leadtools.ImageProcessing.Core.WindowLevelCommand or by loading an image from a file format that supports Window Leveling. If a window-leveled image is saved as any other file format, the image data will be converted before being saved. For more information, refer to Saving Window-Leveled Images.

Use the CodecsSaveOptions class to set up other save options parameters before calling this method.

Use to the SaveImage event to provide progress feedback or to set or modify the saved image data.

This method supports signed data images, but only DICOM and TIFF formats support signed data. This method will throw an exception if you attempt to save a signed image to a format other than DICOM or TIFF.

In LEADTOOLS version 17 and up, when saving a colored image (such as a 24-bits per pixel image) to bitonal (1-bit per pixel), the RasterCodecs object will not use any dithering when converting the image data. This is done because dithering is not the recommended when converting colored images containing text for document processing such as OCR and Barcode. The resulting text will be fuzzy and hard for a recognition engine to process. To save a colored image as bitonal with Floyd-Stein dithering (the behavior of LEADTOOLS 16.5 and earlier) use CodecsSaveOptions.UseImageDitheringMethod along with RasterImage.DitheringMethod as illustrated below:

            // 'codecs' is the RasterCodecs to use when saving
            // 'image' is a colored RasterImage object
            // Setup FloydStein dithering:
            codecs.Options.Save.UseImageDitheringMethod = true;
            image.DitheringMethod = RasterDitheringMethod.FloydStein;
            // Save the image as 1-bpp with auto-dithering:
            codecs.Save(image, fileName, RasterImageFormat.Tif, 1);

For information about quality factors, refer to Compression Quality Factors.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub SaveStream3Example()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_SaveStream3.bin")

      ' Load the source image
      Dim image As RasterImage = codecs.Load(srcFileName)

      ' Create a memory stream
      Dim ms As MemoryStream = New MemoryStream()

      ' Save this image to the stream after the header
      Console.WriteLine("Saving the image")
      Dim position As Long = codecs.Save(image, ms, 0, RasterImageFormat.Cmp, 24)
      image.Dispose()

      Console.WriteLine("{0} bytes saved to the stream")

      ' Save the stream to a file
      Using fs As FileStream = File.Create(destFileName)
         ms.WriteTo(fs)
      End Using

      ms.Close()

      ' Make sure the saved file works

      ' Save the image into disk
      Console.WriteLine("Loading the file back")
      image = codecs.Load(destFileName)
      image.Dispose()

      ' Clean up
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void SaveStream3Example()
     {
         RasterCodecs codecs = new RasterCodecs();

         string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
         string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_SaveStream3.bin");

         // Load the source image
         RasterImage image = codecs.Load(srcFileName);

         // Create a memory stream
         MemoryStream ms = new MemoryStream();

         // Save this image to the stream after the header
         Console.WriteLine("Saving the image");
         long position = codecs.Save(image, ms, 0, RasterImageFormat.Cmp, 24);
         image.Dispose();

         Console.WriteLine("{0} bytes saved to the stream");

         // Save the stream to a file
         using (FileStream fs = File.Create(destFileName))
             ms.WriteTo(fs);

         ms.Close();

         // Make sure the saved file works

         // Save the image into disk
         Console.WriteLine("Loading the file back");
         image = codecs.Load(destFileName);
         image.Dispose();

         // Clean up
         codecs.Dispose();
     }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

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

Reference

RasterCodecs Class
RasterCodecs Members
Overload List
Loading and Saving Images
Loading and Saving Large Tiff Files
Speeding Up 1-Bit Documents
Working with Markers
Fast File Info