Package net.sourceforge.tess4j

Interface ITesseract

  • All Known Implementing Classes:
    Tesseract, Tesseract1
    public interface ITesseract
    An interface represents common OCR methods.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  ITesseract.RenderedFormat
      Rendered formats supported by Tesseract.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String htmlBeginTag  
      static java.lang.String htmlEndTag  

    • Method Summary

      Modifier and Type Method Description
      void createDocuments​(java.lang.String[] filenames, java.lang.String[] outputbases, java.util.List<ITesseract.RenderedFormat> formats)
      Creates documents for given renderers.
      void createDocuments​(java.lang.String filename, java.lang.String outputbase, java.util.List<ITesseract.RenderedFormat> formats)
      Creates documents for given renderers.
      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.
      java.lang.String doOCR​(int xsize, int ysize, java.nio.ByteBuffer buf, java.awt.Rectangle rect, int bpp)
      Performs OCR operation.
      java.lang.String doOCR​(int xsize, int ysize, java.nio.ByteBuffer buf, java.lang.String filename, java.awt.Rectangle rect, int bpp)
      Performs OCR operation.
      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)
      Performs OCR operation.
      java.lang.String doOCR​(java.io.File imageFile)
      Performs OCR operation.
      java.lang.String doOCR​(java.io.File imageFile, java.awt.Rectangle rect)
      Performs OCR operation.
      java.lang.String doOCR​(java.util.List<javax.imageio.IIOImage> imageList, java.awt.Rectangle rect)
      Performs OCR operation.
      java.lang.String doOCR​(java.util.List<javax.imageio.IIOImage> imageList, java.lang.String filename, java.awt.Rectangle rect)
      Performs OCR operation.
      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.
      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 tessdata path.
      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.
      void setTessVariable​(java.lang.String key, java.lang.String value)
      Sets the value of Tesseract's internal parameter.

    • Method Detail

      • doOCR

        java.lang.String doOCR​(java.io.File imageFile)
                throws TesseractException
        Performs OCR operation.
        Parameters:
        imageFile - an image file
        Returns:
        the recognized text
        Throws:
        TesseractException

      • doOCR

        java.lang.String doOCR​(java.io.File imageFile,
                       java.awt.Rectangle rect)
                throws TesseractException
        Performs OCR operation.
        Parameters:
        imageFile - an image 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.
        Returns:
        the recognized text
        Throws:
        TesseractException

      • doOCR

        java.lang.String doOCR​(java.awt.image.BufferedImage bi)
                throws TesseractException
        Performs OCR operation.
        Parameters:
        bi - a buffered image
        Returns:
        the recognized text
        Throws:
        TesseractException

      • doOCR

        java.lang.String doOCR​(java.awt.image.BufferedImage bi,
                       java.awt.Rectangle rect)
                throws TesseractException
        Performs OCR operation.
        Parameters:
        bi - a buffered image
        rect - the bounding rectangle defines the region of the image to be recognized. A rectangle of zero dimension or null indicates the whole image.
        Returns:
        the recognized text
        Throws:
        TesseractException

      • doOCR

        java.lang.String doOCR​(java.util.List<javax.imageio.IIOImage> imageList,
                       java.awt.Rectangle rect)
                throws TesseractException
        Performs OCR operation.
        Parameters:
        imageList - a list of IIOImage objects
        rect - the bounding rectangle defines the region of the image to be recognized. A rectangle of zero dimension or null indicates the whole image.
        Returns:
        the recognized text
        Throws:
        TesseractException

      • doOCR

        java.lang.String doOCR​(java.util.List<javax.imageio.IIOImage> imageList,
                       java.lang.String filename,
                       java.awt.Rectangle rect)
                throws TesseractException
        Performs OCR operation.
        Parameters:
        imageList - a list of IIOImage objects
        filename - 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.
        Returns:
        the recognized text
        Throws:
        TesseractException

      • doOCR

        java.lang.String doOCR​(int xsize,
                       int ysize,
                       java.nio.ByteBuffer buf,
                       java.awt.Rectangle rect,
                       int bpp)
                throws TesseractException
        Performs OCR operation. Use SetImage, (optionally) SetRectangle, and one or more of the Get*Text functions.
        Parameters:
        xsize - width of image
        ysize - height of image
        buf - pixel data
        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.
        Returns:
        the recognized text
        Throws:
        TesseractException

      • doOCR

        java.lang.String doOCR​(int xsize,
                       int ysize,
                       java.nio.ByteBuffer buf,
                       java.lang.String filename,
                       java.awt.Rectangle rect,
                       int bpp)
                throws TesseractException
        Performs OCR operation. Use SetImage, (optionally) SetRectangle, and one or more of the Get*Text functions.
        Parameters:
        xsize - width of image
        ysize - height of image
        buf - pixel data
        filename - 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.
        Returns:
        the recognized text
        Throws:
        TesseractException

      • setDatapath

        void setDatapath​(java.lang.String datapath)
        Sets tessdata path.
        Parameters:
        datapath - the tessdata path to set

      • setLanguage

        void setLanguage​(java.lang.String language)
        Sets language for OCR.
        Parameters:
        language - the language code, which follows ISO 639-3 standard.

      • setOcrEngineMode

        void setOcrEngineMode​(int ocrEngineMode)
        Sets OCR engine mode.
        Parameters:
        ocrEngineMode - the OcrEngineMode to set

      • setPageSegMode

        void setPageSegMode​(int mode)
        Sets page segmentation mode.
        Parameters:
        mode - the page segmentation mode to set

      • setTessVariable

        void setTessVariable​(java.lang.String key,
                     java.lang.String value)
        Sets the value of Tesseract's internal parameter.
        Parameters:
        key - variable name, e.g., tessedit_create_hocr, tessedit_char_whitelist, etc.
        value - value for corresponding variable, e.g., "1", "0", "0123456789", etc.

      • setConfigs

        void setConfigs​(java.util.List<java.lang.String> configs)
        Sets configs to be passed to Tesseract's Init method.
        Parameters:
        configs - list of config filenames, e.g., "digits", "bazaar", "quiet"

      • createDocuments

        void createDocuments​(java.lang.String filename,
                     java.lang.String outputbase,
                     java.util.List<ITesseract.RenderedFormat> formats)
              throws TesseractException
        Creates documents for given renderers.
        Parameters:
        filename - input image
        outputbase - output filename without extension
        formats - types of renderers
        Throws:
        TesseractException

      • createDocuments

        void createDocuments​(java.lang.String[] filenames,
                     java.lang.String[] outputbases,
                     java.util.List<ITesseract.RenderedFormat> formats)
              throws TesseractException
        Creates documents for given renderers.
        Parameters:
        filenames - array of input files
        outputbases - array of output filenames without extension
        formats - types of renderers
        Throws:
        TesseractException

      • createDocumentsWithResults

        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
        Creates documents with OCR result for given renderers at specified page iterator level.
        Parameters:
        bi - input buffered image
        filename - filename (optional)
        outputbase - output filenames without extension
        formats - types of renderer
        pageIteratorLevel - TessPageIteratorLevel enum
        Returns:
        OCR result
        Throws:
        TesseractException

      • createDocumentsWithResults

        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
        Creates documents with OCR results for given renderers at specified page iterator level.
        Parameters:
        bis - array of input buffered images
        filenames - array of filenames
        outputbases - array of output filenames without extension
        formats - types of renderer
        pageIteratorLevel - TessPageIteratorLevel enum
        Returns:
        list of OCR results
        Throws:
        TesseractException

      • createDocumentsWithResults

        OCRResult createDocumentsWithResults​(java.lang.String filename,
                                     java.lang.String outputbase,
                                     java.util.List<ITesseract.RenderedFormat> formats,
                                     int pageIteratorLevel)
                              throws TesseractException
        Creates documents with OCR result for given renderers at specified page iterator level.
        Parameters:
        filename - input file
        outputbase - output filenames without extension
        formats - types of renderer
        pageIteratorLevel - TessPageIteratorLevel enum
        Returns:
        OCR result
        Throws:
        TesseractException

      • createDocumentsWithResults

        java.util.List<OCRResult> createDocumentsWithResults​(java.lang.String[] filenames,
                                                     java.lang.String[] outputbases,
                                                     java.util.List<ITesseract.RenderedFormat> formats,
                                                     int pageIteratorLevel)
                                              throws TesseractException
        Creates documents with OCR results for given renderers at specified page iterator level.
        Parameters:
        filenames - array of input files
        outputbases - array of output filenames without extension
        formats - types of renderer
        pageIteratorLevel - TessPageIteratorLevel enum
        Returns:
        list of OCR results
        Throws:
        TesseractException

      • getSegmentedRegions

        java.util.List<java.awt.Rectangle> getSegmentedRegions​(java.awt.image.BufferedImage bi,
                                                       int pageIteratorLevel)
                                                throws TesseractException
        Gets segmented regions at specified page iterator level.
        Parameters:
        bi - input buffered image
        pageIteratorLevel - TessPageIteratorLevel enum
        Returns:
        list of Rectangle
        Throws:
        TesseractException

      • getWords

        java.util.List<Word> getWords​(java.awt.image.BufferedImage bi,
                              int pageIteratorLevel)
        Gets recognized words at specified page iterator level.
        Parameters:
        bi - input buffered image
        pageIteratorLevel - TessPageIteratorLevel enum
        Returns:
        list of Word