commit-gnuradio
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: n4hy
Subject: [Commit-gnuradio] r9707 - gnuradio/trunk/gnuradio-core/src/lib/general
Date: Fri, 3 Oct 2008 16:30:57 -0600 (MDT)

Author: n4hy
Date: 2008-10-03 16:30:56 -0600 (Fri, 03 Oct 2008)
New Revision: 9707

Modified:
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i
Log:
more cleanup of comments and adding left our functions to swig.  Not yet 
complete

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h    2008-10-03 
21:45:25 UTC (rev 9706)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h    2008-10-03 
22:30:56 UTC (rev 9707)
@@ -88,7 +88,7 @@
            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 @@
    *                           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 @@
             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 @@
             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 @@
             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 @@
               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
 

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i    2008-10-03 
21:45:25 UTC (rev 9706)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i    2008-10-03 
22:30:56 UTC (rev 9707)
@@ -49,6 +49,7 @@
    * \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





reply via email to

[Prev in Thread] Current Thread [Next in Thread]