summaryrefslogtreecommitdiff
path: root/gr-fft/python
diff options
context:
space:
mode:
authorJohnathan Corgan <jcorgan@corganenterprises.com>2012-08-28 12:52:09 -0700
committerJohnathan Corgan <jcorgan@corganenterprises.com>2012-08-28 12:52:09 -0700
commit5892c29ee0509ff8aa226f14da524f7ec30f9654 (patch)
tree759624a4c9f9b5d6c2e2da13906be99aebf25152 /gr-fft/python
parent7adff515181de5cfbd7392d934cac9083a8a6a58 (diff)
parentfc4d37062c46886d3bc1fb0b6c3626d779be4ecd (diff)
Merge remote branch 'reynwar/comments_next' into next
Conflicts: gr-digital/include/digital_constellation.h gr-digital/python/bpsk.py gr-digital/python/qpsk.py
Diffstat (limited to 'gr-fft/python')
-rw-r--r--gr-fft/python/logpwrfft.py36
1 files changed, 24 insertions, 12 deletions
diff --git a/gr-fft/python/logpwrfft.py b/gr-fft/python/logpwrfft.py
index 42a4757f02..f48b60518f 100644
--- a/gr-fft/python/logpwrfft.py
+++ b/gr-fft/python/logpwrfft.py
@@ -40,13 +40,15 @@ class _logpwrfft_base(gr.hier_block2):
"""
Create an log10(abs(fft)) stream chain.
Provide access to the setting the filter and sample rate.
- @param sample_rate Incoming stream sample rate
- @param fft_size Number of FFT bins
- @param ref_scale Sets 0 dB value input amplitude
- @param frame_rate Output frame rate
- @param avg_alpha FFT averaging (over time) constant [0.0-1.0]
- @param average Whether to average [True, False]
- @param win the window taps generation function
+
+ Args:
+ sample_rate: Incoming stream sample rate
+ fft_size: Number of FFT bins
+ ref_scale: Sets 0 dB value input amplitude
+ frame_rate: Output frame rate
+ avg_alpha: FFT averaging (over time) constant [0.0-1.0]
+ average: Whether to average [True, False]
+ win: the window taps generation function
"""
gr.hier_block2.__init__(self, self._name,
gr.io_signature(1, 1, self._item_size), # Input signature
@@ -78,28 +80,36 @@ class _logpwrfft_base(gr.hier_block2):
def set_decimation(self, decim):
"""
Set the decimation on stream decimator.
- @param decim the new decimation
+
+ Args:
+ decim: the new decimation
"""
self._sd.set_decimation(decim)
def set_vec_rate(self, vec_rate):
"""
Set the vector rate on stream decimator.
- @param vec_rate the new vector rate
+
+ Args:
+ vec_rate: the new vector rate
"""
self._sd.set_vec_rate(vec_rate)
def set_sample_rate(self, sample_rate):
"""
Set the new sampling rate
- @param sample_rate the new rate
+
+ Args:
+ sample_rate: the new rate
"""
self._sd.set_sample_rate(sample_rate)
def set_average(self, average):
"""
Set the averaging filter on/off.
- @param average true to set averaging on
+
+ Args:
+ average: true to set averaging on
"""
self._average = average
if self._average:
@@ -110,7 +120,9 @@ class _logpwrfft_base(gr.hier_block2):
def set_avg_alpha(self, avg_alpha):
"""
Set the average alpha and set the taps if average was on.
- @param avg_alpha the new iir filter tap
+
+ Args:
+ avg_alpha: the new iir filter tap
"""
self._avg_alpha = avg_alpha
self.set_average(self._average)