Package io.scanbot.sdk.mrz

Class MrzScannerConfiguration

java.lang.Object

io.scanbot.sdk.mrz.MrzScannerConfiguration

public class MrzScannerConfiguration
extends Object

Configuration for MRZ scanner.

Constructor Summary

Constructors

Constructor	Description
MrzScannerConfiguration()	Constructs MrzScannerConfiguration with default parameters.
MrzScannerConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration, boolean enableDetection, MrzIncompleteResultHandling incompleteResultHandling, boolean returnCrops, ProcessingMode processingMode)	Constructs MrzScannerConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getEnableDetection()	Getter for enableDetection field.
AccumulatedResultsVerifierConfiguration	getFrameAccumulationConfiguration()	Getter for frameAccumulationConfiguration field.
MrzIncompleteResultHandling	getIncompleteResultHandling()	Getter for incompleteResultHandling field.
ProcessingMode	getProcessingMode()	Getter for processingMode field.
boolean	getReturnCrops()	Getter for returnCrops field.
void	setEnableDetection(boolean enableDetection)	Setter for enableDetection field.
void	setFrameAccumulationConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration)	Setter for frameAccumulationConfiguration field.
void	setIncompleteResultHandling(MrzIncompleteResultHandling incompleteResultHandling)	Setter for incompleteResultHandling field.
void	setProcessingMode(ProcessingMode processingMode)	Setter for processingMode field.
void	setReturnCrops(boolean returnCrops)	Setter for returnCrops field.

Methods inherited from class java.lang.Object

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

Constructor Details

MrzScannerConfiguration

public MrzScannerConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration,
 boolean enableDetection,
 MrzIncompleteResultHandling incompleteResultHandling,
 boolean returnCrops,
 ProcessingMode processingMode)

Constructs MrzScannerConfiguration with the given params.

Parameters:

frameAccumulationConfiguration - Configure the frame accumulation process.

enableDetection - Enable MRZ detection. If disabled, the scanner skips the detection step and assumes that the input image is a crop of the MRZ area. Default is `true`.

incompleteResultHandling - Defines how to handle incomplete MRZ results (e.g. caused by failed validation). Default is `REJECT`.

returnCrops - If true, crops of the detected MRZ and its fields will be returned in the result. Default is `false`.

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`.

MrzScannerConfiguration

public MrzScannerConfiguration()

Constructs MrzScannerConfiguration with default parameters.

Method Details

getFrameAccumulationConfiguration

public AccumulatedResultsVerifierConfiguration getFrameAccumulationConfiguration()

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

Returns:

frameAccumulationConfiguration

setFrameAccumulationConfiguration

public void setFrameAccumulationConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration)

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

Parameters:

frameAccumulationConfiguration - Value to set.

getEnableDetection

public boolean getEnableDetection()

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

Returns:

enableDetection

setEnableDetection

public void setEnableDetection(boolean enableDetection)

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

Parameters:

enableDetection - Value to set.

getIncompleteResultHandling

public MrzIncompleteResultHandling getIncompleteResultHandling()

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

Returns:

incompleteResultHandling

setIncompleteResultHandling

public void setIncompleteResultHandling(MrzIncompleteResultHandling incompleteResultHandling)

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

Parameters:

incompleteResultHandling - Value to set.

getReturnCrops

public boolean getReturnCrops()

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

Returns:

returnCrops

setReturnCrops

public void setReturnCrops(boolean returnCrops)

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

Parameters:

returnCrops - 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.