GNU Radio v3.6.2-149-ga6d285d9 C++ API
filter_delay_fc.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 #ifndef INCLUDED_FILTER_FILTER_DELAY_FC_H
00024 #define INCLUDED_FILTER_FILTER_DELAY_FC_H
00025 
00026 #include <filter/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace filter {
00031     
00032     class FILTER_API filter_delay_fc : virtual public gr_sync_block
00033     {
00034     public:
00035 
00036       // gr::filter::filter_delay_fc::sptr
00037       typedef boost::shared_ptr<filter_delay_fc> sptr;
00038 
00039       /*!
00040        * \brief Filter-Delay Combination Block.
00041        * \ingroup filter_blk
00042        *
00043        * The block takes one or two float stream and outputs a complex
00044        * stream. 
00045        *
00046        * If only one float stream is input, the real output is a
00047        * delayed version of this input and the imaginary output is the
00048        * filtered output.
00049        *
00050        * If two floats are connected to the input, then the real
00051        * output is the delayed version of the first input, and the
00052        * imaginary output is the filtered output.
00053        *
00054        * The delay in the real path accounts for the group delay
00055        * introduced by the filter in the imaginary path. The filter
00056        * taps needs to be calculated before initializing this block.
00057        *
00058        */
00059       static sptr make(const std::vector<float> &taps);
00060     };
00061 
00062   } /* namespace filter */
00063 } /* namespace gr */
00064 
00065 #endif /* INCLUDED_FILTER_FILTER_DELAY_FC_H */