Load(Stream) Method

Summary

Loads the specified image stream using default options.

Syntax

Objective-C

C++/CLI

Java

Python

public RasterImage Load( 
   Stream stream 
)

- (nullable LTRasterImage *)loadStream:(LTLeadStream *)stream  
                                 error:(NSError **)error;

public RasterImage load(ILeadStream stream)

public: 
RasterImage^ Load(  
   Stream^ stream 
)

def Load(self,stream):

Parameters

stream
A Stream containing the image data to load.

Return Value

The RasterImage object that this method loads.

Remarks

The stream can point to any supported image file format and bits per pixel, whether compressed or uncompressed.

This method can load all the pages in a multipage file. For more information, refer to the last remark. The resulting image will have the same bits/pixel and color order value of the image as it was stored in the stream.

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. To load a single page from a stream, use Load(Stream stream, int pageNumber).

Example

This example will load all the pages from a stream that contains a single multipage file

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
 
public void LoadStream1Example() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Options.Load.AllPages = true; 
   string singlePageFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   string multiPageFileName = Path.Combine(LEAD_VARS.ImagesDir, "Eye.gif"); 
 
   // Load the file into a stream 
   FileStream fs = File.OpenRead(singlePageFileName); 
 
   // Get the file information (we are interested in the number of pages) 
   CodecsImageInfo info = codecs.GetInformation(fs, true); 
   Debug.WriteLine("Number of pages according to info: {0}", info.TotalPages); 
 
   // Load the image and verify that we loaded all the pages 
   RasterImage image = codecs.Load(fs); 
   Debug.WriteLine("Number of pages loaded: {0}", image.PageCount); 
   Debug.Assert(image.PageCount == info.TotalPages); 
 
   image.Dispose(); 
   fs.Close(); 
 
   // Repeat for a multipage file 
 
   fs = File.OpenRead(multiPageFileName); 
 
   info = codecs.GetInformation(fs, true); 
   Debug.WriteLine("Number of pages according to info: {0}", info.TotalPages); 
 
   image = codecs.Load(fs); 
   Debug.WriteLine("Number of pages loaded: {0}", image.PageCount); 
   Debug.Assert(image.PageCount == info.TotalPages); 
 
   image.Dispose(); 
   fs.Close(); 
 
   // Clean up 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.*; 
import java.net.*; 
import java.nio.file.Paths; 
import java.util.*; 
import java.time.Instant; 
import java.time.Duration; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.codecs.RasterCodecs.FeedCallbackThunk; 
import leadtools.drawing.internal.*; 
import leadtools.imageprocessing.*; 
import leadtools.imageprocessing.color.ChangeIntensityCommand; 
import leadtools.svg.*; 
 
 
public void LoadStream1Example() throws IOException { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
 
   codecs.getOptions().getLoad().setAllPages(true); 
   String singlePageFileName = combine(LEAD_VARS_IMAGES_DIR, "Image1.cmp"); 
   String multiPageFileName = combine(LEAD_VARS_IMAGES_DIR, "Eye.gif"); 
 
   // Load the file into a stream 
   ILeadStream ls = LeadStreamFactory.create(singlePageFileName); 
 
   // Get the file information (we are interested in the number of pages) 
   CodecsImageInfo info = codecs.getInformation(ls, true); 
   System.out.println("Number of pages according to info: " + info.getTotalPages()); 
 
   // Load the image and verify that we loaded all the pages 
   RasterImage image = codecs.load(ls); 
   System.out.println("Number of pages loaded: " + image.getPageCount()); 
   assertTrue(image.getPageCount() == info.getTotalPages()); 
 
   image.dispose(); 
   ls.close(); 
 
   // Repeat for a multipage file 
   ls = LeadStreamFactory.create(multiPageFileName); 
 
   info = codecs.getInformation(ls, true); 
   System.out.println("Number of pages according to info: " + info.getTotalPages()); 
 
   image = codecs.load(ls); 
   System.out.println("Number of pages loaded: " + image.getPageCount()); 
   assertTrue(image.getPageCount() == info.getTotalPages()); 
 
   image.dispose(); 
   ls.close(); 
 
   // Clean up 
   codecs.dispose(); 
}

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 23.0.2024.2.29