OCRParams Class Documentation

classOCRParams

Namespace:com::datalogics::PDFL

Referenced by

Uses types

Constructor & Destructor Documentation

OCRParams

OCRParams()

Create an OCRParams structure with defaults.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getCandidateFontNames

java.util.List< String >getCandidateFontNames()

Returns:

java.util.List< String >

The names of candidate fonts for placing text under an image. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on this object.

Enough font names must be supplied to cover the expected languages/scripts in use.

The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals.

The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro.

If the PlaceTextUnder method in OCREngine can't identify a font that covers the whole text of a word, an exception will be thrown.

getConfigurationParameters

java.util.Map< String, String >getConfigurationParameters()

Returns:

java.util.Map< String, String >

Get the configuration parameters. Note: Reserved for internal use. Do not use unless directed to by Datalogics Support.

getEnableImagePreprocessing

booleangetEnableImagePreprocessing()

Returns:

boolean

Get the image preprocessing enable state.True if any image preprocessing is on.

getEngine

StringgetEngine()

Returns:

String

The engine in use.

getPageSegmentationMode

PageSegmentationModegetPageSegmentationMode()

Returns:

PageSegmentationMode

The page segmentation mode.

getPerformance

PerformancegetPerformance()

Returns:

Performance

The desired engine performance.

getResolution

doublegetResolution()

Returns:

double

Each image will use this resolution by default.

getTesseract4Engine

static StringgetTesseract4Engine()

Returns:

String

Specify the Tesseract v4 engine.Pass this to the engine property.

setCandidateFontNames

voidsetCandidateFontNames(java.util.List< String >candidateFontNames)

Parameters

candidateFontNames: java.util.List< String >

Returns:

void

The names of candidate fonts for placing text under an image. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on this object.

Enough font names must be supplied to cover the expected languages/scripts in use.

The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals.

The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro.

If the PlaceTextUnder method in OCREngine can't identify a font that covers the whole text of a word, an exception will be thrown.

setConfigurationParameters

voidsetConfigurationParameters(java.util.Map< String, String >configurationParameters)

Parameters

configurationParameters: java.util.Map< String, String >

Returns:

void

Set the configuration parameters. Note: Reserved for internal use. Do not use unless directed to by Datalogics Support.

setEnableImagePreprocessing

voidsetEnableImagePreprocessing(booleanenable)

Parameters

enable: boolean

Returns:

void

Enable all image preprocessing, default enabled.Note that once the OCREngine is initialized, this setting is permanent.

setEngine

voidsetEngine(Stringengine)

Parameters

engine: String

Returns:

void

The engine in use.

setPageSegmentationMode

voidsetPageSegmentationMode(PageSegmentationModemode)

Parameters

mode: PageSegmentationMode

Returns:

void

The page segmentation mode.

setPerformance

voidsetPerformance(Performanceperformance)

Parameters

performance: Performance

Returns:

void

The desired engine performance.

setResolution

voidsetResolution(doubleresolution)

Parameters

resolution: double

Returns:

void

Each image will use this resolution by default.