root/doc/html/classitpp_1_1Spread__2d.html @ 353

Revision 353, 11.7 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::Spread_2d 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_1Spread__2d.html">Spread_2d</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Spread_2d Class Reference<br>
72<small>
73[<a class="el" href="group__modulators.html">Digital Modulation</a>]</small>
74</h1><!-- doxytag: class="itpp::Spread_2d" -->Spreading of complex symbols to complex output. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="spread_8h-source.html">spread.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Spread__2d-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="bfa9b69d6c3fc0df7c86f498a07fb120"></a><!-- doxytag: member="itpp::Spread_2d::Spread_2d" ref="bfa9b69d6c3fc0df7c86f498a07fb120" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#bfa9b69d6c3fc0df7c86f498a07fb120">Spread_2d</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a57c068d045eac0b8bc06f090140718e"></a><!-- doxytag: member="itpp::Spread_2d::Spread_2d" ref="a57c068d045eac0b8bc06f090140718e" args="(const vec &amp;incodeI, const vec &amp;incodeQ)" -->
89&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#a57c068d045eac0b8bc06f090140718e">Spread_2d</a> (const vec &amp;incodeI, const vec &amp;incodeQ)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="50280d8b721355583f9f528ed971d232"></a><!-- doxytag: member="itpp::Spread_2d::spread" ref="50280d8b721355583f9f528ed971d232" args="(const cvec &amp;symbols, cvec &amp;out)" -->
93void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#50280d8b721355583f9f528ed971d232">spread</a> (const cvec &amp;symbols, cvec &amp;out)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Spreading of signal. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae630594fa98a261786886a9114748f6"></a><!-- doxytag: member="itpp::Spread_2d::spread" ref="ae630594fa98a261786886a9114748f6" args="(const cvec &amp;symbols)" -->
97cvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#ae630594fa98a261786886a9114748f6">spread</a> (const cvec &amp;symbols)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Spreading of signal. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3e1b5b6672ea0195dbb75fa40704249"></a><!-- doxytag: member="itpp::Spread_2d::despread" ref="a3e1b5b6672ea0195dbb75fa40704249" args="(const cvec &amp;rec_signal, cvec &amp;out, int timing)" -->
101void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#a3e1b5b6672ea0195dbb75fa40704249">despread</a> (const cvec &amp;rec_signal, cvec &amp;out, int timing)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Despreading of signal. <em>timing</em> is the start position of the first symbol, given in number of samples. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e24ad1f59721e4a12e9d9d3637c5147b"></a><!-- doxytag: member="itpp::Spread_2d::despread" ref="e24ad1f59721e4a12e9d9d3637c5147b" args="(const cvec &amp;rec_signal, int timing)" -->
105cvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#e24ad1f59721e4a12e9d9d3637c5147b">despread</a> (const cvec &amp;rec_signal, int timing)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Despreading of signal. <em>timing</em> is the start position of the first symbol, given in number of samples. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fefcc565cf3782507e6005d50b81fa60"></a><!-- doxytag: member="itpp::Spread_2d::set_code" ref="fefcc565cf3782507e6005d50b81fa60" args="(const vec &amp;incodeI, const vec &amp;incodeQ)" -->
109void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#fefcc565cf3782507e6005d50b81fa60">set_code</a> (const vec &amp;incodeI, const vec &amp;incodeQ)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the in-phase and the quadrature-phase spreading codes. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bd74de14d6ea33ff1ea42e3bb85c1059"></a><!-- doxytag: member="itpp::Spread_2d::get_codeI" ref="bd74de14d6ea33ff1ea42e3bb85c1059" args="()" -->
113vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#bd74de14d6ea33ff1ea42e3bb85c1059">get_codeI</a> ()</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the in-phase spreading code. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f523870e08ca676946059ad57a3775fa"></a><!-- doxytag: member="itpp::Spread_2d::get_codeQ" ref="f523870e08ca676946059ad57a3775fa" args="()" -->
117vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#f523870e08ca676946059ad57a3775fa">get_codeQ</a> ()</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the quadrature-phase spreading code. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d1b22706807de241e35fb60ff54082eb"></a><!-- doxytag: member="itpp::Spread_2d::get_period" ref="d1b22706807de241e35fb60ff54082eb" args="()" -->
121int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#d1b22706807de241e35fb60ff54082eb">get_period</a> ()</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the period of the code (length of code vector). <br></td></tr>
124<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
125<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1Spread__1d.html">Spread_1d</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Spread__2d.html#163e426df4bbe7a7e8a173f581d30caa">spreadI</a></td></tr>
127
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eacbe62668fb8a1313602048141e7f88"></a><!-- doxytag: member="itpp::Spread_2d::spreadQ" ref="eacbe62668fb8a1313602048141e7f88" args="" -->
129<a class="el" href="classitpp_1_1Spread__1d.html">Spread_1d</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>spreadQ</b></td></tr>
130
131</table>
132<hr><a name="_details"></a><h2>Detailed Description</h2>
133Spreading of complex symbols to complex output.
134<p>
135The spreading are done independently for the I and Q phases. That is real(symbols) are spread by the incodeI and imag(symbols) are spread by incodeQ.<p>
136Before despreading the phase should be corrected, that is the complex baseband signal should be multiplied by exp(j*PHIk), where PHIk is the phase of that user (and path).<p>
137Obeserve that the spreading is normalized so that the energy per bit is preserved before and after spreading (that is each symbol is multiplied with <code>1/sqrt</code>(N)). Hence, for the multicode case the energy is normalized for one symbol (code) but the transmitted signal consist of a sum of several signals.<p>
138Example: See <a class="el" href="classitpp_1_1Spread__1d.html" title="Spreading of float symbols to float output.">Spread_1d</a> <hr><h2>Member Data Documentation</h2>
139<a class="anchor" name="163e426df4bbe7a7e8a173f581d30caa"></a><!-- doxytag: member="itpp::Spread_2d::spreadI" ref="163e426df4bbe7a7e8a173f581d30caa" args="" -->
140<div class="memitem">
141<div class="memproto">
142      <table class="memname">
143        <tr>
144          <td class="memname"><a class="el" href="classitpp_1_1Spread__1d.html">Spread_1d</a> <a class="el" href="classitpp_1_1Spread__2d.html#163e426df4bbe7a7e8a173f581d30caa">itpp::Spread_2d::spreadI</a><code> [protected]</code>          </td>
145        </tr>
146      </table>
147</div>
148<div class="memdoc">
149
150<p>
151The spreaders for the I and Q channels respectively
152<p>Referenced by <a class="el" href="spread_8cpp-source.html#l00103">despread()</a>, <a class="el" href="spread_8cpp-source.html#l00076">get_codeI()</a>, <a class="el" href="spread_8h-source.html#l00179">get_period()</a>, <a class="el" href="spread_8cpp-source.html#l00091">set_code()</a>, and <a class="el" href="spread_8cpp-source.html#l00098">spread()</a>.</p>
153
154</div>
155</div><p>
156<hr>The documentation for this class was generated from the following files:<ul>
157<li><a class="el" href="spread_8h-source.html">spread.h</a><li><a class="el" href="spread_8cpp.html">spread.cpp</a></ul>
158</div>
159<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
160<a href="http://www.doxygen.org/index.html">
161<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
162</body>
163</html>
Note: See TracBrowser for help on using the browser.