GNU Radio 3.6.5 C++ API

interp_fir_filter_ccf.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,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 /* WARNING: this file is machine generated. Edits will be overwritten */
00024 
00025 #ifndef INCLUDED_FILTER_INTERP_FIR_FILTER_CCF_H
00026 #define INCLUDED_FILTER_INTERP_FIR_FILTER_CCF_H
00027 
00028 #include <filter/api.h>
00029 #include <gr_sync_interpolator.h>
00030 
00031 namespace gr {
00032   namespace filter {
00033 
00034     /*!
00035      * \brief Interpolating FIR filter with gr_complex input, gr_complex output and float taps
00036      * \ingroup filter_blk
00037      *
00038      * \details
00039      * The fir_filter_XXX blocks create finite impulse response
00040      * (FIR) filters that perform the convolution in the time
00041      * domain:
00042      *
00043      * \code
00044      *   out = 0
00045      *   for i in ntaps:
00046      *      out += input[n-i] * taps[i]
00047      * \endcode
00048      *
00049      * The taps are a C++ vector (or Python list) of values of the
00050      * type specified by the third letter in the block's suffix. For
00051      * this block, the value is of type float. Taps can be
00052      * created using the firdes or optfir tools.
00053      *
00054      * These versions of the filter can also act as up-samplers
00055      * (or interpolators) by specifying an integer value for \p
00056      * interpolation.
00057      *
00058      */
00059     class FILTER_API interp_fir_filter_ccf : virtual public gr_sync_interpolator
00060     {
00061     public:
00062       // gr::filter::interp_fir_filter_ccf::sptr
00063       typedef boost::shared_ptr<interp_fir_filter_ccf> sptr;
00064 
00065       /*!
00066        * \brief Interpolating FIR filter with gr_complex input, gr_complex output, and float taps
00067        *
00068        * \param interpolation set the integer interpolation rate
00069        * \param taps a vector/list of taps of type float
00070        */
00071       static sptr make(unsigned interpolation,
00072                                   const std::vector<float> &taps);
00073 
00074       virtual void set_taps(const std::vector<float> &taps) = 0;
00075       virtual std::vector<float> taps() const = 0;
00076     };
00077 
00078   } /* namespace filter */
00079 } /* namespace gr */
00080 
00081 #endif /* INCLUDED_FILTER_INTERP_FIR_FILTER_CCF_H */