public class Tesseract1 extends TessAPI1 implements ITesseract
TessAPI1, provides character
recognition support for common image formats, and multi-page TIFF images
beyond the uncompressed, binary TIFF format supported by Tesseract OCR
engine. The extended capabilities are provided by the
Java Advanced Imaging Image I/O Tools.PDFBox..jar files for jna and
jai-imageio) are in its compile and run-time
classpath.ITesseract.RenderedFormatITessAPI.CANCEL_FUNC, ITessAPI.EANYCODE_CHAR, ITessAPI.ETEXT_DESC, ITessAPI.TessBaseAPI, ITessAPI.TessCancelFunc, ITessAPI.TessChoiceIterator, ITessAPI.TessMutableIterator, ITessAPI.TessOcrEngineMode, ITessAPI.TessOrientation, ITessAPI.TessPageIterator, ITessAPI.TessPageIteratorLevel, ITessAPI.TessPageSegMode, ITessAPI.TessParagraphJustification, ITessAPI.TessPolyBlockType, ITessAPI.TessProgressFunc, ITessAPI.TessResultIterator, ITessAPI.TessResultRenderer, ITessAPI.TessTextlineOrder, ITessAPI.TessWritingDirection, ITessAPI.TimeValDOCUMENT_TITLE, htmlBeginTag, htmlEndTag, PAGE_SEPARATOR| Constructor and Description |
|---|
Tesseract1() |
| Modifier and Type | Method and Description |
|---|---|
void |
createDocuments(java.lang.String[] filenames,
java.lang.String[] outputbases,
java.util.List<ITesseract.RenderedFormat> formats)
Creates documents for given renderer.
|
void |
createDocuments(java.lang.String filename,
java.lang.String outputbase,
java.util.List<ITesseract.RenderedFormat> formats)
Creates documents for given renderer.
|
java.util.List<OCRResult> |
createDocumentsWithResults(java.awt.image.BufferedImage[] bis,
java.lang.String[] filenames,
java.lang.String[] outputbases,
java.util.List<ITesseract.RenderedFormat> formats,
int pageIteratorLevel)
Creates documents with OCR results for given renderers at specified page
iterator level.
|
OCRResult |
createDocumentsWithResults(java.awt.image.BufferedImage bi,
java.lang.String filename,
java.lang.String outputbase,
java.util.List<ITesseract.RenderedFormat> formats,
int pageIteratorLevel)
Creates documents with OCR result for given renderers at specified page
iterator level.
|
java.util.List<OCRResult> |
createDocumentsWithResults(java.lang.String[] filenames,
java.lang.String[] outputbases,
java.util.List<ITesseract.RenderedFormat> formats,
int pageIteratorLevel)
Creates documents with OCR results for given renderers at specified page
iterator level.
|
OCRResult |
createDocumentsWithResults(java.lang.String filename,
java.lang.String outputbase,
java.util.List<ITesseract.RenderedFormat> formats,
int pageIteratorLevel)
Creates documents with OCR result for given renderers at specified page
iterator level.
|
protected void |
dispose()
Releases all of the native resources used by this instance.
|
java.lang.String |
doOCR(java.awt.image.BufferedImage bi)
Performs OCR operation.
|
java.lang.String |
doOCR(java.awt.image.BufferedImage bi,
java.awt.Rectangle rect)
Deprecated.
|
java.lang.String |
doOCR(java.awt.image.BufferedImage bi,
java.lang.String filename,
java.util.List<java.awt.Rectangle> rects)
Performs OCR operation.
|
java.lang.String |
doOCR(java.io.File imageFile)
Performs OCR operation.
|
java.lang.String |
doOCR(java.io.File inputFile,
java.util.List<java.awt.Rectangle> rects)
Performs OCR operation.
|
java.lang.String |
doOCR(java.io.File inputFile,
java.awt.Rectangle rect)
Deprecated.
|
java.lang.String |
doOCR(int xsize,
int ysize,
java.nio.ByteBuffer buf,
int bpp,
java.lang.String filename,
java.util.List<java.awt.Rectangle> rects)
Performs OCR operation.
|
java.lang.String |
doOCR(int xsize,
int ysize,
java.nio.ByteBuffer buf,
java.awt.Rectangle rect,
int bpp)
Deprecated.
|
java.lang.String |
doOCR(int xsize,
int ysize,
java.nio.ByteBuffer buf,
java.lang.String filename,
java.awt.Rectangle rect,
int bpp)
Deprecated.
|
java.lang.String |
doOCR(java.util.List<javax.imageio.IIOImage> imageList,
java.awt.Rectangle rect)
Deprecated.
|
java.lang.String |
doOCR(java.util.List<javax.imageio.IIOImage> imageList,
java.lang.String filename,
java.util.List<java.util.List<java.awt.Rectangle>> roiss)
Performs OCR operation.
|
java.lang.String |
doOCR(java.util.List<javax.imageio.IIOImage> imageList,
java.lang.String filename,
java.awt.Rectangle rect)
Deprecated.
|
protected ITessAPI.TessBaseAPI |
getHandle()
Returns API handle.
|
protected java.lang.String |
getOCRText(java.lang.String filename,
int pageNum)
Gets recognized text.
|
java.util.List<java.awt.Rectangle> |
getSegmentedRegions(java.awt.image.BufferedImage bi,
int pageIteratorLevel)
Gets segmented regions at specified page iterator level.
|
java.util.List<Word> |
getWords(java.awt.image.BufferedImage bi,
int pageIteratorLevel)
Gets recognized words at specified page iterator level.
|
java.util.List<Word> |
getWords(java.util.List<java.awt.image.BufferedImage> biList,
int pageIteratorLevel)
Gets recognized words at specified page iterator level.
|
protected void |
init()
Initializes Tesseract engine.
|
void |
setConfigs(java.util.List<java.lang.String> configs)
Sets configs to be passed to Tesseract's
Init method. |
void |
setDatapath(java.lang.String datapath)
Sets path to
tessdata. |
protected void |
setImage(int xsize,
int ysize,
java.nio.ByteBuffer buf,
int bpp)
Sets image to be processed.
|
protected void |
setImage(java.awt.image.RenderedImage image)
A wrapper for
setImage(int, int, ByteBuffer, int). |
void |
setLanguage(java.lang.String language)
Sets language for OCR.
|
void |
setOcrEngineMode(int ocrEngineMode)
Sets OCR engine mode.
|
void |
setPageSegMode(int mode)
Sets page segmentation mode.
|
protected void |
setROI(java.awt.Rectangle rect)
Sets region of interest.
|
void |
setTessVariable(java.lang.String key,
java.lang.String value)
Deprecated.
Use
setVariable(String key, String value) instead. |
void |
setVariable(java.lang.String key,
java.lang.String value)
Set the value of Tesseract's internal parameter.
|
protected void |
setVariables()
Sets Tesseract's internal parameters.
|
TessAltoRendererCreate, TessBaseAPIAdaptToWordStr, TessBaseAPIAllWordConfidences, TessBaseAPIAnalyseLayout, TessBaseAPIClear, TessBaseAPIClearAdaptiveClassifier, TessBaseAPIClearPersistentCache, TessBaseAPICreate, TessBaseAPIDelete, TessBaseAPIDetectOrientationScript, TessBaseAPIEnd, TessBaseAPIGetAltoText, TessBaseAPIGetAvailableLanguagesAsVector, TessBaseAPIGetBoolVariable, TessBaseAPIGetBoxText, TessBaseAPIGetComponentImages, TessBaseAPIGetComponentImages1, TessBaseAPIGetConnectedComponents, TessBaseAPIGetDatapath, TessBaseAPIGetDoubleVariable, TessBaseAPIGetHOCRText, TessBaseAPIGetInitLanguagesAsString, TessBaseAPIGetInputImage, TessBaseAPIGetInputName, TessBaseAPIGetIntVariable, TessBaseAPIGetIterator, TessBaseAPIGetLoadedLanguagesAsVector, TessBaseAPIGetLSTMBoxText, TessBaseAPIGetMutableIterator, TessBaseAPIGetPageSegMode, TessBaseAPIGetRegions, TessBaseAPIGetSourceYResolution, TessBaseAPIGetStringVariable, TessBaseAPIGetStrips, TessBaseAPIGetTextDirection, TessBaseAPIGetTextlines, TessBaseAPIGetTextlines1, TessBaseAPIGetThresholdedImage, TessBaseAPIGetThresholdedImageScaleFactor, TessBaseAPIGetTsvText, TessBaseAPIGetUnichar, TessBaseAPIGetUNLVText, TessBaseAPIGetUTF8Text, TessBaseAPIGetWords, TessBaseAPIGetWordStrBoxText, TessBaseAPIInit1, TessBaseAPIInit2, TessBaseAPIInit3, TessBaseAPIInit4, TessBaseAPIInit5, TessBaseAPIInitForAnalysePage, TessBaseAPIIsValidWord, TessBaseAPIMeanTextConf, TessBaseAPIPrintVariablesToFile, TessBaseAPIProcessPage, TessBaseAPIProcessPages, TessBaseAPIReadConfigFile, TessBaseAPIRecognize, TessBaseAPIRect, TessBaseAPISetImage, TessBaseAPISetImage2, TessBaseAPISetInputImage, TessBaseAPISetInputName, TessBaseAPISetOutputName, TessBaseAPISetPageSegMode, TessBaseAPISetRectangle, TessBaseAPISetSourceResolution, TessBaseAPISetVariable, TessBoxTextRendererCreate, TessChoiceIteratorConfidence, TessChoiceIteratorDelete, TessChoiceIteratorGetUTF8Text, TessChoiceIteratorNext, TessDeleteIntArray, TessDeleteResultRenderer, TessDeleteText, TessDeleteTextArray, TessHOcrRendererCreate, TessHOcrRendererCreate2, TessLSTMBoxRendererCreate, TessMonitorCreate, TessMonitorDelete, TessMonitorGetCancelThis, TessMonitorGetProgress, TessMonitorSetCancelFunc, TessMonitorSetCancelThis, TessMonitorSetDeadlineMSecs, TessMonitorSetProgressFunc, TessPageIteratorBaseline, TessPageIteratorBegin, TessPageIteratorBlockType, TessPageIteratorBoundingBox, TessPageIteratorCopy, TessPageIteratorDelete, TessPageIteratorGetBinaryImage, TessPageIteratorGetImage, TessPageIteratorIsAtBeginningOf, TessPageIteratorIsAtFinalElement, TessPageIteratorNext, TessPageIteratorOrientation, TessPageIteratorParagraphInfo, TessPDFRendererCreate, TessResultIteratorConfidence, TessResultIteratorCopy, TessResultIteratorDelete, TessResultIteratorGetChoiceIterator, TessResultIteratorGetPageIterator, TessResultIteratorGetPageIteratorConst, TessResultIteratorGetUTF8Text, TessResultIteratorNext, TessResultIteratorSymbolIsDropcap, TessResultIteratorSymbolIsSubscript, TessResultIteratorSymbolIsSuperscript, TessResultIteratorWordFontAttributes, TessResultIteratorWordIsFromDictionary, TessResultIteratorWordIsNumeric, TessResultIteratorWordRecognitionLanguage, TessResultRendererAddImage, TessResultRendererBeginDocument, TessResultRendererEndDocument, TessResultRendererExtention, TessResultRendererImageNum, TessResultRendererInsert, TessResultRendererNext, TessResultRendererTitle, TessTextRendererCreate, TessTsvRendererCreate, TessUnlvRendererCreate, TessVersion, TessWordStrBoxRendererCreateprotected ITessAPI.TessBaseAPI getHandle()
public void setDatapath(java.lang.String datapath)
tessdata.setDatapath in interface ITesseractdatapath - the tessdata path to setpublic void setLanguage(java.lang.String language)
setLanguage in interface ITesseractlanguage - the language code, which follows ISO 639-3 standard.public void setOcrEngineMode(int ocrEngineMode)
setOcrEngineMode in interface ITesseractocrEngineMode - the OcrEngineMode to setpublic void setPageSegMode(int mode)
setPageSegMode in interface ITesseractmode - the page segmentation mode to set@Deprecated
public void setTessVariable(java.lang.String key,
java.lang.String value)
setVariable(String key, String value) instead.setTessVariable in interface ITesseractkey - variable name, e.g., tessedit_create_hocr,
tessedit_char_whitelist, etc.value - value for corresponding variable, e.g., "1", "0",
"0123456789", etc.public void setVariable(java.lang.String key,
java.lang.String value)
setVariable in interface ITesseractkey - variable name, e.g., tessedit_create_hocr,
tessedit_char_whitelist, etc.value - value for corresponding variable, e.g., "1", "0",
"0123456789", etc.public void setConfigs(java.util.List<java.lang.String> configs)
Init method.setConfigs in interface ITesseractconfigs - list of config filenames, e.g., "digits", "bazaar",
"quiet"public java.lang.String doOCR(java.io.File imageFile)
throws TesseractException
doOCR in interface ITesseractimageFile - an image fileTesseractException@Deprecated
public java.lang.String doOCR(java.io.File inputFile,
java.awt.Rectangle rect)
throws TesseractException
doOCR in interface ITesseractinputFile - an image filerect - the bounding rectangle defines the region of the image to be
recognized. A rectangle of zero dimension or null indicates
the whole image.TesseractExceptionpublic java.lang.String doOCR(java.io.File inputFile,
java.util.List<java.awt.Rectangle> rects)
throws TesseractException
doOCR in interface ITesseractinputFile - an image filerects - list of the bounding rectangles defines the regions of the
image to be recognized. A rectangle of zero dimension or
null indicates the whole image.TesseractExceptionpublic java.lang.String doOCR(java.awt.image.BufferedImage bi)
throws TesseractException
doOCR in interface ITesseractbi - a buffered imageTesseractException@Deprecated
public java.lang.String doOCR(java.awt.image.BufferedImage bi,
java.awt.Rectangle rect)
throws TesseractException
doOCR in interface ITesseractbi - a buffered imagerect - the bounding rectangle defines the region of the image to be
recognized. A rectangle of zero dimension or null indicates
the whole image.TesseractExceptionpublic java.lang.String doOCR(java.awt.image.BufferedImage bi,
java.lang.String filename,
java.util.List<java.awt.Rectangle> rects)
throws TesseractException
doOCR in interface ITesseractbi - a buffered imagerects - list of the bounding rectangles defines the regions of the
image to be recognized. A rectangle of zero dimension or
null indicates the whole image.filename - input file name. Needed only for training and reading a
UNLV zone file.TesseractException@Deprecated
public java.lang.String doOCR(java.util.List<javax.imageio.IIOImage> imageList,
java.awt.Rectangle rect)
throws TesseractException
doOCR in interface ITesseractimageList - a list of IIOImage objectsrect - the bounding rectangle defines the region of the image to be
recognized. A rectangle of zero dimension or null indicates
the whole image.TesseractException@Deprecated
public java.lang.String doOCR(java.util.List<javax.imageio.IIOImage> imageList,
java.lang.String filename,
java.awt.Rectangle rect)
throws TesseractException
doOCR in interface ITesseractimageList - a list of IIOImage objectsfilename - input file name. Needed only for training and reading a
UNLV zone file.rect - the bounding rectangle defines the region of the image to be
recognized. A rectangle of zero dimension or null indicates
the whole image.TesseractExceptionpublic java.lang.String doOCR(java.util.List<javax.imageio.IIOImage> imageList,
java.lang.String filename,
java.util.List<java.util.List<java.awt.Rectangle>> roiss)
throws TesseractException
doOCR in interface ITesseractimageList - a list of IIOImage objectsfilename - input file name. Needed only for training and reading a
UNLV zone file.roiss - list of list of the bounding rectangles defines the regions of the
images to be recognized. A rectangle of zero dimension or
null indicates the whole image.TesseractException@Deprecated
public java.lang.String doOCR(int xsize,
int ysize,
java.nio.ByteBuffer buf,
java.awt.Rectangle rect,
int bpp)
throws TesseractException
SetImage, (optionally)
SetRectangle, and one or more of the Get*Text
functions.doOCR in interface ITesseractxsize - width of imageysize - height of imagebuf - pixel datarect - the bounding rectangle defines the region of the image to be
recognized. A rectangle of zero dimension or null indicates
the whole image.bpp - bits per pixel, represents the bit depth of the image, with 1
for binary bitmap, 8 for gray, and 24 for color RGB.TesseractException@Deprecated
public java.lang.String doOCR(int xsize,
int ysize,
java.nio.ByteBuffer buf,
java.lang.String filename,
java.awt.Rectangle rect,
int bpp)
throws TesseractException
SetImage, (optionally)
SetRectangle, and one or more of the Get*Text
functions.doOCR in interface ITesseractxsize - width of imageysize - height of imagebuf - pixel datafilename - input file name. Needed only for training and reading a
UNLV zone file.rect - the bounding rectangle defines the region of the image to be
recognized. A rectangle of zero dimension or null indicates
the whole image.bpp - bits per pixel, represents the bit depth of the image, with 1
for binary bitmap, 8 for gray, and 24 for color RGB.TesseractExceptionpublic java.lang.String doOCR(int xsize,
int ysize,
java.nio.ByteBuffer buf,
int bpp,
java.lang.String filename,
java.util.List<java.awt.Rectangle> rects)
throws TesseractException
SetImage, (optionally)
SetRectangle, and one or more of the Get*Text
functions.doOCR in interface ITesseractxsize - width of imageysize - height of imagebuf - pixel databpp - bits per pixel, represents the bit depth of the image, with 1
for binary bitmap, 8 for gray, and 24 for color RGB.filename - input file name. Needed only for training and reading a
UNLV zone file.rects - list of the bounding rectangles defines the regions of the
image to be recognized. A rectangle of zero dimension or
null indicates the whole image.TesseractExceptionprotected void init()
protected void setVariables()
protected void setImage(java.awt.image.RenderedImage image)
throws java.io.IOException
setImage(int, int, ByteBuffer, int).image - a rendered imagejava.io.IOExceptionprotected void setImage(int xsize,
int ysize,
java.nio.ByteBuffer buf,
int bpp)
xsize - width of imageysize - height of imagebuf - pixel databpp - bits per pixel, represents the bit depth of the image, with 1
for binary bitmap, 8 for gray, and 24 for color RGB.protected void setROI(java.awt.Rectangle rect)
rect - region of interestprotected java.lang.String getOCRText(java.lang.String filename,
int pageNum)
filename - input file name. Needed only for reading a UNLV zone
file.pageNum - page number; needed for hocr paging.public void createDocuments(java.lang.String filename,
java.lang.String outputbase,
java.util.List<ITesseract.RenderedFormat> formats)
throws TesseractException
createDocuments in interface ITesseractfilename - input imageoutputbase - output filename without extensionformats - types of rendererTesseractExceptionpublic void createDocuments(java.lang.String[] filenames,
java.lang.String[] outputbases,
java.util.List<ITesseract.RenderedFormat> formats)
throws TesseractException
createDocuments in interface ITesseractfilenames - array of input filesoutputbases - array of output filenames without extensionformats - types of rendererTesseractExceptionpublic java.util.List<java.awt.Rectangle> getSegmentedRegions(java.awt.image.BufferedImage bi,
int pageIteratorLevel)
throws TesseractException
getSegmentedRegions in interface ITesseractbi - input buffered imagepageIteratorLevel - TessPageIteratorLevel enumRectangleTesseractExceptionpublic java.util.List<Word> getWords(java.awt.image.BufferedImage bi, int pageIteratorLevel)
getWords in interface ITesseractbi - input buffered imagepageIteratorLevel - TessPageIteratorLevel enumWordpublic java.util.List<Word> getWords(java.util.List<java.awt.image.BufferedImage> biList, int pageIteratorLevel)
getWords in interface ITesseractbiList - list of input buffered imagespageIteratorLevel - TessPageIteratorLevel enumWordpublic OCRResult createDocumentsWithResults(java.awt.image.BufferedImage bi, java.lang.String filename, java.lang.String outputbase, java.util.List<ITesseract.RenderedFormat> formats, int pageIteratorLevel) throws TesseractException
createDocumentsWithResults in interface ITesseractbi - input buffered imagefilename - filename (optional)outputbase - output filenames without extensionformats - types of rendererpageIteratorLevel - TessPageIteratorLevel enumTesseractExceptionpublic java.util.List<OCRResult> createDocumentsWithResults(java.awt.image.BufferedImage[] bis, java.lang.String[] filenames, java.lang.String[] outputbases, java.util.List<ITesseract.RenderedFormat> formats, int pageIteratorLevel) throws TesseractException
createDocumentsWithResults in interface ITesseractbis - array of input buffered imagesfilenames - array of filenamesoutputbases - array of output filenames without extensionformats - types of rendererpageIteratorLevel - TessPageIteratorLevel enumTesseractExceptionpublic OCRResult createDocumentsWithResults(java.lang.String filename, java.lang.String outputbase, java.util.List<ITesseract.RenderedFormat> formats, int pageIteratorLevel) throws TesseractException
createDocumentsWithResults in interface ITesseractfilename - input fileoutputbase - output filenames without extensionformats - types of rendererpageIteratorLevel - TessPageIteratorLevel enumTesseractExceptionpublic java.util.List<OCRResult> createDocumentsWithResults(java.lang.String[] filenames, java.lang.String[] outputbases, java.util.List<ITesseract.RenderedFormat> formats, int pageIteratorLevel) throws TesseractException
createDocumentsWithResults in interface ITesseractfilenames - array of input filesoutputbases - array of output filenames without extensionformats - types of rendererpageIteratorLevel - TessPageIteratorLevel enumTesseractExceptionprotected void dispose()
Copyright © 2024 Tess4J. All rights reserved.