boofcv.alg.fiducial.qrcode

Class ReidSolomonCodes

java.lang.Object

boofcv.alg.fiducial.qrcode.ReidSolomonCodes

public class ReidSolomonCodes
extends java.lang.Object

TODO Summarize

Code and code comments based on the tutorial at [1].

[1] Reed-Solomon Codes for Coders Viewed on September 28, 2017

Constructor Summary

Constructors

Constructor and Description
ReidSolomonCodes(int numBits, int primitive)

Method Summary

Modifier and Type	Method and Description
void	computeECC(org.ddogleg.struct.GrowQueue_I8 input, org.ddogleg.struct.GrowQueue_I8 output) Given the input message compute the error correction code for it
boolean	correct(org.ddogleg.struct.GrowQueue_I8 input, org.ddogleg.struct.GrowQueue_I8 ecc) Decodes the message and performs any necessary error correction
boolean	findErrorLocations_BruteForce(org.ddogleg.struct.GrowQueue_I8 errorLocator, int messageLength, org.ddogleg.struct.GrowQueue_I32 locations) Creates a list of bytes that have errors in them
void	setDegree(int degree)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReidSolomonCodes

public ReidSolomonCodes(int numBits,
                        int primitive)

Method Detail

setDegree

public void setDegree(int degree)

computeECC

public void computeECC(org.ddogleg.struct.GrowQueue_I8 input,
                       org.ddogleg.struct.GrowQueue_I8 output)

Given the input message compute the error correction code for it

Parameters:

input - Input message. Modified internally then returned to its initial state

output - error correction code

correct

public boolean correct(org.ddogleg.struct.GrowQueue_I8 input,
                       org.ddogleg.struct.GrowQueue_I8 ecc)

Decodes the message and performs any necessary error correction

Parameters:

input - (Input) Corrupted Message (Output) corrected message

ecc - (Input) error correction code for the message

Returns:

true if it was successful or false if it failed

findErrorLocations_BruteForce

public boolean findErrorLocations_BruteForce(org.ddogleg.struct.GrowQueue_I8 errorLocator,
                                             int messageLength,
                                             org.ddogleg.struct.GrowQueue_I32 locations)

Creates a list of bytes that have errors in them

Parameters:

errorLocator - (Input) Error locator polynomial. Coefficients from small to large.

messageLength - (Input) Length of the message + ecc.

locations - (Output) locations of bytes in message with errors.