diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-03-13 23:03:15 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-03-13 23:03:15 -0400 |
| commit | 3e7d338c626a94b9073db3c57b90ab5d9f35b7f4 (patch) | |
| tree | 405a248bcdb0ecc781d55334239aaa0b2317cdb9 /gr-analog/include/analog/agc_ff.h | |
| parent | 9616494c07b86b8b76c3c49c66fe9dfa037989e7 (diff) | |
analog: added some documentation for a number of blocks.
Diffstat (limited to 'gr-analog/include/analog/agc_ff.h')
| -rw-r--r-- | gr-analog/include/analog/agc_ff.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/gr-analog/include/analog/agc_ff.h b/gr-analog/include/analog/agc_ff.h index 30d1ae1fd9..6046d6f645 100644 --- a/gr-analog/include/analog/agc_ff.h +++ b/gr-analog/include/analog/agc_ff.h @@ -42,6 +42,14 @@ namespace gr { // gr::analog::agc_ff::sptr typedef boost::shared_ptr<agc_ff> sptr; + /*! + * Build a floating point AGC loop block. + * + * \param rate the update rate of the loop. + * \param reference reference value to adjust signal power to. + * \param gain initial gain value. + * \param max_gain maximum gain value (0 for unlimited). + */ static sptr make(float rate = 1e-4, float reference = 1.0, float gain = 1.0, float max_gain = 0.0); |