root/doc/html/classitpp_1_1PAM.html @ 353

Revision 353, 36.4 kB (checked in by smidl, 15 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::PAM 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_1PAM.html">PAM</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::PAM Class Reference<br>
72<small>
73[<a class="el" href="group__modulators.html">Digital Modulation</a>]</small>
74</h1><!-- doxytag: class="itpp::PAM" --><!-- doxytag: inherits="Modulator&lt; double &gt;" -->M-ary <a class="el" href="classitpp_1_1PAM.html" title="M-ary PAM modulator with real symbols.">PAM</a> modulator with real symbols. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="modulator_8h-source.html">modulator.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1PAM-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="a53666adab014006597ad29ed1f805a9"></a><!-- doxytag: member="itpp::PAM::PAM" ref="a53666adab014006597ad29ed1f805a9" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1PAM.html#a53666adab014006597ad29ed1f805a9">PAM</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default Constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8313557132fafc0f41caefd75ca72f17"></a><!-- doxytag: member="itpp::PAM::PAM" ref="8313557132fafc0f41caefd75ca72f17" args="(int M)" -->
89&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1PAM.html#8313557132fafc0f41caefd75ca72f17">PAM</a> (int <a class="el" href="classitpp_1_1Modulator.html#a434960c7ff9e5356d832aa53b46930b">M</a>)</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="bdef15e7e3808977e3d3d9432f55d584"></a><!-- doxytag: member="itpp::PAM::~PAM" ref="bdef15e7e3808977e3d3d9432f55d584" args="()" -->
93virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1PAM.html#bdef15e7e3808977e3d3d9432f55d584">~PAM</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="04183ae1e27cf1e4ebdb80ebed313fb9"></a><!-- doxytag: member="itpp::PAM::set_M" ref="04183ae1e27cf1e4ebdb80ebed313fb9" args="(int M)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1PAM.html#04183ae1e27cf1e4ebdb80ebed313fb9">set_M</a> (int <a class="el" href="classitpp_1_1Modulator.html#a434960c7ff9e5356d832aa53b46930b">M</a>)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the size of the signal constellation. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2bc71f0c4c0326806caf0ed505d55a9c"></a><!-- doxytag: member="itpp::PAM::demodulate_bits" ref="2bc71f0c4c0326806caf0ed505d55a9c" args="(const vec &amp;signal, bvec &amp;output) const " -->
101void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1PAM.html#2bc71f0c4c0326806caf0ed505d55a9c">demodulate_bits</a> (const vec &amp;signal, bvec &amp;output) const </td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hard demodulation of <a class="el" href="classitpp_1_1PAM.html" title="M-ary PAM modulator with real symbols.">PAM</a> symbols in complex domain to bits. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4d5d59449dab2020cdf42510f0cc072"></a><!-- doxytag: member="itpp::PAM::demodulate_bits" ref="f4d5d59449dab2020cdf42510f0cc072" args="(const vec &amp;signal) const " -->
105bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1PAM.html#f4d5d59449dab2020cdf42510f0cc072">demodulate_bits</a> (const vec &amp;signal) const </td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hard demodulation of <a class="el" href="classitpp_1_1PAM.html" title="M-ary PAM modulator with real symbols.">PAM</a> symbols in complex domain to bits. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9722a6826869c6d6e15a9835d76239b"></a><!-- doxytag: member="itpp::PAM::set" ref="b9722a6826869c6d6e15a9835d76239b" args="(const Vec&lt; double &gt; &amp;symbols, const ivec &amp;bits2symbols)" -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#b9722a6826869c6d6e15a9835d76239b">set</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;<a class="el" href="classitpp_1_1Modulator.html#3069840e9e7a44180615fb772cf9ae42">symbols</a>, const ivec &amp;<a class="el" href="classitpp_1_1Modulator.html#3ca26614189cb7a66da369bf0c4b9070">bits2symbols</a>)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the constellation to use in the modulator. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e7cfa06570e2a1de515be5222a53a83"></a><!-- doxytag: member="itpp::PAM::bits_per_symbol" ref="6e7cfa06570e2a1de515be5222a53a83" args="() const" -->
113virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#6e7cfa06570e2a1de515be5222a53a83">bits_per_symbol</a> () const</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns number of bits per symbol. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28b1c28bf8f4596e4d5149f1f3c8cd76"></a><!-- doxytag: member="itpp::PAM::get_symbols" ref="28b1c28bf8f4596e4d5149f1f3c8cd76" args="() const" -->
117virtual <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#28b1c28bf8f4596e4d5149f1f3c8cd76">get_symbols</a> () const</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the symbol values used in the modulator. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#a8186f0e837fd3d440a6acb7a0225d35">get_bits2symbols</a> () const</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the bitmap, which maps input bits into symbols.  <a href="#a8186f0e837fd3d440a6acb7a0225d35"></a><br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f7bde9d3bfa9e39c06017534e3f6647"></a><!-- doxytag: member="itpp::PAM::modulate" ref="4f7bde9d3bfa9e39c06017534e3f6647" args="(const ivec &amp;symbolnumbers, Vec&lt; double &gt; &amp;output) const" -->
124virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#4f7bde9d3bfa9e39c06017534e3f6647">modulate</a> (const ivec &amp;symbolnumbers, <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;output) const</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modulation of symbols. <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0cb2673987e110920b519c139cdebe1"></a><!-- doxytag: member="itpp::PAM::modulate" ref="e0cb2673987e110920b519c139cdebe1" args="(const ivec &amp;symbolnumbers) const" -->
128virtual <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#e0cb2673987e110920b519c139cdebe1">modulate</a> (const ivec &amp;symbolnumbers) const</td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modulation of symbols. <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="845b5fbf4dad59edd3772627250623a1"></a><!-- doxytag: member="itpp::PAM::demodulate" ref="845b5fbf4dad59edd3772627250623a1" args="(const Vec&lt; double &gt; &amp;signal, ivec &amp;output) const" -->
132virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#845b5fbf4dad59edd3772627250623a1">demodulate</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;signal, ivec &amp;output) const</td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Demodulation of symbols. <br></td></tr>
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f2c15efa18d1cb46b8c97723c11ec9d"></a><!-- doxytag: member="itpp::PAM::demodulate" ref="7f2c15efa18d1cb46b8c97723c11ec9d" args="(const Vec&lt; double &gt; &amp;signal) const" -->
136virtual ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#7f2c15efa18d1cb46b8c97723c11ec9d">demodulate</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;signal) const</td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Demodulation of symbols. <br></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="53826bf7e0ec83b99592235b0c2f6235"></a><!-- doxytag: member="itpp::PAM::modulate_bits" ref="53826bf7e0ec83b99592235b0c2f6235" args="(const bvec &amp;bits, Vec&lt; double &gt; &amp;output) const" -->
140virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#53826bf7e0ec83b99592235b0c2f6235">modulate_bits</a> (const bvec &amp;bits, <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;output) const</td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modulation of bits. <br></td></tr>
143<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="622fa1ce4243330b7efa0605a9492513"></a><!-- doxytag: member="itpp::PAM::modulate_bits" ref="622fa1ce4243330b7efa0605a9492513" args="(const bvec &amp;bits) const" -->
144virtual <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#622fa1ce4243330b7efa0605a9492513">modulate_bits</a> (const bvec &amp;bits) const</td></tr>
145
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modulation of bits. <br></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d03bbe8bd467898f149d5f134f6f120"></a><!-- doxytag: member="itpp::PAM::demodulate_bits" ref="4d03bbe8bd467898f149d5f134f6f120" args="(const Vec&lt; double &gt; &amp;signal, bvec &amp;bits) const" -->
148virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#4d03bbe8bd467898f149d5f134f6f120">demodulate_bits</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;signal, bvec &amp;bits) const</td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hard demodulation of bits. <br></td></tr>
151<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e3432dad687ac0ee102c208e34920f8"></a><!-- doxytag: member="itpp::PAM::demodulate_bits" ref="9e3432dad687ac0ee102c208e34920f8" args="(const Vec&lt; double &gt; &amp;signal) const" -->
152virtual bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#9e3432dad687ac0ee102c208e34920f8">demodulate_bits</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;signal) const</td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hard demodulation of bits. <br></td></tr>
155<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#9beffaf8f69378f9c20a85f3023bd9af">demodulate_soft_bits</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;rx_symbols, double N0, vec &amp;soft_bits, <a class="el" href="group__modulators.html#g5128af4688e1a1caa84e1fabf051faa7">Soft_Method</a> method=LOGMAP) const</td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Soft demodulator for AWGN channels.  <a href="#9beffaf8f69378f9c20a85f3023bd9af"></a><br></td></tr>
158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9cba88e460e11775fb72d21b543c375"></a><!-- doxytag: member="itpp::PAM::demodulate_soft_bits" ref="a9cba88e460e11775fb72d21b543c375" args="(const Vec&lt; double &gt; &amp;rx_symbols, double N0, Soft_Method method=LOGMAP) const" -->
159virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#a9cba88e460e11775fb72d21b543c375">demodulate_soft_bits</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;rx_symbols, double N0, <a class="el" href="group__modulators.html#g5128af4688e1a1caa84e1fabf051faa7">Soft_Method</a> method=LOGMAP) const</td></tr>
160
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Soft demodulator for AWGN channels. <br></td></tr>
162<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#bd014d868b4f883712f92a7130401714">demodulate_soft_bits</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;rx_symbols, const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;channel, double N0, vec &amp;soft_bits, <a class="el" href="group__modulators.html#g5128af4688e1a1caa84e1fabf051faa7">Soft_Method</a> method=LOGMAP) const</td></tr>
163
164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Soft demodulator for fading channels.  <a href="#bd014d868b4f883712f92a7130401714"></a><br></td></tr>
165<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e40b7afd0d38d2d86b561b9dff6f55fd"></a><!-- doxytag: member="itpp::PAM::demodulate_soft_bits" ref="e40b7afd0d38d2d86b561b9dff6f55fd" args="(const Vec&lt; double &gt; &amp;rx_symbols, const Vec&lt; double &gt; &amp;channel, double N0, Soft_Method method=LOGMAP) const" -->
166virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#e40b7afd0d38d2d86b561b9dff6f55fd">demodulate_soft_bits</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;rx_symbols, const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt; &amp;channel, double N0, <a class="el" href="group__modulators.html#g5128af4688e1a1caa84e1fabf051faa7">Soft_Method</a> method=LOGMAP) const</td></tr>
167
168<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Soft demodulator for fading channels. <br></td></tr>
169<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bb3e654a3fb6d127ee8d266677689233"></a><!-- doxytag: member="itpp::PAM::calculate_softbit_matrices" ref="bb3e654a3fb6d127ee8d266677689233" args="()" -->
171void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#bb3e654a3fb6d127ee8d266677689233">calculate_softbit_matrices</a> ()</td></tr>
172
173<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function calculates the soft bit mapping matrices S0 and S1. <br></td></tr>
174<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
175<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="533787cc46e673e23308eeba3e3b4adc"></a><!-- doxytag: member="itpp::PAM::scaling_factor" ref="533787cc46e673e23308eeba3e3b4adc" args="" -->
176double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1PAM.html#533787cc46e673e23308eeba3e3b4adc">scaling_factor</a></td></tr>
177
178<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Scaling factor used to normalize the average energy to 1. <br></td></tr>
179<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="552cd7add3e998eca485d0ea39808e0d"></a><!-- doxytag: member="itpp::PAM::setup_done" ref="552cd7add3e998eca485d0ea39808e0d" args="" -->
180bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#552cd7add3e998eca485d0ea39808e0d">setup_done</a></td></tr>
181
182<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setup indicator. <br></td></tr>
183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3656edc52486e0551b734b32ab67d3b6"></a><!-- doxytag: member="itpp::PAM::k" ref="3656edc52486e0551b734b32ab67d3b6" args="" -->
184int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#3656edc52486e0551b734b32ab67d3b6">k</a></td></tr>
185
186<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of bits per modulation symbol. <br></td></tr>
187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a434960c7ff9e5356d832aa53b46930b"></a><!-- doxytag: member="itpp::PAM::M" ref="a434960c7ff9e5356d832aa53b46930b" args="" -->
188int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#a434960c7ff9e5356d832aa53b46930b">M</a></td></tr>
189
190<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of modulation symbols. <br></td></tr>
191<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b1a9a706c0736c51966703bea58cf48"></a><!-- doxytag: member="itpp::PAM::bitmap" ref="1b1a9a706c0736c51966703bea58cf48" args="" -->
192<a class="el" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69">bmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#1b1a9a706c0736c51966703bea58cf48">bitmap</a></td></tr>
193
194<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Bit to symbol mapping table (size: M x k). <br></td></tr>
195<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ca26614189cb7a66da369bf0c4b9070"></a><!-- doxytag: member="itpp::PAM::bits2symbols" ref="3ca26614189cb7a66da369bf0c4b9070" args="" -->
196ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#3ca26614189cb7a66da369bf0c4b9070">bits2symbols</a></td></tr>
197
198<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Bit to symbol mapping in decimal form (size: M). <br></td></tr>
199<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3069840e9e7a44180615fb772cf9ae42"></a><!-- doxytag: member="itpp::PAM::symbols" ref="3069840e9e7a44180615fb772cf9ae42" args="" -->
200<a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#3069840e9e7a44180615fb772cf9ae42">symbols</a></td></tr>
201
202<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Corresponding modulation symbols (size: M). <br></td></tr>
203<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c19c8fe07e95e4eb80e832a633b7c422"></a><!-- doxytag: member="itpp::PAM::S0" ref="c19c8fe07e95e4eb80e832a633b7c422" args="" -->
204imat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#c19c8fe07e95e4eb80e832a633b7c422">S0</a></td></tr>
205
206<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix where row k contains the constellation points with '0' in bit position k. <br></td></tr>
207<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d4c223ffd96fdc5b26ba5c44956998b"></a><!-- doxytag: member="itpp::PAM::S1" ref="9d4c223ffd96fdc5b26ba5c44956998b" args="" -->
208imat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#9d4c223ffd96fdc5b26ba5c44956998b">S1</a></td></tr>
209
210<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix where row k contains the constellation points with '1' in bit position k. <br></td></tr>
211<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
212<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
213<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d47d1377dffb2aed9f21f8f976e80a0a"></a><!-- doxytag: member="itpp::PAM::Modulator_1D" ref="d47d1377dffb2aed9f21f8f976e80a0a" args="" -->
214typedef <a class="el" href="classitpp_1_1Modulator.html">Modulator</a>&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#d47d1377dffb2aed9f21f8f976e80a0a">Modulator_1D</a></td></tr>
215
216<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Definition of 1D Modulator (with real symbols). <br></td></tr>
217<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="97dc4e87ae4fa63c4e7dbbeac0ab00b0"></a><!-- doxytag: member="itpp::PAM::Modulator_2D" ref="97dc4e87ae4fa63c4e7dbbeac0ab00b0" args="" -->
218typedef <a class="el" href="classitpp_1_1Modulator.html">Modulator</a><br class="typebreak">
219&lt; std::complex&lt; double &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Modulator.html#97dc4e87ae4fa63c4e7dbbeac0ab00b0">Modulator_2D</a></td></tr>
220
221<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Definition of 2D Modulator (with complex symbols). <br></td></tr>
222</table>
223<hr><a name="_details"></a><h2>Detailed Description</h2>
224M-ary <a class="el" href="classitpp_1_1PAM.html" title="M-ary PAM modulator with real symbols.">PAM</a> modulator with real symbols.
225<p>
226This class implements an M-ary <a class="el" href="classitpp_1_1PAM.html" title="M-ary PAM modulator with real symbols.">PAM</a> modulator with the following signal values: <img class="formulaInl" alt="$\{-(M-1), \ldots, -3, -1, 1, 3, \ldots, (M-1)\}$" src="form_267.png">. Symbol numbering is from right to left in the increasing order. The Gray encoding of bits to symbols is used.<p>
227The constellation symbols are normalized so that the average energy is equal to 1. That is, normalized with <img class="formulaInl" alt="$ \sqrt{(M^2-1)/3}$" src="form_268.png">.<p>
228<dl class="note" compact><dt><b>Note:</b></dt><dd>This class uses real values for representing symbols. There is a similar class named <a class="el" href="classitpp_1_1PAM__c.html" title="M-ary PAM modulator with complex symbols.">PAM_c</a>, which uses complex values for symbols and therefore is compatible with other <a class="el" href="classitpp_1_1PSK.html" title="M-ary PSK modulator.">PSK</a> and <a class="el" href="classitpp_1_1QAM.html" title="M-ary QAM modulator with square lattice.">QAM</a> based modulators. </dd></dl>
229<hr><h2>Member Function Documentation</h2>
230<a class="anchor" name="bd014d868b4f883712f92a7130401714"></a><!-- doxytag: member="itpp::PAM::demodulate_soft_bits" ref="bd014d868b4f883712f92a7130401714" args="(const Vec&lt; double &gt; &amp;rx_symbols, const Vec&lt; double &gt; &amp;channel, double N0, vec &amp;soft_bits, Soft_Method method=LOGMAP) const" -->
231<div class="memitem">
232<div class="memproto">
233      <table class="memname">
234        <tr>
235          <td class="memname">virtual void <a class="el" href="classitpp_1_1Modulator.html">itpp::Modulator</a>&lt; double  &gt;::demodulate_soft_bits           </td>
236          <td>(</td>
237          <td class="paramtype">const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double  &gt; &amp;&nbsp;</td>
238          <td class="paramname"> <em>rx_symbols</em>, </td>
239        </tr>
240        <tr>
241          <td class="paramkey"></td>
242          <td></td>
243          <td class="paramtype">const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double  &gt; &amp;&nbsp;</td>
244          <td class="paramname"> <em>channel</em>, </td>
245        </tr>
246        <tr>
247          <td class="paramkey"></td>
248          <td></td>
249          <td class="paramtype">double&nbsp;</td>
250          <td class="paramname"> <em>N0</em>, </td>
251        </tr>
252        <tr>
253          <td class="paramkey"></td>
254          <td></td>
255          <td class="paramtype">vec &amp;&nbsp;</td>
256          <td class="paramname"> <em>soft_bits</em>, </td>
257        </tr>
258        <tr>
259          <td class="paramkey"></td>
260          <td></td>
261          <td class="paramtype"><a class="el" href="group__modulators.html#g5128af4688e1a1caa84e1fabf051faa7">Soft_Method</a>&nbsp;</td>
262          <td class="paramname"> <em>method</em> = <code>LOGMAP</code></td><td>&nbsp;</td>
263        </tr>
264        <tr>
265          <td></td>
266          <td>)</td>
267          <td></td><td></td><td> const<code> [virtual, inherited]</code></td>
268        </tr>
269      </table>
270</div>
271<div class="memdoc">
272
273<p>
274Soft demodulator for fading channels.
275<p>
276This function calculates the log-likelihood ratio (LLR) of the received signal from fading channels. Depending on the soft demodulation method chosen, either full log-MAP calculation is performed (default method), according to the following equation: <p class="formulaDsp">
277<img class="formulaDsp" alt="\[\log \left( \frac{P(b_i=0|r)}{P(b_i=1|r)} \right) = \log \left( \frac{\sum_{s_i \in S_0} \exp \left( -\frac{|r_k - c_k s_i|^2}{N_0} \right)} {\sum_{s_i \in S_1} \exp \left( -\frac{|r_k - c_k s_i|^2}{N_0} \right)} \right) \]" src="form_275.png">
278<p>
279 or approximate, but faster calculation is performed.<p>
280The approximate method finds for each bit the closest constellation points that have zero and one in the corresponding position. Let <img class="formulaInl" alt="$d_0 = |r_k - c_k s_0|$" src="form_276.png"> denote the distance to the closest zero point and <img class="formulaInl" alt="$d_1 = |r_k - c_k s_1|$" src="form_277.png"> denote the distance to the closest one point for the corresponding bit respectively. The approximate algorithm then computes <p class="formulaDsp">
281<img class="formulaDsp" alt="\[\frac{d_1^2 - d_0^2}{N_0}\]" src="form_272.png">
282<p>
283<p>
284When this function is to be used together with MAP-based turbo decoding algorithms then the channel reliability factor <img class="formulaInl" alt="$L_c$" src="form_274.png"> of the turbo decoder shall be set to 1. The output from this function can also be used by a Viterbi decoder using an AWGN based metric calculation function.<p>
285<dl compact><dt><b>Parameters:</b></dt><dd>
286  <table border="0" cellspacing="2" cellpadding="0">
287    <tr><td valign="top"></td><td valign="top"><em>rx_symbols</em>&nbsp;</td><td>The received noisy constellation symbols <img class="formulaInl" alt="$r_k$" src="form_278.png"> </td></tr>
288    <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel values <img class="formulaInl" alt="$c_k$" src="form_253.png"> </td></tr>
289    <tr><td valign="top"></td><td valign="top"><em>N0</em>&nbsp;</td><td>The spectral density of the AWGN noise </td></tr>
290    <tr><td valign="top"></td><td valign="top"><em>soft_bits</em>&nbsp;</td><td>The soft bits calculated using the expression above </td></tr>
291    <tr><td valign="top"></td><td valign="top"><em>method</em>&nbsp;</td><td>The method used for demodulation (LOGMAP or APPROX)</td></tr>
292  </table>
293</dl>
294<dl class="note" compact><dt><b>Note:</b></dt><dd>For soft demodulation it is suggested to use the N-dimensional modulator (Modulator_ND) instead, which is based on the QLLR (quantized) arithmetic and therefore is faster. Please note, however, that mixed use of <code>Modulator_1D/<code>Modulator_2D</code> and</code> <code>Modulator_ND</code> is not advised. </dd></dl>
295
296</div>
297</div><p>
298<a class="anchor" name="9beffaf8f69378f9c20a85f3023bd9af"></a><!-- doxytag: member="itpp::PAM::demodulate_soft_bits" ref="9beffaf8f69378f9c20a85f3023bd9af" args="(const Vec&lt; double &gt; &amp;rx_symbols, double N0, vec &amp;soft_bits, Soft_Method method=LOGMAP) const" -->
299<div class="memitem">
300<div class="memproto">
301      <table class="memname">
302        <tr>
303          <td class="memname">virtual void <a class="el" href="classitpp_1_1Modulator.html">itpp::Modulator</a>&lt; double  &gt;::demodulate_soft_bits           </td>
304          <td>(</td>
305          <td class="paramtype">const <a class="el" href="classitpp_1_1Vec.html">Vec</a>&lt; double  &gt; &amp;&nbsp;</td>
306          <td class="paramname"> <em>rx_symbols</em>, </td>
307        </tr>
308        <tr>
309          <td class="paramkey"></td>
310          <td></td>
311          <td class="paramtype">double&nbsp;</td>
312          <td class="paramname"> <em>N0</em>, </td>
313        </tr>
314        <tr>
315          <td class="paramkey"></td>
316          <td></td>
317          <td class="paramtype">vec &amp;&nbsp;</td>
318          <td class="paramname"> <em>soft_bits</em>, </td>
319        </tr>
320        <tr>
321          <td class="paramkey"></td>
322          <td></td>
323          <td class="paramtype"><a class="el" href="group__modulators.html#g5128af4688e1a1caa84e1fabf051faa7">Soft_Method</a>&nbsp;</td>
324          <td class="paramname"> <em>method</em> = <code>LOGMAP</code></td><td>&nbsp;</td>
325        </tr>
326        <tr>
327          <td></td>
328          <td>)</td>
329          <td></td><td></td><td> const<code> [virtual, inherited]</code></td>
330        </tr>
331      </table>
332</div>
333<div class="memdoc">
334
335<p>
336Soft demodulator for AWGN channels.
337<p>
338This function calculates the log-likelihood ratio (LLR) of the received signal from AWGN channels. Depending on the soft demodulation method chosen, either full log-MAP calculation is performed (default method), according to the following equation: <p class="formulaDsp">
339<img class="formulaDsp" alt="\[\log \left( \frac{P(b_i=0|r)}{P(b_i=1|r)} \right) = \log \left( \frac{\sum_{s_i \in S_0} \exp \left( -\frac{|r_k - s_i|^2}{N_0} \right)} {\sum_{s_i \in S_1} \exp \left( -\frac{|r_k - s_i|^2}{N_0} \right)} \right) \]" src="form_269.png">
340<p>
341 or approximate, but faster calculation is performed.<p>
342The approximate method finds for each bit the closest constellation points that have zero and one in the corresponding position. Let <img class="formulaInl" alt="$d_0 = |r_k - s_0|$" src="form_270.png"> denote the distance to the closest zero point and <img class="formulaInl" alt="$d_1 = |r_k - s_1|$" src="form_271.png"> denote the distance to the closest one point for the corresponding bit respectively. The approximate algorithm then computes <p class="formulaDsp">
343<img class="formulaDsp" alt="\[\frac{d_1^2 - d_0^2}{N_0}\]" src="form_272.png">
344<p>
345<p>
346This function can be used on channels where the channel gain <img class="formulaInl" alt="$c_k = 1$" src="form_273.png">.<p>
347When this function is to be used together with MAP-based turbo decoding algorithms then the channel reliability factor <img class="formulaInl" alt="$L_c$" src="form_274.png"> of the turbo decoder shall be set to 1. The output from this function can also be used by a Viterbi decoder using an AWGN based metric calculation function.<p>
348<dl compact><dt><b>Parameters:</b></dt><dd>
349  <table border="0" cellspacing="2" cellpadding="0">
350    <tr><td valign="top"></td><td valign="top"><em>rx_symbols</em>&nbsp;</td><td>The received noisy constellation symbols </td></tr>
351    <tr><td valign="top"></td><td valign="top"><em>N0</em>&nbsp;</td><td>The spectral density of the AWGN noise </td></tr>
352    <tr><td valign="top"></td><td valign="top"><em>soft_bits</em>&nbsp;</td><td>The soft bits calculated using the expression above </td></tr>
353    <tr><td valign="top"></td><td valign="top"><em>method</em>&nbsp;</td><td>The method used for demodulation (LOGMAP or APPROX)</td></tr>
354  </table>
355</dl>
356<dl class="note" compact><dt><b>Note:</b></dt><dd>For soft demodulation it is suggested to use the N-dimensional modulator (<code>Modulator_ND</code>) instead, which is based on the QLLR (quantized) arithmetic and therefore is faster. Please note, however, that mixed use of <code>Modulator_1D/<code>Modulator_2D</code> and</code> <code>Modulator_ND</code> is not advised. </dd></dl>
357
358</div>
359</div><p>
360<a class="anchor" name="a8186f0e837fd3d440a6acb7a0225d35"></a><!-- doxytag: member="itpp::PAM::get_bits2symbols" ref="a8186f0e837fd3d440a6acb7a0225d35" args="() const" -->
361<div class="memitem">
362<div class="memproto">
363      <table class="memname">
364        <tr>
365          <td class="memname">virtual ivec <a class="el" href="classitpp_1_1Modulator.html">itpp::Modulator</a>&lt; double  &gt;::get_bits2symbols           </td>
366          <td>(</td>
367          <td class="paramname">          </td>
368          <td>&nbsp;)&nbsp;</td>
369          <td> const<code> [inline, virtual, inherited]</code></td>
370        </tr>
371      </table>
372</div>
373<div class="memdoc">
374
375<p>
376Get the bitmap, which maps input bits into symbols.
377<p>
378The mapping is done as follows. An input bit sequence in decimal notation is used for indexing the <code>bits2symbols</code> table. The indexing result denotes the symbol to be used from the <code>symbols</code> table, e.g.:<p>
379<div class="fragment"><pre class="fragment"> PSK <a class="code" href="group__miscfunc.html#g441f466a2b056fe5f2b05fcd894c472f" title="Calculates the modulus, i.e. the signed reminder after division.">mod</a>(8); <span class="comment">// assume 8-PSK modulator</span>
380 cvec sym =  <a class="code" href="group__miscfunc.html#g441f466a2b056fe5f2b05fcd894c472f" title="Calculates the modulus, i.e. the signed reminder after division.">mod</a>.get_symbols();
381 ivec bits2sym = <a class="code" href="group__miscfunc.html#g441f466a2b056fe5f2b05fcd894c472f" title="Calculates the modulus, i.e. the signed reminder after division.">mod</a>.get_bits2symbols();
382 bvec in_bits = <span class="stringliteral">"100"</span> <span class="comment">// input bits</span>
383 <span class="keywordtype">int</span> d = <a class="code" href="group__convertfunc.html#g698adf78bc0f9d36fd5987bc87d543fa" title="Convert a bvec to decimal int with the first bit as MSB if msb_first == true.">bin2dec</a>(in_bits); <span class="comment">// decimal representation of in_bits = 4</span>
384 <span class="comment">// mapping of d into PSK symbol using bits2sym and sym tables</span>
385 std::complex&lt;double&gt; out_symbol = sym(bits2sym(d));
386</pre></div> 
387</div>
388</div><p>
389<hr>The documentation for this class was generated from the following files:<ul>
390<li><a class="el" href="modulator_8h-source.html">modulator.h</a><li><a class="el" href="modulator_8cpp.html">modulator.cpp</a></ul>
391</div>
392<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
393<a href="http://www.doxygen.org/index.html">
394<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
395</body>
396</html>
Note: See TracBrowser for help on using the browser.