root/doc/html/classitpp_1_1OFDM.html @ 353

Revision 353, 8.5 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::OFDM Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1OFDM.html">OFDM</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::OFDM Class Reference<br>
72<small>
73[<a class="el" href="group__modulators.html">Digital Modulation</a>]</small>
74</h1><!-- doxytag: class="itpp::OFDM" -->Class for modulating and demodulation of <a class="el" href="classitpp_1_1OFDM.html" title="Class for modulating and demodulation of OFDM signals using the FFT.">OFDM</a> signals using the FFT. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="ofdm_8h-source.html">ofdm.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1OFDM-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
82<tr><td></td></tr>
83<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2eba2ea5dca5b96be5ceee0dcc9b8987"></a><!-- doxytag: member="itpp::OFDM::OFDM" ref="2eba2ea5dca5b96be5ceee0dcc9b8987" args="(void)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#2eba2ea5dca5b96be5ceee0dcc9b8987">OFDM</a> (void)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Empty constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c870bb91ad9092f915432dcdd5808f8"></a><!-- doxytag: member="itpp::OFDM::OFDM" ref="2c870bb91ad9092f915432dcdd5808f8" args="(int inNfft, int inNcp, int inNupsample=1)" -->
89&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#2c870bb91ad9092f915432dcdd5808f8">OFDM</a> (int inNfft, int inNcp, int inNupsample=1)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor <em>Nfft</em> is the size of the FFT. <em>Ncp</em> is the length of the cyclic prefix. <em>Nupsample</em> is the upsampling factor (default=1). <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21a89250b9c24fb704d7a630740deb36"></a><!-- doxytag: member="itpp::OFDM::no_carriers" ref="21a89250b9c24fb704d7a630740deb36" args="()" -->
93int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#21a89250b9c24fb704d7a630740deb36">no_carriers</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of carriers. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cbfc2d0e0e71cfcfde00337cee9809d"></a><!-- doxytag: member="itpp::OFDM::set_parameters" ref="4cbfc2d0e0e71cfcfde00337cee9809d" args="(const int Nfft, const int Ncp, const int inNupsample=1)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#4cbfc2d0e0e71cfcfde00337cee9809d">set_parameters</a> (const int Nfft, const int Ncp, const int inNupsample=1)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set parameters. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a265c8264f282412972cbaa42345082"></a><!-- doxytag: member="itpp::OFDM::modulate" ref="2a265c8264f282412972cbaa42345082" args="(const cvec &amp;input)" -->
101cvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#2a265c8264f282412972cbaa42345082">modulate</a> (const cvec &amp;input)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modulate complex data symbols. Length of <code>input</code> must be <code>Nfft</code>. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb33603059b3f83d30a38395186d21ab"></a><!-- doxytag: member="itpp::OFDM::modulate" ref="cb33603059b3f83d30a38395186d21ab" args="(const cvec &amp;input, cvec &amp;output)" -->
105void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#cb33603059b3f83d30a38395186d21ab">modulate</a> (const cvec &amp;input, cvec &amp;output)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modulate complex data symbols. Length of <code>input</code> must be <code>Nfft</code>. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0d94ac54128bd44f48a17ad4a1ade90"></a><!-- doxytag: member="itpp::OFDM::demodulate" ref="e0d94ac54128bd44f48a17ad4a1ade90" args="(const cvec &amp;input)" -->
109cvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#e0d94ac54128bd44f48a17ad4a1ade90">demodulate</a> (const cvec &amp;input)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Demodulate to complex valued symbols. Length of <code>input</code> must be <code>Nfft+Ncp</code>. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e7c3e25e2746c3b35e57940d34c9906"></a><!-- doxytag: member="itpp::OFDM::demodulate" ref="6e7c3e25e2746c3b35e57940d34c9906" args="(const cvec &amp;input, cvec &amp;output)" -->
113void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1OFDM.html#6e7c3e25e2746c3b35e57940d34c9906">demodulate</a> (const cvec &amp;input, cvec &amp;output)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Demodulate to complex valued symbols. Length of <code>input</code> must be <code>Nfft+Ncp</code>. <br></td></tr>
116</table>
117<hr><a name="_details"></a><h2>Detailed Description</h2>
118Class for modulating and demodulation of <a class="el" href="classitpp_1_1OFDM.html" title="Class for modulating and demodulation of OFDM signals using the FFT.">OFDM</a> signals using the FFT.
119<p>
120The modulated signal is normalized taking into account the cyclic prefix <hr>The documentation for this class was generated from the following files:<ul>
121<li><a class="el" href="ofdm_8h-source.html">ofdm.h</a><li><a class="el" href="ofdm_8cpp.html">ofdm.cpp</a></ul>
122</div>
123<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
124<a href="http://www.doxygen.org/index.html">
125<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
126</body>
127</html>
Note: See TracBrowser for help on using the browser.