GNU Radio Manual and C++ API Reference  3.7.12.0
The Free & Open Software Radio Ecosystem
fft_vcc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2007,2008,2012,2018 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_FFT_FFT_VCC_H
24 #define INCLUDED_FFT_FFT_VCC_H
25 
26 #include <gnuradio/fft/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace fft {
31 
32  /*!
33  * \brief Compute forward or reverse FFT. complex vector in / complex vector out.
34  * \ingroup fourier_analysis_blk
35  *
36  * The FFT operation is defined for a vector \f$x\f$ with \f$N\f$ uniformly
37  * sampled points by
38  *
39  * \f[ X(a) = \sum_{k=0}^{N-1} x(a) \cdot e^{-j 2\pi k a / N} \f]
40  *
41  * \f$ X = FFT\{x\} \f$ is the the FFT transform of \f$x(a)\f$, \f$j\f$ is
42  * the imaginary unit, \f$k\f$ and \f$a\f$ range from \f$0\f$ to \f$N-1\f$.
43  *
44  * The IFFT operation is defined for a vector \f$y\f$ with \f$N\f$
45  * uniformly sampled points by
46  *
47  * \f[ Y(b) = \sum_{k=0}^{N-1} y(b) \cdot e^{j 2\pi k b / N} \f]
48  *
49  * \f$Y = IFFT\{y\}\f$ is the the inverse FFT transform of \f$y(b)\f$,
50  * \f$j\f$ is the imaginary unit, \f$k\f$ and \f$b\f$ range from \f$0\f$ to
51  * \f$N-1\f$.
52  *
53  * \b Note, that due to the underlying FFTW library, the output of a FFT
54  * followed by an IFFT (or the other way arround) will be scaled i.e.
55  * \f$FFT\{ \, IFFT\{x\} \,\} = N \cdot x \neq x\f$.
56  *
57  * \see http://www.fftw.org/faq/section3.html#whyscaled
58  */
59  class FFT_API fft_vcc : virtual public sync_block
60  {
61  public:
62 
63  // gr::fft::fft_vcc::sptr
64  typedef boost::shared_ptr<fft_vcc> sptr;
65  /*! \brief
66  * \param[in] fft_size N.
67  * \param[in] forward True performs FFT, False performs IFFT.
68  * \param[in] window Window function to be used.
69  * \param[in] shifted True moves DC carrier to the middle.
70  * \param[in] nthreads Number of underlying threads.
71  */
72  static sptr make(int fft_size, bool forward,
73  const std::vector<float> &window,
74  bool shift=false, int nthreads=1);
75 
76  virtual void set_nthreads(int n) = 0;
77 
78  virtual int nthreads() const = 0;
79 
80  virtual bool set_window(const std::vector<float> &window) = 0;
81  };
82 
83  } /* namespace fft */
84 } /* namespace gr */
85 
86 #endif /* INCLUDED_FFT_FFT_VCC_H */
Definition: window.h:34
Compute forward or reverse FFT. complex vector in / complex vector out.The FFT operation is defined f...
Definition: fft_vcc.h:59
#define FFT_API
Definition: gr-fft/include/gnuradio/fft/api.h:30
Include this header to use the message passing features.
Definition: logger.h:695
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
boost::shared_ptr< fft_vcc > sptr
Definition: fft_vcc.h:64