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

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