<!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: digital_ofdm_frame_acquisition.h File Reference</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('digital__ofdm__frame__acquisition_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">digital_ofdm_frame_acquisition.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="digital__api_8h_source.html">digital_api.h</a>></code><br/>
<code>#include <<a class="el" href="gr__block_8h_source.html">gr_block.h</a>></code><br/>
<code>#include <vector></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for digital_ofdm_frame_acquisition.h:</div>
<div class="dyncontent">
<div class="center"><img src="digital__ofdm__frame__acquisition_8h__incl.png" border="0" usemap="#digital__ofdm__frame__acquisition_8h" alt=""/></div>
<map name="digital__ofdm__frame__acquisition_8h" id="digital__ofdm__frame__acquisition_8h">
<area shape="rect" id="node3" href="digital__api_8h.html" title="digital_api.h" alt="" coords="5,171,96,197"/><area shape="rect" id="node7" href="gr__block_8h.html" title="gr_block.h" alt="" coords="528,96,609,123"/><area shape="rect" id="node5" href="attributes_8h.html" title="gruel/attributes.h" alt="" coords="262,576,380,603"/><area shape="rect" id="node9" href="gr__core__api_8h.html" title="gr_core_api.h" alt="" coords="271,501,371,528"/><area shape="rect" id="node12" href="gr__basic__block_8h.html" title="gr_basic_block.h" alt="" coords="1113,171,1233,197"/><area shape="rect" id="node99" href="gr__tags_8h.html" title="gr_tags.h" alt="" coords="531,344,607,371"/><area shape="rect" id="node15" href="gr__runtime__types_8h.html" title="gr_runtime_types.h" alt="" coords="221,344,355,371"/><area shape="rect" id="node31" href="gr__sptr__magic_8h_source.html" title="gr_sptr_magic.h" alt="" coords="291,427,405,453"/><area shape="rect" id="node39" href="gr__msg__accepter_8h.html" title="gr_msg_accepter.h" alt="" coords="692,253,825,280"/><area shape="rect" id="node78" href="gr__io__signature_8h.html" title="gr_io_signature.h" alt="" coords="299,253,420,280"/><area shape="rect" id="node82" href="thread_8h.html" title="gruel/thread.h" alt="" coords="1035,253,1136,280"/><area shape="rect" id="node18" href="gr__types_8h.html" title="gr_types.h" alt="" coords="683,427,764,453"/><area shape="rect" id="node27" href="gr__complex_8h.html" title="gr_complex.h" alt="" coords="670,501,769,528"/><area shape="rect" id="node42" href="msg__accepter_8h.html" title="gruel/msg_accepter.h" alt="" coords="632,344,779,371"/><area shape="rect" id="node47" href="pmt_8h.html" title="gruel/pmt.h" alt="" coords="1030,427,1116,453"/><area shape="rect" id="node44" href="gruel_2src_2include_2gruel_2api_8h.html" title="gruel/api.h" alt="" coords="564,501,645,528"/><area shape="rect" id="node58" href="stdint_8h.html" title="stdint.h" alt="" coords="1329,501,1393,528"/><area shape="rect" id="node69" href="pmt__sugar_8h.html" title="gruel/pmt_sugar.h" alt="" coords="1605,501,1731,528"/></map>
</div>
</div>
<p><a href="digital__ofdm__frame__acquisition_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classdigital__ofdm__frame__acquisition.html">digital_ofdm_frame_acquisition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">take a vector of complex constellation points in from an FFT and performs a correlation and equalization.This block takes the output of an FFT of a received OFDM symbol and finds the start of a frame based on two known symbols. It also looks at the surrounding bins in the FFT output for the correlation in case there is a large frequency shift in the data. This block assumes that the fine frequency shift has already been corrected and that the samples fall in the middle of one FFT bin. <a href="classdigital__ofdm__frame__acquisition.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6b2e1eb93ccc511055e69c7ea460e8f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">digital_ofdm_frame_acquisition_sptr</a> <br class="typebreak"/>
<a class="el" href="digital__api_8h.html#ae14969f36ec69051c4b2f13a0db7e9ba">DIGITAL_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="digital__ofdm__frame__acquisition_8h.html#a6b2e1eb93ccc511055e69c7ea460e8f1">digital_make_ofdm_frame_acquisition</a> (unsigned int occupied_carriers, unsigned int fft_length, unsigned int cplen, const std::vector< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > &known_symbol, unsigned int max_fft_shift_len=10)</td></tr>
<tr class="separator:a6b2e1eb93ccc511055e69c7ea460e8f1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a6b2e1eb93ccc511055e69c7ea460e8f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">digital_ofdm_frame_acquisition_sptr</a> <a class="el" href="digital__api_8h.html#ae14969f36ec69051c4b2f13a0db7e9ba">DIGITAL_API</a> digital_make_ofdm_frame_acquisition </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>occupied_carriers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>fft_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>cplen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > & </td>
<td class="paramname"><em>known_symbol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>max_fft_shift_len</em> = <code>10</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">occupied_carriers</td><td>The number of subcarriers with data in the received symbol </td></tr>
<tr><td class="paramname">fft_length</td><td>The size of the FFT vector (occupied_carriers + unused carriers) </td></tr>
<tr><td class="paramname">cplen</td><td>The length of the cycle prefix </td></tr>
<tr><td class="paramname">known_symbol</td><td>A vector of complex numbers representing a known symbol at the start of a frame (usually a BPSK PN sequence) </td></tr>
<tr><td class="paramname">max_fft_shift_len</td><td>Set's the maximum distance you can look between bins for correlation </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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_f7216719ef3afaeb42c046b1c085d582.html">gr-digital</a></li><li class="navelem"><a class="el" href="dir_cd60c432b920e74905d47b61718dc7dc.html">include</a></li><li class="navelem"><a class="el" href="digital__ofdm__frame__acquisition_8h.html">digital_ofdm_frame_acquisition.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:34 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>
