GNU Radio 3.7.1 C++ API
kurtotic_equalizer_cc.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2011,2012 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_DIGITAL_KURTOTIC_EQUALIZER_CC_H
00024 #define INCLUDED_DIGITAL_KURTOTIC_EQUALIZER_CC_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/sync_decimator.h>
00028 
00029 namespace gr {
00030   namespace digital {
00031 
00032     /*!
00033      * \brief Implements a kurtosis-based adaptive equalizer on complex stream
00034      * \ingroup equalizers_blk
00035      *
00036      * \details
00037      * Warning: This block does not yet work.
00038      *
00039      * "Y. Guo, J. Zhao, Y. Sun, "Sign kurtosis maximization based blind
00040      * equalization algorithm," IEEE Conf. on Control, Automation,
00041      * Robotics and Vision, Vol. 3, Dec. 2004, pp. 2052 - 2057."
00042      */
00043     class DIGITAL_API kurtotic_equalizer_cc :
00044       virtual public sync_decimator
00045     {
00046     protected:
00047       virtual gr_complex error(const gr_complex &out) = 0;
00048       virtual void update_tap(gr_complex &tap, const gr_complex &in) = 0;
00049   
00050     public:
00051       // gr::digital::kurtotic_equalizer_cc::sptr
00052       typedef boost::shared_ptr<kurtotic_equalizer_cc> sptr;
00053 
00054       static sptr make(int num_taps, float mu);
00055 
00056       virtual float gain() const = 0;
00057       virtual void set_gain(float mu) = 0;
00058     };
00059 
00060   } /* namespace digital */
00061 } /* namespace gr */
00062 
00063 #endif /* INCLUDED_DIGITAL_KURTOTIC_EQUALIZER_CC_H */