Package io.scanbot.sdk.vin

Class VinScannerConfiguration

java.lang.Object

io.scanbot.sdk.vin.VinScannerConfiguration

public class VinScannerConfiguration
extends Object

Configuration for the VIN scanner.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	getExtractVINFromBarcode()	Getter for extractVINFromBarcode field.
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.
void	setExtractVINFromBarcode(boolean extractVINFromBarcode)	Setter for extractVINFromBarcode 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.

Methods inherited from class java.lang.Object

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

Constructor Details

VinScannerConfiguration

public VinScannerConfiguration(int inputHeightLimit,
 boolean optimizeSingleLine,
 boolean extractVINFromBarcode,
 int ocrResolutionLimit,
 int maximumNumberOfAccumulatedFrames,
 int minimumNumberOfRequiredFramesWithEqualScanningResult)

Constructs VinScannerConfiguration with the given params.

Parameters:

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

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

extractVINFromBarcode - If true, the VIN scanner will also extract VINs from barcodes. Requires a license that allows barcode scanning in addition to VIN scanning. Default is `false`.

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.

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

VinScannerConfiguration

public VinScannerConfiguration()

Constructs VinScannerConfiguration with default parameters.

Method Details

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.

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.

getExtractVINFromBarcode

public boolean getExtractVINFromBarcode()

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

Returns:

extractVINFromBarcode

setExtractVINFromBarcode

public void setExtractVINFromBarcode(boolean extractVINFromBarcode)

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

Parameters:

extractVINFromBarcode - Value to set.

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.

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.