org.apache.tika.parser.ocr

Class TesseractOCRConfig

java.lang.Object

org.apache.tika.parser.ocr.TesseractOCRConfig

All Implemented Interfaces:

Serializable

public class TesseractOCRConfig
extends Object
implements Serializable

Configuration for TesseractOCRParser. This allows to enable TesseractOCRParser and set its parameters:

TesseractOCRConfig config = new TesseractOCRConfig();
config.setTesseractPath(tesseractFolder);
parseContext.set(TesseractOCRConfig.class, config);

Parameters can also be set by either editing the existing TesseractOCRConfig.properties file in, tika-parser/src/main/resources/org/apache/tika/parser/ocr, or overriding it by creating your own and placing it in the package org/apache/tika/parser/ocr on the classpath.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TesseractOCRConfig.OUTPUT_TYPE

Constructor Summary

Constructors

Constructor and Description
TesseractOCRConfig() Default contructor.
TesseractOCRConfig(InputStream is) Loads properties from InputStream and then tries to close InputStream.

Method Summary

Methods

Modifier and Type	Method and Description
String	getColorspace()
int	getDensity()
int	getDepth()
String	getFilter()
String	getImageMagickPath()
String	getLanguage()
int	getMaxFileSizeToOcr()
int	getMinFileSizeToOcr()
TesseractOCRConfig.OUTPUT_TYPE	getOutputType()
String	getPageSegMode()
int	getResize()
String	getTessdataPath()
String	getTesseractPath()
int	getTimeout()
int	isEnableImageProcessing()
void	setColorspace(String colorspace)
void	setDensity(int density)
void	setDepth(int depth)
void	setEnableImageProcessing(int enableImageProcessing) Set the value to true if processing is to be enabled.
void	setFilter(String filter)
void	setImageMagickPath(String ImageMagickPath) Set the path to the ImageMagick executable, needed if it is not on system path.
void	setLanguage(String language) Set tesseract language dictionary to be used.
void	setMaxFileSizeToOcr(int maxFileSizeToOcr) Set maximum file size to submit file to ocr.
void	setMinFileSizeToOcr(int minFileSizeToOcr) Set minimum file size to submit file to ocr.
void	setOutputType(TesseractOCRConfig.OUTPUT_TYPE outputType) Set output type from ocr process.
void	setPageSegMode(String pageSegMode) Set tesseract page segmentation mode.
void	setResize(int resize)
void	setTessdataPath(String tessdataPath) Set the path to the 'tessdata' folder, which contains language files and config files.
void	setTesseractPath(String tesseractPath) Set the path to the Tesseract executable, needed if it is not on system path.
void	setTimeout(int timeout) Set maximum time (seconds) to wait for the ocring process to terminate.

Methods inherited from class java.lang.Object

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

Constructor Detail

TesseractOCRConfig

public TesseractOCRConfig()

Default contructor.

TesseractOCRConfig

public TesseractOCRConfig(InputStream is)

Loads properties from InputStream and then tries to close InputStream. If there is an IOException, this silently swallows the exception and goes back to the default.

Parameters:

is -

Method Detail

getTesseractPath

public String getTesseractPath()

See Also:

setTesseractPath(String tesseractPath)

setTesseractPath

public void setTesseractPath(String tesseractPath)

Set the path to the Tesseract executable, needed if it is not on system path.

Note that if you set this value, it is highly recommended that you also set the path to the 'tessdata' folder using setTessdataPath(java.lang.String).

getTessdataPath

public String getTessdataPath()

See Also:

setTessdataPath(String tessdataPath)

setTessdataPath

public void setTessdataPath(String tessdataPath)

Set the path to the 'tessdata' folder, which contains language files and config files. In some cases (such as on Windows), this folder is found in the Tesseract installation, but in other cases (such as when Tesseract is built from source), it may be located elsewhere.

getLanguage

public String getLanguage()

See Also:

setLanguage(String language)

setLanguage

public void setLanguage(String language)

Set tesseract language dictionary to be used. Default is "eng". Multiple languages may be specified, separated by plus characters.

getPageSegMode

public String getPageSegMode()

See Also:

setPageSegMode(String pageSegMode)

setPageSegMode

public void setPageSegMode(String pageSegMode)

Set tesseract page segmentation mode. Default is 1 = Automatic page segmentation with OSD (Orientation and Script Detection)

getMinFileSizeToOcr

public int getMinFileSizeToOcr()

See Also:

setMinFileSizeToOcr(int minFileSizeToOcr)

setMinFileSizeToOcr

public void setMinFileSizeToOcr(int minFileSizeToOcr)

Set minimum file size to submit file to ocr. Default is 0.

getMaxFileSizeToOcr

public int getMaxFileSizeToOcr()

See Also:

setMaxFileSizeToOcr(int maxFileSizeToOcr)

setMaxFileSizeToOcr

public void setMaxFileSizeToOcr(int maxFileSizeToOcr)

Set maximum file size to submit file to ocr. Default is Integer.MAX_VALUE.

setTimeout

public void setTimeout(int timeout)

Set maximum time (seconds) to wait for the ocring process to terminate. Default value is 120s.

getTimeout

public int getTimeout()

Returns:

timeout value for Tesseract

See Also:

setTimeout(int timeout)

setOutputType

public void setOutputType(TesseractOCRConfig.OUTPUT_TYPE outputType)

Set output type from ocr process. Default is "txt", but can be "hocr". Default value is 120s.

getOutputType

public TesseractOCRConfig.OUTPUT_TYPE getOutputType()

See Also:

setOutputType(OUTPUT_TYPE outputType)

isEnableImageProcessing

public int isEnableImageProcessing()

Returns:

image processing is enabled or not

See Also:

setEnableImageProcessing(int)

setEnableImageProcessing

public void setEnableImageProcessing(int enableImageProcessing)

Set the value to true if processing is to be enabled. Default value is false.

getDensity

public int getDensity()

Returns:

the density

setDensity

public void setDensity(int density)

Parameters:

density - the density to set. Valid range of values is 150-1200. Default value is 300.

getDepth

public int getDepth()

Returns:

the depth

setDepth

public void setDepth(int depth)

Parameters:

depth - the depth to set. Valid values are 2, 4, 8, 16, 32, 64, 256, 4096. Default value is 4.

getColorspace

public String getColorspace()

Returns:

the colorspace

setColorspace

public void setColorspace(String colorspace)

Parameters:

colorspace - the colorspace to set Deafult value is gray.

getFilter

public String getFilter()

Returns:

the filter

setFilter

public void setFilter(String filter)

Parameters:

filter - the filter to set. Valid values are point, hermite, cubic, box, gaussian, catrom, triangle, quadratic and mitchell. Default value is triangle.

getResize

public int getResize()

Returns:

the resize

setResize

public void setResize(int resize)

Parameters:

resize - the resize to set. Valid range of values is 100-900. Default value is 900.

getImageMagickPath

public String getImageMagickPath()

Returns:

path to ImageMagick file.

See Also:

setImageMagickPath(String ImageMagickPath)

setImageMagickPath

public void setImageMagickPath(String ImageMagickPath)

Set the path to the ImageMagick executable, needed if it is not on system path.

Parameters:

ImageMagickPath - to ImageMagick file.