Probe Avg Mag^2: 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...")
 
No edit summary
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Compute a running average of the magnitude squared of the the input. The level and indication as to whether the level exceeds threshold can be retrieved with the 'level' and 'unmuted' accessors.
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.
Use with the function probe block. Available functions to probe: level(), unmuted()
 
If the type is set to Complex->Float, the block will also output the values computed.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Threshold (dB) (''R'')
: 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).
: Threshold for muting.


; Param 2
; Alpha
: blah blah blah
: Gain parameter for the running average filter.


== Example Flowgraph ==
== Example Flowgraph ==
Line 30: Line 31:


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/grc/analog_probe_avg_mag_sqrd_x.block.yml]

Revision as of 09:30, 5 September 2019

Compute a running average of the magnitude squared of the the input. The level and indication as to whether the level exceeds threshold can be retrieved with the 'level' and 'unmuted' accessors.

Use with the function probe block. Available functions to probe: level(), unmuted()

If the type is set to Complex->Float, the block will also output the values computed.

Parameters

(R): Run-time adjustable

Threshold (dB) (R)
Threshold for muting.
Alpha
Gain parameter for the running average filter.

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.

Source Files

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
[1]
Retrieved from "https://wiki.gnuradio.org/index.php?title=Probe_Avg_Mag%5E2&oldid=6066"