BCH Coding

A Python wrapper around the AFF3CT [1] project, transferring the Bose–Chaudhuri–Hocquenghem [2] code implementations to the Hermes forward error correction pipeline structure.

class BCHCoding(self: hermespy.fec.aff3ct.bch.BCHCoding, arg0: SupportsInt | SupportsIndex, arg1: SupportsInt | SupportsIndex, arg2: SupportsInt | SupportsIndex)[source]

Bases: pybind11_object

Parameters:

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

  • code_block_size (int) – Number of code bits per encoded block.

  • power (int) – Number of corretable bit errors.

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

Decode a block of code bits to data bits.

Parameters:

code (numpy.ndarray) – The code bit block to be decoded.

Returns:

The data bit block after decoding.

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

Encode a block of data bits to code bits.

Parameters:

data (numpy.ndarray) – The data bit block to be encoded.

Returns:

The code bit block after encoding.

property bit_block_size[source]

Number of bits within a data block to be encoded.

property code_block_size[source]

Number of bits within a code block to be decoded.

property correction_power[source]

Number of corretable bit errors.

enabled = True[source]
property rate[source]

Coding rate of the BCH code.