<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_simple_correlator.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('gr__simple__correlator_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">gr_simple_correlator.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="gr__simple__correlator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2004 Free Software Foundation, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef INCLUDED_GR_SIMPLE_CORRELATOR_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_SIMPLE_CORRELATOR_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="gr__core__api_8h.html">gr_core_api.h</a>></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="gr__block_8h.html">gr_block.h</a>></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <assert.h></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//#define DEBUG_SIMPLE_CORRELATOR</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span><a class="code" href="classgr__simple__correlator.html" title="inverse of gr_simple_framer (more or less)">gr_simple_correlator</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_simple_correlator></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_simple_correlator_sptr</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_simple_correlator_sptr</a> <a class="code" href="gr__simple__correlator_8h.html#a7cf6acde8da2f7e3f378686e31deed58">gr_make_simple_correlator</a> (<span class="keywordtype">int</span> payload_bytesize);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * \brief inverse of gr_simple_framer (more or less)</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * \ingroup sync_blk</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="classgr__simple__correlator.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classgr__simple__correlator.html" title="inverse of gr_simple_framer (more or less)">gr_simple_correlator</a> : <span class="keyword">public</span> <a class="code" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ...">gr_block</a></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> OVERSAMPLE = 8;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">enum</span> state_t { ST_LOOKING, ST_UNDER_THRESHOLD, ST_LOCKED };</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">int</span> d_payload_bytesize;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  state_t d_state;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_osi; <span class="comment">// over sample index [0,OVERSAMPLE-1]</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_transition_osi; <span class="comment">// first index where Hamming dist < thresh</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_center_osi; <span class="comment">// center of bit</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> d_shift_reg[OVERSAMPLE];</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">int</span> d_bblen; <span class="comment">// length of bitbuf</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_bitbuf; <span class="comment">// demodulated bits</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_pktbuf; <span class="comment">// temp packet buf</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> d_bbi; <span class="comment">// bitbuf index</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> AVG_PERIOD = 512; <span class="comment">// must be power of 2 (for freq offset correction)</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">int</span> d_avbi;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">float</span> d_avgbuf[AVG_PERIOD];</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">float</span> d_avg;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">float</span> d_accum;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#ifdef DEBUG_SIMPLE_CORRELATOR</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"></span> FILE *d_debug_fp; <span class="comment">// binary log file</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">friend</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_simple_correlator_sptr</a> <a class="code" href="gr__simple__correlator_8h.html#a7cf6acde8da2f7e3f378686e31deed58">gr_make_simple_correlator</a> (<span class="keywordtype">int</span> payload_bytesize);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classgr__simple__correlator.html" title="inverse of gr_simple_framer (more or less)">gr_simple_correlator</a> (<span class="keywordtype">int</span> payload_bytesize);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">inline</span> <span class="keywordtype">int</span> slice (<span class="keywordtype">float</span> x)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> x >= d_avg ? 1 : 0;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> update_avg(<span class="keywordtype">float</span> x);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> enter_locked ();</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span> enter_under_threshold ();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> enter_looking ();</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> add_index (<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b)</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> t = a + b;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (t >= OVERSAMPLE)</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  t -= OVERSAMPLE;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  assert (t >= 0 && t < OVERSAMPLE);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> t;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> sub_index (<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b)</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">int</span> t = a - b;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">if</span> (t < 0)</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  t += OVERSAMPLE;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  assert (t >= 0 && t < OVERSAMPLE);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> t;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  ~<a class="code" href="classgr__simple__correlator.html" title="inverse of gr_simple_framer (more or less)">gr_simple_correlator</a> ();</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">int</span> <a class="code" href="classgr__block.html#adf59080d10f322e3816b7ac8f7cb2a7c" title="compute output items from input items">general_work</a> (<span class="keywordtype">int</span> noutput_items,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="gr__types_8h.html#ab02d0a829d67d39e3ac3163016d3a8be">gr_vector_int</a> &ninput_items,</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> };</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_SIMPLE_CORRELATOR_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_284717b6cb06147531c058220802c6d1.html">gnuradio-core</a></li><li class="navelem"><a class="el" href="dir_7c24473031c549da670035bb20d1e97e.html">src</a></li><li class="navelem"><a class="el" href="dir_84906bae47c76101f1fa015cf813f8a2.html">lib</a></li><li class="navelem"><a class="el" href="dir_a82a9d947ffcded01cd668b1a1a6c872.html">general</a></li><li class="navelem"><a class="el" href="gr__simple__correlator_8h.html">gr_simple_correlator.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
