<!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.3.0 C++ API: gr_remez.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <h1>gr_remez.h</h1><a href="gr__remez_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 2004 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 INCLUDED_GR_REMEZ_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_REMEZ_H</span> <a name="l00025"></a>00025 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="gr__types_8h.html">gr_types.h</a>></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <string></span> <a name="l00028"></a>00028 <span class="preprocessor">#include <stdexcept></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 Parks-McClellan FIR filter design.</span> <a name="l00032"></a>00032 <span class="comment"> *</span> <a name="l00033"></a>00033 <span class="comment"> * \ingroup filter_design</span> <a name="l00034"></a>00034 <span class="comment"> *</span> <a name="l00035"></a>00035 <span class="comment"> * Calculates the optimal (in the Chebyshev/minimax sense) FIR filter</span> <a name="l00036"></a>00036 <span class="comment"> * inpulse reponse given a set of band edges, the desired reponse on</span> <a name="l00037"></a>00037 <span class="comment"> * those bands, and the weight given to the error in those bands.</span> <a name="l00038"></a>00038 <span class="comment"> *</span> <a name="l00039"></a>00039 <span class="comment"> * \param order filter order (number of taps in the returned filter - 1)</span> <a name="l00040"></a>00040 <span class="comment"> * \param bands frequency at the band edges [ b1 e1 b2 e2 b3 e3 ...]</span> <a name="l00041"></a>00041 <span class="comment"> * \param ampl desired amplitude at the band edges [ a(b1) a(e1) a(b2) a(e2) ...]</span> <a name="l00042"></a>00042 <span class="comment"> * \param error_weight weighting applied to each band (usually 1)</span> <a name="l00043"></a>00043 <span class="comment"> * \param filter_type one of "bandpass", "hilbert" or "differentiator"</span> <a name="l00044"></a>00044 <span class="comment"> * \param grid_density determines how accurately the filter will be constructed. \</span> <a name="l00045"></a>00045 <span class="comment"> * The minimum value is 16; higher values are slower to compute.</span> <a name="l00046"></a>00046 <span class="comment"> *</span> <a name="l00047"></a>00047 <span class="comment"> * Frequency is in the range [0, 1], with 1 being the Nyquist frequency (Fs/2)</span> <a name="l00048"></a>00048 <span class="comment"> *</span> <a name="l00049"></a>00049 <span class="comment"> * \returns vector of computed taps</span> <a name="l00050"></a>00050 <span class="comment"> *</span> <a name="l00051"></a>00051 <span class="comment"> * \throws std::runtime_error if args are invalid or calculation fails to converge.</span> <a name="l00052"></a>00052 <span class="comment"> */</span> <a name="l00053"></a>00053 <a name="l00054"></a>00054 <a class="code" href="classstd_1_1vector.html">std::vector<double></a> <a name="l00055"></a>00055 <a class="code" href="group__filter__design.html#ga46cf4a6243c0610020572566e1a3198b" title="Parks-McClellan FIR filter design.">gr_remez</a> (<span class="keywordtype">int</span> order, <a name="l00056"></a>00056 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<double></a> &bands, <a name="l00057"></a>00057 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<double></a> &ampl, <a name="l00058"></a>00058 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<double></a> &error_weight, <a name="l00059"></a>00059 <span class="keyword">const</span> std::string filter_type = <span class="stringliteral">"bandpass"</span>, <a name="l00060"></a>00060 <span class="keywordtype">int</span> grid_density = 16 <a name="l00061"></a>00061 ) throw (std::runtime_error); <a name="l00062"></a>00062 <a name="l00063"></a>00063 <a name="l00064"></a>00064 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_REMEZ_H */</span> </pre></div></div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:51:00 2010 for GNU Radio 3.3.0 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>