Package io.scanbot.sdk.barcode

Class BarcodeFormatUpcEanConfiguration

java.lang.Object
io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase
io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase
io.scanbot.sdk.barcode.BarcodeFormatUpcEanConfiguration
public class BarcodeFormatUpcEanConfiguration extends BarcodeFormatOneDConfigurationBase
UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.

  • Constructor Details

    • BarcodeFormatUpcEanConfiguration

      public BarcodeFormatUpcEanConfiguration(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, int minimumNumberOfRequiredFramesWithEqualRecognitionResult, OneDConfirmationMode oneDConfirmationMode, boolean stripCheckDigits, BarcodeDefectProfile barcodeDefectProfile, ConfigState blurryOneDScanner, ConfigState damagedBarcodeReconstruction, boolean ean8, boolean ean13, boolean upca, boolean upce, UpcEanExtensionBehavior extensions, int minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless, boolean convertUpceToUpca)
      Constructs BarcodeFormatUpcEanConfiguration 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`.
      stripCheckDigits - If true, the check digits are stripped from the result. Default is `false`.
      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`.
      damagedBarcodeReconstruction - If ENABLE, the scanner will try extra-hard to scan linear barcodes that are damaged in a way that every single scanline is corrupted, e.g. due to scratches, ink smudges, glare, or other damage or obstruction. Only affects the following barcode formats: Code39, Code128, Ean8, Ean13, and UpcA. Not used in low power or legacy mode. Default is `ENABLE`.
      ean8 - If true, scan and return valid EAN-8 barcodes. Default is `true`.
      ean13 - If true, scan and return valid EAN-13 barcodes. Default is `true`.
      upca - If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes. Default is `true`.
      upce - If true, scan and return valid UPC-E barcodes. Default is `true`.
      extensions - Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions. Default is `ALLOW_ANY`.
      minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless - In case that EAN/UPC barcodes both with and without extensions are allowed, we require this number of frames on which the standalone EAN or UPC (i.e. without extension) has to be detected to be considered as valid (live scanning only). EAN/UPC barcodes with extensions are more prone to slicing (incomplete decoding). Increasing the number of frames on which a barcode has to decode to the same content reduces the probability that an extension is accidentally missed. Default is `1`.
      convertUpceToUpca - UPC-E is a 6-digit code, that has its equivalent in UPC-A 12-digit code with number system 0 or 1. If true, convert this 6-digit code into the corresponding 12-digit code. If false, return the UPC-E code as is. Default is `false`.

    • BarcodeFormatUpcEanConfiguration

      public BarcodeFormatUpcEanConfiguration()
      Constructs BarcodeFormatUpcEanConfiguration with default parameters.

  • Method Details

    • getStripCheckDigits

      public boolean getStripCheckDigits()
      Getter for stripCheckDigits field. See constructor documentation for more information about the field.
      Returns:
      stripCheckDigits

    • setStripCheckDigits

      public void setStripCheckDigits(boolean stripCheckDigits)
      Setter for stripCheckDigits field. See constructor documentation for more information about the field.
      Parameters:
      stripCheckDigits - 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.

    • getDamagedBarcodeReconstruction

      public ConfigState getDamagedBarcodeReconstruction()
      Getter for damagedBarcodeReconstruction field. See constructor documentation for more information about the field.
      Returns:
      damagedBarcodeReconstruction

    • setDamagedBarcodeReconstruction

      public void setDamagedBarcodeReconstruction(ConfigState damagedBarcodeReconstruction)
      Setter for damagedBarcodeReconstruction field. See constructor documentation for more information about the field.
      Parameters:
      damagedBarcodeReconstruction - Value to set.

    • getEan8

      public boolean getEan8()
      Getter for ean8 field. See constructor documentation for more information about the field.
      Returns:
      ean8

    • setEan8

      public void setEan8(boolean ean8)
      Setter for ean8 field. See constructor documentation for more information about the field.
      Parameters:
      ean8 - Value to set.

    • getEan13

      public boolean getEan13()
      Getter for ean13 field. See constructor documentation for more information about the field.
      Returns:
      ean13

    • setEan13

      public void setEan13(boolean ean13)
      Setter for ean13 field. See constructor documentation for more information about the field.
      Parameters:
      ean13 - Value to set.

    • getUpca

      public boolean getUpca()
      Getter for upca field. See constructor documentation for more information about the field.
      Returns:
      upca

    • setUpca

      public void setUpca(boolean upca)
      Setter for upca field. See constructor documentation for more information about the field.
      Parameters:
      upca - Value to set.

    • getUpce

      public boolean getUpce()
      Getter for upce field. See constructor documentation for more information about the field.
      Returns:
      upce

    • setUpce

      public void setUpce(boolean upce)
      Setter for upce field. See constructor documentation for more information about the field.
      Parameters:
      upce - Value to set.

    • getExtensions

      public UpcEanExtensionBehavior getExtensions()
      Getter for extensions field. See constructor documentation for more information about the field.
      Returns:
      extensions

    • setExtensions

      public void setExtensions(UpcEanExtensionBehavior extensions)
      Setter for extensions field. See constructor documentation for more information about the field.
      Parameters:
      extensions - Value to set.

    • getMinimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless

      public int getMinimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless()
      Getter for minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless field. See constructor documentation for more information about the field.
      Returns:
      minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless

    • setMinimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless

      public void setMinimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless(int minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless)
      Setter for minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless field. See constructor documentation for more information about the field.
      Parameters:
      minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless - Value to set.

    • getConvertUpceToUpca

      public boolean getConvertUpceToUpca()
      Getter for convertUpceToUpca field. See constructor documentation for more information about the field.
      Returns:
      convertUpceToUpca

    • setConvertUpceToUpca

      public void setConvertUpceToUpca(boolean convertUpceToUpca)
      Setter for convertUpceToUpca field. See constructor documentation for more information about the field.
      Parameters:
      convertUpceToUpca - Value to set.