<!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_decimator 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__decimator.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_decimator 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_decimator" --><!-- doxytag: inherits="gr_sync_block" -->
<p>synchronous N:1 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__decimator_8h_source.html">gr_sync_decimator.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_sync_decimator:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__sync__decimator__inherit__graph.png" border="0" usemap="#gr__sync__decimator_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__sync__decimator_inherit__map" id="gr__sync__decimator_inherit__map">
<area shape="rect" id="node9" href="classcvsd__encode__sb.html" title="This block performs CVSD audio encoding. Its design and implementation is modeled after the CVSD enco..." alt="" coords="665,5,785,35"/><area shape="rect" id="node11" href="classgr__adaptive__fir__ccf.html" title="Adaptive FIR filter with gr_complex input, gr_complex output and float taps." alt="" coords="660,59,791,88"/><area shape="rect" id="node15" href="classgr__decode__ccsds__27__fb.html" title="A rate 1/2, k=7 convolutional decoder for the CCSDS standardThis block performs soft-decision convolu..." alt="" coords="644,112,807,141"/><area shape="rect" id="node17" href="classgr__deinterleave.html" title="deinterleave a single input into N outputs" alt="" coords="671,165,780,195"/><area shape="rect" id="node19" href="classgr__fft__filter__ccc.html" title="Fast FFT filter with gr_complex input, gr_complex output and gr_complex taps." alt="" coords="669,219,781,248"/><area shape="rect" id="node21" href="classgr__fft__filter__fff.html" title="Fast FFT filter with float input, float output and float taps." alt="" coords="675,272,776,301"/><area shape="rect" id="node23" href="classgr__fir__filter__ccc.html" title="FIR filter with gr_complex input, gr_complex output and gr_complex taps." alt="" coords="671,325,780,355"/><area shape="rect" id="node25" href="classgr__fir__filter__ccf.html" title="FIR filter with gr_complex input, gr_complex output and float taps." alt="" coords="672,379,779,408"/><area shape="rect" id="node27" href="classgr__fir__filter__fcc.html" title="FIR filter with float input, gr_complex output and gr_complex taps." alt="" coords="672,432,779,461"/><area shape="rect" id="node29" href="classgr__fir__filter__fff.html" title="FIR filter with float input, float output and float taps." alt="" coords="675,485,776,515"/><area shape="rect" id="node31" href="classgr__fir__filter__fsf.html" title="FIR filter with float input, short output and float taps." alt="" coords="673,539,777,568"/><area shape="rect" id="node33" href="classgr__fir__filter__scc.html" title="FIR filter with short input, gr_complex output and gr_complex taps." alt="" coords="671,592,780,621"/><area shape="rect" id="node35" href="classgr__freq__xlating__fir__filter__ccc.html" title="FIR filter combined with frequency translation with gr_complex input, gr_complex output and gr_comple..." alt="" coords="633,645,817,675"/><area shape="rect" id="node37" href="classgr__freq__xlating__fir__filter__ccf.html" title="FIR filter combined with frequency translation with gr_complex input, gr_complex output and float tap..." alt="" coords="635,699,816,728"/><area shape="rect" id="node39" href="classgr__freq__xlating__fir__filter__fcc.html" title="FIR filter combined with frequency translation with float input, gr_complex output and gr_complex tap..." alt="" coords="635,752,816,781"/><area shape="rect" id="node41" href="classgr__freq__xlating__fir__filter__fcf.html" title="FIR filter combined with frequency translation with float input, gr_complex output and float tapsThis..." alt="" coords="636,805,815,835"/><area shape="rect" id="node43" href="classgr__freq__xlating__fir__filter__scc.html" title="FIR filter combined with frequency translation with short input, gr_complex output and gr_complex tap..." alt="" coords="633,859,817,888"/><area shape="rect" id="node45" href="classgr__freq__xlating__fir__filter__scf.html" title="FIR filter combined with frequency translation with short input, gr_complex output and float tapsThis..." alt="" coords="635,912,816,941"/><area shape="rect" id="node47" href="classgr__goertzel__fc.html" title="Goertzel single-bin DFT calculation." alt="" coords="673,965,777,995"/><area shape="rect" id="node49" href="classgr__integrate__cc.html" title="output = sum(input[0]...input[n])Integrate successive samples in input stream and decimate..." alt="" coords="671,1019,780,1048"/><area shape="rect" id="node51" href="classgr__integrate__ff.html" title="output = sum(input[0]...input[n])Integrate successive samples in input stream and decimate..." alt="" coords="673,1072,777,1101"/><area shape="rect" id="node53" href="classgr__integrate__ii.html" title="output = sum(input[0]...input[n])Integrate successive samples in input stream and decimate..." alt="" coords="675,1125,776,1155"/><area shape="rect" id="node55" href="classgr__integrate__ss.html" title="output = sum(input[0]...input[n])Integrate successive samples in input stream and decimate..." alt="" coords="671,1179,780,1208"/><area shape="rect" id="node57" href="classgr__interleaved__short__to__complex.html" title="Convert stream of interleaved shorts to a stream of complex." alt="" coords="619,1232,832,1261"/><area shape="rect" id="node59" href="classgr__ofdm__demapper__vcb.html" title="take a stream of vectors in from an FFT and demodulate to a stream of bits. Abstract class must be su..." alt="" coords="645,1285,805,1315"/><area shape="rect" id="node61" href="classgr__pn__correlator__cc.html" title="PN code sequential search correlator." alt="" coords="657,1339,793,1368"/><area shape="rect" id="node63" href="classgr__stream__to__streams.html" title="convert a stream of items into a N streams of itemsConverts a stream of N items into N streams of 1 i..." alt="" coords="649,1392,801,1421"/><area shape="rect" id="node65" href="classgr__stream__to__vector.html" title="convert a stream of items into a stream of blocks containing nitems_per_block" alt="" coords="655,1445,796,1475"/><area shape="rect" id="node67" href="classgsm__fr__encode__sp.html" title="GSM 06.10 Full Rate Vocoder Encodershorts in; 33 byte packets out." alt="" coords="660,1499,791,1528"/><area shape="rect" id="node69" href="classpager__flex__deinterleave.html" title="flex deinterleave description" alt="" coords="647,1552,804,1581"/><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,779,389,808"/><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,779,233,808"/><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,779,115,808"/><area shape="rect" id="node13" href="classgr__cma__equalizer__cc.html" title="Implements constant modulus adaptive filter on complex stream." alt="" coords="881,59,1025,88"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__sync__decimator-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__decimator.html#a285a3292be71f47df2e8f10a779eb752">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__sync__decimator.html#a5ae57c3e625dfaca6487a319c2078a57">set_decimation</a> (unsigned decimation)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a140792c0a9777b6b82eb220cdd424ecd">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="#a140792c0a9777b6b82eb220cdd424ecd"></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__decimator.html#a3a7d9a6487780922c14cbb76d46a0586">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="#a3a7d9a6487780922c14cbb76d46a0586"></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__decimator.html#a23c657d3c3f0482369648e1916751f6f">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="#a23c657d3c3f0482369648e1916751f6f"></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__decimator.html#a90041d67e72c64cb4d0f9a29bfbbd776">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="#a90041d67e72c64cb4d0f9a29bfbbd776"></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__decimator.html#ad3871148480f33b75202744974d9241c">gr_sync_decimator</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 decimation)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>synchronous N:1 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="ad3871148480f33b75202744974d9241c"></a><!-- doxytag: member="gr_sync_decimator::gr_sync_decimator" ref="ad3871148480f33b75202744974d9241c" args="(const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature, unsigned decimation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_sync_decimator::gr_sync_decimator </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>decimation</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="a285a3292be71f47df2e8f10a779eb752"></a><!-- doxytag: member="gr_sync_decimator::decimation" ref="a285a3292be71f47df2e8f10a779eb752" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_sync_decimator::decimation </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__decimator.html#a5ae57c3e625dfaca6487a319c2078a57">set_decimation()</a>.</p>
</div>
</div>
<a class="anchor" id="a23c657d3c3f0482369648e1916751f6f"></a><!-- doxytag: member="gr_sync_decimator::fixed_rate_ninput_to_noutput" ref="a23c657d3c3f0482369648e1916751f6f" args="(int ninput)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_sync_decimator::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="a90041d67e72c64cb4d0f9a29bfbbd776"></a><!-- doxytag: member="gr_sync_decimator::fixed_rate_noutput_to_ninput" ref="a90041d67e72c64cb4d0f9a29bfbbd776" args="(int noutput)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_sync_decimator::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="a140792c0a9777b6b82eb220cdd424ecd"></a><!-- doxytag: member="gr_sync_decimator::forecast" ref="a140792c0a9777b6b82eb220cdd424ecd" 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_decimator::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="a3a7d9a6487780922c14cbb76d46a0586"></a><!-- doxytag: member="gr_sync_decimator::general_work" ref="a3a7d9a6487780922c14cbb76d46a0586" 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_decimator::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="a5ae57c3e625dfaca6487a319c2078a57"></a><!-- doxytag: member="gr_sync_decimator::set_decimation" ref="a5ae57c3e625dfaca6487a319c2078a57" args="(unsigned decimation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_sync_decimator::set_decimation </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>decimation</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__sync__decimator.html#a285a3292be71f47df2e8f10a779eb752">decimation()</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__decimator_8h_source.html">gr_sync_decimator.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__sync__decimator.html">gr_sync_decimator</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
>
2074
