boofcv.alg.fiducial.qrcode

Class QrCodeEncoder

java.lang.Object

boofcv.alg.fiducial.qrcode.QrCodeEncoder

public class QrCodeEncoder
extends java.lang.Object

Provides an easy to use interface for specifying QR-Code parameters and generating the raw data sequence. After the QR Code has been created using this class it can then be rendered. By default it will select the qr code version based on the number of bits and the error correction level based on the version and number of bits. If the error correction isn't specified and the version isn't specified then error correction level M is used by default.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALPHANUMERIC All the possible values in alphanumeric mode.

Constructor Summary

Constructors

Constructor and Description
QrCodeEncoder()

Method Summary

Modifier and Type	Method and Description
QrCodeEncoder	addAlphanumeric(java.lang.String alphaNumeric) Creates a QR-Code which encodes data in the alphanumeric format
QrCodeEncoder	addAutomatic(java.lang.String message) Select the encoding based on the letters in the message.
QrCodeEncoder	addBytes(byte[] data) Creates a QR-Code which encodes data in the byte format.
QrCodeEncoder	addBytes(java.lang.String message)
QrCodeEncoder	addKanji(java.lang.String message) Creates a QR-Code which encodes Kanji characters
QrCodeEncoder	addNumeric(byte[] numbers) Creates a QR-Code which encodes a number sequence
QrCodeEncoder	addNumeric(java.lang.String message) Creates a QR-Code which encodes a number sequence
static byte[]	alphanumericToValues(java.lang.String data)
protected void	bitsToMessage(PackedBits8 stream)
QrCode	eci()
QrCode	fixate() Call this function after you are done adding to the QR code
static void	flipBits8(byte[] array, int size)
static void	flipBits8(org.ddogleg.struct.GrowQueue_I8 array)
static byte	flipBits8(int x)
static int	getLengthBitsAlphanumeric(int version)
static int	getLengthBitsBytes(int version)
static int	getLengthBitsKanji(int version)
static int	getLengthBitsNumeric(int version)
void	reset()
QrCodeEncoder	setError(QrCode.ErrorLevel level)
QrCodeEncoder	setMask(QrCodeMaskPattern pattern)
QrCodeEncoder	setVersion(int version)
static char	valueToAlphanumeric(int value)

Methods inherited from class java.lang.Object

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

Field Detail

ALPHANUMERIC

public static final java.lang.String ALPHANUMERIC

All the possible values in alphanumeric mode.

See Also:

Constant Field Values

Constructor Detail

QrCodeEncoder

public QrCodeEncoder()

Method Detail

reset

public void reset()

setVersion

public QrCodeEncoder setVersion(int version)

setError

public QrCodeEncoder setError(QrCode.ErrorLevel level)

setMask

public QrCodeEncoder setMask(QrCodeMaskPattern pattern)

addAutomatic

public QrCodeEncoder addAutomatic(java.lang.String message)

Select the encoding based on the letters in the message. A very simple algorithm is used internally.

addNumeric

public QrCodeEncoder addNumeric(java.lang.String message)

Creates a QR-Code which encodes a number sequence

Parameters:

message - String that specifies numbers and no other types. Each number has to be from 0 to 9 inclusive.

Returns:

The QR-Code

addNumeric

public QrCodeEncoder addNumeric(byte[] numbers)

Creates a QR-Code which encodes a number sequence

Parameters:

numbers - Array of numbers. Each number has to be from 0 to 9 inclusive.

Returns:

The QR-Code

addAlphanumeric

public QrCodeEncoder addAlphanumeric(java.lang.String alphaNumeric)

Creates a QR-Code which encodes data in the alphanumeric format

Parameters:

alphaNumeric - String containing only alphanumeric values.

Returns:

The QR-Code

alphanumericToValues

public static byte[] alphanumericToValues(java.lang.String data)

valueToAlphanumeric

public static char valueToAlphanumeric(int value)

addBytes

public QrCodeEncoder addBytes(java.lang.String message)

addBytes

public QrCodeEncoder addBytes(byte[] data)

Creates a QR-Code which encodes data in the byte format.

Parameters:

data - Data to be encoded

Returns:

The QR-Code

addKanji

public QrCodeEncoder addKanji(java.lang.String message)

Creates a QR-Code which encodes Kanji characters

Parameters:

message - Data to be encoded

Returns:

The QR-Code

getLengthBitsNumeric

public static int getLengthBitsNumeric(int version)

getLengthBitsAlphanumeric

public static int getLengthBitsAlphanumeric(int version)

getLengthBitsBytes

public static int getLengthBitsBytes(int version)

getLengthBitsKanji

public static int getLengthBitsKanji(int version)

eci

public QrCode eci()

fixate

public QrCode fixate()

Call this function after you are done adding to the QR code

Returns:

The generated QR Code

bitsToMessage

protected void bitsToMessage(PackedBits8 stream)

flipBits8

public static void flipBits8(byte[] array,
                             int size)

flipBits8

public static void flipBits8(org.ddogleg.struct.GrowQueue_I8 array)

flipBits8

public static byte flipBits8(int x)