Sophie

Sophie

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

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: gr_firdes.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('gr__firdes_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gr_firdes.h</h1>  </div>
</div>
<div class="contents">
<a href="gr__firdes_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 2002,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 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _GR_FIRDES_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _GR_FIRDES_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;cmath&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;gr_complex.h&gt;</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/*!</span>
<a name="l00031"></a>00031 <span class="comment"> * \brief Finite Impulse Response (FIR) filter design functions.</span>
<a name="l00032"></a>00032 <span class="comment"> * \ingroup filter_design</span>
<a name="l00033"></a>00033 <span class="comment"> */</span>
<a name="l00034"></a>00034 
<a name="l00035"></a><a class="code" href="classgr__firdes.html">00035</a> <span class="keyword">class </span><a class="code" href="classgr__firdes.html" title="Finite Impulse Response (FIR) filter design functions.">gr_firdes</a> {
<a name="l00036"></a>00036  <span class="keyword">public</span>:
<a name="l00037"></a>00037 
<a name="l00038"></a><a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">00038</a>   <span class="keyword">enum</span> <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> {
<a name="l00039"></a><a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">00039</a>     <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a> = 0,    <span class="comment">// max attenuation 53 dB</span>
<a name="l00040"></a><a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca0283f236f2f1614bcb1534375d0a4d5c">00040</a>     <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca0283f236f2f1614bcb1534375d0a4d5c">WIN_HANN</a> = 1,       <span class="comment">// max attenuation 44 dB</span>
<a name="l00041"></a><a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca1c72b129266703afdcc486aebd763fe8">00041</a>     <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca1c72b129266703afdcc486aebd763fe8">WIN_BLACKMAN</a> = 2,   <span class="comment">// max attenuation 74 dB</span>
<a name="l00042"></a><a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca93358f88cb8ea7cc99ba5b1a45878290">00042</a>     <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca93358f88cb8ea7cc99ba5b1a45878290">WIN_RECTANGULAR</a> = 3,
<a name="l00043"></a><a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456cacf24e696ceb7054a0f48ded24940106e">00043</a>     <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456cacf24e696ceb7054a0f48ded24940106e">WIN_KAISER</a> = 4,     <span class="comment">// max attenuation a function of beta, google it</span>
<a name="l00044"></a><a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca6bc60911da96133b31392c35cb4f797b">00044</a>     <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca6bc60911da96133b31392c35cb4f797b">WIN_BLACKMAN_hARRIS</a> = 5,
<a name="l00045"></a>00045   };
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 
<a name="l00048"></a>00048   <span class="comment">// ... class methods ...</span>
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">  /*!</span>
<a name="l00051"></a>00051 <span class="comment">   * \brief use &quot;window method&quot; to design a low-pass FIR filter</span>
<a name="l00052"></a>00052 <span class="comment">   *</span>
<a name="l00053"></a>00053 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00054"></a>00054 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00055"></a>00055 <span class="comment">   * \p cutoff_freq:            center of transition band (Hz)</span>
<a name="l00056"></a>00056 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00057"></a>00057 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00058"></a>00058 <span class="comment">   *                            band is what sets the number of taps</span>
<a name="l00059"></a>00059 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00060"></a>00060 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00061"></a>00061 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00062"></a>00062 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00063"></a>00063 <span class="comment">   */</span>
<a name="l00064"></a>00064   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00065"></a>00065   <a class="code" href="classgr__firdes.html#a0cf14cf1cab23b635081d0ff8bf6140a" title="use &amp;quot;window method&amp;quot; to design a low-pass FIR filter">low_pass</a> (<span class="keywordtype">double</span> gain,
<a name="l00066"></a>00066             <span class="keywordtype">double</span> sampling_freq,
<a name="l00067"></a>00067             <span class="keywordtype">double</span> cutoff_freq,         <span class="comment">// Hz center of transition band</span>
<a name="l00068"></a>00068             <span class="keywordtype">double</span> transition_width,    <span class="comment">// Hz width of transition band</span>
<a name="l00069"></a>00069             <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00070"></a>00070             <span class="keywordtype">double</span> beta = 6.76);                <span class="comment">// used only with Kaiser</span>
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment">  /*!</span>
<a name="l00073"></a>00073 <span class="comment">   * \brief use &quot;window method&quot; to design a low-pass FIR filter</span>
<a name="l00074"></a>00074 <span class="comment">   *</span>
<a name="l00075"></a>00075 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00076"></a>00076 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00077"></a>00077 <span class="comment">   * \p cutoff_freq:            center of transition band (Hz)</span>
<a name="l00078"></a>00078 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00079"></a>00079 <span class="comment">   * \p attenuation_dB          required stopband attenuation</span>
<a name="l00080"></a>00080 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00081"></a>00081 <span class="comment">   *                            band and the required stop band</span>
<a name="l00082"></a>00082 <span class="comment">   *                            attenuation is what sets the number of taps</span>
<a name="l00083"></a>00083 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00084"></a>00084 <span class="comment">   *                            More attenuatin --&gt; more taps</span>
<a name="l00085"></a>00085 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00086"></a>00086 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00087"></a>00087 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00088"></a>00088 <span class="comment">   */</span>
<a name="l00089"></a>00089 
<a name="l00090"></a>00090   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00091"></a>00091   <a class="code" href="classgr__firdes.html#a7347642df3e2f5090db468750da56d56" title="use &amp;quot;window method&amp;quot; to design a low-pass FIR filter">low_pass_2</a> (<span class="keywordtype">double</span> gain,
<a name="l00092"></a>00092             <span class="keywordtype">double</span> sampling_freq,
<a name="l00093"></a>00093             <span class="keywordtype">double</span> cutoff_freq,         <span class="comment">// Hz beginning transition band</span>
<a name="l00094"></a>00094             <span class="keywordtype">double</span> transition_width,    <span class="comment">// Hz width of transition band</span>
<a name="l00095"></a>00095             <span class="keywordtype">double</span> attenuation_dB,      <span class="comment">// out of band attenuation dB</span>
<a name="l00096"></a>00096             <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00097"></a>00097             <span class="keywordtype">double</span> beta = 6.76);                <span class="comment">// used only with Kaiser</span>
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">  /*!</span>
<a name="l00100"></a>00100 <span class="comment">   * \brief use &quot;window method&quot; to design a high-pass FIR filter</span>
<a name="l00101"></a>00101 <span class="comment">   *</span>
<a name="l00102"></a>00102 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00103"></a>00103 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00104"></a>00104 <span class="comment">   * \p cutoff_freq:            center of transition band (Hz)</span>
<a name="l00105"></a>00105 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00106"></a>00106 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00107"></a>00107 <span class="comment">   *                            band is what sets the number of taps</span>
<a name="l00108"></a>00108 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00109"></a>00109 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00110"></a>00110 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00111"></a>00111 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00112"></a>00112 <span class="comment">   */</span>
<a name="l00113"></a>00113 
<a name="l00114"></a>00114   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00115"></a>00115   <a class="code" href="classgr__firdes.html#acf767ad8eccf3c5c283d578599a63691" title="use &amp;quot;window method&amp;quot; to design a high-pass FIR filter">high_pass</a> (<span class="keywordtype">double</span> gain,
<a name="l00116"></a>00116              <span class="keywordtype">double</span> sampling_freq,
<a name="l00117"></a>00117              <span class="keywordtype">double</span> cutoff_freq,                <span class="comment">// Hz center of transition band</span>
<a name="l00118"></a>00118              <span class="keywordtype">double</span> transition_width,           <span class="comment">// Hz width of transition band</span>
<a name="l00119"></a>00119              <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00120"></a>00120              <span class="keywordtype">double</span> beta = 6.76);               <span class="comment">// used only with Kaiser</span>
<a name="l00121"></a>00121 <span class="comment"></span>
<a name="l00122"></a>00122 <span class="comment">  /*!</span>
<a name="l00123"></a>00123 <span class="comment">   * \brief use &quot;window method&quot; to design a high-pass FIR filter</span>
<a name="l00124"></a>00124 <span class="comment">   *</span>
<a name="l00125"></a>00125 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00126"></a>00126 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00127"></a>00127 <span class="comment">   * \p cutoff_freq:            center of transition band (Hz)</span>
<a name="l00128"></a>00128 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00129"></a>00129 <span class="comment">   * \p attenuation_dB          out of band attenuation</span>
<a name="l00130"></a>00130 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00131"></a>00131 <span class="comment">   *                            band and the required stop band</span>
<a name="l00132"></a>00132 <span class="comment">   *                            attenuation is what sets the number of taps</span>
<a name="l00133"></a>00133 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00134"></a>00134 <span class="comment">   *                            More attenuation --&gt; more taps</span>
<a name="l00135"></a>00135 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00136"></a>00136 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00137"></a>00137 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00138"></a>00138 <span class="comment">   */</span>
<a name="l00139"></a>00139 
<a name="l00140"></a>00140   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00141"></a>00141   <a class="code" href="classgr__firdes.html#a06bb3ea1c1bfeefe8ed860d23285c040" title="use &amp;quot;window method&amp;quot; to design a high-pass FIR filter">high_pass_2</a> (<span class="keywordtype">double</span> gain,
<a name="l00142"></a>00142              <span class="keywordtype">double</span> sampling_freq,
<a name="l00143"></a>00143              <span class="keywordtype">double</span> cutoff_freq,                <span class="comment">// Hz center of transition band</span>
<a name="l00144"></a>00144              <span class="keywordtype">double</span> transition_width,           <span class="comment">// Hz width of transition band</span>
<a name="l00145"></a>00145              <span class="keywordtype">double</span> attenuation_dB,             <span class="comment">// out of band attenuation dB</span>
<a name="l00146"></a>00146              <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00147"></a>00147              <span class="keywordtype">double</span> beta = 6.76);               <span class="comment">// used only with Kaiser</span>
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">  /*!</span>
<a name="l00150"></a>00150 <span class="comment">   * \brief use &quot;window method&quot; to design a band-pass FIR filter</span>
<a name="l00151"></a>00151 <span class="comment">   *</span>
<a name="l00152"></a>00152 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00153"></a>00153 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00154"></a>00154 <span class="comment">   * \p low_cutoff_freq:        center of transition band (Hz)</span>
<a name="l00155"></a>00155 <span class="comment">   * \p high_cutoff_freq:       center of transition band (Hz)</span>
<a name="l00156"></a>00156 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00157"></a>00157 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00158"></a>00158 <span class="comment">   *                            band is what sets the number of taps</span>
<a name="l00159"></a>00159 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00160"></a>00160 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00161"></a>00161 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00162"></a>00162 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00163"></a>00163 <span class="comment">   */</span>
<a name="l00164"></a>00164   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00165"></a>00165   <a class="code" href="classgr__firdes.html#a074fc918cbcd8408898f2660a2d6bbf6" title="use &amp;quot;window method&amp;quot; to design a band-pass FIR filter">band_pass</a> (<span class="keywordtype">double</span> gain,
<a name="l00166"></a>00166              <span class="keywordtype">double</span> sampling_freq,
<a name="l00167"></a>00167              <span class="keywordtype">double</span> low_cutoff_freq,            <span class="comment">// Hz center of transition band</span>
<a name="l00168"></a>00168              <span class="keywordtype">double</span> high_cutoff_freq,           <span class="comment">// Hz center of transition band</span>
<a name="l00169"></a>00169              <span class="keywordtype">double</span> transition_width,           <span class="comment">// Hz width of transition band</span>
<a name="l00170"></a>00170              <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00171"></a>00171              <span class="keywordtype">double</span> beta = 6.76);               <span class="comment">// used only with Kaiser</span>
<a name="l00172"></a>00172 <span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment">  /*!</span>
<a name="l00174"></a>00174 <span class="comment">   * \brief use &quot;window method&quot; to design a band-pass FIR filter</span>
<a name="l00175"></a>00175 <span class="comment">   *</span>
<a name="l00176"></a>00176 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00177"></a>00177 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00178"></a>00178 <span class="comment">   * \p low_cutoff_freq:        center of transition band (Hz)</span>
<a name="l00179"></a>00179 <span class="comment">   * \p high_cutoff_freq:       center of transition band (Hz)</span>
<a name="l00180"></a>00180 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00181"></a>00181 <span class="comment">   * \p attenuation_dB          out of band attenuation</span>
<a name="l00182"></a>00182 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00183"></a>00183 <span class="comment">   *                            band and the required stop band</span>
<a name="l00184"></a>00184 <span class="comment">   *                            attenuation is what sets the number of taps</span>
<a name="l00185"></a>00185 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00186"></a>00186 <span class="comment">   *                            More attenuation --&gt; more taps</span>
<a name="l00187"></a>00187 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00188"></a>00188 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00189"></a>00189 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00190"></a>00190 <span class="comment">   */</span>
<a name="l00191"></a>00191 
<a name="l00192"></a>00192   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00193"></a>00193   <a class="code" href="classgr__firdes.html#a1101286ed88565ed9b273670701cd07b" title="use &amp;quot;window method&amp;quot; to design a band-pass FIR filter">band_pass_2</a> (<span class="keywordtype">double</span> gain,
<a name="l00194"></a>00194              <span class="keywordtype">double</span> sampling_freq,
<a name="l00195"></a>00195              <span class="keywordtype">double</span> low_cutoff_freq,            <span class="comment">// Hz beginning transition band</span>
<a name="l00196"></a>00196              <span class="keywordtype">double</span> high_cutoff_freq,           <span class="comment">// Hz beginning transition band</span>
<a name="l00197"></a>00197              <span class="keywordtype">double</span> transition_width,           <span class="comment">// Hz width of transition band</span>
<a name="l00198"></a>00198              <span class="keywordtype">double</span> attenuation_dB,             <span class="comment">// out of band attenuation dB</span>
<a name="l00199"></a>00199              <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00200"></a>00200              <span class="keywordtype">double</span> beta = 6.76);               <span class="comment">// used only with Kaiser</span>
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment">  /*!</span>
<a name="l00203"></a>00203 <span class="comment">   * \brief use &quot;window method&quot; to design a complex band-pass FIR filter</span>
<a name="l00204"></a>00204 <span class="comment">   *</span>
<a name="l00205"></a>00205 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00206"></a>00206 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00207"></a>00207 <span class="comment">   * \p low_cutoff_freq:        center of transition band (Hz)</span>
<a name="l00208"></a>00208 <span class="comment">   * \p high_cutoff_freq:       center of transition band (Hz)</span>
<a name="l00209"></a>00209 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00210"></a>00210 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00211"></a>00211 <span class="comment">   *                            band is what sets the number of taps</span>
<a name="l00212"></a>00212 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00213"></a>00213 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00214"></a>00214 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00215"></a>00215 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00216"></a>00216 <span class="comment">   */</span>
<a name="l00217"></a>00217 
<a name="l00218"></a>00218   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a>
<a name="l00219"></a>00219   <a class="code" href="classgr__firdes.html#a2d35be73189d6763a00b5585159ee500" title="use &amp;quot;window method&amp;quot; to design a complex band-pass FIR filter">complex_band_pass</a> (<span class="keywordtype">double</span> gain,
<a name="l00220"></a>00220              <span class="keywordtype">double</span> sampling_freq,
<a name="l00221"></a>00221              <span class="keywordtype">double</span> low_cutoff_freq,            <span class="comment">// Hz center of transition band</span>
<a name="l00222"></a>00222              <span class="keywordtype">double</span> high_cutoff_freq,           <span class="comment">// Hz center of transition band</span>
<a name="l00223"></a>00223              <span class="keywordtype">double</span> transition_width,           <span class="comment">// Hz width of transition band</span>
<a name="l00224"></a>00224              <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00225"></a>00225              <span class="keywordtype">double</span> beta = 6.76);               <span class="comment">// used only with Kaiser</span>
<a name="l00226"></a>00226 <span class="comment"></span>
<a name="l00227"></a>00227 <span class="comment">  /*!</span>
<a name="l00228"></a>00228 <span class="comment">   * \brief use &quot;window method&quot; to design a complex band-pass FIR filter</span>
<a name="l00229"></a>00229 <span class="comment">   *</span>
<a name="l00230"></a>00230 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00231"></a>00231 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00232"></a>00232 <span class="comment">   * \p low_cutoff_freq:        center of transition band (Hz)</span>
<a name="l00233"></a>00233 <span class="comment">   * \p high_cutoff_freq:       center of transition band (Hz)</span>
<a name="l00234"></a>00234 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00235"></a>00235 <span class="comment">   * \p attenuation_dB          out of band attenuation</span>
<a name="l00236"></a>00236 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00237"></a>00237 <span class="comment">   *                            band and the required stop band</span>
<a name="l00238"></a>00238 <span class="comment">   *                            attenuation is what sets the number of taps</span>
<a name="l00239"></a>00239 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00240"></a>00240 <span class="comment">   *                            More attenuation --&gt; more taps</span>
<a name="l00241"></a>00241 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00242"></a>00242 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00243"></a>00243 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00244"></a>00244 <span class="comment">   */</span>
<a name="l00245"></a>00245 
<a name="l00246"></a>00246   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a>
<a name="l00247"></a>00247   <a class="code" href="classgr__firdes.html#a7771ca6a6e9d430c2828573651eead19" title="use &amp;quot;window method&amp;quot; to design a complex band-pass FIR filter">complex_band_pass_2</a> (<span class="keywordtype">double</span> gain,
<a name="l00248"></a>00248              <span class="keywordtype">double</span> sampling_freq,
<a name="l00249"></a>00249              <span class="keywordtype">double</span> low_cutoff_freq,            <span class="comment">// Hz beginning transition band</span>
<a name="l00250"></a>00250              <span class="keywordtype">double</span> high_cutoff_freq,           <span class="comment">// Hz beginning transition band</span>
<a name="l00251"></a>00251              <span class="keywordtype">double</span> transition_width,           <span class="comment">// Hz width of transition band</span>
<a name="l00252"></a>00252              <span class="keywordtype">double</span> attenuation_dB,             <span class="comment">// out of band attenuation dB</span>
<a name="l00253"></a>00253              <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00254"></a>00254              <span class="keywordtype">double</span> beta = 6.76);               <span class="comment">// used only with Kaiser</span>
<a name="l00255"></a>00255 <span class="comment"></span>
<a name="l00256"></a>00256 <span class="comment">  /*!</span>
<a name="l00257"></a>00257 <span class="comment">   * \brief use &quot;window method&quot; to design a band-reject FIR filter</span>
<a name="l00258"></a>00258 <span class="comment">   *</span>
<a name="l00259"></a>00259 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00260"></a>00260 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00261"></a>00261 <span class="comment">   * \p low_cutoff_freq:        center of transition band (Hz)</span>
<a name="l00262"></a>00262 <span class="comment">   * \p high_cutoff_freq:       center of transition band (Hz)</span>
<a name="l00263"></a>00263 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00264"></a>00264 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00265"></a>00265 <span class="comment">   *                            band is what sets the number of taps</span>
<a name="l00266"></a>00266 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00267"></a>00267 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00268"></a>00268 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00269"></a>00269 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00270"></a>00270 <span class="comment">   */</span>
<a name="l00271"></a>00271 
<a name="l00272"></a>00272   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00273"></a>00273   <a class="code" href="classgr__firdes.html#aed7654868c14219e4a9bd75aa5b2c39e" title="use &amp;quot;window method&amp;quot; to design a band-reject FIR filter">band_reject</a> (<span class="keywordtype">double</span> gain,
<a name="l00274"></a>00274                <span class="keywordtype">double</span> sampling_freq,
<a name="l00275"></a>00275                <span class="keywordtype">double</span> low_cutoff_freq,          <span class="comment">// Hz center of transition band</span>
<a name="l00276"></a>00276                <span class="keywordtype">double</span> high_cutoff_freq,         <span class="comment">// Hz center of transition band</span>
<a name="l00277"></a>00277                <span class="keywordtype">double</span> transition_width,         <span class="comment">// Hz width of transition band</span>
<a name="l00278"></a>00278                <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00279"></a>00279                <span class="keywordtype">double</span> beta = 6.76);             <span class="comment">// used only with Kaiser</span>
<a name="l00280"></a>00280 <span class="comment"></span>
<a name="l00281"></a>00281 <span class="comment">  /*!</span>
<a name="l00282"></a>00282 <span class="comment">   * \brief use &quot;window method&quot; to design a band-reject FIR filter</span>
<a name="l00283"></a>00283 <span class="comment">   *</span>
<a name="l00284"></a>00284 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00285"></a>00285 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00286"></a>00286 <span class="comment">   * \p low_cutoff_freq:        center of transition band (Hz)</span>
<a name="l00287"></a>00287 <span class="comment">   * \p high_cutoff_freq:       center of transition band (Hz)</span>
<a name="l00288"></a>00288 <span class="comment">   * \p transition_width:       width of transition band (Hz).</span>
<a name="l00289"></a>00289 <span class="comment">   * \p attenuation_dB          out of band attenuation</span>
<a name="l00290"></a>00290 <span class="comment">   *                            The normalized width of the transition</span>
<a name="l00291"></a>00291 <span class="comment">   *                            band and the required stop band</span>
<a name="l00292"></a>00292 <span class="comment">   *                            attenuation is what sets the number of taps</span>
<a name="l00293"></a>00293 <span class="comment">   *                            required.  Narrow --&gt; more taps</span>
<a name="l00294"></a>00294 <span class="comment">   *                            More attenuation --&gt; more taps</span>
<a name="l00295"></a>00295 <span class="comment">   * \p window_type:            What kind of window to use. Determines</span>
<a name="l00296"></a>00296 <span class="comment">   *                            maximum attenuation and passband ripple.</span>
<a name="l00297"></a>00297 <span class="comment">   * \p beta:                   parameter for Kaiser window</span>
<a name="l00298"></a>00298 <span class="comment">   */</span>
<a name="l00299"></a>00299 
<a name="l00300"></a>00300   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00301"></a>00301   <a class="code" href="classgr__firdes.html#a96177c53698f5d443a294358e8122674" title="use &amp;quot;window method&amp;quot; to design a band-reject FIR filter">band_reject_2</a> (<span class="keywordtype">double</span> gain,
<a name="l00302"></a>00302                <span class="keywordtype">double</span> sampling_freq,
<a name="l00303"></a>00303                <span class="keywordtype">double</span> low_cutoff_freq,          <span class="comment">// Hz beginning transition band</span>
<a name="l00304"></a>00304                <span class="keywordtype">double</span> high_cutoff_freq,         <span class="comment">// Hz beginning transition band</span>
<a name="l00305"></a>00305                <span class="keywordtype">double</span> transition_width,         <span class="comment">// Hz width of transition band</span>
<a name="l00306"></a>00306                <span class="keywordtype">double</span> attenuation_dB,           <span class="comment">// out of band attenuation dB</span>
<a name="l00307"></a>00307                <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca9ecf16aac5495bd054e124d073e23bfa">WIN_HAMMING</a>,
<a name="l00308"></a>00308                <span class="keywordtype">double</span> beta = 6.76);             <span class="comment">// used only with Kaiser</span>
<a name="l00309"></a>00309 <span class="comment"></span>
<a name="l00310"></a>00310 <span class="comment">  /*!\brief design a Hilbert Transform Filter</span>
<a name="l00311"></a>00311 <span class="comment">   *</span>
<a name="l00312"></a>00312 <span class="comment">   * \p ntaps:                  Number of taps, must be odd</span>
<a name="l00313"></a>00313 <span class="comment">   * \p window_type:            What kind of window to use</span>
<a name="l00314"></a>00314 <span class="comment">   * \p beta:                   Only used for Kaiser</span>
<a name="l00315"></a>00315 <span class="comment">   */</span>
<a name="l00316"></a>00316   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00317"></a>00317   <a class="code" href="classgr__firdes.html#ae885fbaeb36e33125affcfa7a908be5a" title="design a Hilbert Transform Filter">hilbert</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ntaps = 19,
<a name="l00318"></a>00318            <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> windowtype = <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456ca93358f88cb8ea7cc99ba5b1a45878290">WIN_RECTANGULAR</a>,
<a name="l00319"></a>00319            <span class="keywordtype">double</span> beta = 6.76);
<a name="l00320"></a>00320    <span class="comment"></span>
<a name="l00321"></a>00321 <span class="comment">  /*!</span>
<a name="l00322"></a>00322 <span class="comment">   * \brief design a Root Cosine FIR Filter (do we need a window?)</span>
<a name="l00323"></a>00323 <span class="comment">   *</span>
<a name="l00324"></a>00324 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00325"></a>00325 <span class="comment">   * \p sampling_freq:          sampling freq (Hz)</span>
<a name="l00326"></a>00326 <span class="comment">   * \p symbol rate:            symbol rate, must be a factor of sample rate</span>
<a name="l00327"></a>00327 <span class="comment">   * \p alpha:                  excess bandwidth factor</span>
<a name="l00328"></a>00328 <span class="comment">   * \p ntaps:                  number of taps</span>
<a name="l00329"></a>00329 <span class="comment">   */</span>
<a name="l00330"></a>00330   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00331"></a>00331   <a class="code" href="classgr__firdes.html#a06ddce94f6ea7477d9a2f4d165f0bb1c" title="design a Root Cosine FIR Filter (do we need a window?)">root_raised_cosine</a> (<span class="keywordtype">double</span> gain,
<a name="l00332"></a>00332                       <span class="keywordtype">double</span> sampling_freq,
<a name="l00333"></a>00333                       <span class="keywordtype">double</span> symbol_rate,       <span class="comment">// Symbol rate, NOT bitrate (unless BPSK)</span>
<a name="l00334"></a>00334                       <span class="keywordtype">double</span> alpha,             <span class="comment">// Excess Bandwidth Factor</span>
<a name="l00335"></a>00335                       <span class="keywordtype">int</span> ntaps);
<a name="l00336"></a>00336 <span class="comment"></span>
<a name="l00337"></a>00337 <span class="comment">  /*!</span>
<a name="l00338"></a>00338 <span class="comment">   * \brief design a Gaussian filter</span>
<a name="l00339"></a>00339 <span class="comment">   *</span>
<a name="l00340"></a>00340 <span class="comment">   * \p gain:                   overall gain of filter (typically 1.0)</span>
<a name="l00341"></a>00341 <span class="comment">   * \p symbols per bit:        symbol rate, must be a factor of sample rate</span>
<a name="l00342"></a>00342 <span class="comment">   * \p ntaps:                  number of taps</span>
<a name="l00343"></a>00343 <span class="comment">   */</span>
<a name="l00344"></a>00344   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a>
<a name="l00345"></a>00345   <a class="code" href="classgr__firdes.html#abc309da910b6570a38f800093ebd12b1" title="design a Gaussian filter">gaussian</a> (<span class="keywordtype">double</span> gain,
<a name="l00346"></a>00346             <span class="keywordtype">double</span> spb,       
<a name="l00347"></a>00347             <span class="keywordtype">double</span> bt,              <span class="comment">// Bandwidth to bitrate ratio</span>
<a name="l00348"></a>00348             <span class="keywordtype">int</span> ntaps);
<a name="l00349"></a>00349 
<a name="l00350"></a>00350   <span class="comment">// window functions ...</span>
<a name="l00351"></a>00351   <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;float&gt;</a> <a class="code" href="classgr__firdes.html#a5d1296e7e53019564a8a146fa3a9caaf">window</a> (<a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> type, <span class="keywordtype">int</span> ntaps, <span class="keywordtype">double</span> beta);
<a name="l00352"></a>00352 
<a name="l00353"></a>00353 <span class="keyword">private</span>:
<a name="l00354"></a>00354   <span class="keyword">static</span> <span class="keywordtype">double</span> bessi0(<span class="keywordtype">double</span> x);
<a name="l00355"></a>00355   <span class="keyword">static</span> <span class="keywordtype">void</span> sanity_check_1f (<span class="keywordtype">double</span> sampling_freq, <span class="keywordtype">double</span> f1,
<a name="l00356"></a>00356                                <span class="keywordtype">double</span> transition_width);
<a name="l00357"></a>00357   <span class="keyword">static</span> <span class="keywordtype">void</span> sanity_check_2f (<span class="keywordtype">double</span> sampling_freq, <span class="keywordtype">double</span> f1, <span class="keywordtype">double</span> f2,
<a name="l00358"></a>00358                                <span class="keywordtype">double</span> transition_width);
<a name="l00359"></a>00359   <span class="keyword">static</span> <span class="keywordtype">void</span> sanity_check_2f_c (<span class="keywordtype">double</span> sampling_freq, <span class="keywordtype">double</span> f1, <span class="keywordtype">double</span> f2,
<a name="l00360"></a>00360                                <span class="keywordtype">double</span> transition_width);
<a name="l00361"></a>00361 
<a name="l00362"></a>00362   <span class="keyword">static</span> <span class="keywordtype">int</span> compute_ntaps (<span class="keywordtype">double</span> sampling_freq,
<a name="l00363"></a>00363                             <span class="keywordtype">double</span> transition_width,
<a name="l00364"></a>00364                             <a class="code" href="classgr__firdes.html#a49ec223781ec35f82b52d3f51ab5456c">win_type</a> window_type, <span class="keywordtype">double</span> beta);
<a name="l00365"></a>00365 
<a name="l00366"></a>00366   <span class="keyword">static</span> <span class="keywordtype">int</span> compute_ntaps_windes (<span class="keywordtype">double</span> sampling_freq,
<a name="l00367"></a>00367                                    <span class="keywordtype">double</span> transition_width,
<a name="l00368"></a>00368                                    <span class="keywordtype">double</span> attenuation_dB);
<a name="l00369"></a>00369 };
<a name="l00370"></a>00370 
<a name="l00371"></a>00371 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gr__firdes_8h.html">gr_firdes.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>