Skip to content

Commit 70f13f1

Browse files
committed
Typos: Sinusiods in channel model docs
also, unified capitalization in \li items.
1 parent e61a5c8 commit 70f13f1

File tree

3 files changed

+23
-23
lines changed

3 files changed

+23
-23
lines changed

gr-channels/doc/channels.dox

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@ multipath environment.
3333

3434
The parameters include:
3535

36-
\li noise_voltage: The AWGN noise level as a voltage (to be calculated
36+
\li <b>noise_voltage</b> The AWGN noise level as a voltage (to be calculated
3737
externally to meet, say, a desired SNR).
38-
\li frequency_offset The normalized frequency offset. 0 is no offset;
38+
\li <b>frequency_offset</b> The normalized frequency offset. 0 is no offset;
3939
0.25 would be, for a digital modem, one quarter of the symbol
4040
rate.
41-
\li epsilon The sample timing offset to emulate the different rates
41+
\li <b>epsilon</b> The sample timing offset to emulate the different rates
4242
between the sample clocks of the transmitter and receiver. 1.0 is
4343
no difference.
44-
\li taps Taps of a FIR filter to emulate a multipath delay profile.
45-
\li noise_seed A random number generator seed for the noise source.
44+
\li <b>taps</b> Taps of a FIR filter to emulate a multipath delay profile.
45+
\li <b>noise_seed</b> A random number generator seed for the noise source.
4646

4747

4848
\subsection channels_fading Fading Channel Model
@@ -55,11 +55,11 @@ in the Doppler frequency shift as a normalized value, a line-of-sight
5555
a random seed to the noise generators. These parameters are provided
5656
in the documentation as:
5757

58-
\li N The number of sinusiods to use in simulating the channel 8 is a good value
59-
\li fDTs normalized maximum Doppler frequency, fD * Ts
60-
\li LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models
61-
\li K Rician factor (ratio of the specular power to the scattered power)
62-
\li seed a random number to seed the noise generators
58+
\li <b>N</b> the number of sinusoids to use in simulating the channel; 8 is a good value
59+
\li <b>fDTs</b> normalized maximum Doppler frequency, fD * Ts
60+
\li <b>LOS</b> include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models
61+
\li <b>K</b> Rician factor (ratio of the specular power to the scattered power)
62+
\li <b>seed</b> a random number to seed the noise generators
6363

6464

6565
\subsection channels_selective_fading Frequency-Selective Fading Model
@@ -73,14 +73,14 @@ and another vector of the corresponding magnitudes of the PDP. We also
7373
specify the number of taps in the filter to simulate this. These
7474
parameters are provided in the documentation as:
7575

76-
\li N The number of sinusiods to use in simulating the channel 8 is a good value
77-
\li fDTs normalized maximum Doppler frequency, fD * Ts
78-
\li LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models
79-
\li K Rician factor (ratio of the specular power to the scattered power)
80-
\li seed a random number to seed the noise generators
81-
\li delays A vector of values the specify the time delay of each impulse
82-
\li mags A vector of values that specifies the magnitude of each impulse
83-
\li ntaps The number of filter taps.
76+
\li <b>N</b> the number of sinusoids to use in simulating the channel; 8 is a good value
77+
\li <b>fDTs</b> normalized maximum Doppler frequency, fD * Ts
78+
\li <b>LOS</b> include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models
79+
\li <b>K</b> Rician factor (ratio of the specular power to the scattered power)
80+
\li <b>seed</b> a random number to seed the noise generators
81+
\li <b>delays</b> a vector of values that specify the time delay of each impulse
82+
\li <b>mags</b> a vector of values that specify the magnitude of each impulse
83+
\li <b>ntaps</b> the number of filter taps.
8484

8585

8686
\subsection channels_hw_impairments Hardware Impairments Model

gr-channels/include/gnuradio/channels/fading_model.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ namespace gr {
4747

4848
/*! \brief Build the channel simulator.
4949
*
50-
* \param N The number of sinusiods to use in simulating the channel; 8 is a good value
50+
* \param N the number of sinusoids to use in simulating the channel; 8 is a good value
5151
* \param fDTs normalized maximum Doppler frequency, fD * Ts
5252
* \param LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models
5353
* \param K Rician factor (ratio of the specular power to the scattered power)

gr-channels/include/gnuradio/channels/selective_fading_model.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ namespace gr {
5050

5151
/*! \brief Build the channel simulator.
5252
*
53-
* \param N The number of sinusiods to use in simulating the channel; 8 is a good value
53+
* \param N the number of sinusoids to use in simulating the channel; 8 is a good value
5454
* \param fDTs normalized maximum Doppler frequency, fD * Ts
5555
* \param LOS include Line-of-Site path? selects between Rayleigh (NLOS) and Rician (LOS) models
5656
* \param K Rician factor (ratio of the specular power to the scattered power)
5757
* \param seed a random number to seed the noise generators
58-
* \param delays A vector of values the specify the time delay of each impulse
59-
* \param mags A vector of values that specifies the magnitude of each impulse
60-
* \param ntaps The number of filter taps.
58+
* \param delays a vector of values that specify the time delay of each impulse
59+
* \param mags a vector of values that specify the magnitude of each impulse
60+
* \param ntaps the number of filter taps
6161
*/
6262
static sptr make(unsigned int N,
6363
float fDTs,

0 commit comments

Comments
 (0)