<!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_ff 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__clock__recovery__mm__ff.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_clock_recovery_mm_ff 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_clock_recovery_mm_ff" --><!-- doxytag: inherits="gr_block" -->
<p>Mueller and Müller (M&M) based clock recovery block with float input, float output.This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__clock__recovery__mm__ff_8h_source.html">gr_clock_recovery_mm_ff.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_clock_recovery_mm_ff:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__clock__recovery__mm__ff__inherit__graph.png" border="0" usemap="#gr__clock__recovery__mm__ff_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__clock__recovery__mm__ff_inherit__map" id="gr__clock__recovery__mm__ff_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="56,83,125,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="36,5,145,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__ff-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__clock__recovery__mm__ff.html#a7b8d40e7648e04759a4d2159d874a9d3">~gr_clock_recovery_mm_ff</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__ff.html#ac56914de0d3761f739feda64958b62d8">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="#ac56914de0d3761f739feda64958b62d8"></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__ff.html#a7e8a022678f89fef38d13aa078230f93">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="#a7e8a022678f89fef38d13aa078230f93"></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__ff.html#a76e523017a5de71ff36e12b535d420d0">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__ff.html#a201960d91094177a8863ebdb03806c84">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__ff.html#a206c735267d2adf3e5278de9aaba3e13">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__ff.html#afb24bea3a50e52fbae99db673c77b6e1">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__ff.html#a639978675a6fc2be43a9590f2aa34898">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__ff.html#ac0eea43746feb2859f11e5a2c9b2077e">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__ff.html#a0c12eb61eb3d9433e6c5a45235a70a61">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__ff.html#a6c1489ccd93bd98085697234d403eae9">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__clock__recovery__mm__ff.html#af71a323118b12fa801323900aff1fd15">gr_clock_recovery_mm_ff</a> (float omega, float gain_omega, float mu, float gain_mu, float omega_relative_limit)</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_clock_recovery_mm_ff_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__clock__recovery__mm__ff.html#acfcfac16be25539fd56b2a9b0db85867">gr_make_clock_recovery_mm_ff</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>
<div class="textblock"><p>Mueller and Müller (M&M) based clock recovery block with float input, float output.</p>
<p>This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. </p>
<p>See "Digital Communication Receivers: Synchronization, Channel
Estimation and Signal Processing" by Heinrich Meyr, Marc Moeneclaey, & Stefan Fechtel. ISBN 0-471-50275-8. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7b8d40e7648e04759a4d2159d874a9d3"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::~gr_clock_recovery_mm_ff" ref="a7b8d40e7648e04759a4d2159d874a9d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_clock_recovery_mm_ff::~gr_clock_recovery_mm_ff </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af71a323118b12fa801323900aff1fd15"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::gr_clock_recovery_mm_ff" ref="af71a323118b12fa801323900aff1fd15" 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">gr_clock_recovery_mm_ff::gr_clock_recovery_mm_ff </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>
</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="ac56914de0d3761f739feda64958b62d8"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::forecast" ref="ac56914de0d3761f739feda64958b62d8" 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_ff::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="a206c735267d2adf3e5278de9aaba3e13"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::gain_mu" ref="a206c735267d2adf3e5278de9aaba3e13" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#a639978675a6fc2be43a9590f2aa34898">set_gain_mu()</a>.</p>
</div>
</div>
<a class="anchor" id="afb24bea3a50e52fbae99db673c77b6e1"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::gain_omega" ref="afb24bea3a50e52fbae99db673c77b6e1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#ac0eea43746feb2859f11e5a2c9b2077e">set_gain_omega()</a>.</p>
</div>
</div>
<a class="anchor" id="a7e8a022678f89fef38d13aa078230f93"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::general_work" ref="a7e8a022678f89fef38d13aa078230f93" 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_ff::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>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a76e523017a5de71ff36e12b535d420d0"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::mu" ref="a76e523017a5de71ff36e12b535d420d0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#a0c12eb61eb3d9433e6c5a45235a70a61">set_mu()</a>.</p>
</div>
</div>
<a class="anchor" id="a201960d91094177a8863ebdb03806c84"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::omega" ref="a201960d91094177a8863ebdb03806c84" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#a6c1489ccd93bd98085697234d403eae9">set_omega()</a>.</p>
</div>
</div>
<a class="anchor" id="a639978675a6fc2be43a9590f2aa34898"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::set_gain_mu" ref="a639978675a6fc2be43a9590f2aa34898" args="(float gain_mu)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#a206c735267d2adf3e5278de9aaba3e13">gain_mu()</a>.</p>
</div>
</div>
<a class="anchor" id="ac0eea43746feb2859f11e5a2c9b2077e"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::set_gain_omega" ref="ac0eea43746feb2859f11e5a2c9b2077e" args="(float gain_omega)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#afb24bea3a50e52fbae99db673c77b6e1">gain_omega()</a>.</p>
</div>
</div>
<a class="anchor" id="a0c12eb61eb3d9433e6c5a45235a70a61"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::set_mu" ref="a0c12eb61eb3d9433e6c5a45235a70a61" args="(float mu)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#a76e523017a5de71ff36e12b535d420d0">mu()</a>.</p>
</div>
</div>
<a class="anchor" id="a6c1489ccd93bd98085697234d403eae9"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::set_omega" ref="a6c1489ccd93bd98085697234d403eae9" args="(float omega)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_clock_recovery_mm_ff::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__clock__recovery__mm__ff.html#a201960d91094177a8863ebdb03806c84">omega()</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="acfcfac16be25539fd56b2a9b0db85867"></a><!-- doxytag: member="gr_clock_recovery_mm_ff::gr_make_clock_recovery_mm_ff" ref="acfcfac16be25539fd56b2a9b0db85867" 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_ff_sptr</a> gr_make_clock_recovery_mm_ff </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>
</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__clock__recovery__mm__ff_8h_source.html">gr_clock_recovery_mm_ff.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__clock__recovery__mm__ff.html">gr_clock_recovery_mm_ff</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
>
775
