Load(string,int,CodecsLoadByteOrder,int,int) Method

Summary

Loads the specified image file using specific options.

Syntax

Objective-C

C++

public RasterImage Load( 
   string fileName, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order, 
   int firstPage, 
   int lastPage 
)

Public Overloads Function Load( _ 
   ByVal fileName As String, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal order As CodecsLoadByteOrder, _ 
   ByVal firstPage As Integer, _ 
   ByVal lastPage As Integer _ 
) As RasterImage

- (nullable LTRasterImage *)loadFile:(NSString *)file  
                        bitsPerPixel:(NSInteger)bitsPerPixel  
                               order:(LTCodecsLoadByteOrder)order  
                           firstPage:(NSInteger)firstPage  
                            lastPage:(NSInteger)lastPage  
                               error:(NSError **)error

public: 
RasterImage^ Load(  
   String^ fileName, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order, 
   int firstPage, 
   int lastPage 
)

Parameters

fileName
A String containing the name of the image file to load.

bitsPerPixel
Resulting image pixel depth. Valid values are:

Value	Meaning
0	Keep the original file's pixel depth (Do not convert).
1 to 8	The specified bits per pixel in the resulting image.
12	12 bits per pixel in the resulting image.
16	16 bits per pixel in the resulting image.
24	24 bits per pixel in the resulting image.
32	32 bits per pixel in the resulting image.
48	48 bits per pixel in the resulting image.
64	64 bits per pixel in the resulting image.

order
Color order for 16-bit, 24-bit, 32-bit, 48-bit, and 64-bit images. If the resulting image is less than 16 bits per pixel, this will have no effect since palletized images have no order. The following are valid values.

Value	Meaning
CodecsLoadByteOrder.Rgb	Red, green, and blue color order in memory
CodecsLoadByteOrder.Bgr	Blue, green, and red color order in memory
CodecsLoadByteOrder.Gray	12 or 16-bit grayscale image. 12 and 16-bit grayscale images are only supported in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGray	Load the image as red, green, blue OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions
CodecsLoadByteOrder.BgrOrGray	Load the image as blue, green, red OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions
CodecsLoadByteOrder.Romm	ROMM order. ROMM only supports 24 and 48-bit images
CodecsLoadByteOrder.BgrOrGrayOrRomm	Load the image as red, green, blue OR as a 12 or 16-bit grayscale image OR as ROMM. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions only. ROMM only supports 24 and 48-bit color images.

firstPage
1-based index of the first page to load.

lastPage
The 1-based index of the last page to load. Must be greater than or equal to firstPage. You can pass -1 to load from firstPage to the last page in the file.

Return Value

The RasterImage object that this method loads.

Remarks

The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.

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.

Example

This example will show how to load an image using different bits/pixel and color order than saved on disk. Also, it will show how to load a single page or a group of pages from a multipage file

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public void LoadFile2Example() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // First, test loading as different color byte order and bits per pixel 
   string singlePageFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
 
   // Get the file information 
   CodecsImageInfo info = codecs.GetInformation(singlePageFileName, true); 
   Console.WriteLine("Order according to info is: {0}, bits/pixel is: {1}", info.Order, info.BitsPerPixel); 
 
   // Now, load this file with different color byte order and bits per pixel 
   int bitsPerPixel = 1; 
   RasterImage image = codecs.Load(singlePageFileName, bitsPerPixel, CodecsLoadByteOrder.Rgb, 1, 1); 
   Console.WriteLine("Loaded as {0} order and {1} bits/pixel", image.Order, image.BitsPerPixel); 
   Debug.Assert(bitsPerPixel == image.BitsPerPixel); 
   image.Dispose(); 
 
   string multiPageFileName = Path.Combine(LEAD_VARS.ImagesDir, "Eye.gif"); 
 
   // Get the file information (we are interested in the number of pages) 
   info = codecs.GetInformation(multiPageFileName, true); 
   Console.WriteLine("Number of pages according to info: {0}", info.TotalPages); 
 
   // Load the first page 
   int first = 1; 
   int last = 1; 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, first, last); 
   Console.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount); 
   Debug.Assert(image.PageCount == last - first + 1); 
   image.Dispose(); 
 
   // Load the second page 
   first = 2; 
   last = 2; 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, first, last); 
   Console.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount); 
   Debug.Assert(image.PageCount == last - first + 1); 
   image.Dispose(); 
 
   // Load from the second page to the second before last page 
   first = 2; 
   last = info.TotalPages - 1; 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, first, last); 
   Console.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount); 
   Debug.Assert(image.PageCount == last - first + 1); 
   image.Dispose(); 
 
   // load all the pages 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, -1); 
   Console.WriteLine("Loading all pages, pages loaded = {0}", image.PageCount); 
   Debug.Assert(image.PageCount == info.TotalPages); 
   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 LoadFile2Example() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   ' First, test loading as different color byte order and bits per pixel 
   Dim singlePageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp") 
 
   ' Get the file information 
   Dim info As CodecsImageInfo = codecs.GetInformation(singlePageFileName, True) 
   Console.WriteLine("Order according to info is: {0}, bits/pixel is: {1}", info.Order, info.BitsPerPixel) 
 
   ' Now, load this file with different color byte order and bits per pixel 
   Dim bitsPerPixel As Integer = 1 
   Dim image As RasterImage = codecs.Load(singlePageFileName, bitsPerPixel, CodecsLoadByteOrder.Rgb, 1, 1) 
   Console.WriteLine("Loaded as {0} order and {1} bits/pixel", image.Order, image.BitsPerPixel) 
   Debug.Assert(bitsPerPixel = image.BitsPerPixel) 
   image.Dispose() 
 
   Dim multiPageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Eye.gif") 
 
   ' Get the file information (we are interested in the number of pages) 
   info = codecs.GetInformation(multiPageFileName, True) 
   Console.WriteLine("Number of pages according to info: {0}", info.TotalPages) 
 
   ' Load the first page 
   Dim first As Integer = 1 
   Dim last As Integer = 1 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, first, last) 
   Console.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount) 
   Debug.Assert(image.PageCount = last - first + 1) 
   image.Dispose() 
 
   ' Load the second page 
   first = 2 
   last = 2 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, first, last) 
   Console.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount) 
   Debug.Assert(image.PageCount = last - first + 1) 
   image.Dispose() 
 
   ' Load from the second page to page before last 
   first = 2 
   last = info.TotalPages - 1 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, first, last) 
   Console.WriteLine("Loading pages {0} to {1}, pages loaded = {2}", first, last, image.PageCount) 
   Debug.Assert(image.PageCount = last - first + 1) 
   image.Dispose() 
 
   ' load all the pages 
   image = codecs.Load(multiPageFileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, -1) 
   Console.WriteLine("Loading all pages, pages loaded = {0}", image.PageCount) 
   Debug.Assert(image.PageCount = info.TotalPages) 
   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