Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gri_agc2_cc.i
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include <math.h>
24
25 /*!
26  * \brief high performance Automatic Gain Control class with attack and decay rates
27  *
28  * For Power the absolute value of the complex number is used.
29  */
30
31
32 class gri_agc2_cc {
33
34  public:
35   gri_agc2_cc (float attack_rate = 1e-1, float decay_rate = 1e-2, float reference = 1.0, 
36                float gain = 1.0, float max_gain = 0.0);
37   float decay_rate ();
38   float attack_rate ();
39   float reference ();
40   float gain ();
41   float max_gain ();
42   };