<!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_dd_mpsk_sync_cc 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__dd__mpsk__sync__cc.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> | <a href="#friends">Friends</a> </div> <div class="headertitle"> <h1>gr_dd_mpsk_sync_cc Class Reference<div class="ingroups"><a class="el" href="group__sync__blk.html">Synchronization</a></div></h1> </div> </div> <div class="contents"> <!-- doxytag: class="gr_dd_mpsk_sync_cc" --><!-- doxytag: inherits="gr_block" --> <p>Decision directed M-PSK synchronous demodThis block performs joint carrier tracking and symbol timing recovery. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__dd__mpsk__sync__cc_8h_source.html">gr_dd_mpsk_sync_cc.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_dd_mpsk_sync_cc:</div> <div class="dyncontent"> <div class="center"><img src="classgr__dd__mpsk__sync__cc__inherit__graph.png" border="0" usemap="#gr__dd__mpsk__sync__cc_inherit__map" alt="Inheritance graph"/></div> <map name="gr__dd__mpsk__sync__cc_inherit__map" id="gr__dd__mpsk__sync__cc_inherit__map"> <area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="45,83,115,112"/><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 abstraction of an ..." alt="" coords="25,5,135,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__dd__mpsk__sync__cc-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#a819a802e07f108984ce9e714b5ecc8db">~gr_dd_mpsk_sync_cc</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#ac66825ce2aa809b67d115230be6b5d1c">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="#ac66825ce2aa809b67d115230be6b5d1c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#a121b460945aad49f7de9b379ca11a575">mu</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#a1bb9b1fa3e94bd49f6b0f420ae777272">omega</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#aa740bd4c2b4a1bd5308a2f28e88db121">gain_mu</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#ae82e530d764cee18d7bcb30da5368474">gain_omega</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#ae1870931ae0113bfc5dded42ffbb18bf">set_gain_mu</a> (float gain_mu)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#a034144109a494a86d97b4194e134d2d7">set_gain_omega</a> (float gain_omega)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#abc43d441d4d2a319ada46bbb91fad82e">set_mu</a> (float mu)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#a2998c88b13849abb754350c5f51b1d07">set_omega</a> (float omega)</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__dd__mpsk__sync__cc.html#abda9d523df71c20dedef767b4e05f581">gr_dd_mpsk_sync_cc</a> (float alpha, float beta, float max_freq, float min_freq, float ref_phase, float omega, float gain_omega, float mu, float gain_mu)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#a4b2511faef74997cb05af32d352593e8">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="#a4b2511faef74997cb05af32d352593e8"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="friends"></a> Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_dd_mpsk_sync_cc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dd__mpsk__sync__cc.html#a768410b456fa895d2e73964c4744d1cd">gr_make_dd_mpsk_sync_cc</a> (float alpha, float beta, float max_freq, float min_freq, float ref_phase, float omega, float gain_omega, float mu, float gain_mu)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Decision directed M-PSK synchronous demod</p> <p>This block performs joint carrier tracking and symbol timing recovery. </p> <p>input: complex baseband; output: properly timed complex samples ready for slicing.</p> <p>N.B, at this point, it handles only QPSK. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a819a802e07f108984ce9e714b5ecc8db"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::~gr_dd_mpsk_sync_cc" ref="a819a802e07f108984ce9e714b5ecc8db" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_dd_mpsk_sync_cc::~gr_dd_mpsk_sync_cc </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="abda9d523df71c20dedef767b4e05f581"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::gr_dd_mpsk_sync_cc" ref="abda9d523df71c20dedef767b4e05f581" args="(float alpha, float beta, float max_freq, float min_freq, float ref_phase, float omega, float gain_omega, float mu, float gain_mu)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_dd_mpsk_sync_cc::gr_dd_mpsk_sync_cc </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>alpha</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>beta</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>max_freq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>min_freq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>ref_phase</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>omega</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>gain_omega</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>mu</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>gain_mu</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="ac66825ce2aa809b67d115230be6b5d1c"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::forecast" ref="ac66825ce2aa809b67d115230be6b5d1c" 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_dd_mpsk_sync_cc::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__block.html#aa1f2518b5c97126bb015adb9e2027f4a">gr_block</a>.</p> </div> </div> <a class="anchor" id="aa740bd4c2b4a1bd5308a2f28e88db121"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::gain_mu" ref="aa740bd4c2b4a1bd5308a2f28e88db121" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_dd_mpsk_sync_cc::gain_mu </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__dd__mpsk__sync__cc.html#ae1870931ae0113bfc5dded42ffbb18bf">set_gain_mu()</a>.</p> </div> </div> <a class="anchor" id="ae82e530d764cee18d7bcb30da5368474"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::gain_omega" ref="ae82e530d764cee18d7bcb30da5368474" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_dd_mpsk_sync_cc::gain_omega </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__dd__mpsk__sync__cc.html#a034144109a494a86d97b4194e134d2d7">set_gain_omega()</a>.</p> </div> </div> <a class="anchor" id="a4b2511faef74997cb05af32d352593e8"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::general_work" ref="a4b2511faef74997cb05af32d352593e8" 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_dd_mpsk_sync_cc::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> [protected, 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>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p> </div> </div> <a class="anchor" id="a121b460945aad49f7de9b379ca11a575"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::mu" ref="a121b460945aad49f7de9b379ca11a575" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_dd_mpsk_sync_cc::mu </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__dd__mpsk__sync__cc.html#abc43d441d4d2a319ada46bbb91fad82e">set_mu()</a>.</p> </div> </div> <a class="anchor" id="a1bb9b1fa3e94bd49f6b0f420ae777272"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::omega" ref="a1bb9b1fa3e94bd49f6b0f420ae777272" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_dd_mpsk_sync_cc::omega </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__dd__mpsk__sync__cc.html#a2998c88b13849abb754350c5f51b1d07">set_omega()</a>.</p> </div> </div> <a class="anchor" id="ae1870931ae0113bfc5dded42ffbb18bf"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::set_gain_mu" ref="ae1870931ae0113bfc5dded42ffbb18bf" args="(float gain_mu)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_dd_mpsk_sync_cc::set_gain_mu </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>gain_mu</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="classgr__dd__mpsk__sync__cc.html#aa740bd4c2b4a1bd5308a2f28e88db121">gain_mu()</a>.</p> </div> </div> <a class="anchor" id="a034144109a494a86d97b4194e134d2d7"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::set_gain_omega" ref="a034144109a494a86d97b4194e134d2d7" args="(float gain_omega)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_dd_mpsk_sync_cc::set_gain_omega </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>gain_omega</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="classgr__dd__mpsk__sync__cc.html#ae82e530d764cee18d7bcb30da5368474">gain_omega()</a>.</p> </div> </div> <a class="anchor" id="abc43d441d4d2a319ada46bbb91fad82e"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::set_mu" ref="abc43d441d4d2a319ada46bbb91fad82e" args="(float mu)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_dd_mpsk_sync_cc::set_mu </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>mu</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="classgr__dd__mpsk__sync__cc.html#a121b460945aad49f7de9b379ca11a575">mu()</a>.</p> </div> </div> <a class="anchor" id="a2998c88b13849abb754350c5f51b1d07"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::set_omega" ref="a2998c88b13849abb754350c5f51b1d07" args="(float omega)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_dd_mpsk_sync_cc::set_omega </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>omega</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="classgr__dd__mpsk__sync__cc.html#a1bb9b1fa3e94bd49f6b0f420ae777272">omega()</a>.</p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a768410b456fa895d2e73964c4744d1cd"></a><!-- doxytag: member="gr_dd_mpsk_sync_cc::gr_make_dd_mpsk_sync_cc" ref="a768410b456fa895d2e73964c4744d1cd" args="(float alpha, float beta, float max_freq, float min_freq, float ref_phase, float omega, float gain_omega, float mu, float gain_mu)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_dd_mpsk_sync_cc_sptr</a> gr_make_dd_mpsk_sync_cc </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>alpha</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>beta</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>max_freq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>min_freq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>ref_phase</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>omega</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>gain_omega</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>mu</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>gain_mu</em> </td> </tr> <tr> <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__dd__mpsk__sync__cc_8h_source.html">gr_dd_mpsk_sync_cc.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classgr__dd__mpsk__sync__cc.html">gr_dd_mpsk_sync_cc</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>