Package io.scanbot.sdk.check

Class CheckScannerConfiguration

java.lang.Object

io.scanbot.sdk.check.CheckScannerConfiguration

public class CheckScannerConfiguration
extends Object

Configuration of the check scanner.

Constructor Summary

Constructors

Constructor	Description
CheckScannerConfiguration()	Constructs CheckScannerConfiguration with default parameters.
CheckScannerConfiguration(CheckDocumentDetectionMode documentDetectionMode, List<CheckStandard> acceptedCheckStandards, ResultAccumulationConfiguration resultAccumulationConfig, ProcessingMode processingMode)	Constructs CheckScannerConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
List<CheckStandard>	getAcceptedCheckStandards()	Getter for acceptedCheckStandards field.
CheckDocumentDetectionMode	getDocumentDetectionMode()	Getter for documentDetectionMode field.
ProcessingMode	getProcessingMode()	Getter for processingMode field.
ResultAccumulationConfiguration	getResultAccumulationConfig()	Getter for resultAccumulationConfig field.
void	setAcceptedCheckStandards(List<CheckStandard> acceptedCheckStandards)	Setter for acceptedCheckStandards field.
void	setDocumentDetectionMode(CheckDocumentDetectionMode documentDetectionMode)	Setter for documentDetectionMode field.
void	setProcessingMode(ProcessingMode processingMode)	Setter for processingMode field.
void	setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)	Setter for resultAccumulationConfig field.

Methods inherited from class java.lang.Object

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

Constructor Details

CheckScannerConfiguration

public CheckScannerConfiguration(CheckDocumentDetectionMode documentDetectionMode,
 List<CheckStandard> acceptedCheckStandards,
 ResultAccumulationConfiguration resultAccumulationConfig,
 ProcessingMode processingMode)

Constructs CheckScannerConfiguration with the given params.

Parameters:

documentDetectionMode - Document detection to be performed in addition to scanning the machine-readable data in the check. By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data. A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located. If cropping is enabled, check recognition will be performed on the cropped image of the check, which may improve recognition results. Default is `DISABLED`.

acceptedCheckStandards - Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.

resultAccumulationConfig - Configuration for how to accumulate results.

processingMode - Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it. On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject. Default is `AUTO`.

CheckScannerConfiguration

public CheckScannerConfiguration()

Constructs CheckScannerConfiguration with default parameters.

Method Details

getDocumentDetectionMode

public CheckDocumentDetectionMode getDocumentDetectionMode()

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

Returns:

documentDetectionMode

setDocumentDetectionMode

public void setDocumentDetectionMode(CheckDocumentDetectionMode documentDetectionMode)

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

Parameters:

documentDetectionMode - Value to set.

getAcceptedCheckStandards

public List<CheckStandard> getAcceptedCheckStandards()

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

Returns:

acceptedCheckStandards

setAcceptedCheckStandards

public void setAcceptedCheckStandards(List<CheckStandard> acceptedCheckStandards)

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

Parameters:

acceptedCheckStandards - Value to set.

getResultAccumulationConfig

public ResultAccumulationConfiguration getResultAccumulationConfig()

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

Returns:

resultAccumulationConfig

setResultAccumulationConfig

public void setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)

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

Parameters:

resultAccumulationConfig - Value to set.

getProcessingMode

public ProcessingMode getProcessingMode()

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

Returns:

processingMode

setProcessingMode

public void setProcessingMode(ProcessingMode processingMode)

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

Parameters:

processingMode - Value to set.