<!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_rational_resampler_base_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_rational_resampler_base_fff Class Reference<br/>
<small>
[<a class="el" href="group__filter__blk.html">Filters</a>]</small>
</h1><!-- doxytag: class="gr_rational_resampler_base_fff" --><!-- doxytag: inherits="gr_block" -->
<p>Rational Resampling Polyphase FIR filter with float input, float output and float taps.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__rational__resampler__base__fff_8h_source.html">gr_rational_resampler_base_fff.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_rational_resampler_base_fff:</div>
<div class="dynsection">
<div class="center"><img src="classgr__rational__resampler__base__fff__inherit__graph.png" border="0" usemap="#gr__rational__resampler__base__fff_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__rational__resampler__base__fff_inherit__map" id="gr__rational__resampler__base__fff_inherit__map">
<area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="71,237,140,267"/><area shape="rect" id="node4" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="51,160,160,189"/><area shape="rect" id="node6" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="44,83,167,112"/><area shape="rect" id="node8" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="36,5,175,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__rational__resampler__base__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__rational__resampler__base__fff.html#a515820896617abaf6f09db8a70c06e89">~gr_rational_resampler_base_fff</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#a6c6978e86e41cf36ec46f1fd8da58f00">history</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#a105db50c0961705e18244f5e865b957b">set_history</a> (unsigned history)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#ade2661514662f32e9855573db91149b1">interpolation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#a5a7ffd12b033b04948fa4505ababb611">decimation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#a1ff0be0794d415b229423926c9c60998">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="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#af847541f01c596484aae869742c368c6">forecast</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items_required)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Estimate input requirements given output request. <a href="#af847541f01c596484aae869742c368c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#a93f8b04731192e9b869119d3bc4335cf">general_work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute output items from input items <a href="#a93f8b04731192e9b869119d3bc4335cf"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_rational_resampler_base_fff_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__rational__resampler__base__fff.html#ab32459081aa0b2538dd1a0813ca9cf72">gr_make_rational_resampler_base_fff</a> (unsigned interpolation, unsigned decimation, 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>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Rational Resampling Polyphase FIR filter with float input, float output and float taps. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a515820896617abaf6f09db8a70c06e89"></a><!-- doxytag: member="gr_rational_resampler_base_fff::~gr_rational_resampler_base_fff" ref="a515820896617abaf6f09db8a70c06e89" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_rational_resampler_base_fff::~gr_rational_resampler_base_fff </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5a7ffd12b033b04948fa4505ababb611"></a><!-- doxytag: member="gr_rational_resampler_base_fff::decimation" ref="a5a7ffd12b033b04948fa4505ababb611" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_rational_resampler_base_fff::decimation </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af847541f01c596484aae869742c368c6"></a><!-- doxytag: member="gr_rational_resampler_base_fff::forecast" ref="af847541f01c596484aae869742c368c6" args="(int noutput_items, gr_vector_int &ninput_items_required)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_rational_resampler_base_fff::forecast </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_int</a> & </td>
<td class="paramname"> <em>ninput_items_required</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Estimate input requirements given output request. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>noutput_items</em> </td><td>number of output items to produce </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ninput_items_required</em> </td><td>number of input items required on each input stream</td></tr>
</table>
</dd>
</dl>
<p>Given a request to product <code>noutput_items</code>, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#aa1f2518b5c97126bb015adb9e2027f4a">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a93f8b04731192e9b869119d3bc4335cf"></a><!-- doxytag: member="gr_rational_resampler_base_fff::general_work" ref="a93f8b04731192e9b869119d3bc4335cf" args="(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_rational_resampler_base_fff::general_work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_int</a> & </td>
<td class="paramname"> <em>ninput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"> <em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"> <em>output_items</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compute output items from input items </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>noutput_items</em> </td><td>number of output items to write on each output stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ninput_items</em> </td><td>number of input items available on each input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>input_items</em> </td><td>vector of pointers to the input items, one entry per input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output_items</em> </td><td>vector of pointers to the output items, one entry per output stream</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items</dd></dl>
<p>general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </p>
<p>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a6c6978e86e41cf36ec46f1fd8da58f00"></a><!-- doxytag: member="gr_rational_resampler_base_fff::history" ref="a6c6978e86e41cf36ec46f1fd8da58f00" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_rational_resampler_base_fff::history </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assume block computes y_i = f(x_i, x_i-1, x_i-2, x_i-3...) History is the number of x_i's that are examined to produce one y_i. This comes in handy for FIR filters, where we use history to ensure that our input contains the appropriate "history" for the filter. History should be equal to the number of filter taps. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#ad3b305a663f4b5b5c4e17070d00f05d9">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="ade2661514662f32e9855573db91149b1"></a><!-- doxytag: member="gr_rational_resampler_base_fff::interpolation" ref="ade2661514662f32e9855573db91149b1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_rational_resampler_base_fff::interpolation </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a105db50c0961705e18244f5e865b957b"></a><!-- doxytag: member="gr_rational_resampler_base_fff::set_history" ref="a105db50c0961705e18244f5e865b957b" args="(unsigned history)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_rational_resampler_base_fff::set_history </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>history</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classgr__block.html#a7c1c85a2d47f72255efd821a6f98f7ba">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a1ff0be0794d415b229423926c9c60998"></a><!-- doxytag: member="gr_rational_resampler_base_fff::set_taps" ref="a1ff0be0794d415b229423926c9c60998" args="(const std::vector< float > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_rational_resampler_base_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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ab32459081aa0b2538dd1a0813ca9cf72"></a><!-- doxytag: member="gr_rational_resampler_base_fff::gr_make_rational_resampler_base_fff" ref="ab32459081aa0b2538dd1a0813ca9cf72" args="(unsigned interpolation, unsigned decimation, const std::vector< float > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_rational_resampler_base_fff_sptr</a> gr_make_rational_resampler_base_fff </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>interpolation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>decimation</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__rational__resampler__base__fff_8h_source.html">gr_rational_resampler_base_fff.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:54 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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
def0228095a1541e2d3632b6b6da7c38
>
files
>
2398
