LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
LoadCmykPlanes(Stream,Int32,Int32) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > LoadCmykPlanes Method : LoadCmykPlanes(Stream,Int32,Int32) Method



stream
A System.IO.Stream containing the data of the image file to load. The image data must be CMYK, otherwise the method will fail and throw an exception.
bitsPerPixel
Resulting image pixel depth. Possible values are:
Value Meaning
8 Each plane will be a grayscale 8 bis per pixel image.
16 Each plane will be a grayscale 16 bits per pixel image.
page
1-based index of the page from which the planes should be loaded.
stream
A System.IO.Stream containing the data of the image file to load. The image data must be CMYK, otherwise the method will fail and throw an exception.
bitsPerPixel
Resulting image pixel depth. Possible values are:
Value Meaning
8 Each plane will be a grayscale 8 bis per pixel image.
16 Each plane will be a grayscale 16 bits per pixel image.
page
1-based index of the page from which the planes should be loaded.
Loads CMYK TIFF streams as CMYK and avoids the colorspace conversion to RGB.

Syntax

Visual Basic (Declaration) 
Overloads Public Function LoadCmykPlanes( _
   ByVal stream As Stream, _
   ByVal bitsPerPixel As Integer, _
   ByVal page As Integer _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim stream As Stream
Dim bitsPerPixel As Integer
Dim page As Integer
Dim value As RasterImage
 
value = instance.LoadCmykPlanes(stream, bitsPerPixel, page)
C# 
public RasterImage LoadCmykPlanes( 
   Stream stream,
   int bitsPerPixel,
   int page
)
C++/CLI 
public:
RasterImage^ LoadCmykPlanes( 
   Stream^ stream,
   int bitsPerPixel,
   int page
) 

Parameters

stream
A System.IO.Stream containing the data of the image file to load. The image data must be CMYK, otherwise the method will fail and throw an exception.
bitsPerPixel
Resulting image pixel depth. Possible values are:
Value Meaning
8 Each plane will be a grayscale 8 bis per pixel image.
16 Each plane will be a grayscale 16 bits per pixel image.
page
1-based index of the page from which the planes should be loaded.

Return Value

A Leadtools.RasterImage that this method loads. The image will contain one page for each of the CMYK planes.

Example

Remarks

If the data does not have to be loaded as CMYK, use RasterCodecs.Load or RasterCodecs.LoadAsync.

Support for 16-bit grayscale images is only available in the Document/Medical Imaging editions.

This method will fail if the input file is not TIFF CMYK. Note that not all the pages should be CMYK - it is enough if only the page that you wish to load is CMYK.

Only the following memory load options are supported by this method:

This method uses the values of RasterCodecs.Options.Tiff.Load.ImageFileDirectoryOffset.

If the image being loaded contains alpha channel information, it will be stored in the 5th page of the returned image.

Use RasterImagePainter.PaintCmykPlanes to display the array and SaveCmykArray to save an image as a CMYK TIFF file.

If you want to convert the CMYK array to a regular BGR image and use the other methods or save to a file format other than TIFF CMYK, use ColorMergeCommand and set the ColorMergeCommand.Type to ColorMergeCommandType.Cmyk.

If you have an alpha image, use RasterImage.SetAlphaImage to set the alpha image.

You can apply image processing on each individual image. This allows you to process each color plane separately.

If you want to load a non-CMYK file as an array of color plane, use the normal RasterCodecs.Load or RasterCodecs.LoadAsync methods and then use ColorSeparateCommand and RasterImage.CreateAlphaImage method.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also