root/doc/html/classitpp_1_1Multicode__Spread__2d.html @ 353

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

doc

RevLine 
[353]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::Multicode_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_1Multicode__Spread__2d.html">Multicode_Spread_2d</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Multicode_Spread_2d Class Reference<br>
72<small>
73[<a class="el" href="group__modulators.html">Digital Modulation</a>]</small>
74</h1><!-- doxytag: class="itpp::Multicode_Spread_2d" -->Multicode 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_1Multicode__Spread__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="437f9610a2ceb329719c3147a46d573f"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::Multicode_Spread_2d" ref="437f9610a2ceb329719c3147a46d573f" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#437f9610a2ceb329719c3147a46d573f">Multicode_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="6dd6111c9403166d6c28257ffe02abf0"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::Multicode_Spread_2d" ref="6dd6111c9403166d6c28257ffe02abf0" args="(const mat &amp;incodesI, const mat &amp;incodesQ)" -->
89&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#6dd6111c9403166d6c28257ffe02abf0">Multicode_Spread_2d</a> (const mat &amp;incodesI, const mat &amp;incodesQ)</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="17bb74ea4c88fe0ffd565b9020dede28"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::spread" ref="17bb74ea4c88fe0ffd565b9020dede28" args="(const cvec &amp;symbols)" -->
93cvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#17bb74ea4c88fe0ffd565b9020dede28">spread</a> (const cvec &amp;symbols)</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="d191b52b55d0306fd7e591a299b4d94d"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::despread" ref="d191b52b55d0306fd7e591a299b4d94d" args="(const cvec &amp;receivedsignal, int timing)" -->
97cvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#d191b52b55d0306fd7e591a299b4d94d">despread</a> (const cvec &amp;receivedsignal, int timing)</td></tr>
98
99<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>
100<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#a77a0c16beadaa6e31824140a15bebce">set_codes</a> (const mat &amp;incodesI, const mat &amp;incodesQ)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the spreading codes.  <a href="#a77a0c16beadaa6e31824140a15bebce"></a><br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a28c9d96cf8a10f374e94b650a14f11"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::get_codesI" ref="9a28c9d96cf8a10f374e94b650a14f11" args="()" -->
104mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#9a28c9d96cf8a10f374e94b650a14f11">get_codesI</a> ()</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the matrix containing the in-phase codes (as rows). <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fd62519d808496e19f43e5e0e52bf1e"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::get_codesQ" ref="2fd62519d808496e19f43e5e0e52bf1e" args="()" -->
108mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#2fd62519d808496e19f43e5e0e52bf1e">get_codesQ</a> ()</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the matrix containing the quadrature-phase codes (as rows). <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8adbb54032fa9629334798ffc31f8597"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::get_period" ref="8adbb54032fa9629334798ffc31f8597" args="()" -->
112int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#8adbb54032fa9629334798ffc31f8597">get_period</a> ()</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the spreading factor. <br></td></tr>
115<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
116<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html">Multicode_Spread_1d</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__2d.html#2c2a7ea2b6d753cc0e668d1380878a4e">mcspreadI</a></td></tr>
118
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5d386cf3b10829b504fbd9a8889103c"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::mcspreadQ" ref="a5d386cf3b10829b504fbd9a8889103c" args="" -->
120<a class="el" href="classitpp_1_1Multicode__Spread__1d.html">Multicode_Spread_1d</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>mcspreadQ</b></td></tr>
121
122</table>
123<hr><a name="_details"></a><h2>Detailed Description</h2>
124Multicode spreading of complex symbols to complex output.
125<p>
126The 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>
127Before 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>
128Obeserve 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>
129Example: See <a class="el" href="classitpp_1_1Spread__1d.html" title="Spreading of float symbols to float output.">Spread_1d</a> <hr><h2>Member Function Documentation</h2>
130<a class="anchor" name="a77a0c16beadaa6e31824140a15bebce"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::set_codes" ref="a77a0c16beadaa6e31824140a15bebce" args="(const mat &amp;incodesI, const mat &amp;incodesQ)" -->
131<div class="memitem">
132<div class="memproto">
133      <table class="memname">
134        <tr>
135          <td class="memname">void itpp::Multicode_Spread_2d::set_codes           </td>
136          <td>(</td>
137          <td class="paramtype">const mat &amp;&nbsp;</td>
138          <td class="paramname"> <em>incodesI</em>, </td>
139        </tr>
140        <tr>
141          <td class="paramkey"></td>
142          <td></td>
143          <td class="paramtype">const mat &amp;&nbsp;</td>
144          <td class="paramname"> <em>incodesQ</em></td><td>&nbsp;</td>
145        </tr>
146        <tr>
147          <td></td>
148          <td>)</td>
149          <td></td><td></td><td></td>
150        </tr>
151      </table>
152</div>
153<div class="memdoc">
154
155<p>
156Set the spreading codes.
157<p>
158The codes are given as rows in the matricies <em>incodesI</em> and <em>incodesQ</em>. The number of rows shall equal the number of multiple spreading codes
159<p>References <a class="el" href="itassert_8h-source.html#l00094">it_assert</a>, <a class="el" href="spread_8h-source.html#l00274">mcspreadI</a>, and <a class="el" href="spread_8cpp-source.html#l00118">itpp::Multicode_Spread_1d::set_codes()</a>.</p>
160
161<p>Referenced by <a class="el" href="spread_8cpp-source.html#l00161">Multicode_Spread_2d()</a>.</p>
162
163</div>
164</div><p>
165<hr><h2>Member Data Documentation</h2>
166<a class="anchor" name="2c2a7ea2b6d753cc0e668d1380878a4e"></a><!-- doxytag: member="itpp::Multicode_Spread_2d::mcspreadI" ref="2c2a7ea2b6d753cc0e668d1380878a4e" args="" -->
167<div class="memitem">
168<div class="memproto">
169      <table class="memname">
170        <tr>
171          <td class="memname"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html">Multicode_Spread_1d</a> <a class="el" href="classitpp_1_1Multicode__Spread__2d.html#2c2a7ea2b6d753cc0e668d1380878a4e">itpp::Multicode_Spread_2d::mcspreadI</a><code> [protected]</code>          </td>
172        </tr>
173      </table>
174</div>
175<div class="memdoc">
176
177<p>
178The multicode spreaders for the I and Q channels respectively
179<p>Referenced by <a class="el" href="spread_8cpp-source.html#l00189">despread()</a>, <a class="el" href="spread_8cpp-source.html#l00166">get_codesI()</a>, <a class="el" href="spread_8h-source.html#l00270">get_period()</a>, <a class="el" href="spread_8cpp-source.html#l00176">set_codes()</a>, and <a class="el" href="spread_8cpp-source.html#l00184">spread()</a>.</p>
180
181</div>
182</div><p>
183<hr>The documentation for this class was generated from the following files:<ul>
184<li><a class="el" href="spread_8h-source.html">spread.h</a><li><a class="el" href="spread_8cpp.html">spread.cpp</a></ul>
185</div>
186<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
187<a href="http://www.doxygen.org/index.html">
188<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
189</body>
190</html>
Note: See TracBrowser for help on using the browser.