more cleanup of comments and adding left our functions to swig. Not yet complete

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@9707 221aa14e-8319-0410-a670-987f0aec2ac5

diff --git a/gnuradio-core/src/lib/general/gr_firdes.h b/gnuradio-core/src/lib/general/gr_firdes.h
index 7b30084d96b700b8e7d653e4c3471b9720fd7df8..11752ddaeddb438aa5579cb38363cb68e69d27be 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_firdes.h
+++ b/gnuradio-core/src/lib/general/gr_firdes.h
@@ -88,7 +88,7 @@ class gr_firdes {
            double sampling_freq,
            double cutoff_freq,         // Hz beginning transition band
            double transition_width,    // Hz width of transition band
-           double attenuation_dB,   // attenuation dB
+           double attenuation_dB,      // out of band attenuation dB
            win_type window = WIN_HAMMING,
            double beta = 6.76);                // used only with Kaiser
 
@@ -106,6 +106,7 @@ class gr_firdes {
    *                           maximum attenuation and passband ripple.
    * \p beta:                  parameter for Kaiser window
    */
+
   static std::vector<float>
   high_pass (double gain,
             double sampling_freq,
@@ -114,12 +115,28 @@ class gr_firdes {
             win_type window = WIN_HAMMING,
             double beta = 6.76);               // used only with Kaiser
 
+  /*!
+   * \brief use "window method" to design a high-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          out of band 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>
   high_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,   // attenuation dB
+            double attenuation_dB,             // out of band attenuation dB
             win_type window = WIN_HAMMING,
             double beta = 6.76);               // used only with Kaiser
 
@@ -147,13 +164,29 @@ class gr_firdes {
             win_type window = WIN_HAMMING,
             double beta = 6.76);               // used only with Kaiser
 
+  /*!
+   * \brief use "window method" to design a band-pass FIR filter
+   *
+   * \p gain:                  overall gain of filter (typically 1.0)
+   * \p sampling_freq:         sampling freq (Hz)
+   * \p low_cutoff_freq:       center of transition band (Hz)
+   * \p high_cutoff_freq:      center of transition band (Hz)
+   * \p transition_width:      width of transition band (Hz).
+   * \p attenuation_dB          out of band 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>
   band_pass_2 (double gain,
             double sampling_freq,
             double low_cutoff_freq,            // Hz beginning transition band
             double high_cutoff_freq,           // Hz beginning transition band
             double transition_width,           // Hz width of transition band
-            double attenuation_dB,   // attenuation dB
+            double attenuation_dB,             // out of band attenuation dB
             win_type window = WIN_HAMMING,
             double beta = 6.76);               // used only with Kaiser
 
@@ -182,17 +215,33 @@ class gr_firdes {
             win_type window = WIN_HAMMING,
             double beta = 6.76);               // used only with Kaiser
 
+  /*!
+   * \brief use "window method" to design a complex band-pass FIR filter
+   *
+   * \p gain:                  overall gain of filter (typically 1.0)
+   * \p sampling_freq:         sampling freq (Hz)
+   * \p low_cutoff_freq:       center of transition band (Hz)
+   * \p high_cutoff_freq:      center of transition band (Hz)
+   * \p transition_width:      width of transition band (Hz).
+   * \p attenuation_dB          out of band 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<gr_complex>
   complex_band_pass_2 (double gain,
             double sampling_freq,
             double low_cutoff_freq,            // Hz beginning transition band
             double high_cutoff_freq,           // Hz beginning transition band
             double transition_width,           // Hz width of transition band
-            double attenuation_dB,             // attenuation dB
+            double attenuation_dB,             // out of band attenuation dB
             win_type window = WIN_HAMMING,
             double beta = 6.76);               // used only with Kaiser
 
-
   /*!
    * \brief use "window method" to design a band-reject FIR filter
    *
@@ -218,13 +267,30 @@ class gr_firdes {
               win_type window = WIN_HAMMING,
               double beta = 6.76);             // used only with Kaiser
 
+  /*!
+   * \brief use "window method" to design a band-reject FIR filter
+   *
+   * \p gain:                  overall gain of filter (typically 1.0)
+   * \p sampling_freq:         sampling freq (Hz)
+   * \p low_cutoff_freq:       center of transition band (Hz)
+   * \p high_cutoff_freq:      center of transition band (Hz)
+   * \p transition_width:      width of transition band (Hz).
+   * \p attenuation_dB          out of band 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>
   band_reject_2 (double gain,
               double sampling_freq,
               double low_cutoff_freq,          // Hz beginning transition band
               double high_cutoff_freq,         // Hz beginning transition band
               double transition_width,         // Hz width of transition band
-              double attenuation_dB,           // attenuation dB
+              double attenuation_dB,           // out of band attenuation dB
               win_type window = WIN_HAMMING,
               double beta = 6.76);             // used only with Kaiser
 

diff --git a/gnuradio-core/src/lib/general/gr_firdes.i b/gnuradio-core/src/lib/general/gr_firdes.i
index 4ac9855d23d8e8dbb2c562b2b7bd73d0d6e4013f..73becadba6604f1f881ca60d37852b0bbe8776a1 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_firdes.i
+++ b/gnuradio-core/src/lib/general/gr_firdes.i
@@ -49,6 +49,7 @@ class gr_firdes {
    * \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          out of band attenuation
    *                           The normalized width of the transition
    *                           band is what sets the number of taps
    *                           required.  Narrow --> more taps