-
Notifications
You must be signed in to change notification settings - Fork 141
/
encoder.rst
63 lines (45 loc) · 1.7 KB
/
encoder.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. _enc-bch-encoder-parameters:
|BCH| Encoder parameters
------------------------
.. _enc-bch-enc-cw-size:
``--enc-cw-size, -N`` |image_required_argument|
"""""""""""""""""""""""""""""""""""""""""""""""
:Type: integer
:Examples: ``--enc-cw-size 127``
|factory::Encoder::parameters::p+cw-size,N|
:math:`N = 2^m – 1`, where :math:`m` is an integer from 3.
.. _enc-bch-enc-info-bits:
``--enc-info-bits, -K`` |image_required_argument|
"""""""""""""""""""""""""""""""""""""""""""""""""
:Type: integer
:Examples: ``--enc-info-bits 92``
|factory::Encoder::parameters::p+info-bits,K|
This argument is not required if :ref:`dec-bch-dec-corr-pow` is given, as it
is calculated automatically.
.. _enc-bch-enc-type:
``--enc-type``
""""""""""""""
:Type: text
:Allowed values: ``BCH`` ``AZCW`` ``COSET`` ``USER``
:Default: ``BCH``
:Examples: ``--enc-type AZCW``
|factory::Encoder::parameters::p+type|
Description of the allowed values:
+-----------+------------------------+
| Value | Description |
+===========+========================+
| ``BCH`` | |enc-type_descr_bch| |
+-----------+------------------------+
| ``AZCW`` | |enc-type_descr_azcw| |
+-----------+------------------------+
| ``COSET`` | |enc-type_descr_coset| |
+-----------+------------------------+
| ``USER`` | |enc-type_descr_user| |
+-----------+------------------------+
.. |enc-type_descr_bch| replace:: Select the standard |BCH| encoder.
.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`
parameter.
.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`
parameter.
.. |enc-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`
parameter.