<!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_clock_recovery_mm_cc 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.2 --> <div class="contents"> <h1>gr_clock_recovery_mm_cc Class Reference<br/> <small> [<a class="el" href="group__sync__blk.html">Synchronization</a>]</small> </h1><!-- doxytag: class="gr_clock_recovery_mm_cc" --><!-- doxytag: inherits="gr_block" --> <p>Mueller and Müller (M&M) based clock recovery block with complex input, complex output.This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. The complex version here is based on: Modified Mueller and Muller clock recovery circuit Based: G. R. Danesfahani, T.G. Jeans, "Optimisation of modified Mueller and Muller algorithm," Electronics Letters, Vol. 31, no. 13, 22 June 1995, pp. 1032 - 1033. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__clock__recovery__mm__cc_8h_source.html">gr_clock_recovery_mm_cc.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_clock_recovery_mm_cc:</div> <div class="dynsection"> <div class="center"><img src="classgr__clock__recovery__mm__cc__inherit__graph.png" border="0" usemap="#gr__clock__recovery__mm__cc_inherit__map" alt="Inheritance graph"/></div> <map name="gr__clock__recovery__mm__cc_inherit__map" id="gr__clock__recovery__mm__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..." alt="" coords="60,83,129,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..." alt="" coords="40,5,149,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__clock__recovery__mm__cc-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__clock__recovery__mm__cc.html#a366ed7c384f193ffdfce0b46e5f01420">~gr_clock_recovery_mm_cc</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__clock__recovery__mm__cc.html#a1e8163d25765d1a34a0b1e06b067781a">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="#a1e8163d25765d1a34a0b1e06b067781a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__clock__recovery__mm__cc.html#ae069ef90c7b6dd6c6592ae64e0a498b7">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="#ae069ef90c7b6dd6c6592ae64e0a498b7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__clock__recovery__mm__cc.html#a621dc8828bbc3766a32bdee5e92bbf0a">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__clock__recovery__mm__cc.html#a88fed85be8f81ea644c1fdfd23795263">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__clock__recovery__mm__cc.html#a57e5b142f0990de19a2bc106620c8108">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__clock__recovery__mm__cc.html#a0f2cadb649b88b7254247d4f84c5ae2d">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__clock__recovery__mm__cc.html#ad64b060674df8eb0f5f66d1a1e189783">set_verbose</a> (<a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> verbose)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__clock__recovery__mm__cc.html#a38253e2898398a474590b30a2d387d4d">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__clock__recovery__mm__cc.html#abb4514b377a27de250362fcb5f1547ab">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__clock__recovery__mm__cc.html#a804d8256009b8051e53e8987594068ed">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__clock__recovery__mm__cc.html#adf35a4edc790217345649b47ddf078e8">set_omega</a> (float omega)</td></tr> <tr><td colspan="2"><h2>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__clock__recovery__mm__cc.html#a61e37cc5d01feed019a83c974ea76c1e">gr_clock_recovery_mm_cc</a> (float omega, float gain_omega, float mu, float gain_mu, float omega_relative_limi)</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_clock_recovery_mm_cc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__clock__recovery__mm__cc.html#ae8848f973160df3279ce087f01636c03">gr_make_clock_recovery_mm_cc</a> (float omega, float gain_omega, float mu, float gain_mu, float omega_relative_limit)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Mueller and Müller (M&M) based clock recovery block with complex input, complex output.</p> <p>This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. The complex version here is based on: Modified Mueller and Muller clock recovery circuit Based: G. R. Danesfahani, T.G. Jeans, "Optimisation of modified Mueller and Muller algorithm," Electronics Letters, Vol. 31, no. 13, 22 June 1995, pp. 1032 - 1033. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a366ed7c384f193ffdfce0b46e5f01420"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::~gr_clock_recovery_mm_cc" ref="a366ed7c384f193ffdfce0b46e5f01420" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_clock_recovery_mm_cc::~gr_clock_recovery_mm_cc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a61e37cc5d01feed019a83c974ea76c1e"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::gr_clock_recovery_mm_cc" ref="a61e37cc5d01feed019a83c974ea76c1e" args="(float omega, float gain_omega, float mu, float gain_mu, float omega_relative_limi)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_clock_recovery_mm_cc::gr_clock_recovery_mm_cc </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 class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>omega_relative_limi</em></td><td> </td> </tr> <tr> <td></td> <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="a1e8163d25765d1a34a0b1e06b067781a"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::forecast" ref="a1e8163d25765d1a34a0b1e06b067781a" 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_clock_recovery_mm_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><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="a57e5b142f0990de19a2bc106620c8108"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::gain_mu" ref="a57e5b142f0990de19a2bc106620c8108" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_clock_recovery_mm_cc::gain_mu </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="a0f2cadb649b88b7254247d4f84c5ae2d"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::gain_omega" ref="a0f2cadb649b88b7254247d4f84c5ae2d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_clock_recovery_mm_cc::gain_omega </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="ae069ef90c7b6dd6c6592ae64e0a498b7"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::general_work" ref="ae069ef90c7b6dd6c6592ae64e0a498b7" 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_clock_recovery_mm_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><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="a621dc8828bbc3766a32bdee5e92bbf0a"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::mu" ref="a621dc8828bbc3766a32bdee5e92bbf0a" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_clock_recovery_mm_cc::mu </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="a88fed85be8f81ea644c1fdfd23795263"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::omega" ref="a88fed85be8f81ea644c1fdfd23795263" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_clock_recovery_mm_cc::omega </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="a38253e2898398a474590b30a2d387d4d"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::set_gain_mu" ref="a38253e2898398a474590b30a2d387d4d" args="(float gain_mu)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_clock_recovery_mm_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"> </div> </div> <a class="anchor" id="abb4514b377a27de250362fcb5f1547ab"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::set_gain_omega" ref="abb4514b377a27de250362fcb5f1547ab" args="(float gain_omega)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_clock_recovery_mm_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"> </div> </div> <a class="anchor" id="a804d8256009b8051e53e8987594068ed"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::set_mu" ref="a804d8256009b8051e53e8987594068ed" args="(float mu)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_clock_recovery_mm_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"> </div> </div> <a class="anchor" id="adf35a4edc790217345649b47ddf078e8"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::set_omega" ref="adf35a4edc790217345649b47ddf078e8" args="(float omega)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_clock_recovery_mm_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"> </div> </div> <a class="anchor" id="ad64b060674df8eb0f5f66d1a1e189783"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::set_verbose" ref="ad64b060674df8eb0f5f66d1a1e189783" args="(bool verbose)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_clock_recovery_mm_cc::set_verbose </td> <td>(</td> <td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td> <td class="paramname"> <em>verbose</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ae8848f973160df3279ce087f01636c03"></a><!-- doxytag: member="gr_clock_recovery_mm_cc::gr_make_clock_recovery_mm_cc" ref="ae8848f973160df3279ce087f01636c03" args="(float omega, float gain_omega, float mu, float gain_mu, float omega_relative_limit)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_clock_recovery_mm_cc_sptr</a> gr_make_clock_recovery_mm_cc </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 class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>omega_relative_limit</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__clock__recovery__mm__cc_8h_source.html">gr_clock_recovery_mm_cc.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>