C G I L M O P R S T V

## C

call() - Method in class com.asprise.ocr.OcrExecutorService.OcrCallable
com.asprise.ocr - package com.asprise.ocr
CONFIG_PROP_KEY_VALUE_SEPARATOR - Static variable in class com.asprise.ocr.Ocr
  Do not change unless you are told so.
CONFIG_PROP_SEPARATOR - Static variable in class com.asprise.ocr.Ocr
  Do not change unless you are told so.

## G

getConsoleMode() - Static method in class com.asprise.ocr.Ocr
  -1 unknow / 0 no / 1 yes
getCpuCores() - Static method in class com.asprise.ocr.OcrExecutorService
  Returns number of CPU core available for the current JVM.
getLibraryVersion() - Static method in class com.asprise.ocr.Ocr
  The library version.
getLibraryVersion(boolean) - Static method in class com.asprise.ocr.Ocr
  The library version.

## I

isEngineRunning() - Method in class com.asprise.ocr.Ocr
  Returns true only if the engine has been started and has not been stopped yet.
isSetupRequired() - Static method in class com.asprise.ocr.Ocr
  Whether one-time setup is required.

## L

LANGUAGE_DEU - Static variable in class com.asprise.ocr.Ocr
  deu (German)
LANGUAGE_ENG - Static variable in class com.asprise.ocr.Ocr
  eng (English)
LANGUAGE_FRA - Static variable in class com.asprise.ocr.Ocr
  fra (French)
LANGUAGE_POR - Static variable in class com.asprise.ocr.Ocr
  por (Portuguese)
LANGUAGE_SPA - Static variable in class com.asprise.ocr.Ocr
  spa (Spanish)
listSupportedLanguages() - Static method in class com.asprise.ocr.Ocr
  Returns all supported languages.

## M

main(String[]) - Static method in class com.asprise.ocr.Ocr
  Displays the library version and optional performs OCR on the input file.

## O

Ocr - Class in com.asprise.ocr
  Represents an engine of Asprise OCR - a high performance OCR engine for Java/C#/VB.NET/C/C++ on Windows, Linux, Mac OS X and Unix.
Ocr() - Constructor for class com.asprise.ocr.Ocr
Ocr.ImagePreProcessingType - Enum in com.asprise.ocr
  Image pre-processing type
Ocr.PageType - Enum in com.asprise.ocr
  Page type hint
Ocr.PropertyBuilder - Class in com.asprise.ocr
  Builder for configuring scan properties.
Ocr.PropertyBuilder() - Constructor for class com.asprise.ocr.Ocr.PropertyBuilder
OcrException - Exception in com.asprise.ocr
  Ocr related exception.
OcrException() - Constructor for exception com.asprise.ocr.OcrException
OcrException(String) - Constructor for exception com.asprise.ocr.OcrException
OcrException(String, Throwable) - Constructor for exception com.asprise.ocr.OcrException
OcrException(Throwable) - Constructor for exception com.asprise.ocr.OcrException
OcrExecutorService - Class in com.asprise.ocr
  Executor service for OCR.
OcrExecutorService(String, String) - Constructor for class com.asprise.ocr.OcrExecutorService
  A service executor with thread count equal to number of CPU core available.
OcrExecutorService(String, String, int) - Constructor for class com.asprise.ocr.OcrExecutorService
  Creates a new instance of OCR service executor
OcrExecutorService.OcrCallable - Class in com.asprise.ocr
  Represents an OCR task.
OcrExecutorService.OcrCallable(File[], String, String, Object...) - Constructor for class com.asprise.ocr.OcrExecutorService.OcrCallable
  See Ocr.recognize(java.io.File[], String, String, Object...)
OcrExecutorService.OcrCallable(String, int, int, int, int, int, String, String, Object...) - Constructor for class com.asprise.ocr.OcrExecutorService.OcrCallable
  See Ocr.recognize(String, int, int, int, int, int, String, String, Object...)
OUTPUT_FORMAT_PDF - Static variable in class com.asprise.ocr.Ocr
  Output recognition result as searchable PDF
OUTPUT_FORMAT_PLAINTEXT - Static variable in class com.asprise.ocr.Ocr
  Output recognition result as plain text
OUTPUT_FORMAT_XML - Static variable in class com.asprise.ocr.Ocr
  Output recognition result in XML format with additional information if coordination, confidence, runtime, etc.

## P

PAGES_ALL - Static variable in class com.asprise.ocr.Ocr
  Recognize all pages.
