Imported Upstream version 3.2.2
[debian/gnuradio] / grc / blocks / blks2_error_rate.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##Error Rate:
5 ##      Custom blks2 block
6 ###################################################
7  -->
8 <block>
9         <name>Error Rate</name>
10         <key>blks2_error_rate</key>
11         <import>from grc_gnuradio import blks2 as grc_blks2</import>
12         <make>grc_blks2.error_rate(
13         type=$type,
14         win_size=$win_size,
15         bits_per_symbol=$bits_per_symbol,
16 )</make>
17         <param>
18                 <name>Type</name>
19                 <key>type</key>
20                 <type>enum</type>
21                 <option>
22                         <name>Bit Error Rate</name>
23                         <key>'BER'</key>
24                         <opt>hide_bps:</opt>
25                 </option>
26                 <option>
27                         <name>Symbol Error Rate</name>
28                         <key>'SER'</key>
29                         <opt>hide_bps:all</opt>
30                 </option>
31         </param>
32         <param>
33                 <name>Window Size</name>
34                 <key>win_size</key>
35                 <value>1000</value>
36                 <type>int</type>
37         </param>
38         <param>
39                 <name>Bits per Symbol</name>
40                 <key>bits_per_symbol</key>
41                 <value>2</value>
42                 <type>int</type>
43                 <hide>$type.hide_bps</hide>
44         </param>
45         <sink>
46                 <name>ref</name>
47                 <type>byte</type>
48         </sink>
49         <sink>
50                 <name>in</name>
51                 <type>byte</type>
52         </sink>
53         <source>
54                 <name>out</name>
55                 <type>float</type>
56         </source>
57         <doc>
58 Calculate the bit error rate (BER) or the symbol error rate (SER) over a number of samples given by the window size. \
59 The actual window size will start at size one and grow to the full window size as new samples arrive. \
60 Once the window has reached full size, old samples are shifted out of the window and new samples shfited in.
61
62 The error block compares the input byte stream to the reference byte stream. \
63 For example, the reference byte stream could be the input to a modulator, \
64 and the input byte stream could be the output of a modulator.
65
66 Each byte in the incoming stream represents one symbol. \
67 The bits per symbol parameter is only useful for calculating the BER.
68         </doc>
69 </block>