Difference between revisions of "BER"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
(clarify description)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This block measures the bit error rate between two streams of packed data. It compares the bits of each streams and counts the number of incorrect bits between them. It outputs the log of the bit error rate, so a value of -X is 10^{-X} bit errors.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]]. This first section should describe what the block does and how to use it, using however many paragraphs necessary. Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
When <code>Test Mode</code> is set to false (default), it is in streaming mode. This means that the output is constantly producing the current value of the BER. In this mode, there is a single output BER calculation per chunk of bytes passed to it, so there is no exact timing between calculations of BER. In this mode, the other two parameters to the constructor are ignored.
 +
 
 +
<code>Test Mode</code> equals true is used in the ber_curve_gen example and for other offline analysis of BER curves. Here, the block waits until at least<br> <code>BER Min Errors</code> are observed and then produces a BER calculation. The parameter <code>BER Limit</code> helps make sure that the simulation is controlled. If the BER calculation drops below the <code>BER Limit</code> setting, the block will exit and simply return the set limit; the real BER is therefore some amount lower than this.
 +
 
 +
Note that this block takes in data as packed bytes with 8-bits per byte used. It outputs a stream of floats as the log-scale BER.
  
 
== Parameters ==
 
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
+
; Test Mode
 +
: False for normal streaming mode (default); true for test mode.
  
; Param 1 (''R'')
+
; BER Min Errors
: Description of parameter, provide any tips or recommended values. Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
+
: The block needs to observe this many errors before outputting a result. Only valid when test_mode=true.
  
; Param 2
+
; BER Limit
: blah blah blah
+
: If the BER calculation falls below this limit, produce this value and exit. Only valid when test_mode=true.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 25:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ber_bf_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ber_bf_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/ber_bf.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/fec_ber_bf.block.yml]

Latest revision as of 14:59, 18 April 2020

This block measures the bit error rate between two streams of packed data. It compares the bits of each streams and counts the number of incorrect bits between them. It outputs the log of the bit error rate, so a value of -X is 10^{-X} bit errors.

When Test Mode is set to false (default), it is in streaming mode. This means that the output is constantly producing the current value of the BER. In this mode, there is a single output BER calculation per chunk of bytes passed to it, so there is no exact timing between calculations of BER. In this mode, the other two parameters to the constructor are ignored.

Test Mode equals true is used in the ber_curve_gen example and for other offline analysis of BER curves. Here, the block waits until at least
BER Min Errors are observed and then produces a BER calculation. The parameter BER Limit helps make sure that the simulation is controlled. If the BER calculation drops below the BER Limit setting, the block will exit and simply return the set limit; the real BER is therefore some amount lower than this.

Note that this block takes in data as packed bytes with 8-bits per byte used. It outputs a stream of floats as the log-scale BER.

Parameters[edit]

Test Mode
False for normal streaming mode (default); true for test mode.
BER Min Errors
The block needs to observe this many errors before outputting a result. Only valid when test_mode=true.
BER Limit
If the BER calculation falls below this limit, produce this value and exit. Only valid when test_mode=true.

Example Flowgraph[edit]

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files[edit]

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]