git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2004,2005,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 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_SINGLE_POLE_IIR_FILTER_CC_H
  24 #define INCLUDED_GR_SINGLE_POLE_IIR_FILTER_CC_H
  25
  26 #include <gr_sync_block.h>
  27 #include <gr_single_pole_iir.h>
  28 #include <gr_complex.h>
  29 #include <stdexcept>
  30
  31 class gr_single_pole_iir_filter_cc;
  32 typedef boost::shared_ptr<gr_single_pole_iir_filter_cc> gr_single_pole_iir_filter_cc_sptr;
  33
  34 gr_single_pole_iir_filter_cc_sptr
  35 gr_make_single_pole_iir_filter_cc (double alpha, unsigned int vlen=1);
  36
  37 /*!
  38  * \brief  single pole IIR filter with complex input, complex output
  39  * \ingroup filter_blk
  40  *
  41  * The input and output satisfy a difference equation of the form
  42
  43  \f[
  44  y[n] - (1-alpha) y[n-1] = alpha x[n]
  45  \f]
  46
  47  * with the corresponding rational system function
  48
  49  \f[
  50  H(z) = \frac{alpha}{1 - (1-alpha) z^{-1}}
  51  \f]
  52
  53  * Note that some texts define the system function with a + in the denominator.
  54  * If you're using that convention, you'll need to negate the feedback tap.
  55  */
  56 class gr_single_pole_iir_filter_cc : public gr_sync_block
  57 {
  58  private:
  59   friend gr_single_pole_iir_filter_cc_sptr
  60   gr_make_single_pole_iir_filter_cc (double alpha, unsigned int vlen);
  61
  62   unsigned int                                          d_vlen;
  63   std::vector<gr_single_pole_iir<gr_complex,gr_complex,double> >        d_iir;
  64
  65   gr_single_pole_iir_filter_cc (double alpha, unsigned int vlen);
  66
  67  public:
  68   ~gr_single_pole_iir_filter_cc ();
  69
  70   void set_taps (double alpha);
  71
  72   int work (int noutput_items,
  73             gr_vector_const_void_star &input_items,
  74             gr_vector_void_star &output_items);
  75 };
  76
  77 #endif