net.sourceforge.tess4j.util

Class ImageIOHelper

java.lang.Object

net.sourceforge.tess4j.util.ImageIOHelper

public class ImageIOHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
ImageIOHelper()

Method Summary

Modifier and Type	Method and Description
static ByteBuffer	convertImageData(BufferedImage bi) Converts BufferedImage to ByteBuffer.
static List<File>	createTiffFiles(File imageFile, int index) Creates a list of TIFF image files from an image file.
static List<File>	createTiffFiles(File imageFile, int index, boolean preserve) Creates a list of TIFF image files from an image file.
static List<File>	createTiffFiles(List<IIOImage> imageList, int index) Creates a list of TIFF image files from a list of IIOImage objects.
static List<File>	createTiffFiles(List<IIOImage> imageList, int index, int dpiX, int dpiY)
static List<IIOImage>	getIIOImageList(BufferedImage bi) Gets a list of IIOImage objects for a BufferedImage.
static List<IIOImage>	getIIOImageList(File imageFile) Gets a list of IIOImage objects for an image file.
static ByteBuffer	getImageByteBuffer(IIOImage image) Gets pixel data of an IIOImage object.
static ByteBuffer	getImageByteBuffer(RenderedImage image) Gets pixel data of an RenderedImage object.
static List<BufferedImage>	getImageList(File imageFile) Gets a list of BufferedImage objects for an image file.
static void	mergeTiff(BufferedImage[] inputImages, File outputTiff) Merges multiple images into one multi-page TIFF image.
static void	mergeTiff(BufferedImage[] inputImages, File outputTiff, String compressionType) Merges multiple images into one multi-page TIFF image.
static void	mergeTiff(File[] inputImages, File outputTiff) Merges multiple images into one multi-page TIFF image.
static void	mergeTiff(List<IIOImage> imageList, File outputTiff) Merges multiple images into one multi-page TIFF image.
static void	mergeTiff(List<IIOImage> imageList, File outputTiff, String compressionType) Merges multiple images into one multi-page TIFF image.
static Map<String,String>	readImageData(IIOImage oimage) Reads image meta data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageIOHelper

public ImageIOHelper()

Method Detail

createTiffFiles

public static List<File> createTiffFiles(File imageFile,
                                         int index)
                                  throws IOException

Creates a list of TIFF image files from an image file. It basically converts images of other formats to TIFF format, or a multi-page TIFF image to multiple TIFF image files.

Parameters:

imageFile - input image file

index - an index of the page; -1 means all pages, as in a multi-page TIFF image

Returns:

a list of TIFF image files

Throws:

IOException

createTiffFiles

public static List<File> createTiffFiles(File imageFile,
                                         int index,
                                         boolean preserve)
                                  throws IOException

Creates a list of TIFF image files from an image file. It basically converts images of other formats to TIFF format, or a multi-page TIFF image to multiple TIFF image files.

Parameters:

imageFile - input image file

index - an index of the page; -1 means all pages, as in a multi-page TIFF image

preserve - preserve compression mode

Returns:

a list of TIFF image files

Throws:

IOException

createTiffFiles

public static List<File> createTiffFiles(List<IIOImage> imageList,
                                         int index)
                                  throws IOException

Creates a list of TIFF image files from a list of IIOImage objects.

Parameters:

imageList - a list of IIOImage objects

index - an index of the page; -1 means all pages

Returns:

a list of TIFF image files

Throws:

IOException

createTiffFiles

public static List<File> createTiffFiles(List<IIOImage> imageList,
                                         int index,
                                         int dpiX,
                                         int dpiY)
                                  throws IOException

Throws:

IOException

getImageByteBuffer

public static ByteBuffer getImageByteBuffer(IIOImage image)
                                     throws IOException

Gets pixel data of an IIOImage object.

Parameters:

image - an IIOImage object

Returns:

a byte buffer of pixel data

Throws:

IOException

getImageByteBuffer

public static ByteBuffer getImageByteBuffer(RenderedImage image)
                                     throws IOException

Gets pixel data of an RenderedImage object.

Parameters:

image - an RenderedImage object

Returns:

a byte buffer of pixel data

Throws:

IOException

convertImageData

public static ByteBuffer convertImageData(BufferedImage bi)

Converts BufferedImage to ByteBuffer.

Parameters:

bi - Input image

Returns:

pixel data

getImageList

public static List<BufferedImage> getImageList(File imageFile)
                                        throws IOException

Gets a list of BufferedImage objects for an image file.

Parameters:

imageFile - input image file. It can be any of the supported formats, including TIFF, JPEG, GIF, PNG, BMP, JPEG

Returns:

a list of BufferedImage objects

Throws:

IOException

getIIOImageList

public static List<IIOImage> getIIOImageList(File imageFile)
                                      throws IOException

Gets a list of IIOImage objects for an image file.

Parameters:

imageFile - input image file. It can be any of the supported formats, including TIFF, JPEG, GIF, PNG, BMP, JPEG, and PDF if GPL Ghostscript is installed

Returns:

a list of IIOImage objects

Throws:

IOException

getIIOImageList

public static List<IIOImage> getIIOImageList(BufferedImage bi)
                                      throws IOException

Gets a list of IIOImage objects for a BufferedImage.

Parameters:

bi - input image

Returns:

a list of IIOImage objects

Throws:

IOException

mergeTiff

public static void mergeTiff(File[] inputImages,
                             File outputTiff)
                      throws IOException

Merges multiple images into one multi-page TIFF image.

Parameters:

inputImages - an array of image files

outputTiff - the output multi-page TIFF file

Throws:

IOException

mergeTiff

public static void mergeTiff(BufferedImage[] inputImages,
                             File outputTiff)
                      throws IOException

Merges multiple images into one multi-page TIFF image.

Parameters:

inputImages - an array of BufferedImage

outputTiff - the output TIFF file

Throws:

IOException

mergeTiff

public static void mergeTiff(BufferedImage[] inputImages,
                             File outputTiff,
                             String compressionType)
                      throws IOException

Merges multiple images into one multi-page TIFF image.

Parameters:

inputImages - an array of BufferedImage

outputTiff - the output TIFF file

compressionType - valid values: LZW, CCITT T.6, PackBits

Throws:

IOException

mergeTiff

public static void mergeTiff(List<IIOImage> imageList,
                             File outputTiff)
                      throws IOException

Merges multiple images into one multi-page TIFF image.

Parameters:

imageList - a list of IIOImage objects

outputTiff - the output TIFF file

Throws:

IOException

mergeTiff

public static void mergeTiff(List<IIOImage> imageList,
                             File outputTiff,
                             String compressionType)
                      throws IOException

Merges multiple images into one multi-page TIFF image.

Parameters:

imageList - a list of IIOImage objects

outputTiff - the output TIFF file

compressionType - valid values: LZW, CCITT T.6, PackBits

Throws:

IOException

readImageData

public static Map<String,String> readImageData(IIOImage oimage)

Reads image meta data.

Parameters:

oimage -

Returns:

a map of meta data