com.aspose.ocr

Class OcrInput

java.lang.Object

com.aspose.ocr.OcrInput

All Implemented Interfaces:

Iterable<ImageData>

public class OcrInput
extends Object
implements Iterable<ImageData>

Main class for recognize text from images.

Version:

25.9.0

Author:

Aspose

Constructor Summary

Constructors

Constructor and Description
OcrInput(InputType type)
OcrInput(InputType type, PreprocessingFilter filters) Constructor to create container and set the type of images / documents and filters for further processing / recognition.

Method Summary

Modifier and Type	Method and Description
void	add(BufferedImage image) Add the BufferedImage containing the image for recognition / processing.
void	add(BufferedImage image, int startPage, int pagesCount) Add the BufferedImage containing the multipage image for recognition / processing.
void	add(InputStream stream) Add the InputStream containing the image for recognition / processing.
void	add(InputStream stream, int startPage, int pagesCount) Add the InputStream containing the multipage image for recognition / processing.
void	add(int[] pixels, int width, int height, int bitsPerPixel) Add the decoded image to the list for recognition / processing.
void	add(String fullPath) Add the path or URI containing the image for recognition / processing.
void	add(String fullPath, int startPage, int pagesCount) Add the multipage images / documents for recognition / processing.
void	addBase64(String base64) Add the base64 string containing the image for recognition / processing.
void	clear() Set the amount of items for processing / recognition as 0.
void	clearFilters() Remove all filters.
ImageData	get(int index) Returns information about processed / recognized image.
Iterator<ImageData>	iterator()
void	replaceFilters(PreprocessingFilter filters) Remove old filters and set new.
int	size() Amount of items for processing / recognition.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

OcrInput

public OcrInput(InputType type,
                PreprocessingFilter filters)

Constructor to create container and set the type of images / documents and filters for further processing / recognition.

Parameters:

type - Set the images/documents type will be added to container.

filters - Set processing filters will be applied for further processing or recognition.

OcrInput

public OcrInput(InputType type)

Method Detail

replaceFilters

public void replaceFilters(PreprocessingFilter filters)

Remove old filters and set new.

Parameters:

filters - Processing filters will be applied for further processing or recognition.

clearFilters

public void clearFilters()

Remove all filters.

add

public void add(String fullPath)

Add the path or URI containing the image for recognition / processing. The type of the image must correspond to the type specified in the constructor.

Parameters:

fullPath - Path to the image/ document / folder / archive.

add

public void add(BufferedImage image)

Add the BufferedImage containing the image for recognition / processing. The type of the image must correspond to the type specified in the constructor.

Parameters:

image - BufferedImage containing the image or document.

add

public void add(String fullPath,
                int startPage,
                int pagesCount)

Add the multipage images / documents for recognition / processing. The type of the image must correspond to the type specified in the constructor.

Parameters:

fullPath - Path to the image/ document / folder / archive.

startPage - The first page/image for processing / recognition. Use for documents, zip, folders.

pagesCount - The total amount of pages/images for processing / recognition. Use for documents, zip, folders. Default = all.

add

public void add(BufferedImage image,
                int startPage,
                int pagesCount)

Add the BufferedImage containing the multipage image for recognition / processing. The type of the image must correspond to the type specified in the constructor.

Parameters:

image - BufferedImage containing the multipage document.

startPage - The first page/image for processing / recognition. Use for documents.

pagesCount - The total amount of pages/images for processing / recognition. Use for documents. Default = all.

add

public void add(int[] pixels,
                int width,
                int height,
                int bitsPerPixel)

Add the decoded image to the list for recognition / processing. The type of the image must correspond to the type specified in the constructor (SingleImage).

Parameters:

pixels - The pixels are represented as 32-bit integer values (rgb).

width - Image width.

height - Image height.

bitsPerPixel - Supports 1-32 bits.

add

public void add(InputStream stream)

Add the InputStream containing the image for recognition / processing. The type of the image must correspond to the type specified in the constructor.

Parameters:

stream - InputStream containing the image or document.

add

public void add(InputStream stream,
                int startPage,
                int pagesCount)

Add the InputStream containing the multipage image for recognition / processing. The type of the image must correspond to the type specified in the constructor.

Parameters:

stream - InputStream containing the multipage document.

startPage - The first page/image for processing / recognition. Use for documents.

pagesCount - The total amount of pages/images for processing / recognition. Use for documents. Default = all.

addBase64

public void addBase64(String base64)

Add the base64 string containing the image for recognition / processing. The type of the image must correspond to the type specified in the constructor.

Parameters:

base64 - Base64 string with single image.

clear

public void clear()

Set the amount of items for processing / recognition as 0. Clear the collection.

size

public int size()

Amount of items for processing / recognition.

Returns:

Amount of items.

get

public ImageData get(int index)

Returns information about processed / recognized image.

Parameters:

index - Position of the image in the List.

Returns:

The object of @see ImageData

iterator

public Iterator<ImageData> iterator()

Specified by:

iterator in interface Iterable<ImageData>