Probe Rate: Difference between revisions

From GNU Radio
Jump to navigation Jump to 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...")
 
(fix links)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
__NOTOC__
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.
<span id="gr_vad"></span>
 
Used to measure throughput (how many items/samples are flowing through per second).  Note that this block outputs a message, you will need to use a [[Message Debug]] to display the probe results in the console.
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; Min Update Time (ms)
: Minimum update time in milliseconds


; Param 1 (''R'')
; Update Alpha
: 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).
: Gain for running average filter


; Param 2
<div data-vad="3.10,later">
: blah blah blah
; Name
: Specify for identification of the the Probe Rate block. Useful, for example, when printing the output of multiple Probe Rate blocks, e.g., with [[Message Debug]]
</div>


== Example Flowgraph ==
== Example Flowgraph ==


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.
In this flowgraph, the Probe Rate block is measuring the sample rate of the Audio Source block.
 
[[File:USRP_NBFM_xmt.png|800px]]


== Source Files ==
== Source Files ==


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/probe_rate_impl.cc probe_rate_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/probe_rate_impl.h probe_rate_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/probe_rate.h probe_rate.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_probe_rate.block.yml blocks_probe_rate.block.yml]

Latest revision as of 17:46, 29 November 2023


Used to measure throughput (how many items/samples are flowing through per second). Note that this block outputs a message, you will need to use a Message Debug to display the probe results in the console.

Parameters

Min Update Time (ms)
Minimum update time in milliseconds
Update Alpha
Gain for running average filter
Name
Specify for identification of the the Probe Rate block. Useful, for example, when printing the output of multiple Probe Rate blocks, e.g., with Message Debug

Example Flowgraph

In this flowgraph, the Probe Rate block is measuring the sample rate of the Audio Source block.

USRP NBFM xmt.png

Source Files

C++ files
probe_rate_impl.cc
Header files
probe_rate_impl.h
Public header files
probe_rate.h
Block definition
blocks_probe_rate.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=Probe_Rate&oldid=13645"