Load(string,int,CodecsLoadByteOrder,int,int) Method (original) (raw)
Summary
Loads the specified image file using specific options.
Syntax
C#
Objective-C
C++/CLI
Python
- (nullable LTRasterImage *)loadFile:(NSString *)file
bitsPerPixel:(NSInteger)_bitsPerPixel_
order:(LTCodecsLoadByteOrder)_order_
firstPage:(NSInteger)_firstPage_
lastPage:(NSInteger)_lastPage_
error:(NSError **)error
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.
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;
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);
Debug.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);
Debug.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);
Debug.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);
Debug.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);
Debug.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);
Debug.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);
Debug.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:\LEADTOOLS22\Resources\Images";
}
Leadtools.Codecs Assembly
CompactFile(Stream,Stream,int,int,bool,int,int,bool,int,CodecsSavePageMode,bool,bool) Method
CompactFile(Stream,Stream,int,int,bool,long,int,bool,long,CodecsSavePageMode,bool,bool,bool) Method
CompactFile(string,string,int,int,bool,int,int,bool,int,CodecsSavePageMode,bool,bool) Method
CompactFile(string,string,int,int,bool,long,int,bool,long,CodecsSavePageMode,bool,bool,bool) Method