GNU Radio 3.6.5.1 C++ API
gr_iir_filter_ffd.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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 
23 #ifndef INCLUDED_GR_IIR_FILTER_FFD_H
24 #define INCLUDED_GR_IIR_FILTER_FFD_H
25 
26 #include <gr_core_api.h>
27 #include <gr_sync_block.h>
28 #include <gri_iir.h>
29 #include <stdexcept>
30 
31 class gr_iir_filter_ffd;
34 gr_make_iir_filter_ffd (const std::vector<double> &fftaps,
35  const std::vector<double> &fbtaps) throw (std::invalid_argument);
36 
37 /*!
38  * \brief IIR filter with float input, float output and double taps
39  *
40  * This filter uses the Direct Form I implementation, where
41  * \p fftaps contains the feed-forward taps, and \p fbtaps the feedback ones.
42  *
43  *
44  * The input and output satisfy a difference equation of the form
45  \htmlonly
46  \f{
47  y[n] - \sum_{k=1}^{M} a_k y[n-k] = \sum_{k=0}^{N} b_k x[n-k]
48  \f}
49  \endhtmlonly
50 
51  \xmlonly
52  y[n] - \sum_{k=1}^{M} a_k y[n-k] = \sum_{k=0}^{N} b_k x[n-k]
53  \endxmlonly
54 
55  * with the corresponding rational system function
56  \htmlonly
57  \f{
58  H(z) = \ frac{\sum_{k=0}^{M} b_k z^{-k}}{1 - \sum_{k=1}^{N} a_k z^{-k}}
59  \f}
60  \endhtmlonly
61 
62  \xmlonly
63  H(z) = \ frac{\sum_{k=0}^{M} b_k z^{-k}}{1 - \sum_{k=1}^{N} a_k z^{-k}}
64  \endxmlonly
65 
66  * Note that some texts define the system function with a + in the denominator.
67  * If you're using that convention, you'll need to negate the feedback taps.
68  */
70 {
71  private:
73  gr_make_iir_filter_ffd (const std::vector<double> &fftaps,
74  const std::vector<double> &fbtaps) throw (std::invalid_argument);
75 
77  std::vector<double> d_new_fftaps;
78  std::vector<double> d_new_fbtaps;
79  bool d_updated;
80 
81  /*!
82  * Construct an IIR filter with the given taps
83  */
84  gr_iir_filter_ffd (const std::vector<double> &fftaps,
85  const std::vector<double> &fbtaps) throw (std::invalid_argument);
86 
87  public:
89 
90  void set_taps (const std::vector<double> &fftaps,
91  const std::vector<double> &fbtaps) throw (std::invalid_argument);
92 
93  int work (int noutput_items,
94  gr_vector_const_void_star &input_items,
95  gr_vector_void_star &output_items);
96 };
97 
98 #endif