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/agc2_ff.h | |
| parent | 9616494c07b86b8b76c3c49c66fe9dfa037989e7 (diff) | |
analog: added some documentation for a number of blocks.
Diffstat (limited to 'gr-analog/include/analog/agc2_ff.h')
| -rw-r--r-- | gr-analog/include/analog/agc2_ff.h | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/gr-analog/include/analog/agc2_ff.h b/gr-analog/include/analog/agc2_ff.h index 27dd6d92e5..4bb7b0f646 100644 --- a/gr-analog/include/analog/agc2_ff.h +++ b/gr-analog/include/analog/agc2_ff.h @@ -31,7 +31,8 @@ namespace gr { namespace analog { /*! - * \brief high performance Automatic Gain Control class + * \brief high performance Automatic Gain Control class with + * attack and decay rates. * * \ingroup level_blk * Power is approximated by absolute value @@ -42,6 +43,15 @@ namespace gr { // gr::analog::agc2_ff::sptr typedef boost::shared_ptr<agc2_ff> sptr; + /*! + * Build a floating point AGC loop block with attack and decay rates. + * + * \param attack_rate the update rate of the loop when in attack mode. + * \param decay_rate the update rate of the loop when in decay mode. + * \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 attack_rate = 1e-1, float decay_rate = 1e-2, float reference = 1.0, float gain = 1.0, float max_gain = 0.0); |