Detect Peak: 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...")
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Detect the peak of a signal. If a peak is detected, this block outputs a 1, or it outputs 0's.
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.
 
Possible more information [https://www.gnuradio.org/doc/sphinx-3.7.0/analog/peak_detectors_blk.html#gnuradio.analog.dpll_bb here], but this block's wiki page needs to be improved.


== 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'')
; Period
: 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).
:  


; Param 2
; Gain (''R'')
: blah blah blah
:  


== Example Flowgraph ==
== Example Flowgraph ==
Line 19: Line 19:


== Source Files ==
== Source Files ==
dpll_bb is the referenced name for most files. Look at the Block definition below to see how the analog dpll_bb is built with the block name detect peak


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


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


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


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-analog/grc/analog_dpll_bb.block.yml analog_dpll_bb.block.yml]
 
; Test File
: [https://github.com/gnuradio/gnuradio/blob/main/gr-analog/python/analog/qa_dpll.py qa_dpll.py]

Latest revision as of 02:11, 2 August 2023

Detect the peak of a signal. If a peak is detected, this block outputs a 1, or it outputs 0's.


Possible more information here, but this block's wiki page needs to be improved.

Parameters

(R): Run-time adjustable

Period
Gain (R)

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

dpll_bb is the referenced name for most files. Look at the Block definition below to see how the analog dpll_bb is built with the block name detect peak

C++ files
dpll_bb_impl.cc
Header files
dpll_bb_impl.h
Public header files
dpll_bb.h
Block definition
analog_dpll_bb.block.yml
Test File
qa_dpll.py
Retrieved from "https://wiki.gnuradio.org/index.php?title=Detect_Peak&oldid=13274"