Package boofcv.alg.fiducial.aztec

Class AztecEncoder

java.lang.Object

boofcv.alg.fiducial.aztec.AztecMessageErrorCorrection

boofcv.alg.fiducial.aztec.AztecEncoder

public class AztecEncoder
extends AztecMessageErrorCorrection

Encodes the data message into binary data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AztecEncoder.MessageSegment	Contains the data for a sequence of characters that are all encoded in the same mode

Field Summary

Fields

Modifier and Type	Field	Description
double	errorCorrectionLength	Amount of error correction is determined by this number.

Fields inherited from class boofcv.alg.fiducial.aztec.AztecMessageErrorCorrection

ecc10, ecc12, ecc6, ecc8, storageDataWords, storageEccWords

Constructor Summary

Constructors

Constructor	Description
AztecEncoder()

Method Summary

Modifier and Type	Method	Description
AztecEncoder	addAutomatic(String message)	Automatically select which encoding mode it should encode this message.
AztecEncoder	addBytes(byte[] data, int offset, int length)
AztecEncoder	addDigit(String message)
AztecEncoder	addLower(String message)
AztecEncoder	addMixed(String message)
AztecEncoder	addPunctuation(String message)
AztecEncoder	addUpper(String message)
AztecCode	fixate()	Encodes into binary data all the segments, computes ECC, and constructs the final marker.
void	reset()
AztecEncoder	setEcc(double fraction)
AztecEncoder	setLayers(int numLayers)
AztecEncoder	setStructure(AztecCode.Structure structure)

Methods inherited from class boofcv.alg.fiducial.aztec.AztecMessageErrorCorrection

applyErrorCorrection, computeEccWords

Methods inherited from class java.lang.Object

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

Field Details

errorCorrectionLength

public double errorCorrectionLength

Amount of error correction is determined by this number. ecc_words = errorCorrectionLength*code_words - 3. Larger values will require more data and larger markers, but do offer more fault tolerance. See G.2 in ISO document.

Constructor Details

AztecEncoder

public AztecEncoder()

Method Details

reset

public void reset()

setEcc

public AztecEncoder setEcc(double fraction)

setStructure

public AztecEncoder setStructure(AztecCode.Structure structure)

setLayers

public AztecEncoder setLayers(int numLayers)

addUpper

public AztecEncoder addUpper(String message)

addLower

public AztecEncoder addLower(String message)

addMixed

public AztecEncoder addMixed(String message)

addPunctuation

public AztecEncoder addPunctuation(String message)

addDigit

public AztecEncoder addDigit(String message)

addBytes

public AztecEncoder addBytes(byte[] data,
 int offset,
 int length)

addAutomatic

public AztecEncoder addAutomatic(String message)

Automatically select which encoding mode it should encode this message. This will select the most efficient encoding possible.

fixate

public AztecCode fixate()

Encodes into binary data all the segments, computes ECC, and constructs the final marker. Anything which is not explicitly specified will have a reasonable value auto selected.

Returns:

Returns a new marker.