Package io.scanbot.sdk.barcode

Class BarcodeFormatItfConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatItfConfiguration

public class BarcodeFormatItfConfiguration
extends BarcodeFormatOneDConfigurationBase

ITF (Interleaved 2-of-5) barcode configuration. Add to scanner configuration to scan Interleaved 2-of-5 (ITF) barcodes.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatItfConfiguration()	Constructs BarcodeFormatItfConfiguration with default parameters.
BarcodeFormatItfConfiguration(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, int minimumNumberOfRequiredFramesWithEqualRecognitionResult, OneDConfirmationMode oneDConfirmationMode, int minimumTextLength, int maximumTextLength, BarcodeDefectProfile barcodeDefectProfile, ConfigState blurryOneDScanner)	Constructs BarcodeFormatItfConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
BarcodeDefectProfile	getBarcodeDefectProfile()	Getter for barcodeDefectProfile field.
ConfigState	getBlurryOneDScanner()	Getter for blurryOneDScanner field.
int	getMaximumTextLength()	Getter for maximumTextLength field.
int	getMinimumTextLength()	Getter for minimumTextLength field.
void	setBarcodeDefectProfile(BarcodeDefectProfile barcodeDefectProfile)	Setter for barcodeDefectProfile field.
void	setBlurryOneDScanner(ConfigState blurryOneDScanner)	Setter for blurryOneDScanner field.
void	setMaximumTextLength(int maximumTextLength)	Setter for maximumTextLength field.
void	setMinimumTextLength(int minimumTextLength)	Setter for minimumTextLength field.

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

getMinimum1DQuietZoneSize, getMinimumNumberOfRequiredFramesWithEqualRecognitionResult, getOneDConfirmationMode, setMinimum1DQuietZoneSize, setMinimumNumberOfRequiredFramesWithEqualRecognitionResult, setOneDConfirmationMode

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 Details

BarcodeFormatItfConfiguration

public BarcodeFormatItfConfiguration(String regexFilter,
 double minimumSizeScore,
 boolean addAdditionalQuietZone,
 int minimum1DQuietZoneSize,
 int minimumNumberOfRequiredFramesWithEqualRecognitionResult,
 OneDConfirmationMode oneDConfirmationMode,
 int minimumTextLength,
 int maximumTextLength,
 BarcodeDefectProfile barcodeDefectProfile,
 ConfigState blurryOneDScanner)

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

minimumTextLength - Minimum text length. Applied only to linear barcode formats that allow variable length. Default is `1`.

maximumTextLength - Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length. Default is `0`.

barcodeDefectProfile - Specifies which kind of barcode defects are tried to fix. Default is `GENERIC_AND_THERMAL`.

blurryOneDScanner - If ENABLE, the scanner will try extra-hard to scan linear barcodes that are heavily blurred or otherwise damaged. Default is `ENABLE`.

BarcodeFormatItfConfiguration

public BarcodeFormatItfConfiguration()

Constructs BarcodeFormatItfConfiguration with default parameters.

Method Details

getMinimumTextLength

public int getMinimumTextLength()

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

Returns:

minimumTextLength

setMinimumTextLength

public void setMinimumTextLength(int minimumTextLength)

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

Parameters:

minimumTextLength - Value to set.

getMaximumTextLength

public int getMaximumTextLength()

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

Returns:

maximumTextLength

setMaximumTextLength

public void setMaximumTextLength(int maximumTextLength)

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

Parameters:

maximumTextLength - Value to set.

getBarcodeDefectProfile

public BarcodeDefectProfile getBarcodeDefectProfile()

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

Returns:

barcodeDefectProfile

setBarcodeDefectProfile

public void setBarcodeDefectProfile(BarcodeDefectProfile barcodeDefectProfile)

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

Parameters:

barcodeDefectProfile - Value to set.

getBlurryOneDScanner

public ConfigState getBlurryOneDScanner()

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

Returns:

blurryOneDScanner

setBlurryOneDScanner

public void setBlurryOneDScanner(ConfigState blurryOneDScanner)

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

Parameters:

blurryOneDScanner - Value to set.