Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 5613

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: gri_fft.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">GNU Radio 3.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('gri__fft_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gri_fft.h</h1>  </div>
</div>
<div class="contents">
<a href="gri__fft_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2003,2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _GRI_FFT_H_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _GRI_FFT_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="comment">/*</span>
<a name="l00026"></a>00026 <span class="comment"> * Wrappers for FFTW single precision 1d dft</span>
<a name="l00027"></a>00027 <span class="comment"> */</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;gr_complex.h&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;boost/thread.hpp&gt;</span>
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment">/*!</span>
<a name="l00033"></a>00033 <span class="comment"> * \brief Export reference to planner mutex for those apps that</span>
<a name="l00034"></a>00034 <span class="comment"> * want to use FFTW w/o using the gri_fftw* classes.</span>
<a name="l00035"></a>00035 <span class="comment"> */</span>
<a name="l00036"></a><a class="code" href="classgri__fft__planner.html">00036</a> <span class="keyword">class </span><a class="code" href="classgri__fft__planner.html" title="Export reference to planner mutex for those apps that want to use FFTW w/o using the gri_fftw* classe...">gri_fft_planner</a> {
<a name="l00037"></a>00037 <span class="keyword">public</span>:
<a name="l00038"></a><a class="code" href="classgri__fft__planner.html#a2af2c801dadbb8e205d537e4aed5e1c0">00038</a>   <span class="keyword">typedef</span> boost::mutex::scoped_lock <a class="code" href="classgri__fft__planner.html#a2af2c801dadbb8e205d537e4aed5e1c0">scoped_lock</a>;<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">  /*!</span>
<a name="l00040"></a>00040 <span class="comment">   * Return reference to planner mutex</span>
<a name="l00041"></a>00041 <span class="comment">   */</span>
<a name="l00042"></a>00042   <span class="keyword">static</span> boost::mutex &amp;<a class="code" href="classgri__fft__planner.html#a94afe83b4d307468601e0a8aa4e0ea63">mutex</a>();
<a name="l00043"></a>00043 };
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/*!</span>
<a name="l00046"></a>00046 <span class="comment"> * \brief FFT: complex in, complex out</span>
<a name="l00047"></a>00047 <span class="comment"> * \ingroup misc</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a><a class="code" href="classgri__fft__complex.html">00049</a> <span class="keyword">class </span><a class="code" href="classgri__fft__complex.html" title="FFT: complex in, complex out.">gri_fft_complex</a> {
<a name="l00050"></a>00050   <span class="keywordtype">int</span>         d_fft_size;
<a name="l00051"></a>00051   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *d_inbuf;
<a name="l00052"></a>00052   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *d_outbuf;
<a name="l00053"></a>00053   <span class="keywordtype">void</span>       *d_plan;
<a name="l00054"></a>00054   
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056   <a class="code" href="classgri__fft__complex.html#a6a7c2719faa5236fafdca4322a7d9f70">gri_fft_complex</a> (<span class="keywordtype">int</span> fft_size, <span class="keywordtype">bool</span> forward = <span class="keyword">true</span>);
<a name="l00057"></a>00057   <span class="keyword">virtual</span> <a class="code" href="classgri__fft__complex.html#a1cfc8e147bc33d0309f388fecc82eb0d">~gri_fft_complex</a> ();
<a name="l00058"></a>00058 
<a name="l00059"></a>00059   <span class="comment">/*</span>
<a name="l00060"></a>00060 <span class="comment">   * These return pointers to buffers owned by gri_fft_complex into which</span>
<a name="l00061"></a>00061 <span class="comment">   * input and output take place.  It&#39;s done this way in order to</span>
<a name="l00062"></a>00062 <span class="comment">   * ensure optimal alignment for SIMD instructions.</span>
<a name="l00063"></a>00063 <span class="comment">   */</span>
<a name="l00064"></a><a class="code" href="classgri__fft__complex.html#a7c3dbb457a3f5f2500c2734949695c8c">00064</a>   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *<a class="code" href="classgri__fft__complex.html#a7c3dbb457a3f5f2500c2734949695c8c">get_inbuf</a> ()<span class="keyword">  const </span>{ <span class="keywordflow">return</span> d_inbuf; }
<a name="l00065"></a><a class="code" href="classgri__fft__complex.html#a609568b21420eb12aa896bdc96d59ab3">00065</a>   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *<a class="code" href="classgri__fft__complex.html#a609568b21420eb12aa896bdc96d59ab3">get_outbuf</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_outbuf; }
<a name="l00066"></a>00066 
<a name="l00067"></a><a class="code" href="classgri__fft__complex.html#a687e3200bc70a287fabf501ae2b41a10">00067</a>   <span class="keywordtype">int</span> <a class="code" href="classgri__fft__complex.html#a687e3200bc70a287fabf501ae2b41a10">inbuf_length</a> ()<span class="keyword">  const </span>{ <span class="keywordflow">return</span> d_fft_size; }
<a name="l00068"></a><a class="code" href="classgri__fft__complex.html#a5a92538cb013724f0c5a08cfcf93476b">00068</a>   <span class="keywordtype">int</span> <a class="code" href="classgri__fft__complex.html#a5a92538cb013724f0c5a08cfcf93476b">outbuf_length</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_fft_size; }
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment">  /*!</span>
<a name="l00071"></a>00071 <span class="comment">   * compute FFT.  The input comes from inbuf, the output is placed in outbuf.</span>
<a name="l00072"></a>00072 <span class="comment">   */</span>
<a name="l00073"></a>00073   <span class="keywordtype">void</span> <a class="code" href="classgri__fft__complex.html#a11a73905f34fa05a4988e4eef727350e">execute</a> ();
<a name="l00074"></a>00074 };
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">/*!</span>
<a name="l00077"></a>00077 <span class="comment"> * \brief FFT: real in, complex out</span>
<a name="l00078"></a>00078 <span class="comment"> * \ingroup misc</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a><a class="code" href="classgri__fft__real__fwd.html">00080</a> <span class="keyword">class </span><a class="code" href="classgri__fft__real__fwd.html" title="FFT: real in, complex out.">gri_fft_real_fwd</a> {
<a name="l00081"></a>00081   <span class="keywordtype">int</span>         d_fft_size;
<a name="l00082"></a>00082   <span class="keywordtype">float</span>      *d_inbuf;
<a name="l00083"></a>00083   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *d_outbuf;
<a name="l00084"></a>00084   <span class="keywordtype">void</span>       *d_plan;
<a name="l00085"></a>00085   
<a name="l00086"></a>00086 <span class="keyword">public</span>:
<a name="l00087"></a>00087   <a class="code" href="classgri__fft__real__fwd.html#ac673c220b1e3d92d39bb9421bd806cf8">gri_fft_real_fwd</a> (<span class="keywordtype">int</span> fft_size);
<a name="l00088"></a>00088   <span class="keyword">virtual</span> <a class="code" href="classgri__fft__real__fwd.html#ad81e614d6d2a06446f98ba2cc5119953">~gri_fft_real_fwd</a> ();
<a name="l00089"></a>00089 
<a name="l00090"></a>00090   <span class="comment">/*</span>
<a name="l00091"></a>00091 <span class="comment">   * These return pointers to buffers owned by gri_fft_real_fwd into</span>
<a name="l00092"></a>00092 <span class="comment">   * which input and output take place.  It&#39;s done this way in order</span>
<a name="l00093"></a>00093 <span class="comment">   * to ensure optimal alignment for SIMD instructions.</span>
<a name="l00094"></a>00094 <span class="comment">   */</span>
<a name="l00095"></a><a class="code" href="classgri__fft__real__fwd.html#a02c2b74514a0e5af2d80c998d1b6ebfb">00095</a>   <span class="keywordtype">float</span> *<a class="code" href="classgri__fft__real__fwd.html#a02c2b74514a0e5af2d80c998d1b6ebfb">get_inbuf</a> ()<span class="keyword">      const </span>{ <span class="keywordflow">return</span> d_inbuf; }
<a name="l00096"></a><a class="code" href="classgri__fft__real__fwd.html#a24c3d8f208545484f2393f987962a292">00096</a>   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *<a class="code" href="classgri__fft__real__fwd.html#a24c3d8f208545484f2393f987962a292">get_outbuf</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_outbuf; }
<a name="l00097"></a>00097 
<a name="l00098"></a><a class="code" href="classgri__fft__real__fwd.html#acd26944e3a1b8e8721389d04226b160b">00098</a>   <span class="keywordtype">int</span> <a class="code" href="classgri__fft__real__fwd.html#acd26944e3a1b8e8721389d04226b160b">inbuf_length</a> ()<span class="keyword">  const </span>{ <span class="keywordflow">return</span> d_fft_size; }
<a name="l00099"></a><a class="code" href="classgri__fft__real__fwd.html#a5371a75180e9b5502562981e9086c536">00099</a>   <span class="keywordtype">int</span> <a class="code" href="classgri__fft__real__fwd.html#a5371a75180e9b5502562981e9086c536">outbuf_length</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_fft_size / 2 + 1; }
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment">  /*!</span>
<a name="l00102"></a>00102 <span class="comment">   * compute FFT.  The input comes from inbuf, the output is placed in outbuf.</span>
<a name="l00103"></a>00103 <span class="comment">   */</span>
<a name="l00104"></a>00104   <span class="keywordtype">void</span> <a class="code" href="classgri__fft__real__fwd.html#ad58c1984ecd7cf119577e6e1f9e6cfaa">execute</a> ();
<a name="l00105"></a>00105 };
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/*!</span>
<a name="l00108"></a>00108 <span class="comment"> * \brief FFT: complex in, float out</span>
<a name="l00109"></a>00109 <span class="comment"> * \ingroup misc</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a><a class="code" href="classgri__fft__real__rev.html">00111</a> <span class="keyword">class </span><a class="code" href="classgri__fft__real__rev.html" title="FFT: complex in, float out.">gri_fft_real_rev</a> {
<a name="l00112"></a>00112   <span class="keywordtype">int</span>         d_fft_size;
<a name="l00113"></a>00113   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *d_inbuf;
<a name="l00114"></a>00114   <span class="keywordtype">float</span>      *d_outbuf;
<a name="l00115"></a>00115   <span class="keywordtype">void</span>       *d_plan;
<a name="l00116"></a>00116   
<a name="l00117"></a>00117 <span class="keyword">public</span>:
<a name="l00118"></a>00118   <a class="code" href="classgri__fft__real__rev.html#a9de0f1d19cac2b10fb66b3e32c0736a6">gri_fft_real_rev</a> (<span class="keywordtype">int</span> fft_size);
<a name="l00119"></a>00119   <span class="keyword">virtual</span> <a class="code" href="classgri__fft__real__rev.html#a6c72714feeaca093af5d192563d8953e">~gri_fft_real_rev</a> ();
<a name="l00120"></a>00120 
<a name="l00121"></a>00121   <span class="comment">/*</span>
<a name="l00122"></a>00122 <span class="comment">   * These return pointers to buffers owned by gri_fft_real_rev into</span>
<a name="l00123"></a>00123 <span class="comment">   * which input and output take place.  It&#39;s done this way in order</span>
<a name="l00124"></a>00124 <span class="comment">   * to ensure optimal alignment for SIMD instructions.</span>
<a name="l00125"></a>00125 <span class="comment">   */</span>
<a name="l00126"></a><a class="code" href="classgri__fft__real__rev.html#a192c4bb4c24d76b154d260a3bb94603f">00126</a>   <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *<a class="code" href="classgri__fft__real__rev.html#a192c4bb4c24d76b154d260a3bb94603f">get_inbuf</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_inbuf; }
<a name="l00127"></a><a class="code" href="classgri__fft__real__rev.html#a4b22d5fd197086cd3301feef403ff791">00127</a>   <span class="keywordtype">float</span> *<a class="code" href="classgri__fft__real__rev.html#a4b22d5fd197086cd3301feef403ff791">get_outbuf</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_outbuf; }
<a name="l00128"></a>00128 
<a name="l00129"></a><a class="code" href="classgri__fft__real__rev.html#a7f651884fd858c366bdb8dc2d7741988">00129</a>   <span class="keywordtype">int</span> <a class="code" href="classgri__fft__real__rev.html#a7f651884fd858c366bdb8dc2d7741988">inbuf_length</a> ()<span class="keyword">  const </span>{ <span class="keywordflow">return</span> d_fft_size / 2 + 1; }
<a name="l00130"></a><a class="code" href="classgri__fft__real__rev.html#abaac2aa3eb09aacde2852854ed8be60c">00130</a>   <span class="keywordtype">int</span> <a class="code" href="classgri__fft__real__rev.html#abaac2aa3eb09aacde2852854ed8be60c">outbuf_length</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_fft_size; }
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment">  /*!</span>
<a name="l00133"></a>00133 <span class="comment">   * compute FFT.  The input comes from inbuf, the output is placed in outbuf.</span>
<a name="l00134"></a>00134 <span class="comment">   */</span>
<a name="l00135"></a>00135   <span class="keywordtype">void</span> <a class="code" href="classgri__fft__real__rev.html#a71811f0fcec7b341b5b274d83f7b9616">execute</a> ();
<a name="l00136"></a>00136 };
<a name="l00137"></a>00137 
<a name="l00138"></a>00138 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gri__fft_8h.html">gri_fft.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>