Reed-Solomon Coding

A Python wrapper around the AFF3CT [1] project, transferring the Reed-Solomon [2] implementations to the Hermes forward error correction pipeline structure.

class ReedSolomonCoding(self: hermespy.fec.aff3ct.rs.ReedSolomonCoding, arg0: SupportsInt | SupportsIndex, arg1: SupportsInt | SupportsIndex)

Bases: pybind11_object

Parameters:

• data_block_size – Number of data bits per block to be encoded.

• correction_power – Number of symbol errors the coding may correct.

decode(self: hermespy.fec.aff3ct.rs.ReedSolomonCoding, arg0: Annotated[numpy.typing.ArrayLike, numpy.int32]) → numpy.typing.NDArray[numpy.int32]

Decode a block of code bits to data bits.

Parameters:

code – The code bit block to be decoded.

Returns: The data bit block after decoding.

encode(self: hermespy.fec.aff3ct.rs.ReedSolomonCoding, arg0: Annotated[numpy.typing.ArrayLike, numpy.int32]) → numpy.typing.NDArray[numpy.int32]

Encode a block of data bits to code bits.

Parameters:

data – The data bit block to be encoded.

Returns: The code bit block after encoding.

property bit_block_size

Number of bits within a data block to be encoded.

property code_block_size

Number of bits within a code block to be decoded.

property correction_power

Number of symbol errors the coding may correct.

enabled = True

property rate

The coding rate.

[1]

A. Cassagne, O. Hartmann, M. Léonardon, K. He, C. Leroux, R. Tajan, O. Aumage, D. Barthou, T. Tonnellier, V. Pignoly, B. Le Gal, and C. Jégo. Aff3ct: a fast forward error correction toolbox! Elsevier SoftwareX, 10:100345, October 2019. URL: http://www.sciencedirect.com/science/article/pii/S2352711019300457, doi:https://doi.org/10.1016/j.softx.2019.100345.

[2]

I. S. Reed and G. Solomon. Polynomial codes over certain finite fields. Journal of the Society for Industrial and Applied Mathematics, 8(2):300–304, 1960. URL: https://doi.org/10.1137/0108018, arXiv:https://doi.org/10.1137/0108018, doi:10.1137/0108018.