Package io.scanbot.sdk.textpattern

Class TextPatternScannerConfiguration

java.lang.Object

io.scanbot.sdk.textpattern.TextPatternScannerConfiguration

public class TextPatternScannerConfiguration
extends Object

Configuration for the text pattern scanner.

Constructor Summary

Constructors

Constructor	Description
TextPatternScannerConfiguration()	Constructs TextPatternScannerConfiguration with default parameters.
TextPatternScannerConfiguration(int ocrResolutionLimit, int inputHeightLimit, int maximumNumberOfAccumulatedFrames, int minimumNumberOfRequiredFramesWithEqualScanningResult, boolean optimizeSingleLine, ContentValidator validator)	Constructs TextPatternScannerConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
int	getInputHeightLimit()	Getter for inputHeightLimit field.
int	getMaximumNumberOfAccumulatedFrames()	Getter for maximumNumberOfAccumulatedFrames field.
int	getMinimumNumberOfRequiredFramesWithEqualScanningResult()	Getter for minimumNumberOfRequiredFramesWithEqualScanningResult field.
int	getOcrResolutionLimit()	Deprecated. Replaced by getInputHeightLimit() or setInputHeightLimit(int) or the corresponding constructor argument.
boolean	getOptimizeSingleLine()	Getter for optimizeSingleLine field.
ContentValidator	getValidator()	Getter for validator field.
void	setInputHeightLimit(int inputHeightLimit)	Setter for inputHeightLimit field.
void	setMaximumNumberOfAccumulatedFrames(int maximumNumberOfAccumulatedFrames)	Setter for maximumNumberOfAccumulatedFrames field.
void	setMinimumNumberOfRequiredFramesWithEqualScanningResult(int minimumNumberOfRequiredFramesWithEqualScanningResult)	Setter for minimumNumberOfRequiredFramesWithEqualScanningResult field.
void	setOcrResolutionLimit(int ocrResolutionLimit)	Deprecated. Replaced by getInputHeightLimit() or setInputHeightLimit(int) or the corresponding constructor argument.
void	setOptimizeSingleLine(boolean optimizeSingleLine)	Setter for optimizeSingleLine field.
void	setValidator(ContentValidator validator)	Setter for validator field.

Methods inherited from class java.lang.Object

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

Constructor Details

TextPatternScannerConfiguration

public TextPatternScannerConfiguration(int ocrResolutionLimit,
 int inputHeightLimit,
 int maximumNumberOfAccumulatedFrames,
 int minimumNumberOfRequiredFramesWithEqualScanningResult,
 boolean optimizeSingleLine,
 ContentValidator validator)

Constructs TextPatternScannerConfiguration with the given params.

Parameters:

ocrResolutionLimit - The option will be ignored if `inputHeightLimit` is not 0. Maximum image size (height or width) for OCR process. 0 - do not rescale. Default is `0`. Deprecated. Replaced by getInputHeightLimit() or setInputHeightLimit(int) or the corresponding constructor argument.

inputHeightLimit - Maximum image height for OCR processing. 0 - do not rescale. Default is `120`.

maximumNumberOfAccumulatedFrames - Maximum number of accumulated frames to inspect before actual result is returned. Default is `3`.

minimumNumberOfRequiredFramesWithEqualScanningResult - Minimum number of accumulated frames that have equal result. Default is `2`.

optimizeSingleLine - Optimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably. Default is `false`.

validator - Content validator.

TextPatternScannerConfiguration

public TextPatternScannerConfiguration()

Constructs TextPatternScannerConfiguration with default parameters.

Method Details

getOcrResolutionLimit

public int getOcrResolutionLimit()

Deprecated.

Replaced by getInputHeightLimit() or setInputHeightLimit(int) or the corresponding constructor argument.

Getter for ocrResolutionLimit field. See constructor documentation for more information about the field.

Returns:

ocrResolutionLimit

setOcrResolutionLimit

public void setOcrResolutionLimit(int ocrResolutionLimit)

Deprecated.

Replaced by getInputHeightLimit() or setInputHeightLimit(int) or the corresponding constructor argument.

Setter for ocrResolutionLimit field. See constructor documentation for more information about the field.

Parameters:

ocrResolutionLimit - Value to set.

getInputHeightLimit

public int getInputHeightLimit()

Getter for inputHeightLimit field. See constructor documentation for more information about the field.

Returns:

inputHeightLimit

setInputHeightLimit

public void setInputHeightLimit(int inputHeightLimit)

Setter for inputHeightLimit field. See constructor documentation for more information about the field.

Parameters:

inputHeightLimit - Value to set.

getMaximumNumberOfAccumulatedFrames

public int getMaximumNumberOfAccumulatedFrames()

Getter for maximumNumberOfAccumulatedFrames field. See constructor documentation for more information about the field.

Returns:

maximumNumberOfAccumulatedFrames

setMaximumNumberOfAccumulatedFrames

public void setMaximumNumberOfAccumulatedFrames(int maximumNumberOfAccumulatedFrames)

Setter for maximumNumberOfAccumulatedFrames field. See constructor documentation for more information about the field.

Parameters:

maximumNumberOfAccumulatedFrames - Value to set.

getMinimumNumberOfRequiredFramesWithEqualScanningResult

public int getMinimumNumberOfRequiredFramesWithEqualScanningResult()

Getter for minimumNumberOfRequiredFramesWithEqualScanningResult field. See constructor documentation for more information about the field.

Returns:

minimumNumberOfRequiredFramesWithEqualScanningResult

setMinimumNumberOfRequiredFramesWithEqualScanningResult

public void setMinimumNumberOfRequiredFramesWithEqualScanningResult(int minimumNumberOfRequiredFramesWithEqualScanningResult)

Setter for minimumNumberOfRequiredFramesWithEqualScanningResult field. See constructor documentation for more information about the field.

Parameters:

minimumNumberOfRequiredFramesWithEqualScanningResult - Value to set.

getOptimizeSingleLine

public boolean getOptimizeSingleLine()

Getter for optimizeSingleLine field. See constructor documentation for more information about the field.

Returns:

optimizeSingleLine

setOptimizeSingleLine

public void setOptimizeSingleLine(boolean optimizeSingleLine)

Setter for optimizeSingleLine field. See constructor documentation for more information about the field.

Parameters:

optimizeSingleLine - Value to set.

getValidator

public ContentValidator getValidator()

Getter for validator field. See constructor documentation for more information about the field.

Returns:

validator

setValidator

public void setValidator(ContentValidator validator)

Setter for validator field. See constructor documentation for more information about the field.

Parameters:

validator - Value to set.