Difference between revisions of "AGC3"

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...")
 
 
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.
+
Unlike the [[AGC2]] loop, this uses an initial linear calculation at the beginning for very fast initial acquisition. Moves to IIR model for tracking purposes.
 +
For Power the absolute value of the complex number is used.
  
 
== 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'')
 +
: 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)
 +
; IIR update decimation
 +
: Stride by this number of samples before computing an IIR gain update
  
; Param 2
 
: blah blah blah
 
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 29:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/lib/agc3_cc_impl.cc Here]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/lib/agc3_cc_impl.h Here]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/include/gnuradio/analog/agc3_cc.h Here]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/grc/analog_agc3_xx.block.yml Yaml]

Latest revision as of 16:37, 23 July 2019

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

Unlike the AGC2 loop, this uses an initial linear calculation at the beginning for very fast initial acquisition. Moves to IIR model for tracking purposes. For Power the absolute value of the complex number is used.

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)
IIR update decimation
Stride by this number of samples before computing an IIR gain update


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