Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / filter / gri_mmse_fir_interpolator_cc.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2002,2007 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 3, 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 #ifndef _GRI_MMSE_FIR_INTERPOLATOR_CC_H_
23 #define _GRI_MMSE_FIR_INTERPOLATOR_CC_H_
24
25 #include <gr_complex.h>
26 #include <vector>
27
28 class gr_fir_ccf;
29
30 /*!
31  * \brief Compute intermediate samples between signal samples x(k*Ts)
32  * \ingroup filter_primitive
33  *
34  * This implements a Mininum Mean Squared Error interpolator with 8 taps.
35  * It is suitable for signals where the bandwidth of interest B = 1/(4*Ts)
36  * Where Ts is the time between samples.
37  *
38  * Although mu, the fractional delay, is specified as a float, it is actually
39  * quantized.  0.0 <= mu <= 1.0.  That is, mu is quantized in the interpolate 
40  * method to 32nd's of a sample.
41  */
42
43 class gri_mmse_fir_interpolator_cc {
44 public:
45   gri_mmse_fir_interpolator_cc ();
46   ~gri_mmse_fir_interpolator_cc ();
47
48   unsigned ntaps () const;
49   unsigned nsteps () const;
50
51   /*!
52    * \brief compute a single interpolated output value.
53    *
54    * \p input must have ntaps() valid entries and be 8-byte aligned.
55    * input[0] .. input[ntaps() - 1] are referenced to compute the output value.
56    * \throws std::invalid_argument if input is not 8-byte aligned.
57    *
58    * \p mu must be in the range [0, 1] and specifies the fractional delay.
59    *
60    * \returns the interpolated input value.
61    */
62   gr_complex interpolate (const gr_complex input[], float mu);
63
64 protected:
65   std::vector<gr_fir_ccf *>     filters;
66 };
67
68
69 #endif /* _GRI_MMSE_FIR_INTERPOLATOR_CC_H_ */