Difference between revisions of "Regenerate"

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...")
 
 
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Detect the peak of a signal and repeat every period samples.
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.
 
If a peak is detected, this block outputs a 1 repeated every period samples until reset by detection of another 1 on the input or stopped after Max Regen Count regenerations have occurred.


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>


; 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).
: The number of samples between regenerations.


; Param 2
; Max Regen Count
: blah blah blah
: The maximum number of regenerations to perform; if set to -1 or ULONG_MAX, it will regenerate continuously.


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

Latest revision as of 16:45, 20 August 2019

Detect the peak of a signal and repeat every period samples.

If a peak is detected, this block outputs a 1 repeated every period samples until reset by detection of another 1 on the input or stopped after Max Regen Count regenerations have occurred.


Parameters[edit]

Period
The number of samples between regenerations.
Max Regen Count
The maximum number of regenerations to perform; if set to -1 or ULONG_MAX, it will regenerate continuously.

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
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO