Sophie

Sophie

distrib > Mageia > 3 > i586 > by-pkgid > d2c3cd0736fcf741288cdfea8c6ba8c2 > files > 2297

gnuradio-doc-3.6.4.1-1.mga3.noarch.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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr::filter::kernel::fft_filter_ccc Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">gr::filter::kernel::fft_filter_ccc Class Reference<div class="ingroups"><a class="el" href="group__filter__blk.html">Filters</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Fast FFT filter with gr_complex input, gr_complex output and gr_complex taps.  
 <a href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="fft__filter_8h_source.html">fft_filter.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2f688f70eb7172439389e3f1d1fefae3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#a2f688f70eb7172439389e3f1d1fefae3">fft_filter_ccc</a> (int decimation, const std::vector&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &gt; &amp;<a class="el" href="gr-filter_2include_2filter_2interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>, int <a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#a96618262799874739906d561cba8389c">nthreads</a>=1)</td></tr>
<tr class="memdesc:a2f688f70eb7172439389e3f1d1fefae3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an FFT filter for complex vectors with the given taps and decimation rate.  <a href="#a2f688f70eb7172439389e3f1d1fefae3"></a><br/></td></tr>
<tr class="separator:a2f688f70eb7172439389e3f1d1fefae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11fb4dca51e0d234c370a25bada9dbdd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#a11fb4dca51e0d234c370a25bada9dbdd">~fft_filter_ccc</a> ()</td></tr>
<tr class="separator:a11fb4dca51e0d234c370a25bada9dbdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae56e8fc2e64ccafebf4d9de7f7ccf1e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#aae56e8fc2e64ccafebf4d9de7f7ccf1e">set_taps</a> (const std::vector&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &gt; &amp;<a class="el" href="gr-filter_2include_2filter_2interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr>
<tr class="memdesc:aae56e8fc2e64ccafebf4d9de7f7ccf1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new taps for the filter.  <a href="#aae56e8fc2e64ccafebf4d9de7f7ccf1e"></a><br/></td></tr>
<tr class="separator:aae56e8fc2e64ccafebf4d9de7f7ccf1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24990f4eb540bbdd7f0f15c19d3b70f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#a24990f4eb540bbdd7f0f15c19d3b70f7">set_nthreads</a> (int n)</td></tr>
<tr class="memdesc:a24990f4eb540bbdd7f0f15c19d3b70f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set number of threads to use.  <a href="#a24990f4eb540bbdd7f0f15c19d3b70f7"></a><br/></td></tr>
<tr class="separator:a24990f4eb540bbdd7f0f15c19d3b70f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96618262799874739906d561cba8389c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#a96618262799874739906d561cba8389c">nthreads</a> () const </td></tr>
<tr class="memdesc:a96618262799874739906d561cba8389c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of threads being used.  <a href="#a96618262799874739906d561cba8389c"></a><br/></td></tr>
<tr class="separator:a96618262799874739906d561cba8389c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6260658e0eab6bd51fba467049872c7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html#aa6260658e0eab6bd51fba467049872c7">filter</a> (int nitems, const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *input, <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *output)</td></tr>
<tr class="memdesc:aa6260658e0eab6bd51fba467049872c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform the filter operation.  <a href="#aa6260658e0eab6bd51fba467049872c7"></a><br/></td></tr>
<tr class="separator:aa6260658e0eab6bd51fba467049872c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Fast FFT filter with gr_complex input, gr_complex output and gr_complex taps. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2f688f70eb7172439389e3f1d1fefae3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gr::filter::kernel::fft_filter_ccc::fft_filter_ccc </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>decimation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>taps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>nthreads</em> = <code>1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct an FFT filter for complex vectors with the given taps and decimation rate. </p>
<p>This is the basic implementation for performing FFT filter for fast convolution in other blocks for complex vectors (such as <a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html" title="Fast FFT filter with gr_complex input, gr_complex output and gr_complex taps.">fft_filter_ccc</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">decimation</td><td>The decimation rate of the filter (int) </td></tr>
    <tr><td class="paramname">taps</td><td>The filter taps (complex) </td></tr>
    <tr><td class="paramname">nthreads</td><td>The number of threads for the FFT to use (int) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a11fb4dca51e0d234c370a25bada9dbdd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gr::filter::kernel::fft_filter_ccc::~fft_filter_ccc </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa6260658e0eab6bd51fba467049872c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int gr::filter::kernel::fft_filter_ccc::filter </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>nitems</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *&#160;</td>
          <td class="paramname"><em>output</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Perform the filter operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">nitems</td><td>The number of items to produce </td></tr>
    <tr><td class="paramname">input</td><td>The input vector to be filtered </td></tr>
    <tr><td class="paramname">output</td><td>The result of the filter operation </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a96618262799874739906d561cba8389c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int gr::filter::kernel::fft_filter_ccc::nthreads </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get number of threads being used. </p>

</div>
</div>
<a class="anchor" id="a24990f4eb540bbdd7f0f15c19d3b70f7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr::filter::kernel::fft_filter_ccc::set_nthreads </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>n</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set number of threads to use. </p>

</div>
</div>
<a class="anchor" id="aae56e8fc2e64ccafebf4d9de7f7ccf1e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int gr::filter::kernel::fft_filter_ccc::set_taps </td>
          <td>(</td>
          <td class="paramtype">const std::vector&lt; <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>taps</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set new taps for the filter. </p>
<p>Sets new taps and resets the class properties to handle different sizes </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">taps</td><td>The filter taps (complex) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fft__filter_8h_source.html">fft_filter.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacegr.html">gr</a></li><li class="navelem"><a class="el" href="namespacegr_1_1filter.html">filter</a></li><li class="navelem"><a class="el" href="namespacegr_1_1filter_1_1kernel.html">kernel</a></li><li class="navelem"><a class="el" href="classgr_1_1filter_1_1kernel_1_1fft__filter__ccc.html">fft_filter_ccc</a></li>
    <li class="footer">Generated on Fri Apr 19 2013 16:20:41 for GNU Radio 3.6.4.1 C++ API by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
  </ul>
</div>
</body>
</html>