Package io.scanbot.sdk.barcode

Class BarcodeFormatOneDConfigurationBase

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase

Direct Known Subclasses:

BarcodeFormatCodabarConfiguration, BarcodeFormatCode11Configuration, BarcodeFormatCode128Configuration, BarcodeFormatCode2Of5Configuration, BarcodeFormatCode39Configuration, BarcodeFormatCode93Configuration, BarcodeFormatDataBarConfiguration, BarcodeFormatDataBarExpandedConfiguration, BarcodeFormatDataBarLimitedConfiguration, BarcodeFormatItfConfiguration, BarcodeFormatMsiPlesseyConfiguration, BarcodeFormatPharmaCodeConfiguration, BarcodeFormatUpcEanConfiguration

public abstract class BarcodeFormatOneDConfigurationBase
extends BarcodeFormatConfigurationBase

Base class for all linear (1D) barcode configurations.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatOneDConfigurationBase()	Constructs BarcodeFormatOneDConfigurationBase with default parameters.
BarcodeFormatOneDConfigurationBase(java.lang.String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, int minimumNumberOfRequiredFramesWithEqualRecognitionResult, OneDConfirmationMode oneDConfirmationMode)	Constructs BarcodeFormatOneDConfigurationBase with the given params.

Method Summary

Modifier and Type	Method	Description
int	getMinimum1DQuietZoneSize()	Getter for minimum1DQuietZoneSize field.
int	getMinimumNumberOfRequiredFramesWithEqualRecognitionResult()	Getter for minimumNumberOfRequiredFramesWithEqualRecognitionResult field.
OneDConfirmationMode	getOneDConfirmationMode()	Getter for oneDConfirmationMode field.
void	setMinimum1DQuietZoneSize(int minimum1DQuietZoneSize)	Setter for minimum1DQuietZoneSize field.
void	setMinimumNumberOfRequiredFramesWithEqualRecognitionResult(int minimumNumberOfRequiredFramesWithEqualRecognitionResult)	Setter for minimumNumberOfRequiredFramesWithEqualRecognitionResult field.
void	setOneDConfirmationMode(OneDConfirmationMode oneDConfirmationMode)	Setter for oneDConfirmationMode field.

Methods inherited from class io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

getAddAdditionalQuietZone, getMinimumSizeScore, getRegexFilter, setAddAdditionalQuietZone, setMinimumSizeScore, setRegexFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

BarcodeFormatOneDConfigurationBase

public BarcodeFormatOneDConfigurationBase(java.lang.String regexFilter,
                                          double minimumSizeScore,
                                          boolean addAdditionalQuietZone,
                                          int minimum1DQuietZoneSize,
                                          int minimumNumberOfRequiredFramesWithEqualRecognitionResult,
                                          OneDConfirmationMode oneDConfirmationMode)

Constructs BarcodeFormatOneDConfigurationBase with the given params.

Parameters:

regexFilter - Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). Default is ""

minimumSizeScore - Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is. Default is 0

addAdditionalQuietZone - If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode. Default is false

minimum1DQuietZoneSize - Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11. Default is 6

minimumNumberOfRequiredFramesWithEqualRecognitionResult - Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only). Linear barcodes are more prone to false positives. Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive. Default is 1

oneDConfirmationMode - Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes. Default is THOROUGH

BarcodeFormatOneDConfigurationBase

public BarcodeFormatOneDConfigurationBase()

Constructs BarcodeFormatOneDConfigurationBase with default parameters.

Method Detail

getMinimum1DQuietZoneSize

public int getMinimum1DQuietZoneSize()

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

Returns:

minimum1DQuietZoneSize

setMinimum1DQuietZoneSize

public void setMinimum1DQuietZoneSize(int minimum1DQuietZoneSize)

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

Parameters:

minimum1DQuietZoneSize - Value to set.

getMinimumNumberOfRequiredFramesWithEqualRecognitionResult

public int getMinimumNumberOfRequiredFramesWithEqualRecognitionResult()

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

Returns:

minimumNumberOfRequiredFramesWithEqualRecognitionResult

setMinimumNumberOfRequiredFramesWithEqualRecognitionResult

public void setMinimumNumberOfRequiredFramesWithEqualRecognitionResult(int minimumNumberOfRequiredFramesWithEqualRecognitionResult)

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

Parameters:

minimumNumberOfRequiredFramesWithEqualRecognitionResult - Value to set.

getOneDConfirmationMode

public OneDConfirmationMode getOneDConfirmationMode()

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

Returns:

oneDConfirmationMode

setOneDConfirmationMode

public void setOneDConfirmationMode(OneDConfirmationMode oneDConfirmationMode)

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

Parameters:

oneDConfirmationMode - Value to set.