boofcv.alg.fiducial.qrcode

Class QrCode

java.lang.Object

boofcv.alg.fiducial.qrcode.QrCode

All Implemented Interfaces:

java.lang.Cloneable

public class QrCode
extends java.lang.Object
implements java.lang.Cloneable

Information for a detected QR Code.

Position Patterns (PP) have their vertices CCW order. The polygons are oriented such that the following sides are paired: ppCorner[1,2] paired ppRight[3,0] and ppCorner[2,3] paired ppDown[0,1].

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QrCode.Alignment Information related to a specific alignment pattern.
static class	QrCode.BlockInfo Specifies the format for a data block.
static class	QrCode.ErrorLevel Error correction level
static class	QrCode.Failure Specifies the step at which decoding failed
static class	QrCode.Mode The encoding mode.
static class	QrCode.VersionInfo

Field Summary

Fields

Modifier and Type	Field and Description
org.ddogleg.struct.FastQueue<QrCode.Alignment>	alignment Alignment pattern information
georegression.struct.shapes.Polygon2D_F64	bounds Approximate bounding box for QR-Code.
byte[]	corrected Raw byte data after error correction has been applied to it.
QrCode.ErrorLevel	error Level of error correction
QrCode.Failure	failureCause Specifies where the QR code parsing failed
georegression.struct.homography.Homography2D_F64	Hinv A homography transform from grid bit coordinates into image pixels.
static java.util.List<georegression.struct.point.Point2D_I32>[]	LOCATION_BITS Location of data bits in the code qr for each version.
QrCodeMaskPattern	mask Which masking pattern is applied
static int	MAX_VERSION Maximum possible version of a QR Code
java.lang.String	message If applicable the message is decoded into a sequence of characters.
QrCode.Mode	mode Text encoding mode
georegression.struct.shapes.Polygon2D_F64	ppCorner
georegression.struct.shapes.Polygon2D_F64	ppDown
georegression.struct.shapes.Polygon2D_F64	ppRight The finder pattern that is composed of the 3 position patterns.
byte[]	rawbits The raw byte data encoded into the QR Code.
double	threshCorner
double	threshDown
double	threshRight
int	version which version of QR code was found.
static int	VERSION_ENCODED_AT The QR code version after which and including version information is encoded into the QR code
static QrCode.VersionInfo[]	VERSION_INFO

Constructor Summary

Constructors

Constructor and Description
QrCode()

Method Summary

Modifier and Type	Method and Description
QrCode	clone()
int	getNumberOfDataBytes()
int	getNumberOfModules()
void	reset() Resets the QR-Code so that it's in its initial state.
void	set(QrCode o) Sets 'this' so that it's equivalent to 'o'.
static int	totalModules(int version)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_VERSION

public static final int MAX_VERSION

Maximum possible version of a QR Code

See Also:

Constant Field Values

VERSION_ENCODED_AT

public static final int VERSION_ENCODED_AT

The QR code version after which and including version information is encoded into the QR code

See Also:

Constant Field Values

VERSION_INFO

public static final QrCode.VersionInfo[] VERSION_INFO

LOCATION_BITS

public static final java.util.List<georegression.struct.point.Point2D_I32>[] LOCATION_BITS

Location of data bits in the code qr for each version. Precomputed for speed.

ppRight

public georegression.struct.shapes.Polygon2D_F64 ppRight

The finder pattern that is composed of the 3 position patterns. Orientation of corners in each position pattern goes in clockwise direction (when viewed in an image, CCW mathematically) 0 = top left, 1 = top right, 2 = bottom right, 3 = bottom left.

ppCorner

public georegression.struct.shapes.Polygon2D_F64 ppCorner

ppDown

public georegression.struct.shapes.Polygon2D_F64 ppDown

threshRight

public double threshRight

threshCorner

public double threshCorner

threshDown

public double threshDown

version

public int version

which version of QR code was found. 1 to 40

error

public QrCode.ErrorLevel error

Level of error correction

mask

public QrCodeMaskPattern mask

Which masking pattern is applied

alignment

public org.ddogleg.struct.FastQueue<QrCode.Alignment> alignment

Alignment pattern information

mode

public QrCode.Mode mode

Text encoding mode

rawbits

public byte[] rawbits

The raw byte data encoded into the QR Code. data + ecc

corrected

public byte[] corrected

Raw byte data after error correction has been applied to it. Only contains the data portion.

message

public java.lang.String message

If applicable the message is decoded into a sequence of characters.

failureCause

public QrCode.Failure failureCause

Specifies where the QR code parsing failed

bounds

public georegression.struct.shapes.Polygon2D_F64 bounds

Approximate bounding box for QR-Code. The bottom right corner is estimated by intersecting lines and should not be used in SFM applications. Order: top-left = 0. Top-right = 1, Bottom-Right = 2, Bottom-Left = 3.

Hinv

public georegression.struct.homography.Homography2D_F64 Hinv

A homography transform from grid bit coordinates into image pixels.

Constructor Detail

QrCode

public QrCode()

Method Detail

getNumberOfModules

public int getNumberOfModules()

getNumberOfDataBytes

public int getNumberOfDataBytes()

totalModules

public static int totalModules(int version)

reset

public void reset()

Resets the QR-Code so that it's in its initial state.

clone

public QrCode clone()

Overrides:

clone in class java.lang.Object

set

public void set(QrCode o)

Sets 'this' so that it's equivalent to 'o'.

Parameters:

o - The target object