Skip to content

Commit 53cb06f

Browse files
authored
Update signals.py
Corrected docstring for pseudorandom.
1 parent cffb4ff commit 53cb06f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

pyExSi/signals.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,15 @@ def pseudo_random(N, rg=None):
7474
"""
7575
Pseudorandom distribution.
7676
77-
Magnitudes are 1, phase is random.
77+
Generated random data has amplitude spectrum of magnuted 1 and
78+
uniformly distributed phase.
7879
7980
:param N: Number of points.
8081
:type N: int
8182
:param rg: Initialized Generator object
8283
:type rg: numpy.random._generator.Generator
83-
:returns: Random samples from the “standard normal” distribution
84+
:returns: Random samples with amplitude spectrum of magnuted 1 and
85+
uniformly distributed phase.
8486
8587
Example
8688
--------
@@ -849,4 +851,4 @@ def get_kurtosis(signal):
849851
if __name__ == "__main__":
850852
time = np.arange(1000)/10000
851853
burst = sine_sweep(time=time, freq_start=3000, freq_stop=15000, mode='logarithmic')
852-
print(burst)
854+
print(burst)

0 commit comments

Comments
 (0)