diff options
| author | Johnathan Corgan <johnathan@corganlabs.com> | 2015-04-26 15:04:34 -0700 |
|---|---|---|
| committer | Johnathan Corgan <johnathan@corganlabs.com> | 2015-04-26 15:04:34 -0700 |
| commit | 83f70594d0ac2bae347bc44cbb4a5a89138afcc9 (patch) | |
| tree | 614ecc7d0faceb5997686caaefc1e5618629012e | |
| parent | 4547dc260ab08ef83d912169b8c93a4348b7db06 (diff) | |
| parent | 70f13f1c76efe5dfbdd1e33b151eb0d70efac25d (diff) | |
Merge remote-tracking branch 'mmueller/docs_typo_sinusiod' into maint
| -rw-r--r-- | gr-channels/doc/channels.dox | 36 | ||||
| -rw-r--r-- | gr-channels/include/gnuradio/channels/fading_model.h | 2 | ||||
| -rw-r--r-- | gr-channels/include/gnuradio/channels/selective_fading_model.h | 8 |
3 files changed, 23 insertions, 23 deletions
diff --git a/gr-channels/doc/channels.dox b/gr-channels/doc/channels.dox index bb87ed5dc5..7b60c308b7 100644 --- a/gr-channels/doc/channels.dox +++ b/gr-channels/doc/channels.dox @@ -33,16 +33,16 @@ multipath environment. The parameters include: -\li noise_voltage: The AWGN noise level as a voltage (to be calculated +\li <b>noise_voltage</b> The AWGN noise level as a voltage (to be calculated externally to meet, say, a desired SNR). -\li frequency_offset The normalized frequency offset. 0 is no offset; +\li <b>frequency_offset</b> The normalized frequency offset. 0 is no offset; 0.25 would be, for a digital modem, one quarter of the symbol rate. -\li epsilon The sample timing offset to emulate the different rates +\li <b>epsilon</b> The sample timing offset to emulate the different rates between the sample clocks of the transmitter and receiver. 1.0 is no difference. -\li taps Taps of a FIR filter to emulate a multipath delay profile. -\li noise_seed A random number generator seed for the noise source. +\li <b>taps</b> Taps of a FIR filter to emulate a multipath delay profile. +\li <b>noise_seed</b> A random number generator seed for the noise source. \subsection channels_fading Fading Channel Model @@ -55,11 +55,11 @@ in the Doppler frequency shift as a normalized value, a line-of-sight a random seed to the noise generators. These parameters are provided in the documentation as: -\li N The number of sinusiods to use in simulating the channel 8 is a good value -\li fDTs normalized maximum Doppler frequency, fD * Ts -\li LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models -\li K Rician factor (ratio of the specular power to the scattered power) -\li seed a random number to seed the noise generators +\li <b>N</b> the number of sinusoids to use in simulating the channel; 8 is a good value +\li <b>fDTs</b> normalized maximum Doppler frequency, fD * Ts +\li <b>LOS</b> include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models +\li <b>K</b> Rician factor (ratio of the specular power to the scattered power) +\li <b>seed</b> a random number to seed the noise generators \subsection channels_selective_fading Frequency-Selective Fading Model @@ -73,14 +73,14 @@ and another vector of the corresponding magnitudes of the PDP. We also specify the number of taps in the filter to simulate this. These parameters are provided in the documentation as: -\li N The number of sinusiods to use in simulating the channel 8 is a good value -\li fDTs normalized maximum Doppler frequency, fD * Ts -\li LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models -\li K Rician factor (ratio of the specular power to the scattered power) -\li seed a random number to seed the noise generators -\li delays A vector of values the specify the time delay of each impulse -\li mags A vector of values that specifies the magnitude of each impulse -\li ntaps The number of filter taps. +\li <b>N</b> the number of sinusoids to use in simulating the channel; 8 is a good value +\li <b>fDTs</b> normalized maximum Doppler frequency, fD * Ts +\li <b>LOS</b> include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models +\li <b>K</b> Rician factor (ratio of the specular power to the scattered power) +\li <b>seed</b> a random number to seed the noise generators +\li <b>delays</b> a vector of values that specify the time delay of each impulse +\li <b>mags</b> a vector of values that specify the magnitude of each impulse +\li <b>ntaps</b> the number of filter taps. \subsection channels_hw_impairments Hardware Impairments Model diff --git a/gr-channels/include/gnuradio/channels/fading_model.h b/gr-channels/include/gnuradio/channels/fading_model.h index 4b1411369a..3d9d500b15 100644 --- a/gr-channels/include/gnuradio/channels/fading_model.h +++ b/gr-channels/include/gnuradio/channels/fading_model.h @@ -47,7 +47,7 @@ namespace gr { /*! \brief Build the channel simulator. * - * \param N The number of sinusiods to use in simulating the channel; 8 is a good value + * \param N the number of sinusoids to use in simulating the channel; 8 is a good value * \param fDTs normalized maximum Doppler frequency, fD * Ts * \param LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models * \param K Rician factor (ratio of the specular power to the scattered power) diff --git a/gr-channels/include/gnuradio/channels/selective_fading_model.h b/gr-channels/include/gnuradio/channels/selective_fading_model.h index 5788d8dc09..0296d9376d 100644 --- a/gr-channels/include/gnuradio/channels/selective_fading_model.h +++ b/gr-channels/include/gnuradio/channels/selective_fading_model.h @@ -50,14 +50,14 @@ namespace gr { /*! \brief Build the channel simulator. * - * \param N The number of sinusiods to use in simulating the channel; 8 is a good value + * \param N the number of sinusoids to use in simulating the channel; 8 is a good value * \param fDTs normalized maximum Doppler frequency, fD * Ts * \param LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models * \param K Rician factor (ratio of the specular power to the scattered power) * \param seed a random number to seed the noise generators - * \param delays A vector of values the specify the time delay of each impulse - * \param mags A vector of values that specifies the magnitude of each impulse - * \param ntaps The number of filter taps. + * \param delays a vector of values that specify the time delay of each impulse + * \param mags a vector of values that specify the magnitude of each impulse + * \param ntaps the number of filter taps */ static sptr make(unsigned int N, float fDTs, |