Package io.scanbot.sdk.frameaccumulation

Class ResultAccumulationConfiguration

java.lang.Object

io.scanbot.sdk.frameaccumulation.ResultAccumulationConfiguration

public class ResultAccumulationConfiguration
extends Object

Configuration for how to accumulate results.

Constructor Summary

Constructors

Constructor	Description
ResultAccumulationConfiguration()	Constructs ResultAccumulationConfiguration with default parameters.
ResultAccumulationConfiguration(ConfirmationMethod confirmationMethod, int minConfirmations, double minConfidenceForStableField, int autoClearThreshold)	Constructs ResultAccumulationConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
int	getAutoClearThreshold()	Getter for autoClearThreshold field.
ConfirmationMethod	getConfirmationMethod()	Getter for confirmationMethod field.
double	getMinConfidenceForStableField()	Getter for minConfidenceForStableField field.
int	getMinConfirmations()	Getter for minConfirmations field.
void	setAutoClearThreshold(int autoClearThreshold)	Setter for autoClearThreshold field.
void	setConfirmationMethod(ConfirmationMethod confirmationMethod)	Setter for confirmationMethod field.
void	setMinConfidenceForStableField(double minConfidenceForStableField)	Setter for minConfidenceForStableField field.
void	setMinConfirmations(int minConfirmations)	Setter for minConfirmations field.

Methods inherited from class java.lang.Object

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

Constructor Details

ResultAccumulationConfiguration

public ResultAccumulationConfiguration(ConfirmationMethod confirmationMethod,
 int minConfirmations,
 double minConfidenceForStableField,
 int autoClearThreshold)

Constructs ResultAccumulationConfiguration with the given params.

Parameters:

confirmationMethod - Method used to confirm a result. Default is `EXACT`.

minConfirmations - Number of confirmations required to consider a result confirmed (see ConfirmationMethod). Requiring more confirmations will increase the reliability of the result but also the time to gather enough confirmations. In live mode, this is the number of camera frames that must confirm a field value. In single-shot mode, this is the number of internal recognition attempts that must agree on a field value. If not enough attempts confirm a field, the status will be OK_BUT_LOW_CONFIDENCE_RESULT instead of OK. Default is `3`.

minConfidenceForStableField - Minimum confidence required to consider a field confirmed. Default is `0.8`.

autoClearThreshold - Will auto-clear the cache if this number of frames have been a different document type or empty. Default is `4`.

ResultAccumulationConfiguration

public ResultAccumulationConfiguration()

Constructs ResultAccumulationConfiguration with default parameters.

Method Details

getConfirmationMethod

public ConfirmationMethod getConfirmationMethod()

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

Returns:

confirmationMethod

setConfirmationMethod

public void setConfirmationMethod(ConfirmationMethod confirmationMethod)

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

Parameters:

confirmationMethod - Value to set.

getMinConfirmations

public int getMinConfirmations()

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

Returns:

minConfirmations

setMinConfirmations

public void setMinConfirmations(int minConfirmations)

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

Parameters:

minConfirmations - Value to set.

getMinConfidenceForStableField

public double getMinConfidenceForStableField()

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

Returns:

minConfidenceForStableField

setMinConfidenceForStableField

public void setMinConfidenceForStableField(double minConfidenceForStableField)

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

Parameters:

minConfidenceForStableField - Value to set.

getAutoClearThreshold

public int getAutoClearThreshold()

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

Returns:

autoClearThreshold

setAutoClearThreshold

public void setAutoClearThreshold(int autoClearThreshold)

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

Parameters:

autoClearThreshold - Value to set.