Package io.scanbot.sdk.barcode

Class BarcodeFormatMsiPlesseyConfiguration

  • public class BarcodeFormatMsiPlesseyConfiguration
extends BarcodeFormatOneDConfigurationBase
    MSI Plessey barcode configuration. Add to scanner configuration to scan MSI Plessey barcodes.

    • Constructor Detail

      • BarcodeFormatMsiPlesseyConfiguration

        public BarcodeFormatMsiPlesseyConfiguration​(java.lang.String regexFilter,
                                            double minimumSizeScore,
                                            boolean addAdditionalQuietZone,
                                            int minimum1DQuietZoneSize,
                                            int minimum1DConfirmationCount,
                                            boolean stripCheckDigits,
                                            int minimumTextLength,
                                            int maximumTextLength,
                                            boolean enableOneDBlurScanner,
                                            java.util.List<MsiPlesseyChecksumAlgorithm> checksumAlgorithms)
        Constructs BarcodeFormatMsiPlesseyConfiguration 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
        minimum1DConfirmationCount - In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid. Default is 1
        stripCheckDigits - If true, the check digits are stripped from the result. Default is false
        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
        enableOneDBlurScanner - If true, barcodes with heavy blur or from far distance are tried to scan. Default is true
        checksumAlgorithms - List of MSI Plessey checksum algorithms to apply during scanning. A barcode is considered valid if it passes any of the checksum algorithms in the list. If the list is empty, no checksum validation is performed.

      • BarcodeFormatMsiPlesseyConfiguration

        public BarcodeFormatMsiPlesseyConfiguration()
        Constructs BarcodeFormatMsiPlesseyConfiguration with default parameters.

    • Method Detail

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

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

      • getEnableOneDBlurScanner

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

      • setEnableOneDBlurScanner

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

      • getChecksumAlgorithms

        public java.util.List<MsiPlesseyChecksumAlgorithm> getChecksumAlgorithms()
        Getter for checksumAlgorithms field. See constructor documentation for more information about the field.
        Returns:
        checksumAlgorithms

      • setChecksumAlgorithms

        public void setChecksumAlgorithms​(java.util.List<MsiPlesseyChecksumAlgorithm> checksumAlgorithms)
        Setter for checksumAlgorithms field. See constructor documentation for more information about the field.
        Parameters:
        checksumAlgorithms - Value to set.