Difference between revisions of "AGC2"

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...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
High performance Automatic Gain Control class with attack and decay rates.
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.
+
For Power the absolute value of the complex number is used.
  
 +
If the attack and decay rates are the same, this block is identical to [[AGC]]
 
== 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'')
+
; Attack_rate (''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).
+
: The update rate of the loop when in attack mode.
 
+
; Decay_rate (''R'')
; Param 2
+
: The update rate of the loop when in decay mode.
: blah blah blah
+
; Reference (''R'')
 +
: Reference value to adjust signal power to.
 +
; Gain (''R'')
 +
: Initial gain value.
 +
; Max gain (''R'')
 +
: Maximum gain value (0 for unlimited)
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 26:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/lib/agc2_cc_impl.cc Complex input]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/lib/agc2_ff_impl.cc Float input]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/include/gnuradio/analog/agc2.h Algorithms implementation]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/lib/agc2_cc_impl.h Complex input]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/lib/agc2_ff_impl.h Float input]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/include/gnuradio/analog/agc2_cc.h Complex input]
 +
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/include/gnuradio/analog/agc2_ff.h Float input]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/grc/analog_agc2_xx.block.yml Yaml]

Latest revision as of 16:15, 23 July 2019

High performance Automatic Gain Control class with attack and decay rates.

For Power the absolute value of the complex number is used.

If the attack and decay rates are the same, this block is identical to AGC

Parameters[edit]

(R): Run-time adjustable

Attack_rate (R)
The update rate of the loop when in attack mode.
Decay_rate (R)
The update rate of the loop when in decay mode.
Reference (R)
Reference value to adjust signal power to.
Gain (R)
Initial gain value.
Max gain (R)
Maximum gain value (0 for unlimited)

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
Complex input
Float input
Algorithms implementation
Header files
Complex input
Float input
Public header files
Complex input
Float input
Block definition
Yaml