Fixed documentation for optfir band pass filters.
authorTom Rondeau <trondeau@molly.home>
Mon, 24 Aug 2009 21:50:06 +0000 (17:50 -0400)
committerTom Rondeau <trondeau@molly.home>
Mon, 24 Aug 2009 21:50:06 +0000 (17:50 -0400)
gnuradio-core/src/python/gnuradio/optfir.py

index ad5743287eefc54e3affec99c6b1fa21604c76a3..f09ab1e8588ef971e70f4f1b3327a6bdfb71509b 100644 (file)
@@ -56,8 +56,10 @@ def low_pass (gain, Fs, freq1, freq2, passband_ripple_db, stopband_atten_db,
 ##  Builds a band pass filter.
 #   @param gain  Filter gain in the passband (linear)
 #   @param Fs    Sampling rate (sps)
-#   @param freq1 End of stop band (in Hz)
-#   @param freq2 Start of pass band (in Hz)
+#   @param freq_sb1 End of stop band (in Hz)
+#   @param freq_pb1 Start of pass band (in Hz)
+#   @param freq_pb2 End of pass band (in Hz)
+#   @param freq_sb2 Start of stop band (in Hz)
 #   @param passband_ripple_db Pass band ripple in dB (should be small, < 1)
 #   @param stopband_atten_db  Stop band attenuation in dB (should be large, >= 60)
 #   @param nextra_taps  Extra taps to use in the filter (default=2)
@@ -80,8 +82,10 @@ def band_pass (gain, Fs, freq_sb1, freq_pb1, freq_pb2, freq_sb2,
 #   spinning it up to the right center frequency
 #   @param gain  Filter gain in the passband (linear)
 #   @param Fs    Sampling rate (sps)
-#   @param freq1 End of stop band (in Hz)
-#   @param freq2 Start of pass band (in Hz)
+#   @param freq_sb1 End of stop band (in Hz)
+#   @param freq_pb1 Start of pass band (in Hz)
+#   @param freq_pb2 End of pass band (in Hz)
+#   @param freq_sb2 Start of stop band (in Hz)
 #   @param passband_ripple_db Pass band ripple in dB (should be small, < 1)
 #   @param stopband_atten_db  Stop band attenuation in dB (should be large, >= 60)
 #   @param nextra_taps  Extra taps to use in the filter (default=2)