GNU Radio 3.6.5 C++ API

gr_adaptive_fir_ccf.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_ADAPTIVE_FIR_CCF_H
00024 #define INCLUDED_GR_ADAPTIVE_FIR_CCF_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_sync_decimator.h>
00028 
00029 /*!
00030  * \brief Adaptive FIR filter with gr_complex input, gr_complex output and float taps
00031  */
00032 class GR_CORE_API gr_adaptive_fir_ccf : public gr_sync_decimator
00033 {
00034 private:
00035   std::vector<float>  d_new_taps;
00036   bool                d_updated;
00037 
00038 protected:
00039   float               d_error;
00040   std::vector<float>  d_taps;
00041 
00042   // Override to calculate error signal per output
00043   virtual float error(const gr_complex &out) = 0;
00044 
00045   // Override to calculate new weight from old, corresponding input
00046   virtual void update_tap(float &tap, const gr_complex &in) = 0;
00047 
00048   gr_adaptive_fir_ccf(const char *name, int decimation, const std::vector<float> &taps);
00049 
00050 public:
00051   void set_taps(const std::vector<float> &taps);
00052 
00053   int work(int noutput_items,
00054            gr_vector_const_void_star &input_items,
00055            gr_vector_void_star &output_items);
00056 };
00057 
00058 #endif