<!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_fir_fff Class Reference</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 --> <div class="contents"> <h1>gr_fir_fff Class Reference</h1><!-- doxytag: class="gr_fir_fff" --> <p>Abstract class for FIR with float input, float output and float tapsThis is the abstract class for a Finite Impulse Response filter. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__fir__fff_8h_source.html">gr_fir_fff.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_fir_fff:</div> <div class="dynsection"> <div class="center"><img src="classgr__fir__fff__inherit__graph.png" border="0" usemap="#gr__fir__fff_inherit__map" alt="Inheritance graph"/></div> <map name="gr__fir__fff_inherit__map" id="gr__fir__fff_inherit__map"> <area shape="rect" id="node3" href="classgr__fir__fff__generic.html" title="Concrete class for generic implementation of FIR with float input, float output and..." alt="" coords="148,83,265,112"/><area shape="rect" id="node5" href="classgr__fir__fff__altivec.html" title="altivec version of gr_fir_fff" alt="" coords="5,160,120,189"/><area shape="rect" id="node7" href="classgr__fir__fff__armv7__a.html" title="armv7_a using NEON coprocessor version of gr_fir_fff" alt="" coords="144,160,269,189"/><area shape="rect" id="node9" href="classgr__fir__fff__simd.html" title="common base class for SIMD versions of gr_fir_fffThis base class handles alignment..." alt="" coords="293,160,397,189"/><area shape="rect" id="node11" href="classgr__fir__fff__3dnow.html" title="3DNow! version of gr_fir_fff" alt="" coords="223,237,337,267"/><area shape="rect" id="node13" href="classgr__fir__fff__sse.html" title="SSE version of gr_fir_fff." alt="" coords="361,237,460,267"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__fir__fff-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#abb048967e21dc9aca56e551ff4042eec">gr_fir_fff</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">construct new FIR with given taps. <a href="#abb048967e21dc9aca56e551ff4042eec"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#a9f7f901a8030ba8e8940a0c9cd3d795d">gr_fir_fff</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#acf438d5de004cd0a852358d52d8d1609">~gr_fir_fff</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#aea3a56a189c75c3752900d05a5b627d3">filter</a> (const float input[])=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">compute a single output value. <a href="#aea3a56a189c75c3752900d05a5b627d3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#ad53a1e12dd89e647fdbeea37691df85a">filterN</a> (float output[], const float input[], unsigned long n)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">compute an array of N output values. <a href="#ad53a1e12dd89e647fdbeea37691df85a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#a930255550bf68802cd694fe79091738f">filterNdec</a> (float output[], const float input[], unsigned long n, unsigned decimate)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">compute an array of N output values, decimating the input <a href="#a930255550bf68802cd694fe79091738f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#ad692c67d571c9fdd45a214bac28c38d6">set_taps</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">install <code>new_taps</code> as the current taps. <a href="#ad692c67d571c9fdd45a214bac28c38d6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#a4c8fdac7c6d2d3eea81064c7ed5f25e6">get_taps</a> () const </td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">d_taps</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Abstract class for FIR with float input, float output and float taps</p> <p>This is the abstract class for a Finite Impulse Response filter. </p> <p>The trailing suffix has the form _IOT where I codes the input type, O codes the output type, and T codes the tap type. I,O,T are elements of the set 's' (short), 'f' (float), 'c' (gr_complex), 'i' (int) </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="abb048967e21dc9aca56e551ff4042eec"></a><!-- doxytag: member="gr_fir_fff::gr_fir_fff" ref="abb048967e21dc9aca56e551ff4042eec" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_fir_fff::gr_fir_fff </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>construct new FIR with given taps. </p> <p>Note that taps must be in forward order, e.g., coefficient 0 is stored in new_taps[0], coefficient 1 is stored in new_taps[1], etc. </p> </div> </div> <a class="anchor" id="a9f7f901a8030ba8e8940a0c9cd3d795d"></a><!-- doxytag: member="gr_fir_fff::gr_fir_fff" ref="a9f7f901a8030ba8e8940a0c9cd3d795d" args="(const std::vector< float > &taps)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_fir_fff::gr_fir_fff </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td> <td class="paramname"> <em>taps</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="acf438d5de004cd0a852358d52d8d1609"></a><!-- doxytag: member="gr_fir_fff::~gr_fir_fff" ref="acf438d5de004cd0a852358d52d8d1609" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual gr_fir_fff::~gr_fir_fff </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aea3a56a189c75c3752900d05a5b627d3"></a><!-- doxytag: member="gr_fir_fff::filter" ref="aea3a56a189c75c3752900d05a5b627d3" args="(const float input[])=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual float gr_fir_fff::filter </td> <td>(</td> <td class="paramtype">const float </td> <td class="paramname"> <em>input</em>[]</td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>compute a single output value. </p> <p><code>input</code> must have <a class="el" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps()</a> valid entries. input[0] .. input[<a class="el" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps()</a> - 1] are referenced to compute the output value.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>the filtered input value. </dd></dl> <p>Implemented in <a class="el" href="classgr__fir__fff__altivec.html#aa1b8a9d8435b82e208047ab6b79d05be">gr_fir_fff_altivec</a>, <a class="el" href="classgr__fir__fff__armv7__a.html#aab3ad9afac32fc42b770ba89a3df0adb">gr_fir_fff_armv7_a</a>, <a class="el" href="classgr__fir__fff__generic.html#a9c78953f14ec2db18421d53309ab2541">gr_fir_fff_generic</a>, and <a class="el" href="classgr__fir__fff__simd.html#af7851e658801505687df0f94f85fb34a">gr_fir_fff_simd</a>.</p> </div> </div> <a class="anchor" id="ad53a1e12dd89e647fdbeea37691df85a"></a><!-- doxytag: member="gr_fir_fff::filterN" ref="ad53a1e12dd89e647fdbeea37691df85a" args="(float output[], const float input[], unsigned long n)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gr_fir_fff::filterN </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>output</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const float </td> <td class="paramname"> <em>input</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>n</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>compute an array of N output values. </p> <p><code>input</code> must have (n - 1 + <a class="el" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps()</a>) valid entries. input[0] .. input[n - 1 + <a class="el" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps()</a> - 1] are referenced to compute the output values. </p> <p>Implemented in <a class="el" href="classgr__fir__fff__generic.html#a7e3e776a481dabaf2511e8c1cb70dcc4">gr_fir_fff_generic</a>.</p> </div> </div> <a class="anchor" id="a930255550bf68802cd694fe79091738f"></a><!-- doxytag: member="gr_fir_fff::filterNdec" ref="a930255550bf68802cd694fe79091738f" args="(float output[], const float input[], unsigned long n, unsigned decimate)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gr_fir_fff::filterNdec </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>output</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const float </td> <td class="paramname"> <em>input</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>n</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned </td> <td class="paramname"> <em>decimate</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>compute an array of N output values, decimating the input </p> <p><code>input</code> must have (decimate * (n - 1) + <a class="el" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps()</a>) valid entries. input[0] .. input[decimate * (n - 1) + <a class="el" href="classgr__fir__fff.html#ac199a4f381799624a28559c9d8f76826">ntaps()</a> - 1] are referenced to compute the output values. </p> <p>Implemented in <a class="el" href="classgr__fir__fff__generic.html#aad21a689717ce5e0f1fd7bcdd798ca49">gr_fir_fff_generic</a>.</p> </div> </div> <a class="anchor" id="a4c8fdac7c6d2d3eea81064c7ed5f25e6"></a><!-- doxytag: member="gr_fir_fff::get_taps" ref="a4c8fdac7c6d2d3eea81064c7ed5f25e6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="classstd_1_1vector.html">std::vector</a><float> gr_fir_fff::get_taps </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>current taps </dd></dl> <p>References <a class="el" href="gr__fir__fff_8h_source.html#l00050">d_taps</a>, and <a class="el" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse()</a>.</p> </div> </div> <a class="anchor" id="ac199a4f381799624a28559c9d8f76826"></a><!-- doxytag: member="gr_fir_fff::ntaps" ref="ac199a4f381799624a28559c9d8f76826" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned gr_fir_fff::ntaps </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>number of taps in filter. </dd></dl> <p>References <a class="el" href="gr__fir__fff_8h_source.html#l00050">d_taps</a>.</p> </div> </div> <a class="anchor" id="ad692c67d571c9fdd45a214bac28c38d6"></a><!-- doxytag: member="gr_fir_fff::set_taps" ref="ad692c67d571c9fdd45a214bac28c38d6" args="(const std::vector< float > &taps)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gr_fir_fff::set_taps </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td> <td class="paramname"> <em>taps</em></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>install <code>new_taps</code> as the current taps. </p> <p>Reimplemented in <a class="el" href="classgr__fir__fff__altivec.html#a7d38cc74814840008f179064825e945b">gr_fir_fff_altivec</a>, <a class="el" href="classgr__fir__fff__armv7__a.html#a7603286aba8b8676c5e5cefdc4a1438a">gr_fir_fff_armv7_a</a>, and <a class="el" href="classgr__fir__fff__simd.html#a222d088b12c98ffbdfa6964da92948ca">gr_fir_fff_simd</a>.</p> <p>References <a class="el" href="gr__fir__fff_8h_source.html#l00050">d_taps</a>, and <a class="el" href="gr__reverse_8h.html#a0e0995ad6539dd54e5e331ccb3681932">gr_reverse()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a1777535e2e5c1ea2618e6034bf27cd03"></a><!-- doxytag: member="gr_fir_fff::d_taps" ref="a1777535e2e5c1ea2618e6034bf27cd03" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1vector.html">std::vector</a><float> <a class="el" href="classgr__fir__fff.html#a1777535e2e5c1ea2618e6034bf27cd03">gr_fir_fff::d_taps</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="gr__fir__fff_8h_source.html#l00117">get_taps()</a>, <a class="el" href="gr__fir__fff_8h_source.html#l00112">ntaps()</a>, and <a class="el" href="gr__fir__fff_8h_source.html#l00102">set_taps()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gr__fir__fff_8h_source.html">gr_fir_fff.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:43 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>