root/doc/html/classitpp_1_1Static__Fading__Generator.html @ 354

Revision 353, 19.8 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::Static_Fading_Generator 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_1Static__Fading__Generator.html">Static_Fading_Generator</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Static_Fading_Generator Class Reference<br>
72<small>
73[<a class="el" href="group__channels.html">Channel Modeling</a>]</small>
74</h1><!-- doxytag: class="itpp::Static_Fading_Generator" --><!-- doxytag: inherits="itpp::Fading_Generator" -->Static fading generator class. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="channel_8h-source.html">channel.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Static__Fading__Generator-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="6a0a33b29aa0b1cbf1127380063614c8"></a><!-- doxytag: member="itpp::Static_Fading_Generator::Static_Fading_Generator" ref="6a0a33b29aa0b1cbf1127380063614c8" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Static__Fading__Generator.html#6a0a33b29aa0b1cbf1127380063614c8">Static_Fading_Generator</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="8c46c2ebb5b9424321fba5d0c06f2a11"></a><!-- doxytag: member="itpp::Static_Fading_Generator::~Static_Fading_Generator" ref="8c46c2ebb5b9424321fba5d0c06f2a11" args="()" -->
89virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Static__Fading__Generator.html#8c46c2ebb5b9424321fba5d0c06f2a11">~Static_Fading_Generator</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c98b49b70e89a5ef3aff5e1dd3fb8e27"></a><!-- doxytag: member="itpp::Static_Fading_Generator::init" ref="c98b49b70e89a5ef3aff5e1dd3fb8e27" args="()" -->
93virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Static__Fading__Generator.html#c98b49b70e89a5ef3aff5e1dd3fb8e27">init</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the generator. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a20159bff443fc58e1f0d8d356f67fe"></a><!-- doxytag: member="itpp::Static_Fading_Generator::generate" ref="2a20159bff443fc58e1f0d8d356f67fe" args="(int no_samples, cvec &amp;output)" -->
97virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Static__Fading__Generator.html#2a20159bff443fc58e1f0d8d356f67fe">generate</a> (int no_samples, cvec &amp;output)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate <em>no_samples</em> values from the fading process. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="303d2454c55a32ea459b2986bc103d31"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_LOS_power" ref="303d2454c55a32ea459b2986bc103d31" args="(double relative_power)" -->
101void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#303d2454c55a32ea459b2986bc103d31">set_LOS_power</a> (double relative_power)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set relative LOS power. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b4e75267789eb8e6ba796ea56457091"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_LOS_doppler" ref="8b4e75267789eb8e6ba796ea56457091" args="(double relative_doppler)" -->
105virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#8b4e75267789eb8e6ba796ea56457091">set_LOS_doppler</a> (double relative_doppler)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set relative Doppler of the LOS component (for correlated fading generators). <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a020f2c970b3c347db7f9db39641b8aa"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_time_offset" ref="a020f2c970b3c347db7f9db39641b8aa" args="(int offset)" -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#a020f2c970b3c347db7f9db39641b8aa">set_time_offset</a> (int offset)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set time offset in samples (for correlated fading generators). <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c61d461f35719366404da7b454578132"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_filter_length" ref="c61d461f35719366404da7b454578132" args="(int filter_length)" -->
113virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#c61d461f35719366404da7b454578132">set_filter_length</a> (int filter_length)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set FIR filter length (for FIR fading generator). <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0c9e5efe80612659c4293c5086e4939"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_norm_doppler" ref="e0c9e5efe80612659c4293c5086e4939" args="(double norm_doppler)" -->
117virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#e0c9e5efe80612659c4293c5086e4939">set_norm_doppler</a> (double norm_doppler)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set normalized Doppler (for correlated fading generators). <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e03abc2611e2658ecbfa809a571545dc"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_doppler_spectrum" ref="e03abc2611e2658ecbfa809a571545dc" args="(DOPPLER_SPECTRUM spectrum)" -->
121virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#e03abc2611e2658ecbfa809a571545dc">set_doppler_spectrum</a> (<a class="el" href="group__channels.html#gfd030225d513c962191cbce565337fd8">DOPPLER_SPECTRUM</a> spectrum)</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set Doppler spectrum (for Rice fading generator). <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb48831a6883828cc2f176e00dacf916"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_no_frequencies" ref="fb48831a6883828cc2f176e00dacf916" args="(int no_freq)" -->
125virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#fb48831a6883828cc2f176e00dacf916">set_no_frequencies</a> (int no_freq)</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set number of sine frequencies (for Rice fading generator). <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14efae5d9a4b08d00b7952877f3f74ef"></a><!-- doxytag: member="itpp::Static_Fading_Generator::set_rice_method" ref="14efae5d9a4b08d00b7952877f3f74ef" args="(RICE_METHOD method)" -->
129virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#14efae5d9a4b08d00b7952877f3f74ef">set_rice_method</a> (<a class="el" href="group__channels.html#g5909a344554fcfbc9d5c87dcd206974b">RICE_METHOD</a> method)</td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set calculation method of Doppler frequencies and amplitudes (for Rice fading generator). <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="25a4f2666677dd154219eee76e27a648"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_LOS_power" ref="25a4f2666677dd154219eee76e27a648" args="() const " -->
133double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#25a4f2666677dd154219eee76e27a648">get_LOS_power</a> () const </td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get relative power of LOS component (Rice factor). <br></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="777a8b3a8d2754421b4dc9de81d2e989"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_LOS_doppler" ref="777a8b3a8d2754421b4dc9de81d2e989" args="() const " -->
137virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#777a8b3a8d2754421b4dc9de81d2e989">get_LOS_doppler</a> () const </td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get relative Doppler of the LOS component (for correlated fading generators). <br></td></tr>
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e11dc7b0a862e2d86c55097f9551547"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_time_offset" ref="3e11dc7b0a862e2d86c55097f9551547" args="() const " -->
141virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#3e11dc7b0a862e2d86c55097f9551547">get_time_offset</a> () const </td></tr>
142
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get time offset in samples (for correlated fading generators). <br></td></tr>
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c5d34d4ca2a06634f8a91394f83fe58"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_filter_length" ref="1c5d34d4ca2a06634f8a91394f83fe58" args="() const " -->
145virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#1c5d34d4ca2a06634f8a91394f83fe58">get_filter_length</a> () const </td></tr>
146
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set FIR filter length (for FIR fading generator). <br></td></tr>
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18431c4491c4d64801b3a2ed63d90795"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_norm_doppler" ref="18431c4491c4d64801b3a2ed63d90795" args="() const " -->
149virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#18431c4491c4d64801b3a2ed63d90795">get_norm_doppler</a> () const </td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return normalized Doppler (for correlated fading generators). <br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dfc80efcd94edf481d0b631b9eabb8ec"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_doppler_spectrum" ref="dfc80efcd94edf481d0b631b9eabb8ec" args="() const " -->
153virtual <a class="el" href="group__channels.html#gfd030225d513c962191cbce565337fd8">DOPPLER_SPECTRUM</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#dfc80efcd94edf481d0b631b9eabb8ec">get_doppler_spectrum</a> () const </td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return Doppler spectrum (for Rice fading generator). <br></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0463428de18bb3fc78a879ef7d5e6c5"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_no_frequencies" ref="c0463428de18bb3fc78a879ef7d5e6c5" args="() const " -->
157virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#c0463428de18bb3fc78a879ef7d5e6c5">get_no_frequencies</a> () const </td></tr>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get number of sine frequencies (for Rice fading generator). <br></td></tr>
160<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29db45399c53169186ce3bcf66474e68"></a><!-- doxytag: member="itpp::Static_Fading_Generator::get_rice_method" ref="29db45399c53169186ce3bcf66474e68" args="() const " -->
161virtual <a class="el" href="group__channels.html#g5909a344554fcfbc9d5c87dcd206974b">RICE_METHOD</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#29db45399c53169186ce3bcf66474e68">get_rice_method</a> () const </td></tr>
162
163<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get calculation method of Doppler frequencies and amplitudes (for Rice fading generator). <br></td></tr>
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56173b73a996d6e87ebe2b43090837c5"></a><!-- doxytag: member="itpp::Static_Fading_Generator::shift_time_offset" ref="56173b73a996d6e87ebe2b43090837c5" args="(int no_samples)" -->
165virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#56173b73a996d6e87ebe2b43090837c5">shift_time_offset</a> (int no_samples)</td></tr>
166
167<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift generator time offset by a number of samples (for correlated fading generators). <br></td></tr>
168<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6bc7379a25d5adc4d9d2eddf92cfb9c"></a><!-- doxytag: member="itpp::Static_Fading_Generator::generate" ref="b6bc7379a25d5adc4d9d2eddf92cfb9c" args="(int no_samples)" -->
169cvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#b6bc7379a25d5adc4d9d2eddf92cfb9c">generate</a> (int no_samples)</td></tr>
170
171<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate <em>no_samples</em> values from the fading process. <br></td></tr>
172<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
173<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33f0b3260d64d38b5279203885891f2f"></a><!-- doxytag: member="itpp::Static_Fading_Generator::static_sample" ref="33f0b3260d64d38b5279203885891f2f" args="" -->
174std::complex&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Static__Fading__Generator.html#33f0b3260d64d38b5279203885891f2f">static_sample</a></td></tr>
175
176<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static Rayleigh distributed sample. <br></td></tr>
177<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fc31470215eda975bbefa15f9638504"></a><!-- doxytag: member="itpp::Static_Fading_Generator::init_flag" ref="6fc31470215eda975bbefa15f9638504" args="" -->
178bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#6fc31470215eda975bbefa15f9638504">init_flag</a></td></tr>
179
180<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">signals if generator is initialized or not <br></td></tr>
181<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5512a1606e0e89476ff8554081aeafe"></a><!-- doxytag: member="itpp::Static_Fading_Generator::los_power" ref="d5512a1606e0e89476ff8554081aeafe" args="" -->
182double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#d5512a1606e0e89476ff8554081aeafe">los_power</a></td></tr>
183
184<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relative power of LOS component compared to diffuse component (K factor). <br></td></tr>
185<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b92dcea4661469227e558ece50975c6"></a><!-- doxytag: member="itpp::Static_Fading_Generator::los_diffuse" ref="6b92dcea4661469227e558ece50975c6" args="" -->
186double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#6b92dcea4661469227e558ece50975c6">los_diffuse</a></td></tr>
187
188<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Diffuse component: sqrt(1 / (1 + los_power)). <br></td></tr>
189<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8d8f76a8d3965731972137c5d95b8d2"></a><!-- doxytag: member="itpp::Static_Fading_Generator::los_direct" ref="c8d8f76a8d3965731972137c5d95b8d2" args="" -->
190double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fading__Generator.html#c8d8f76a8d3965731972137c5d95b8d2">los_direct</a></td></tr>
191
192<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Direct component: sqrt(los_power / (1 + los_power)). <br></td></tr>
193</table>
194<hr><a name="_details"></a><h2>Detailed Description</h2>
195Static fading generator class.
196<p>
197<dl class="author" compact><dt><b>Author:</b></dt><dd>Adam Piatyszek</dd></dl>
198This class implements the static fading generator, which can be used on each tap of the TDL channel model. This generator produces a set of identical (static) Rayleigh or Rice distributed channel coefficients. <hr>The documentation for this class was generated from the following files:<ul>
199<li><a class="el" href="channel_8h-source.html">channel.h</a><li><a class="el" href="channel_8cpp.html">channel.cpp</a></ul>
200</div>
201<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
202<a href="http://www.doxygen.org/index.html">
203<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
204</body>
205</html>
Note: See TracBrowser for help on using the browser.