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

   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_sync_block.h>
  27 #include <gri_iir.h>
  28 #include <stdexcept>
  29
  30 class gr_iir_filter_ffd;
  31 typedef boost::shared_ptr<gr_iir_filter_ffd> gr_iir_filter_ffd_sptr;
  32 gr_iir_filter_ffd_sptr
  33 gr_make_iir_filter_ffd (const std::vector<double> &fftaps,
  34                         const std::vector<double> &fbtaps) throw (std::invalid_argument);
  35
  36 /*!
  37  * \brief  IIR filter with float input, float output and double taps
  38  * \ingroup filter_blk
  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
  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
  50  * with the corresponding rational system function
  51
  52  \f[
  53  H(z) = \frac{\sum_{k=0}^{M} b_k z^{-k}}{1 - \sum_{k=1}^{N} a_k z^{-k}}
  54  \f]
  55
  56  * Note that some texts define the system function with a + in the denominator.
  57  * If you're using that convention, you'll need to negate the feedback taps.
  58  */
  59 class gr_iir_filter_ffd : public gr_sync_block
  60 {
  61  private:
  62   friend gr_iir_filter_ffd_sptr
  63   gr_make_iir_filter_ffd (const std::vector<double> &fftaps,
  64                           const std::vector<double> &fbtaps) throw (std::invalid_argument);
  65
  66   gri_iir<float,float,double>           d_iir;
  67   std::vector<double>                   d_new_fftaps;
  68   std::vector<double>                   d_new_fbtaps;
  69   bool                                  d_updated;
  70
  71   /*!
  72    * Construct an IIR filter with the given taps
  73    */
  74   gr_iir_filter_ffd (const std::vector<double> &fftaps,
  75                      const std::vector<double> &fbtaps) throw (std::invalid_argument);
  76
  77  public:
  78   ~gr_iir_filter_ffd ();
  79
  80   void set_taps (const std::vector<double> &fftaps,
  81                  const std::vector<double> &fbtaps) throw (std::invalid_argument);
  82
  83   int work (int noutput_items,
  84             gr_vector_const_void_star &input_items,
  85             gr_vector_void_star &output_items);
  86 };
  87
  88 #endif