root/doc/html/classitpp_1_1Multicode__Spread__1d.html @ 353

Revision 353, 10.2 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::Multicode_Spread_1d 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__1d.html">Multicode_Spread_1d</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Multicode_Spread_1d Class Reference<br>
72<small>
73[<a class="el" href="group__modulators.html">Digital Modulation</a>]</small>
74</h1><!-- doxytag: class="itpp::Multicode_Spread_1d" -->Multicode spreading of float symbols. 
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__1d-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="df460875d1ff4d0ac7eeeb48c3153af3"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::Multicode_Spread_1d" ref="df460875d1ff4d0ac7eeeb48c3153af3" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#df460875d1ff4d0ac7eeeb48c3153af3">Multicode_Spread_1d</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="7a1287c14515c3595d1a49135e226615"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::Multicode_Spread_1d" ref="7a1287c14515c3595d1a49135e226615" args="(const mat &amp;incodes)" -->
89&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#7a1287c14515c3595d1a49135e226615">Multicode_Spread_1d</a> (const mat &amp;incodes)</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="b4a4bf20d12ab55d7c1cd8e2311b9e50"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::spread" ref="b4a4bf20d12ab55d7c1cd8e2311b9e50" args="(const vec &amp;symbols)" -->
93vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#b4a4bf20d12ab55d7c1cd8e2311b9e50">spread</a> (const vec &amp;symbols)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Spreading function. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df7f9c3bf59293b380b09ad9530a3917"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::despread" ref="df7f9c3bf59293b380b09ad9530a3917" args="(const vec &amp;receivedsignal, int timing)" -->
97vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#df7f9c3bf59293b380b09ad9530a3917">despread</a> (const vec &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"><a class="anchor" name="edb895ca87b4ffc0dbc0187630a66c1a"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::set_codes" ref="edb895ca87b4ffc0dbc0187630a66c1a" args="(const mat &amp;incodes)" -->
101void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#edb895ca87b4ffc0dbc0187630a66c1a">set_codes</a> (const mat &amp;incodes)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the spreading codes. Each row represent one spreading code. The spreading factor equals the number of columns. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3ce42aa57da30d4e2392f614686d412"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::get_codes" ref="c3ce42aa57da30d4e2392f614686d412" args="()" -->
105mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#c3ce42aa57da30d4e2392f614686d412">get_codes</a> ()</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the matrix containing the spreading codes used as rows in the matrix. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="127b71b47b4d4550e8037d601dab38ad"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::get_period" ref="127b71b47b4d4550e8037d601dab38ad" args="()" -->
109int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#127b71b47b4d4550e8037d601dab38ad">get_period</a> ()</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the spreading factor. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e70e1f8a8d9074d0b3f420281bbd7b94"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::get_nocodes" ref="e70e1f8a8d9074d0b3f420281bbd7b94" args="()" -->
113int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#e70e1f8a8d9074d0b3f420281bbd7b94">get_nocodes</a> ()</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of multi-codes used. <br></td></tr>
116<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f10bf0aeba2780d0e0ebc501096f653b"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::codes" ref="f10bf0aeba2780d0e0ebc501096f653b" args="" -->
118mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#f10bf0aeba2780d0e0ebc501096f653b">codes</a></td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The spreading codes used size (<img class="formulaInl" alt="$L \times N$" src="form_311.png">). <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60690aa30eac3da6db869a9ae1f752ad"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::L" ref="60690aa30eac3da6db869a9ae1f752ad" args="" -->
122int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#60690aa30eac3da6db869a9ae1f752ad">L</a></td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of multi-codes. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="813ff1c4f58a868dd953401a4dc873d4"></a><!-- doxytag: member="itpp::Multicode_Spread_1d::N" ref="813ff1c4f58a868dd953401a4dc873d4" args="" -->
126int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Multicode__Spread__1d.html#813ff1c4f58a868dd953401a4dc873d4">N</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The spreading factor. <br></td></tr>
129</table>
130<hr><a name="_details"></a><h2>Detailed Description</h2>
131Multicode spreading of float symbols.
132<p>
133Obeserve 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>
134Example: See <a class="el" href="classitpp_1_1Spread__1d.html" title="Spreading of float symbols to float output.">Spread_1d</a> <hr>The documentation for this class was generated from the following files:<ul>
135<li><a class="el" href="spread_8h-source.html">spread.h</a><li><a class="el" href="spread_8cpp.html">spread.cpp</a></ul>
136</div>
137<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
138<a href="http://www.doxygen.org/index.html">
139<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
140</body>
141</html>
Note: See TracBrowser for help on using the browser.