parse(String) - Static method in enum com.asprise.ocr.Ocr.PageType
PROP_IMG_PREPROCESS_CUSTOM_CMDS - Static variable in class com.asprise.ocr.Ocr
  Custom mage pre-processing command
PROP_IMG_PREPROCESS_TYPE - Static variable in class com.asprise.ocr.Ocr
  Image pre-processing type
PROP_IMG_PREPROCESS_TYPE_CUSTOM - Static variable in class com.asprise.ocr.Ocr
  Custom, need to set PROP_IMG_PREPROCESS_CUSTOM_CMDS
PROP_IMG_PREPROCESS_TYPE_DEFAULT - Static variable in class com.asprise.ocr.Ocr
  Use system default
PROP_IMG_PREPROCESS_TYPE_DEFAULT_WITH_ORIENTATION_DETECTION - Static variable in class com.asprise.ocr.Ocr
  Default + page orientation detection
PROP_INPUT_PDF_DPI - Static variable in class com.asprise.ocr.Ocr
  The DPI to be used to render the PDF file; default is 300 if not specified
PROP_LIMIT_TO_CHARSET - Static variable in class com.asprise.ocr.Ocr
  Recognizes only the specified list of characters.
PROP_OUTPUT_SEPARATE_WORDS - Static variable in class com.asprise.ocr.Ocr
  Set to 'true' to set the output level as word instead of the default, line.
PROP_PAGE_TYPE - Static variable in class com.asprise.ocr.Ocr
  Use this property to hint the OCR engine about page type.
PROP_PAGE_TYPE_AUTO - Static variable in class com.asprise.ocr.Ocr
PROP_PAGE_TYPE_SCATTERED - Static variable in class com.asprise.ocr.Ocr
PROP_PAGE_TYPE_SINGLE_BLOCK - Static variable in class com.asprise.ocr.Ocr
PROP_PAGE_TYPE_SINGLE_CHAR - Static variable in class com.asprise.ocr.Ocr
PROP_PAGE_TYPE_SINGLE_COLUMN - Static variable in class com.asprise.ocr.Ocr
PROP_PAGE_TYPE_SINGLE_LINE - Static variable in class com.asprise.ocr.Ocr
PROP_PAGE_TYPE_SINGLE_WORD - Static variable in class com.asprise.ocr.Ocr
PROP_PDF_OUTPUT_CONF_THRESHOLD - Static variable in class com.asprise.ocr.Ocr
  Valid value: 0 ~ 100 - text recognized below or above confidence will be highlighted in different colors.
PROP_PDF_OUTPUT_FILE - Static variable in class com.asprise.ocr.Ocr
  PDF output file - required for PDF output.
PROP_PDF_OUTPUT_FONT - Static variable in class com.asprise.ocr.Ocr
  Font to be used for PDF output.
PROP_PDF_OUTPUT_IMAGE_DPI - Static variable in class com.asprise.ocr.Ocr
  The DPI of the images or '0' to auto-detect.
PROP_PDF_OUTPUT_IMAGE_FORCE_BW - Static variable in class com.asprise.ocr.Ocr
  Convert images into black/white to reduce PDF output file size.
PROP_PDF_OUTPUT_RETURN_TEXT_FORMAT - Static variable in class com.asprise.ocr.Ocr
  Return text in 'text' or 'xml' format when the output format is set to PDF.
PROP_PDF_OUTPUT_RETURN_TEXT_FORMAT_PLAINTEXT - Static variable in class com.asprise.ocr.Ocr
PROP_PDF_OUTPUT_RETURN_TEXT_FORMAT_XML - Static variable in class com.asprise.ocr.Ocr
PROP_PDF_OUTPUT_TEXT_VISIBLE - Static variable in class com.asprise.ocr.Ocr
  Make text visible - for debugging and analysis purpose.
PROP_SAVE_INTERMEDIATE_IMAGES_TO_DIR - Static variable in class com.asprise.ocr.Ocr
  Save intermediate images generated for debug purpose - don't specify or empty string to skip saving
PROP_TABLE_MIN_SIDE_LENGTH - Static variable in class com.asprise.ocr.Ocr
  default is 31 if not specified
PROP_TABLE_SKIP_DETECTION - Static variable in class com.asprise.ocr.Ocr
  table will be detected by default; set this property to true to skip detection.

## R

recognize(URL[], String, String, Object...) - Method in class com.asprise.ocr.Ocr
  Performs text/barcode recognition on the given files with the specified output format.
