Load(Stream,LeadRect) Method

Summary

Loads the specified rectangle from the specified image stream using default options.

Syntax

C++

Java

public RasterImage Load( 
   Stream stream, 
   LeadRect tile 
)

Public Overloads Function Load( _ 
   ByVal stream As Stream, _ 
   ByVal tile As LeadRect _ 
) As RasterImage

public RasterImage load(ILeadStream stream, LeadRect tile)

public: 
RasterImage^ Load(  
   Stream^ stream, 
   LeadRect tile 
)

Parameters

stream
A Stream containing the image data to load.

tile
A LeadRect describing the tile/area of the image to load.

Return Value

The RasterImage object that this method loads.

Remarks

This method loads a section of an image stream (any format). The section begins is defined by tile rectangle.

LEADTOOLS will attempt to load corrupted files so you can see at least a portion of the image. For these images, the load methods succeed, but LoadStatus will return an error code.

Use the CodecsLoadOptions class to set up other load option parameters before calling this method.

Support for 12 and 16-bit grayscale, and 48 and 64-bit color images is only available in the Document/Medical Imaging editions.

For supported formats, refer to Summary of All Supported File Formats.

LEADTOOLS loads all PDF files as Raster PDF uncompressed RasterImageFormat.RasPdf, regardless of the compression and color space used when saving the file.

The CodecsLoadOptions.AllPages property controls whether RasterCodecs will try to load all pages or just the first page if the image data contains multiple pages.

Example

This example will create a rectangle area from a stream containing image data.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public void LoadTileStream1Example() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_LoadTileStream1.bmp"); 
 
   FileStream fs = File.OpenRead(srcFileName); 
 
   // Get the image dimension 
   CodecsImageInfo info = codecs.GetInformation(fs, false); 
 
   // Load the lower right corner of the image 
   LeadRect rc = new LeadRect( 
      info.Width / 2, 
      info.Height / 2, 
      info.Width / 2, 
      info.Height / 2); 
 
   RasterImage image = codecs.Load(fs, rc); 
   fs.Close(); 
 
   Debug.Assert(image.Width == (info.Width / 2)); 
   Debug.Assert(image.Height == (info.Height / 2)); 
 
   // Save this image back to disk 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24); 
   image.Dispose(); 
 
   // Clean up 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub LoadTileStream1Example() 
   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_LoadTileStream1.bmp") 
 
   Dim fs As FileStream = File.OpenRead(srcFileName) 
 
   ' Get the image dimension 
   Dim info As CodecsImageInfo = codecs.GetInformation(fs, False) 
 
   ' Load the lower right corner of the image 
   Dim rc As LeadRect = New LeadRect(info.Width \ 2, info.Height \ 2, info.Width \ 2, info.Height \ 2) 
 
   Dim image As RasterImage = codecs.Load(fs, rc) 
   fs.Close() 
 
   Debug.Assert(image.Width = (info.Width \ 2)) 
   Debug.Assert(image.Height = (info.Height \ 2)) 
 
   ' Save this image back to disk 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24) 
   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

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Examples; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Windows.Media; 
 
public void LoadTileStream1Example(Stream inStreamCmp, Stream outStreamBmp) 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Get the image dimension 
   CodecsImageInfo info = codecs.GetInformation(inStreamCmp, false); 
 
   // Load the lower right corner of the image 
   LeadRect rc = new LeadRect(info.Width / 2, info.Height / 2, info.Width / 2, info.Height / 2); 
 
   RasterImage image = codecs.Load(inStreamCmp, rc); 
   Debug.Assert(image.Width == (info.Width / 2)); 
   Debug.Assert(image.Height == (info.Height / 2)); 
 
   // Save this image back to disk 
   codecs.Save(image, outStreamBmp, RasterImageFormat.Bmp, 24); 
   image.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Windows.Media 
 
Public Sub LoadTileStream1Example(ByVal inStreamCmp As Stream, ByVal outStreamBmp As Stream) 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   ' Get the image dimension 
   Dim info As CodecsImageInfo = codecs.GetInformation(inStreamCmp, False) 
 
   ' Load the lower right corner of the image 
   Dim rc As LeadRect = New LeadRect(info.Width / 2, info.Height / 2, info.Width / 2, info.Height / 2) 
 
   Dim image As RasterImage = codecs.Load(inStreamCmp, rc) 
   Debug.Assert(image.Width = (info.Width / 2)) 
   Debug.Assert(image.Height = (info.Height / 2)) 
 
   ' Save this image back to disk 
   codecs.Save(image, outStreamBmp, RasterImageFormat.Bmp, 24) 
   image.Dispose() 
End Sub

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Overload List

Loading and Saving Images

Loading and Saving Large TIFF / BigTIFF Files

Speeding Up 1-Bit Documents

Fast File Info

Download our FREE evaluation

Help Version 20.0.2020.4.3