[Commit-gnuradio] r9693 - gnuradio/trunk/gnuradio-core/src/lib/general

[n4hy]

Author: n4hy
Date: 2008-10-01 11:18:13 -0600 (Wed, 01 Oct 2008)
New Revision: 9693

Modified:
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i
Log:
when gr_firdes.i was last touched, my version 2 filter design programs were 
removed from the swig file.  Also added is appropriate remarks for the 
low_pass_2 only.  More later

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h    2008-10-01 
16:28:01 UTC (rev 9692)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h    2008-10-01 
17:18:13 UTC (rev 9693)
@@ -68,6 +68,21 @@
            win_type window = WIN_HAMMING,
            double beta = 6.76);                // used only with Kaiser
 
+  /*!
+   * \brief use "window method" to design a low-pass FIR filter
+   *
+   * \p gain:                  overall gain of filter (typically 1.0)
+   * \p sampling_freq:         sampling freq (Hz)
+   * \p cutoff_freq:           center of transition band (Hz)
+   * \p transition_width:      width of transition band (Hz).
+   * \p attenuation_dB          required stopband attenuation
+   *                           The normalized width of the transition
+   *                           band is what sets the number of taps
+   *                           required.  Narrow --> more taps
+   * \p window_type:           What kind of window to use. Determines
+   *                           maximum attenuation and passband ripple.
+   * \p beta:                  parameter for Kaiser window
+   */
   static std::vector<float>
   low_pass_2 (double gain,
            double sampling_freq,

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i    2008-10-01 
16:28:01 UTC (rev 9692)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i    2008-10-01 
17:18:13 UTC (rev 9693)
@@ -43,6 +43,31 @@
            ) throw(std::out_of_range);
 
   /*!
+   * \brief use "window method" to design a low-pass FIR filter
+   *  using alternative design criteria
+   * \p gain:                  overall gain of filter (typically 1.0)
+   * \p sampling_freq:         sampling freq (Hz)
+   * \p cutoff_freq:           center of transition band (Hz)
+   * \p transition_width:      width of transition band (Hz).
+   *                           The normalized width of the transition
+   *                           band is what sets the number of taps
+   *                           required.  Narrow --> more taps
+   * \p attenuation_dB          The required stop band attenuation in dB
+   * \p window_type:           What kind of window to use. Determines
+   *                           maximum attenuation and passband ripple.
+   * \p beta:                  parameter for Kaiser window
+   */
+  static std::vector<float>
+  low_pass_2 (double gain,
+           double sampling_freq,
+           double cutoff_freq,         // Hz center of transition band
+           double transition_width,    // Hz width of transition band
+           double attenuation_dB,       // out of band attenuation
+           win_type window = WIN_HAMMING,
+           double beta = 6.76          // used only with Kaiser
+           ) throw(std::out_of_range);
+
+  /*!
    * \brief use "window method" to design a high-pass FIR filter
    *
    * \p gain:                  overall gain of filter (typically 1.0)