recognize(File[], String, String, Object...) - Method in class com.asprise.ocr.Ocr
  Performs text/barcode recognition on the given files with the specified output format.
recognize(RenderedImage, String, String, Object...) - Method in class com.asprise.ocr.Ocr
  Performs text/barcode recognition on the given image with the specified output format.
recognize(String, int, int, int, int, int, String, String, Object...) - Method in class com.asprise.ocr.Ocr
  Performs OCR on the given input files.
RECOGNIZE_TYPE_ALL - Static variable in class com.asprise.ocr.Ocr
  Recognize both text and barcode
RECOGNIZE_TYPE_BARCODE - Static variable in class com.asprise.ocr.Ocr
  Recognize barcode
RECOGNIZE_TYPE_TEXT - Static variable in class com.asprise.ocr.Ocr
  Recognize text

## S

saveAocrXslToDir(File, boolean) - Static method in class com.asprise.ocr.Ocr
  Saves aocr.xsl to the specified directory
saveIntermediateImagesToDir(File) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Save intermediate images generated for debug purpose - don't specify or empty string to skip saving
setCustomImagePreProcessing(String) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  set the image pre-processing type to Ocr.ImagePreProcessingType.CUSTOM and the corresponding custom commands.
setImagePreProcessingType(Ocr.ImagePreProcessingType) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Sets the image pre-processing type
setInputPdfDpi(int) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  The DPI to be used to render the PDF file; default is 300 if not specified
setLimitToCharset(String) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  recognizes only certain characters
setLimitToCharsetDigitsOnly() - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  only recognizes '0123456789'
setOutputSeparateWords(boolean) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  whether to use word as the base unit for output; set to false to use the default unit: line.
setPageType(Ocr.PageType) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  hints the page type to the OCR engine
setPageType(String) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  hints the page type to the OCR engine
setPdfImageForceBlackWhite(boolean) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  true to convert image in PDF to black/white to save space false for keeping as is (default).
setPdfOutputFile(File) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Target pdf output file when output format is set to pdf
setPdfOutputFile(String) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Target pdf output file when output format is set to pdf
setPdfOutputFontSans(boolean) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  true to set PDF output font to Sans, false to Serif (default).
setPdfOutputReturnNothing() - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Return neither plain text nor xml when the output format is set to PDF.
setPdfOutputReturnPlainText() - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Return plain text when the output format is set to PDF.
setPdfOutputReturnXml() - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Return xml when the output format is set to PDF.
setPdfTextVisible(boolean) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  true to make text recognized visible on PDF or false for transparent (default).
setSkipTableDetection(boolean) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Whether table detection should be skipped.
setTableDetectionMinSideLength(int) - Method in class com.asprise.ocr.Ocr.PropertyBuilder
  Sets the min side length of a table cell when table detection is enabled.
setUp() - Static method in class com.asprise.ocr.Ocr
  Performs one-time setup; does nothing if setup has already been done.
shutdown() - Method in class com.asprise.ocr.OcrExecutorService
SPEED_FAST - Static variable in class com.asprise.ocr.Ocr
  less speed, better accuracy
SPEED_FASTEST - Static variable in class com.asprise.ocr.Ocr
  Highest speed, accuracy may suffer - default option
SPEED_SLOW - Static variable in class com.asprise.ocr.Ocr
  lowest speed, best accuracy
startEngine(String, String) - Method in class com.asprise.ocr.Ocr
  Starts the OCR engine; does nothing if the engine has already been started.
stopEngine() - Method in class com.asprise.ocr.Ocr
  Stops the OCR engine; does nothing if it has already been stopped.
stopOcrEngines() - Method in class com.asprise.ocr.OcrExecutorService

## T

threadLocalOcr - Static variable in class com.asprise.ocr.OcrExecutorService
toString() - Method in enum com.asprise.ocr.Ocr.ImagePreProcessingType
toString() - Method in enum com.asprise.ocr.Ocr.PageType

## V

valueOf(String) - Static method in enum com.asprise.ocr.Ocr.ImagePreProcessingType
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.asprise.ocr.Ocr.PageType
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.asprise.ocr.Ocr.ImagePreProcessingType
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.asprise.ocr.Ocr.PageType
  Returns an array containing the constants of this enum type, in the order they are declared.

C G I L M O P R S T V

Copyright © Asprise Software. All Rights Reserved. Please visit the product page at asprise.com