Documentation

Application

Interfaces, Classes and Traits

QRDataModeInterface: Specifies the methods reqired for the data modules (Number, Alphanum, Byte and Kanji) and holds version information in several constants
LuminanceSourceInterface
QROutputInterface: Converts the data matrix into readable output
BitBuffer: Holds the raw binary data
EccLevel: This class encapsulates the four error correction levels defined by the QR code standard.
ECICharset
FormatInformation: Encapsulates a QR Code's format information, including the data mask used and error correction level.
GenericGFPoly: Represents a polynomial whose coefficients are elements of a GF.
GF256: This class contains utility methods for performing mathematical operations over the Galois Fields. Operations use a given primitive polynomial in calculations.
MaskPattern: ISO/IEC 18004:2000 Section 8.8.1
MaskPatternTester: Receives a QRData object and runs the mask pattern tests on it.
Mode: ISO 18004:2006, 6.4.1, Tables 2 and 3
ReedSolomonDecoder: Implements Reed-Solomon decoding, as the name implies.
ReedSolomonEncoder: ISO/IEC 18004:2000 Section 8.5 ff
Version
AlphaNum: Alphanumeric mode: 0 to 9, A to Z, space, $ % * + - . / :
Byte: Byte mode, ISO-8859-1 or UTF-8
ECI: Adds an ECI Designator
Kanji: Kanji mode: double-byte characters from the Shift JIS character set
Number: Numeric mode: decimal digits 0 to 9
QRCodeDataException: An exception container
QRData: Processes the binary data and maps it on a matrix which is then being returned
QRDataModeAbstract
QRMatrix: Holds a numerical representation of the final QR Code; maps the ECC coded binary data and applies the mask pattern
Binarizer: This class implements a local thresholding algorithm, which while slower than the GlobalHistogramBinarizer, is fairly efficient for what it does. It is designed for high frequency images of barcodes with black data on white backgrounds. For this application, it does a much better job than a global blackpoint with severe shadows and gradients.
BitMatrix
BitMatrixParser
Decoder: The main class which implements QR Code decoding -- as opposed to locating and extracting the QR Code from an image.
DecoderResult: Encapsulates the result of decoding a matrix of bits. This typically applies to 2D barcode formats. For now it contains the raw bytes obtained, as well as a String interpretation of those bytes, if applicable.
GDLuminanceSource: This class is used to help decode images from files which arrive as GD Resource It does not support rotation.
IMagickLuminanceSource: This class is used to help decode images from files which arrive as Imagick Resource It does not support rotation.
LuminanceSourceAbstract: The purpose of this class hierarchy is to abstract different bitmap implementations across platforms into a standard interface for requesting greyscale luminance values. The interface only provides immutable methods; therefore crop and rotation create copies. This is to ensure that one Reader does not modify the original luminance source and leave it in an unknown state for other Readers in the chain.
AlignmentPattern: Encapsulates an alignment pattern, which are the smaller square patterns found in all but the simplest QR Codes.
AlignmentPatternFinder: This class attempts to find alignment patterns in a QR Code. Alignment patterns look like finder patterns but are smaller and appear at regular intervals throughout the image.
Detector: Encapsulates logic that can detect a QR Code in an image, even if the QR Code is rotated or skewed, or partially obscured.
FinderPattern: Encapsulates a finder pattern, which are the three square patterns found in the corners of QR Codes. It also encapsulates a count of similar finder patterns, as a convenience to the finder's bookkeeping.
FinderPatternFinder: This class attempts to find finder patterns in a QR Code. Finder patterns are the square markers at three corners of a QR Code.
GridSampler: Implementations of this class can, given locations of finder patterns for a QR code in an image, sample the right points in the image to reconstruct the QR code, accounting for perspective distortion. It is abstracted since it is relatively expensive and should be allowed to take advantage of platform-specific optimized implementations, like Sun's Java Advanced Imaging library, but which may not be available in other environments such as J2ME, and vice versa.
PerspectiveTransform: This class implements a perspective transform in two dimensions. Given four source and four destination points, it will compute the transformation implied between them. The code is based directly upon section 3.4.2 of George Wolberg's "Digital Image Warping"; see pages 54-56.
ResultPoint: Encapsulates a point of interest in an image containing a barcode. Typically, this would be the location of a finder pattern or the corner of the barcode, for example.
QRCodeOutputException: An exception container
QRFpdf: QRFpdf output module (requires fpdf)
QRImage: Converts the matrix into GD images, raw or base64 output (requires ext-gd)
QRImagick: ImageMagick output module (requires ext-imagick)
QRMarkup: Converts the matrix into markup types: HTML, SVG, .
QROutputAbstract: common output abstract
QRString: Converts the matrix data into string types
QRCode: Turns a text string into a Model 2 QR Code
QRCodeException: An exception container
QROptions: The QRCode settings container
BitBufferTest: BitBuffer coverage test
MaskPatternTest
MaskPatternTesterTest: MaskPatternTester coverage test
AlphaNumTest: Tests the AlphaNum class
ByteTest: Tests the Byte class
DatainterfaceTestAbstract: The data interface test abstract
KanjiTest: Tests the Kanji class
NumberTest: Tests the Number class
QRMatrixTest: Tests the QRMatix class
QRFpdfTest: Tests the QRFpdf output module
QRImageTest: Tests the QRImage output module
QRImagickTest: Tests the QRImagick output module
QRMarkupTest: Tests the QRMarkup output module
QROutputTestAbstract: Test abstract for the several (built-in) output modules, should also be used to test custom output modules
QRStringTest: Tests the QRString output module
QRCodeReaderTest: Tests the QR Code reader
QRCodeTest: Tests basic functions of the QRCode class
QROptionsTest: QROptions test
QROptionsTrait: The QRCode plug-in settings & setter functionality