Adding Doxygen comments to new FFT filter blocks.
[debian/gnuradio] / gnuradio-core / src / lib / filter / gri_fft_filter_ccc.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2010 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_GRI_FFT_FILTER_CCC_H
24 #define INCLUDED_GRI_FFT_FILTER_CCC_H
25
26 #include <gr_complex.h>
27 #include <vector>
28
29 class gri_fft_complex;
30
31 /*!
32  * \brief Fast FFT filter with gr_complex input, gr_complex output and gr_complex taps
33  * \ingroup filter_blk
34  */
35 class gri_fft_filter_ccc
36 {
37  private:
38   int                      d_ntaps;
39   int                      d_nsamples;
40   int                      d_fftsize;           // fftsize = ntaps + nsamples - 1
41   int                      d_decimation;
42   gri_fft_complex         *d_fwdfft;            // forward "plan"
43   gri_fft_complex         *d_invfft;            // inverse "plan"
44   std::vector<gr_complex>  d_tail;              // state carried between blocks for overlap-add
45   std::vector<gr_complex>  d_xformed_taps;      // Fourier xformed taps
46   std::vector<gr_complex>  d_new_taps;
47
48   void compute_sizes(int ntaps);
49   int tailsize() const { return d_ntaps - 1; }
50   
51  public:
52   /*!
53    * \brief Construct an FFT filter for complex vectors with the given taps and decimation rate.
54    *
55    * This is the basic implementation for performing FFT filter for fast convolution
56    * in other blocks for complex vectors (such as gr_fft_filter_ccc).
57    * \param decimation The decimation rate of the filter (int)
58    * \param taps       The filter taps (complex)
59    */
60   gri_fft_filter_ccc (int decimation, const std::vector<gr_complex> &taps);
61   ~gri_fft_filter_ccc ();
62
63   /*!
64    * \brief Set new taps for the filter.
65    *
66    * Sets new taps and resets the class properties to handle different sizes
67    * \param taps       The filter taps (complex)
68    */
69   int set_taps (const std::vector<gr_complex> &taps);
70   
71   /*!
72    * \brief Perform the filter operation
73    *
74    * \param nitems  The number of items to produce
75    * \param input   The input vector to be filtered
76    * \param output  The result of the filter operation
77    */
78   int filter (int nitems, const gr_complex *input, gr_complex *output);
79
80 };
81
82 #endif /* INCLUDED_GRI_FFT_FILTER_CCC_H */