<!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_sync_interpolator Class Reference</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('classgr__sync__interpolator.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>gr_sync_interpolator Class Reference<div class="ingroups"><a class="el" href="group__base__blk.html">Base classes for GR Blocks</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_sync_interpolator" --><!-- doxytag: inherits="gr_sync_block" -->
<p>synchronous 1:N input to output with historyOverride work to provide the signal processing implementation.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__sync__interpolator_8h_source.html">gr_sync_interpolator.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_sync_interpolator:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__sync__interpolator__inherit__graph.png" border="0" usemap="#gr__sync__interpolator_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__sync__interpolator_inherit__map" id="gr__sync__interpolator_inherit__map">
<area shape="rect" id="node9" href="classcvsd__decode__bs.html" title="This block performs CVSD audio decoding. Its design and implementation is modeled after the CVSD enco..." alt="" coords="671,5,791,35"/><area shape="rect" id="node11" href="classgr__bytes__to__syms.html" title="Convert stream of bytes to stream of +/- 1 symbolsinput: stream of bytes; output: stream of float..." alt="" coords="667,59,795,88"/><area shape="rect" id="node13" href="classgr__chunks__to__symbols__bc.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation ..." alt="" coords="643,112,819,141"/><area shape="rect" id="node15" href="classgr__chunks__to__symbols__bf.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation ..." alt="" coords="644,165,817,195"/><area shape="rect" id="node17" href="classgr__chunks__to__symbols__ic.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation ..." alt="" coords="644,219,817,248"/><area shape="rect" id="node19" href="classgr__chunks__to__symbols__if.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation ..." alt="" coords="645,272,816,301"/><area shape="rect" id="node21" href="classgr__chunks__to__symbols__sc.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation ..." alt="" coords="643,325,819,355"/><area shape="rect" id="node23" href="classgr__chunks__to__symbols__sf.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation ..." alt="" coords="644,379,817,408"/><area shape="rect" id="node25" href="classgr__complex__to__interleaved__short.html" title="Convert stream of complex to a stream of interleaved shorts." alt="" coords="624,432,837,461"/><area shape="rect" id="node27" href="classgr__cpfsk__bc.html" title="Perform continuous phase 2-level frequency shift keying modulation on an input stream of unpacked bit..." alt="" coords="684,485,777,515"/><area shape="rect" id="node29" href="classgr__encode__ccsds__27__bb.html" title="A rate 1/2, k=7 convolutional encoder for the CCSDS standardThis block performs convolutional encodin..." alt="" coords="648,539,813,568"/><area shape="rect" id="node31" href="classgr__interleave.html" title="interleave N inputs to a single output" alt="" coords="683,592,779,621"/><area shape="rect" id="node33" href="classgr__interp__fir__filter__ccc.html" title="Interpolating FIR filter with gr_complex input, gr_complex output and gr_complex taps." alt="" coords="656,645,805,675"/><area shape="rect" id="node35" href="classgr__interp__fir__filter__ccf.html" title="Interpolating FIR filter with gr_complex input, gr_complex output and float taps." alt="" coords="657,699,804,728"/><area shape="rect" id="node37" href="classgr__interp__fir__filter__fcc.html" title="Interpolating FIR filter with float input, gr_complex output and gr_complex taps." alt="" coords="657,752,804,781"/><area shape="rect" id="node39" href="classgr__interp__fir__filter__fff.html" title="Interpolating FIR filter with float input, float output and float taps." alt="" coords="660,805,801,835"/><area shape="rect" id="node41" href="classgr__interp__fir__filter__fsf.html" title="Interpolating FIR filter with float input, short output and float taps." alt="" coords="659,859,803,888"/><area shape="rect" id="node43" href="classgr__interp__fir__filter__scc.html" title="Interpolating FIR filter with short input, gr_complex output and gr_complex taps." alt="" coords="656,912,805,941"/><area shape="rect" id="node45" href="classgr__ofdm__cyclic__prefixer.html" title="adds a cyclic prefix vector to an input size long ofdm symbol(vector) and converts vector to a stream..." alt="" coords="651,965,811,995"/><area shape="rect" id="node47" href="classgr__repeat.html" title="Repeat a sample 'interp' times in output stream." alt="" coords="693,1019,768,1048"/><area shape="rect" id="node49" href="classgr__streams__to__stream.html" title="Convert N streams of 1 item into a 1 stream of N itemsConvert N streams of 1 item into 1 stream of N ..." alt="" coords="655,1072,807,1101"/><area shape="rect" id="node51" href="classgr__unpack__k__bits__bb.html" title="Converts a byte with k relevent bits to k output bytes with 1 bit in the LSB." alt="" coords="659,1125,803,1155"/><area shape="rect" id="node53" href="classgr__vector__to__stream.html" title="convert a stream of blocks of nitems_per_block items into a stream of items" alt="" coords="660,1179,801,1208"/><area shape="rect" id="node55" href="classgsm__fr__decode__ps.html" title="GSM 06.10 Full Rate Vocoder Decoder." alt="" coords="665,1232,796,1261"/><area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="283,619,389,648"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="164,619,233,648"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ..." alt="" coords="5,619,115,648"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__sync__interpolator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__interpolator.html#a39beb8a7754295afcc0ff4e5240ceaaf">interpolation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__interpolator.html#a25bb02d6ac26404780bdd217355107ad">set_interpolation</a> (unsigned interpolation)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__interpolator.html#a81ef017ef4ec17d0808cd1c0e2ceb803">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="#a81ef017ef4ec17d0808cd1c0e2ceb803"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__interpolator.html#a49cd2967b214ead14270d97dab932301">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="#a49cd2967b214ead14270d97dab932301"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__interpolator.html#a943227c6134e71a7867a66977b414533">fixed_rate_ninput_to_noutput</a> (int ninput)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. <a href="#a943227c6134e71a7867a66977b414533"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__interpolator.html#a03961e37cf520668a87f53762e638b9f">fixed_rate_noutput_to_ninput</a> (int noutput)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. <a href="#a03961e37cf520668a87f53762e638b9f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__interpolator.html#a0038ee6e80dc446b02ff1caf2556780b">gr_sync_interpolator</a> (const std::string &name, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> input_signature, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> output_signature, unsigned interpolation)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>synchronous 1:N input to output with history</p>
<p>Override work to provide the signal processing implementation. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0038ee6e80dc446b02ff1caf2556780b"></a><!-- doxytag: member="gr_sync_interpolator::gr_sync_interpolator" ref="a0038ee6e80dc446b02ff1caf2556780b" args="(const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature, unsigned interpolation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_sync_interpolator::gr_sync_interpolator </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> </td>
<td class="paramname"><em>input_signature</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> </td>
<td class="paramname"><em>output_signature</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>interpolation</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a943227c6134e71a7867a66977b414533"></a><!-- doxytag: member="gr_sync_interpolator::fixed_rate_ninput_to_noutput" ref="a943227c6134e71a7867a66977b414533" args="(int ninput)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_sync_interpolator::fixed_rate_ninput_to_noutput </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>ninput</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. </p>
<p>Reimplemented from <a class="el" href="classgr__sync__block.html#a0cbbc0ce275498411248e678038710b2">gr_sync_block</a>.</p>
</div>
</div>
<a class="anchor" id="a03961e37cf520668a87f53762e638b9f"></a><!-- doxytag: member="gr_sync_interpolator::fixed_rate_noutput_to_ninput" ref="a03961e37cf520668a87f53762e638b9f" args="(int noutput)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_sync_interpolator::fixed_rate_noutput_to_ninput </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>noutput</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. </p>
<p>Reimplemented from <a class="el" href="classgr__sync__block.html#adaecb00ae09408c22e46c44d09aad53e">gr_sync_block</a>.</p>
</div>
</div>
<a class="anchor" id="a81ef017ef4ec17d0808cd1c0e2ceb803"></a><!-- doxytag: member="gr_sync_interpolator::forecast" ref="a81ef017ef4ec17d0808cd1c0e2ceb803" 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_sync_interpolator::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>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">noutput_items</td><td>number of output items to produce </td></tr>
<tr><td class="paramname">ninput_items_required</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__sync__block.html#a1327e83509baf039aa3c816ea81a8f22">gr_sync_block</a>.</p>
</div>
</div>
<a class="anchor" id="a49cd2967b214ead14270d97dab932301"></a><!-- doxytag: member="gr_sync_interpolator::general_work" ref="a49cd2967b214ead14270d97dab932301" 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_sync_interpolator::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>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">noutput_items</td><td>number of output items to write on each output stream </td></tr>
<tr><td class="paramname">ninput_items</td><td>number of input items available on each input stream </td></tr>
<tr><td class="paramname">input_items</td><td>vector of pointers to the input items, one entry per input stream </td></tr>
<tr><td class="paramname">output_items</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>Reimplemented from <a class="el" href="classgr__sync__block.html#a56ca60b6bc20a3510f71d961891fa81b">gr_sync_block</a>.</p>
</div>
</div>
<a class="anchor" id="a39beb8a7754295afcc0ff4e5240ceaaf"></a><!-- doxytag: member="gr_sync_interpolator::interpolation" ref="a39beb8a7754295afcc0ff4e5240ceaaf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_sync_interpolator::interpolation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__sync__interpolator.html#a25bb02d6ac26404780bdd217355107ad">set_interpolation()</a>.</p>
</div>
</div>
<a class="anchor" id="a25bb02d6ac26404780bdd217355107ad"></a><!-- doxytag: member="gr_sync_interpolator::set_interpolation" ref="a25bb02d6ac26404780bdd217355107ad" args="(unsigned interpolation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_sync_interpolator::set_interpolation </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>interpolation</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__sync__interpolator.html#a39beb8a7754295afcc0ff4e5240ceaaf">interpolation()</a>, <a class="el" href="classgr__block.html#a14e8b799f920e52afb93fac413b1a729">gr_block::set_output_multiple()</a>, and <a class="el" href="classgr__block.html#ab9dc7e6d30692bbfa65fc7c4eef6fc9d">gr_block::set_relative_rate()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__sync__interpolator_8h_source.html">gr_sync_interpolator.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__sync__interpolator.html">gr_sync_interpolator</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
2079
