Package io.scanbot.sdk.documentdata

Class GlareDetectionConfiguration

java.lang.Object

io.scanbot.sdk.documentdata.DocumentDataExtractorConfigurationElement

io.scanbot.sdk.documentdata.GlareDetectionConfiguration

public class GlareDetectionConfiguration
extends DocumentDataExtractorConfigurationElement

Glare detection configuration. The recognizer will detect whether fields are obstructed by glare. This feature is enabled by default. This configuration has no effect in SINGLE_SHOT mode.

Constructor Summary

Constructors

Constructor	Description
GlareDetectionConfiguration()	Constructs GlareDetectionConfiguration with default parameters.
GlareDetectionConfiguration(double glareDetectionThreshold)	Constructs GlareDetectionConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
double	getGlareDetectionThreshold()	Getter for glareDetectionThreshold field.
void	setGlareDetectionThreshold(double glareDetectionThreshold)	Setter for glareDetectionThreshold field.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlareDetectionConfiguration

public GlareDetectionConfiguration(double glareDetectionThreshold)

Constructs GlareDetectionConfiguration with the given params.

Parameters:

glareDetectionThreshold - Glare detection threshold. The value should be in the range [0.0, 1.0]. Determines how much glare is acceptable relative to the text size. So 0.5 means that the glare can be up to 50% of the text size. If set to 0.0, the feature is disabled. Default is 0.5

GlareDetectionConfiguration

public GlareDetectionConfiguration()

Constructs GlareDetectionConfiguration with default parameters.

Method Detail

getGlareDetectionThreshold

public double getGlareDetectionThreshold()

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

Returns:

glareDetectionThreshold

setGlareDetectionThreshold

public void setGlareDetectionThreshold(double glareDetectionThreshold)

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

Parameters:

glareDetectionThreshold - Value to set.