<!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.3.0 C++ API: gr_pll_carriertracking_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.3 -->
<div class="contents">
<h1>gr_pll_carriertracking_cc Class Reference<br/>
<small>
[<a class="el" href="group__sync__blk.html">Synchronization</a>]</small>
</h1><!-- doxytag: class="gr_pll_carriertracking_cc" --><!-- doxytag: inherits="gr_sync_block" -->
<p>Implements a PLL which locks to the input frequency and outputs the input signal mixed with that carrier.input: stream of complex; output: stream of complex.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__pll__carriertracking__cc_8h_source.html">gr_pll_carriertracking_cc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_pll_carriertracking_cc:</div>
<div class="dynsection">
<div class="center"><img src="classgr__pll__carriertracking__cc__inherit__graph.png" border="0" usemap="#gr__pll__carriertracking__cc_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__pll__carriertracking__cc_inherit__map" id="gr__pll__carriertracking__cc_inherit__map">
<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..." alt="" coords="33,315,140,344"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="52,237,121,267"/><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..." alt="" coords="32,160,141,189"/><area shape="rect" id="node8" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="25,83,148,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="17,5,156,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__pll__carriertracking__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"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pll__carriertracking__cc.html#a27b39f0c7e1c65bd40e2012f0e17343f">lock_detector</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pll__carriertracking__cc.html#a0d552ad4fdd28f3103366d4ce258c5a1">squelch_enable</a> (<a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pll__carriertracking__cc.html#a0771dfdbe560d07ec8011781f389a6fe">set_lock_threshold</a> (float)</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_pll_carriertracking_cc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pll__carriertracking__cc.html#a21b0d274183c85c5e66122a00125f11c">gr_make_pll_carriertracking_cc</a> (float alpha, float beta, float max_freq, float min_freq)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implements a PLL which locks to the input frequency and outputs the input signal mixed with that carrier.</p>
<p>input: stream of complex; output: stream of complex. </p>
<p>This PLL locks onto a [possibly noisy] reference carrier on the input and outputs that signal, downconverted to DC</p>
<p>All settings max_freq and min_freq are in terms of radians per sample, NOT HERTZ. Alpha is the phase gain (first order, units of radians per radian) and beta is the frequency gain (second order, units of radians per sample per radian) </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgr__pll__freqdet__cf.html" title="Implements a PLL which locks to the input frequency and outputs an estimate of that...">gr_pll_freqdet_cf</a>, <a class="el" href="classgr__pll__carriertracking__cc.html" title="Implements a PLL which locks to the input frequency and outputs the input signal...">gr_pll_carriertracking_cc</a> </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a27b39f0c7e1c65bd40e2012f0e17343f"></a><!-- doxytag: member="gr_pll_carriertracking_cc::lock_detector" ref="a27b39f0c7e1c65bd40e2012f0e17343f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_pll_carriertracking_cc::lock_detector </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0771dfdbe560d07ec8011781f389a6fe"></a><!-- doxytag: member="gr_pll_carriertracking_cc::set_lock_threshold" ref="a0771dfdbe560d07ec8011781f389a6fe" args="(float)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_pll_carriertracking_cc::set_lock_threshold </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0d552ad4fdd28f3103366d4ce258c5a1"></a><!-- doxytag: member="gr_pll_carriertracking_cc::squelch_enable" ref="a0d552ad4fdd28f3103366d4ce258c5a1" args="(bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_pll_carriertracking_cc::squelch_enable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a21b0d274183c85c5e66122a00125f11c"></a><!-- doxytag: member="gr_pll_carriertracking_cc::gr_make_pll_carriertracking_cc" ref="a21b0d274183c85c5e66122a00125f11c" args="(float alpha, float beta, float max_freq, float min_freq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_pll_carriertracking_cc_sptr</a> gr_make_pll_carriertracking_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><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__pll__carriertracking__cc_8h_source.html">gr_pll_carriertracking_cc.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:53 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
